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

[sdk-metrics] implement metrics exemplars #5147

Open
5 tasks
pichlermarc opened this issue Nov 13, 2024 · 0 comments
Open
5 tasks

[sdk-metrics] implement metrics exemplars #5147

pichlermarc opened this issue Nov 13, 2024 · 0 comments
Labels
needs:code-contribution This feature/bug is ready to implement pkg:sdk-metrics spec-feature This is a request to implement a new feature which is already specified by the OTel specification type:feature A feature with no sub-issues to address

Comments

@pichlermarc
Copy link
Member

Description

Important

This is a large feature that is not suitable for beginners.
Please make sure to sync with @open-telemetry/javascript-approvers first to ensure that there is bandwidth to review your work on this feature. It is recommended that the assignee joins the OpenTelemetry JavaScript SIG Meeting on Wednesdays to discuss any questions.

Prerequisite knowledge:

  • @opentelemetry/sdk-metrics internals
  • Knowlege about trace context and context management in OTel JS

Exemplars are a stable specification feature (see specification) that has a bootstrapped implementation in @opentelemetry/sdk-metrics which has never been driven to completion.

The goal of this issue is to implement this feature according to the specification and expose it to the user as an experimental feature. The assignee may have to remove and adapt the existing code to ensure that it follows all our requirements as laid out on this issue.

This issue is considered done when

  • the exemplars feature is implemented according to the current specification
  • a mechanism to collect and export exemplars is implemented
  • documentation is updated to include information about metrics exemplars and how to use them
  • serialization logic in @opentelemetry/otlp-transformer is amended in a way so that Exemplars may be exported using the existing OTLP/protobuf, OTLP/json and OTLP/grpc exporters
  • follow-up issues have been created to stabilize the feature after a suitable time-frame

Additonal Requirements

  • only interfaces and (factory)-functions as may be exposed as new APIs on @opentelemetry/sdk-metrics
  • all new interfaces and functions MUST be marked as @experimental
  • any properties added to the existing the public API of @opentelemetry/sdk-metrics MUST be optional and marked as @experimental

Additional Information/Resources

@pichlermarc pichlermarc added spec-feature This is a request to implement a new feature which is already specified by the OTel specification pkg:sdk-metrics type:feature A feature with no sub-issues to address needs:code-contribution This feature/bug is ready to implement labels Nov 13, 2024
@pichlermarc pichlermarc added this to the Metrics After GA milestone Nov 13, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
needs:code-contribution This feature/bug is ready to implement pkg:sdk-metrics spec-feature This is a request to implement a new feature which is already specified by the OTel specification type:feature A feature with no sub-issues to address
Projects
None yet
Development

No branches or pull requests

1 participant