Change to relative links
This commit is contained in:
parent
d445ea5eec
commit
84cd08ef20
|
|
@ -65,7 +65,7 @@ Names SHOULD follow these rules:
|
||||||
values: the executable name and command arguments.
|
values: the executable name and command arguments.
|
||||||
|
|
||||||
- When an attribute represents a measurement,
|
- When an attribute represents a measurement,
|
||||||
[Metric Name Pluralization Guidelines](https://github.com/open-telemetry/semantic-conventions/blob/main/docs/general/metrics.md#pluralization)
|
[Metric Name Pluralization Guidelines](./metrics.md#pluralization)
|
||||||
SHOULD be followed for the attribute name.
|
SHOULD be followed for the attribute name.
|
||||||
|
|
||||||
## Name Reuse Prohibition
|
## Name Reuse Prohibition
|
||||||
|
|
@ -83,7 +83,7 @@ denote old attribute names in rename operations).
|
||||||
of a namespace.
|
of a namespace.
|
||||||
|
|
||||||
- When coming up with a new semantic convention make sure to check existing
|
- When coming up with a new semantic convention make sure to check existing
|
||||||
namespaces ([Semantic Conventions](https://github.com/open-telemetry/semantic-conventions/blob/main/docs/README.md))
|
namespaces ([Semantic Conventions](./README.md))
|
||||||
to see if the new name fits.
|
to see if the new name fits.
|
||||||
|
|
||||||
- When a new namespace is necessary consider whether it should be a top-level
|
- When a new namespace is necessary consider whether it should be a top-level
|
||||||
|
|
@ -107,7 +107,7 @@ denote old attribute names in rename operations).
|
||||||
## Recommendations for Application Developers
|
## Recommendations for Application Developers
|
||||||
|
|
||||||
As an application developer when you need to record an attribute first consult
|
As an application developer when you need to record an attribute first consult
|
||||||
existing [semantic conventions](https://github.com/open-telemetry/semantic-conventions/blob/main/docs/README.md).
|
existing [semantic conventions](./README.md).
|
||||||
If an appropriate name does not exists you will need to come up with a new name.
|
If an appropriate name does not exists you will need to come up with a new name.
|
||||||
To do that consider a few options:
|
To do that consider a few options:
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -1,4 +1,4 @@
|
||||||
# Attribute Requirement Levels for Semantic Conventions
|
# Attribute Requirement Levels
|
||||||
|
|
||||||
**Status**: [Stable](../document-status.md)
|
**Status**: [Stable](../document-status.md)
|
||||||
|
|
||||||
|
|
@ -35,7 +35,7 @@ For example, Metric attributes that may have high cardinality can only be define
|
||||||
A semantic convention that refers to an attribute from another semantic convention MAY modify the requirement level within its own scope. Otherwise, requirement level from the referred semantic convention applies.
|
A semantic convention that refers to an attribute from another semantic convention MAY modify the requirement level within its own scope. Otherwise, requirement level from the referred semantic convention applies.
|
||||||
|
|
||||||
<!-- TODO(jsuereth) - make examples not break on changes to semconv -->
|
<!-- TODO(jsuereth) - make examples not break on changes to semconv -->
|
||||||
For example, [Database semantic convention](https://github.com/open-telemetry/semantic-conventions/blob/main/docs/database/README.md) references `network.transport` attribute defined in [General attributes](https://github.com/open-telemetry/semantic-conventions/blob/main/docs/general/README.md) with `Conditionally Required` level on it.
|
For example, [Database semantic convention](../database/README.md) references `network.transport` attribute defined in [General attributes](./README.md) with `Conditionally Required` level on it.
|
||||||
|
|
||||||
## Required
|
## Required
|
||||||
|
|
||||||
|
|
@ -52,7 +52,7 @@ All instrumentations MUST populate the attribute when the given condition is sat
|
||||||
When a `Conditionally Required` attribute's condition is not satisfied, and there is no requirement to populate the attribute, semantic conventions MAY provide special instructions on how to handle it. If no instructions are given and if instrumentation can populate the attribute, instrumentation SHOULD use the `Opt-In` requirement level on the attribute.
|
When a `Conditionally Required` attribute's condition is not satisfied, and there is no requirement to populate the attribute, semantic conventions MAY provide special instructions on how to handle it. If no instructions are given and if instrumentation can populate the attribute, instrumentation SHOULD use the `Opt-In` requirement level on the attribute.
|
||||||
|
|
||||||
<!-- TODO(jsuereth) - make examples not break on changes to semconv -->
|
<!-- TODO(jsuereth) - make examples not break on changes to semconv -->
|
||||||
For example, `server.address` is `Conditionally Required` by the [Database convention](https://github.com/open-telemetry/semantic-conventions/blob/main/docs/database/README.md) when available. When `network.peer.address` is available instead, instrumentation can do a DNS lookup, cache and populate `server.address`, but only if the user explicitly enables the instrumentation to do so, considering the performance issues that DNS lookups introduce.
|
For example, `server.address` is `Conditionally Required` by the [Database convention](../database/README.md) when available. When `network.peer.address` is available instead, instrumentation can do a DNS lookup, cache and populate `server.address`, but only if the user explicitly enables the instrumentation to do so, considering the performance issues that DNS lookups introduce.
|
||||||
|
|
||||||
## Recommended
|
## Recommended
|
||||||
|
|
||||||
|
|
|
||||||
Loading…
Reference in New Issue