redpanda-data / redpanda-data/connect
Tracing spans should include component label in name
Open
Nobody has claimed this yet.
enhancement
observability
ux
- Dominant language
- Go
- Stars
- 8.8k
- Forks
- 969
- Avg merge
- 1d 13h
- Merged PRs (30d)
- 64
Description
Span names are currently the same as component types e.g. bloblang / log / output_stdout. This makes it hard to distinguish them and tie them back to config when analysing traces. A couple of solutions come to mind:
- Span names should include the label when available e.g.
<type>_<label>/bloblang_uppercase. - Spans should use label as name and set component type as an attribute. Use type as span name if label is not set. In all cases component type should be an attribute.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
No file or test is named. First locate the tracing span-name creation entry point and any existing span tests, then confirm which of the two proposed naming policies maintainers want. Done means spans distinguish components, connect to configuration labels when available, and expose the component type as an attribute according to the chosen policy.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- go
- Domain
- observability
- Issue type
- Feature
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 25/100