opentelemetry-specification icon indicating copy to clipboard operation
opentelemetry-specification copied to clipboard

Migrate metric semantic conventions into YAML

Open jsuereth opened this issue 4 years ago • 9 comments

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 avatar Oct 07 '21 16:10 jsuereth

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

Oberon00 avatar Oct 07 '21 19:10 Oberon00

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 avatar Oct 08 '21 03:10 reyang

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 avatar Oct 27 '21 00:10 jamesmoessis

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

jamesmoessis avatar Oct 27 '21 01:10 jamesmoessis

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

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

ocelotl avatar Oct 27 '21 09:10 ocelotl

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

osherv avatar Sep 02 '22 10:09 osherv

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. https://github.com/open-telemetry/build-tools/pull/79

joaopgrassi avatar Sep 02 '22 10:09 joaopgrassi

Hello folks, I've just done a bunch more work on https://github.com/open-telemetry/build-tools/pull/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 😄

jamesmoessis avatar Sep 13 '22 02:09 jamesmoessis

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

I am not involved in this effort, please contact @jamesmoessis :v:

ocelotl avatar Sep 21 '22 17:09 ocelotl