open-telemetry / open-telemetry/weaver
The provenance is not always properly reported
Nobody has claimed this yet.
- Dominant language
- Rust
- Stars
- 486
- Forks
- 108
- Avg merge
- 3d 4h
- Merged PRs (30d)
- 40
Description
The provenance information reported by Weaver is not always ideal. Below are a few examples that should be improved:
Instead of:
Provenance: https://github.com/open-telemetry/semantic-conventions/archive/refs/tags/v1.27.0.zip[model]/metrics/go-metrics.yaml
We should have:
Provenance: https://github.com/open-telemetry/semantic-conventions/archive/refs/tags/v1.27.0.zip[model/metrics/go-metrics.yaml]
Instead of:
⚠ The attribute `aws.dynamodb.table_names` in the group `registry.aws.dynamodb` contains an example that will be considered invalid in the future. All examples SHOULD be of type `string[]`.
│ Provenance: "/Users/L.Querel/.weaver/semconv_registry_cache/repo.EcPezALMZfx2/registry/aws.yaml"
We should have:
⚠ The attribute `aws.dynamodb.table_names` in the group `registry.aws.dynamodb` contains an example that will be considered invalid in the future. All examples SHOULD be of type `string[]`.
│ Provenance: https://github.com/open-telemetry/semantic-conventions/archive/refs/tags/v1.27.0.zip[model/registry/aws.yaml]
Implementation recommendation: In weaver_cache we should extend RegistryPath to add a method updating the current path with a relative path.
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 in the weaver_cache module and inspect RegistryPath, focusing on how the current path is assembled and displayed. Extend the path handling as recommended, then verify that the reported provenance uses the archive URL with the relative path in brackets and no local cache path.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- rust
- Domain
- tooling
- Issue type
- Bug
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Clearly specified
- Newbie friendliness
- 52/100