-
Notifications
You must be signed in to change notification settings - Fork 894
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Move metrics requirement levels to semconv repo (#3956)
- Loading branch information
1 parent
3dac62b
commit 3c2eaae
Showing
1 changed file
with
7 additions
and
38 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| 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/). |