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

Move metrics requirement levels to semconv repo #3956

Merged
merged 5 commits into from
Apr 5, 2024
Merged

Move metrics requirement levels to semconv repo #3956

Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
b03e4ed
Metrics requirement levels moved to semconv repo
joaopgrassi Mar 22, 2024
6e49905
Merge branch 'main' into metrics-requirement-level-to-semconv
joaopgrassi Mar 26, 2024
a4630b0
Merge branch 'main' into metrics-requirement-level-to-semconv
joaopgrassi Mar 28, 2024
ea01737
Merge branch 'main' into metrics-requirement-level-to-semconv
arminru Mar 29, 2024
a31752f
Merge branch 'main' into metrics-requirement-level-to-semconv
joaopgrassi Apr 5, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
45 changes: 7 additions & 38 deletions specification/metrics/metric-requirement-level.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,40 +1,9 @@
# Metric Requirement Levels for Semantic Conventions

**Status**: [Stable](../document-status.md)

<details>
<summary>Table of Contents</summary>

<!-- toc -->

- [Required](#required)
- [Recommended](#recommended)
- [Opt-In](#opt-in)

<!-- tocstop -->

</details>

The following metric requirement levels are specified:
<!--- Hugo front matter used to generate the website version of this page:
linkTitle: Metric Requirement Levels
redirect: /docs/specs/semconv/general/metric-requirement-level/ 301!
--->

- [Required](#required)
- [Recommended](#recommended)
- [Opt-In](#opt-in)

## Required

All instrumentations MUST emit the metric.
A semantic convention defining a Required metric expects that an absolute majority of instrumentation libraries and applications are able to efficiently emit it.

## Recommended

Instrumentations SHOULD emit the metric by default if it's readily available and can be efficiently emitted. Instrumentations MAY offer a configuration option to disable Recommended metrics.

Instrumentations that decide not to emit `Recommended` metrics due to performance, security, privacy, or other consideration by default, SHOULD allow for opting in to emitting them as defined for the `Opt-In` requirement level if the metrics are logically applicable.

## Opt-In

Instrumentations SHOULD emit the metric if and only if the user configures the instrumentation to do so.
Instrumentation that doesn't support configuration MUST NOT emit `Opt-In` metrics.
# Metric Requirement Levels for Semantic Conventions

This attribute requirement level is recommended for metrics that are particularly expensive to retrieve or might pose a security or privacy risk. These should therefore only be enabled deliberately by a user making an informed decision.
This page has moved to
[Metric Requirement Levels](https://opentelemetry.io/docs/specs/semconv/general/metric-requirement-level/).
Loading