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

Added display_name property to all registry attribute groups #985

Open
wants to merge 2 commits into
base: main
Choose a base branch
from

Conversation

AlexanderWert
Copy link
Member

Fixes #978

@AlexanderWert
Copy link
Member Author

AlexanderWert commented Apr 30, 2024

To make CI happy we need also: open-telemetry/build-tools#316

Copy link
Contributor

@trisch-me trisch-me left a comment

Choose a reason for hiding this comment

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

thanks for quick implementing it. @jsuereth could add this now into the final PR to populate correct name

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

@trisch-me
Copy link
Contributor

One question though - should we enforce then a presence of this property for registry?

@AlexanderWert
Copy link
Member Author

One question though - should we enforce then a presence of this property for registry?

yeah, I guess we could extend open-telemetry/build-tools#316 to include it in the validity checks

Copy link
Contributor

@lmolkova lmolkova left a comment

Choose a reason for hiding this comment

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

Could you please create an issue to update schema definition (or just update the schema definition) in the https://github.com/open-telemetry/build-tools/blob/main/semantic-conventions/semconv.schema.json to include it?

We want to move it to this repo #916, but it's not done yet

Copy link

@noahfalk noahfalk left a comment

Choose a reason for hiding this comment

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

LGTM

@noahfalk
Copy link

@JamesNK (Just fyi - This looks like a minor cosmetic change)

@jsuereth
Copy link
Contributor

jsuereth commented May 1, 2024

One question though - should we enforce then a presence of this property for registry?

Once we get the rule-engine/checker working in weaver, this is a simple configuration for semantic-conventions. Let's see if we can get that prioritized as a the next feature we need from weaver for semconv.

Copy link
Contributor

@jsuereth jsuereth left a comment

Choose a reason for hiding this comment

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

Thanks for adding all of these.

We need to update both build-tools and weaver. I merged your build-tools change (will need a release) but we'll also need to update weaver.

Since the weaver PR merged, you should be able to actually update the weaver attribute_group.md.j2 template to use this value in this PR.

@AlexanderWert
Copy link
Member Author

Could you please create an issue to update schema definition (or just update the schema definition) in the https://github.com/open-telemetry/build-tools/blob/main/semantic-conventions/semconv.schema.json to include it?

Done, see: open-telemetry/build-tools#317

Signed-off-by: Alexander Wert <alexander.wert@elastic.co>
Signed-off-by: Alexander Wert <alexander.wert@elastic.co>
@AlexanderWert
Copy link
Member Author

Since the weaver PR merged, you should be able to actually update the weaver attribute_group.md.j2 template to use this value in this PR.

@jsuereth Done with the last commit.

@lmolkova
Copy link
Contributor

lmolkova commented May 2, 2024

@AlexanderWert I think you need to run make table-generation to re-generate registry MD files with display name.

@AlexanderWert
Copy link
Member Author

@AlexanderWert I think you need to run make table-generation to re-generate registry MD files with display name.

That's not working yet, I'm getting a validation error from weaver. So, as @jsuereth mentioned above, we need to fix weaver validation first and release a new docker image, I guess.

@jsuereth What exactly needs to be done to fix the weaver validation? Is it just about adding display_name as a property in this struct?: https://github.com/open-telemetry/weaver/blob/261e4f42518fee67a00b1a81be4029a82fd19799/crates/weaver_semconv/src/group.rs#L21

@jsuereth
Copy link
Contributor

jsuereth commented May 6, 2024

@AlexanderWert Yes - I think that change (and propagation of its value) should be what you need to do in weaver.

There's also a TemplateGroup: https://github.com/open-telemetry/weaver/blob/main/crates/weaver_forge/src/registry.rs#L29

Once you have Group / TemplateGroup updated and wired - we can immediately start rendering this attribute in the registry.

Copy link

This PR was marked stale due to lack of activity. It will be closed in 7 days.

@github-actions github-actions bot added the Stale label May 22, 2024
@joaopgrassi joaopgrassi removed the Stale label May 28, 2024
@joaopgrassi joaopgrassi added the never stale PRs marked with this label will be never staled and automatically closed label Jun 10, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
never stale PRs marked with this label will be never staled and automatically closed Skip Changelog Label to skip the changelog check
Projects
Development

Successfully merging this pull request may close these issues.

Add name property on registry attribute groups
7 participants