open-telemetry / open-telemetry/opentelemetry-java-instrumentation
[Metadata] Document metric bridges
Nobody has claimed this yet.
- Dominant language
- Java
- Stars
- 2.6k
- Forks
- 1.2k
- Avg merge
- 2d 18h
- Merged PRs (30d)
- 228
Description
There are a handful of instrumentations that enable metrics, but through a bridge or converter as opposed to generating them directly. Examples are the kafka client, micrometer. These should be documented in a different approach than the existing instrumentations, and excluded from the standard way we are currently using the "telemetry" section in the instrumentation-list.yaml catalog. Perhaps there should also be a new "feature" added to help categorize these.
Discussed here: https://github.com/open-telemetry/opentelemetry-java-instrumentation/pull/15319#discussion_r2532037546
Instrumentations that should be reviewed and evaluated to see if they fit into this other category:
- kafka-clients-2.6
- micrometer-1.5
- dropwizard-metrics-4.0
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
Start with instrumentation-list.yaml and the discussion linked from pull request 15319, then review kafka-clients-2.6, micrometer-1.5, and dropwizard-metrics-4.0. Determine how metric bridges should be represented separately from the standard telemetry section and whether a new feature category is needed; done means the affected entries and documentation approach are defined and updated consistently.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- java
- Domain
- documentation, observability
- Issue type
- Documentation
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100