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 for go runtime metrics #535

Closed
dashpole opened this issue Nov 16, 2023 · 1 comment · Fixed by #981
Closed

Semantic conventions for go runtime metrics #535

dashpole opened this issue Nov 16, 2023 · 1 comment · Fixed by #981
Assignees
Labels
enhancement New feature or request

Comments

@dashpole
Copy link
Contributor

For runtime semantic conventions, we currently only have JVM metrics defined: https://github.com/open-telemetry/semantic-conventions/tree/main/docs/runtime#semantic-conventions-for-runtime-environment. The Go SIG (discussed on 11/16/23) would like to agree on conventions in this repository before expanding the set of metrics offered by the go runtime instrumentation package: https://pkg.go.dev/go.opentelemetry.io/contrib/instrumentation/runtime#pkg-overview to minimize the churn to users.

Additional context:

Starting Questions/potential issues:

  • Which metrics from the go runtime are stable? What are the stability guarantees?
  • Which metrics should be on-by-default? Go is possibly considering recommending a default set: runtime: diagnostics improvements tracking issue golang/go#57175 (comment).
  • Go runtime metrics are currently named runtime.go.*, which conflicts with the runtime metrics guidance: Metrics specific to a certain runtime environment should be prefixed with the runtime's top-level namespace {environment}.*, e.g., jvm.*

@MrAlias @pellared

@dashpole dashpole added the enhancement New feature or request label Nov 16, 2023
@trask
Copy link
Member

trask commented Nov 16, 2023

Which metrics from the go runtime are stable? What are the stability guarantees?

in case the prior art helps, we are putting the breaking JVM metrics changes that we are implementing as part of JVM metric stability behind OTEL_SEMCONV_STABILITY_OPT_IN=jvm (and will make them the default in upcoming Java Instrumentation 2.0)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

Successfully merging a pull request may close this issue.

4 participants