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

Semantic Conventions should provide support for code generation of AnyValue (event/complex types) fields #1748

Open
MSNev opened this issue Jan 15, 2025 · 2 comments
Labels
tooling Regarding build, workflows, build-tools, ...

Comments

@MSNev
Copy link
Contributor

MSNev commented Jan 15, 2025

Description

As part of the introduction for the Logs AnyValue and the discussions around support for Complete types Semantic Conventions / Weaver should provide guidance and support on how SIG's should create and optionally namespace the (potentially nested) fields of a complex body or attribute definition.

While the intent of event (complex) fields is to be isolated for usage only within the specific event definition, so that different events / complex types may contain the same "named" field with different meanings, comments, constraints, etc).

So while for some events / types this will mean that this will be generated in only a single location (code base), the Semantic Convention for this does not preclude or infer that their will only ever be a single generator (instrumentation, etc) of these complex fields.

Workarounds

  • Hand coding / hard coding any of these names (where necessary)

Considerations

  • As not all types / languages will necessarily need this capability so there should be some type of opt-in or specific selection of the needed "type"
  • Default helpers / tools should provide guidance on how these should be generated and / or namespaced

Additional Context

This issue is related and highlighted by open-telemetry/semantic-conventions-java#135, which while this specific issue / need is due to the historic definitions, it has highlighted that as more complex types are created this will become more important.

Discussed in the Semantic Conventions Tooling meeting on Jan 15th, 2025.

@MSNev
Copy link
Contributor Author

MSNev commented Jan 15, 2025

Cross created issue as this will most likely require changes in both Semantic Conventions and Weaver
open-telemetry/weaver#555

@lmolkova lmolkova added the tooling Regarding build, workflows, build-tools, ... label Jan 18, 2025
@lmolkova
Copy link
Contributor

lmolkova commented Jan 23, 2025

Discussed at Log SIG on 1/21:

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
tooling Regarding build, workflows, build-tools, ...
Projects
Development

No branches or pull requests

2 participants