Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: 🌓🚀 add a utility attr name-to-description lookup function #267

Draft
wants to merge 7 commits into
base: main
Choose a base branch
from

Conversation

robbkidd
Copy link
Member

Which problem is this PR solving?

  • Help folks know what an OTel attribute means.

Short description of the changes

The first baby steps toward showing a description for a recognized attribute. Look up names that match stable OpenTelemetry semantic conventions and return a reasonable description. The descriptions in this PR are pulled from the semconv "brief" associated with each attribute.

The Future

  • We expect to continue using the OTel semconv brief for each stable attribute name.
  • Generate this lookup from the semconv models?

@robbkidd robbkidd changed the title feat: add a utility attr name-to-description lookup function feat: 🌓🚀 add a utility attr name-to-description lookup function Jun 24, 2024
robbkidd added 6 commits June 24, 2024 14:22
Response body size is still experimental. Don't include it.
Which are stable? From the semconv repo[1] at v1.26.0 tag:

    ❯ cat model/registry/http.yaml | \
        yq '.groups[] |
            select(.id == "registry.http").attributes[] |
            select(.stability == "stable") |
            "attrName: \(.id)\nexpectedDescription: \(.brief)\n" '

[1] https://github.com/open-telemetry/semantic-conventions
We like maps. Maps are fast.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants