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.

Sign up for GitHub

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

Jump to bottom

[telemetry] Define lifecycle and stability of telemetry #10003

Open
mx-psi opened this issue Apr 19, 2024 · 3 comments · May be fixed by open-telemetry/opentelemetry.io#5092
Open

[telemetry] Define lifecycle and stability of telemetry #10003

mx-psi opened this issue Apr 19, 2024 · 3 comments · May be fixed by open-telemetry/opentelemetry.io#5092
Assignees
@codeboten
Labels
collector-telemetry healthchecker and other telemetry collection issues help wanted Good issue for contributors to OpenTelemetry Service to pick up priority:p2 Medium release:required-for-ga Must be resolved before GA release
Milestone
Self observability

Comments

@mx-psi
Copy link
Member

mx-psi commented Apr 19, 2024

On the GA Roadmap, we have

  • Metrics, or a subset of them, should be marked as stable in the documentation
  • [...]
  • Stability expectations and lifecycle for telemetry should be documented, so that users can know what they can rely on for their dashboards and alerts

A starting point can be https://kubernetes.io/docs/concepts/cluster-administration/system-metrics/#metric-lifecycle
@mx-psi mx-psi added help wanted Good issue for contributors to OpenTelemetry Service to pick up priority:p2 Medium collector-telemetry healthchecker and other telemetry collection issues labels Apr 19, 2024
@lavishpal
Copy link
Contributor

@mx-psi
Could you assign this issue to me and it will be helpful if you provide guidance on how to get started?

@mx-psi
Copy link
Member Author

mx-psi commented May 6, 2024

@lavishpal We can start with a document that lists out what we guarantee from a stable metric (in terms of what can change). We can initially host the document in the docs/ folder of this repository. Once we have that, we can consider next steps

@mx-psi mx-psi added this to the Self observability milestone May 24, 2024
@mx-psi mx-psi added the release:required-for-ga Must be resolved before GA release label Jul 17, 2024
@tiffany76
Copy link
Contributor

During the Comms SIG meeting on August 5, we discussed where this content should live: website or repo. Since the lifecycle of the telemetry affects whether it can be used, the group felt this content belongs on the website where it can benefit end users. We are seeking additional comments as well.

codeboten added a commit to codeboten/opentelemetry.io that referenced this issue Aug 22, 2024
@codeboten
Collector telemetry lifecycle
21163cf 
This is an initial attempt at documenting the lifecycle of telemetry emitted by the Collector.

Fixes open-telemetry/opentelemetry-collector#10003

Signed-off-by: Alex Boten <223565+codeboten@users.noreply.github.com>
@codeboten codeboten linked a pull request Aug 22, 2024 that will close this issue
Open
@codeboten codeboten self-assigned this Aug 22, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@codeboten codeboten

Labels
collector-telemetry healthchecker and other telemetry collection issues help wanted Good issue for contributors to OpenTelemetry Service to pick up priority:p2 Medium release:required-for-ga Must be resolved before GA release
Projects
Collector: v1
Status: Waiting for reviews
Milestone
Self observability
Development

Successfully merging a pull request may close this issue.

Collector telemetry lifecycle codeboten/opentelemetry.io
4 participants
@codeboten @mx-psi @tiffany76 @lavishpal