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.

Sign up for GitHub

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

Jump to bottom

Allow sharing/inheriting notes/brief from overriden ref attributes #183

Closed
joaopgrassi opened this issue Jun 15, 2023 · 2 comments
Closed

Allow sharing/inheriting notes/brief from overriden ref attributes #183

joaopgrassi opened this issue Jun 15, 2023 · 2 comments
Labels
enhancement New feature or request help wanted Extra attention is needed semconv/md Related specifically to the markdown output of the semantic convention generator semconv/model Related to the data model or YAML format of the semantic convention generator semconv Related to the semantic convention generator.

Comments

@joaopgrassi
Copy link
Member

It seems it's not possible to share brief/notes (might also be others?) from an attribute that is a ref and overrides the "original" attribute.

For example, the case with the server.address attribute:

  1. Originally defined in server.yaml with its own brief/note field
  2. Referenced in http-common.yaml from server.yaml, overriding the brief/note
  3. Referenced in traces/http from http-common.yaml -> Doesn't get the note from http-common.yaml

This makes it so we need to copy/paste things over and over. See this PR for the problem in action.

It would be great if we could also "share" the notes/brief from an attribute that has been overridden somehow.
@joaopgrassi joaopgrassi added enhancement New feature or request help wanted Extra attention is needed semconv Related to the semantic convention generator. semconv/md Related specifically to the markdown output of the semantic convention generator semconv/model Related to the data model or YAML format of the semantic convention generator labels Jun 15, 2023
@joaopgrassi joaopgrassi changed the title Allow to share/inherit notes/brief from overriden ref Allow to share/inherit notes/brief from overriden ref attribute Jun 15, 2023
@joaopgrassi joaopgrassi mentioned this issue Jun 15, 2023
Merged
@joaopgrassi joaopgrassi changed the title Allow to share/inherit notes/brief from overriden ref attribute Allow sharing/inheriting notes/brief from overriden ref attributes Jun 15, 2023
@Oberon00
Copy link
Member

One suggestion of how a solution could look like: Reference the overriden attribute using group_id:attribute_name (new colon-syntax to distinguish normal fully.qualified.attribute_name syntax), where group_id is the ID of the referencing group (NB: Not the prefix!).

@joaopgrassi joaopgrassi mentioned this issue Jul 25, 2023
Open
@lmolkova
Copy link
Contributor

lmolkova commented Oct 3, 2023

I think this is fixed in #204, and here's semconv changes open-telemetry/semantic-conventions#367.

So closing this one, feel free to reopen if I missed something.

@lmolkova lmolkova closed this as completed Oct 3, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
enhancement New feature or request help wanted Extra attention is needed semconv/md Related specifically to the markdown output of the semantic convention generator semconv/model Related to the data model or YAML format of the semantic convention generator semconv Related to the semantic convention generator.
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
3 participants
@Oberon00 @lmolkova @joaopgrassi