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

Generate Attribute Registry using Weaver #917

Merged
merged 72 commits into from
May 1, 2024

Conversation

jsuereth
Copy link
Contributor

@jsuereth jsuereth commented Apr 11, 2024

This PR is ready for review. Upon enough acceptance, a weaver version will be cut with all necessary functionality so and this PR will be updated to only use this version.

How to Review

All content under attributes-registry is autogenerated files. For styling issues/concerns, you can comment directly on jinja templates under templates/registry/markdown.

For issues where attribute registry "groups" are not displaying, you can comment on templates/registry/markdown/weaver.yaml where the configuration for resolving attribute registry exists.

For issues on snippet generation (and moving from local to full in all snippets), comment directly on templates with problematic issues and we'll open bugs against Weaver to improve its out of the box support (Note: this will be moving to JINJA templates we would control in semconv repository eventually).

Ready-For-Merge TODOs

Blocking

Nice to Have

Changes

Update the entire docs/attributes-registry directory to be autogenreated from semantic convention YAML.

  • Add new makefile target for generating the attribute registry
  • Add jinja templates for rendering README / namespace markdown files as close as possible to oriiginal
  • Add new makefile target for testing difference between weaver-generated snippets and existing snippets.
  • Clean up some oddities in model YAML files when detected.
  • Update "recording an exception" to link to stable opentelemetry.io page.
  • Update markdown "fix" prettier usage to apply to the attribute registry.
  • Update makefile check to see if attribute registry is out of date

Merge requirement checklist

jsuereth and others added 30 commits April 10, 2024 09:41
Relies on (not submitted yet) flatten filter in weaver
- Update notes macros to be a library for re-use
- Update attribute registry so deprecated yaml consistently use prefix
- Add Deprecated rendering markdwon
- Update config to extract deprecated attributes  in registry.
@nirga
Copy link
Contributor

nirga commented Apr 24, 2024

@jsuereth looks like unrelated changed in the gen-ai folder?

@jsuereth
Copy link
Contributor Author

@jsuereth looks like unrelated changed in the gen-ai folder?

@nirga What are you seeing that's not related?

As part of this PR:

  • All attribute registry links are now /docs/attributes-registry vs. relative paths.
  • All enums are now open (decision made a while ago, snippet generation now accounts for it)
  • All markdown snippets implicitly use "full" config.

Copy link
Member

@ChrsMark ChrsMark left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@jsuereth jsuereth changed the title [WIP] Generate Attribute Registry using Weaver Generate Attribute Registry using Weaver Apr 29, 2024
docs/attributes-registry/exception.md Show resolved Hide resolved
docs/attributes-registry/http.md Outdated Show resolved Hide resolved
docs/attributes-registry/otel.md Outdated Show resolved Hide resolved
docs/attributes-registry/server.md Show resolved Hide resolved
docs/attributes-registry/source.md Show resolved Hide resolved
docs/attributes-registry/telemetry.md Outdated Show resolved Hide resolved
docs/runtime/jvm-metrics.md Show resolved Hide resolved
.github/CODEOWNERS Show resolved Hide resolved
Copy link
Contributor

@lquerel lquerel left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@lmolkova lmolkova merged commit 651d779 into open-telemetry:main May 1, 2024
11 of 12 checks passed
@jsuereth jsuereth deleted the wip-weaver-attribute-registry branch May 1, 2024 18:24
drewby pushed a commit to drewby/otel-semantic-conventions that referenced this pull request May 23, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
Archived in project
Development

Successfully merging this pull request may close these issues.

9 participants