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

Migrate metric semantic conventions into YAML #2001

Open
jsuereth opened this issue Oct 7, 2021 · 9 comments
Open

Migrate metric semantic conventions into YAML #2001

jsuereth opened this issue Oct 7, 2021 · 9 comments
Labels
area:semantic-conventions Related to semantic conventions release:allowed-for-ga Editorial changes that can still be added before GA since they don't require action by SIGs spec:metrics Related to the specification/metrics directory

Comments

@jsuereth
Copy link
Contributor

jsuereth commented Oct 7, 2021

This may need updates to the tool as we go to support how metric conventions are viewed, but we should work on getting metric semantic conventions into the YAML files for code generation.

Was raised in Java SiG for folks working on new types of instrumentation using metric semantic conventions.

@jsuereth jsuereth added area:semantic-conventions Related to semantic conventions spec:metrics Related to the specification/metrics directory labels Oct 7, 2021
@Oberon00
Copy link
Member

Oberon00 commented Oct 7, 2021

How much YAML "code" sharing should there be between trace and metric conventions, regarding attributes?

@reyang reyang assigned ocelotl and unassigned yurishkuro Oct 8, 2021
@reyang
Copy link
Member

reyang commented Oct 8, 2021

Discussed during the 10/07/2021 Metrics SIG meeting.

@ocelotl is offering help here.

Note that the current mechanism/script might need to be improved in order to support metrics, e.g. the support for instrument names.

@reyang reyang added the release:allowed-for-ga Editorial changes that can still be added before GA since they don't require action by SIGs label Oct 8, 2021
@jamesmoessis
Copy link
Contributor

How much YAML "code" sharing should there be between trace and metric conventions, regarding attributes?

@Oberon00 This is a great question. For conventions that apply to both metrics and traces, IMO metric attributes could be a subset of the trace attributes. The reason being, all attributes would apply to both but metrics need to be lower cardinality.

@jamesmoessis
Copy link
Contributor

I'm more than happy to assist with this - @ocelotl did you need any help?

@ocelotl
Copy link
Contributor

ocelotl commented Oct 27, 2021

I'm more than happy to assist with this - @ocelotl did you need any help?

Hey @jamesmoessis, I'll contact you via slack, thanks!

@osherv
Copy link
Member

osherv commented Sep 2, 2022

@ocelotl Hey, I'll be more than happy to join this task as well!

@joaopgrassi
Copy link
Member

Maybe it's not known, so I'll post here:

There's a PR in the build-tools repo that proposes a way to generate markdown tables from yaml for metrics. open-telemetry/build-tools#79

@jamesmoessis
Copy link
Contributor

Hello folks, I've just done a bunch more work on open-telemetry/build-tools#79 and I believe it is now at a stage close to being merged. If anyone else wants to review the structure of the yaml and the generated markdown tables, please feel free to review and join the discussion on the PR 😄

@ocelotl
Copy link
Contributor

ocelotl commented Sep 21, 2022

@ocelotl Hey, I'll be more than happy to join this task as well!

I am not involved in this effort, please contact @jamesmoessis ✌️

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area:semantic-conventions Related to semantic conventions release:allowed-for-ga Editorial changes that can still be added before GA since they don't require action by SIGs spec:metrics Related to the specification/metrics directory
Development

No branches or pull requests

8 participants