diff --git a/.lychee.toml b/.lychee.toml index 812f0efbb..672bacfeb 100644 --- a/.lychee.toml +++ b/.lychee.toml @@ -1,15 +1,15 @@ -include-fragments = true +include_fragments = true accept = ["200..=299", "403"] -exclude = [ +exclude = [ "^https://www.foo.bar", # excluding links to pull requests and issues is done for performance "^https://github.com/open-telemetry/semantic-conventions/(pull|issue)/\\d+$" ] # better to be safe and avoid failures -max-retries = 6 +max_retries = 6 # insecure is currently needed for https://osi-model.com insecure = true diff --git a/docs/general/naming.md b/docs/general/naming.md index 51b04cd7a..62921a4ae 100644 --- a/docs/general/naming.md +++ b/docs/general/naming.md @@ -193,7 +193,7 @@ OpenTelemetry specification. might include multiple values: the executable name and command arguments. - When an attribute represents a measurement, - [Metric Name Pluralization Guidelines](./metrics.md#pluralization) SHOULD be + [Name Pluralization Guidelines](./naming.md#pluralization) SHOULD be followed for the attribute name. ### Signal-specific Attributes diff --git a/docs/hardware/README.md b/docs/hardware/README.md index 6b7f098cb..13d1470f8 100644 --- a/docs/hardware/README.md +++ b/docs/hardware/README.md @@ -7,7 +7,7 @@ linkTitle: Hardware **Status**: [Experimental][DocumentStatus] This document describes instruments and attributes for common hardware level -metrics in OpenTelemetry. Consider the [general metric semantic conventions](/docs/general/metrics.md#general-metric-semantic-conventions) +metrics in OpenTelemetry. Consider the [general metric semantic conventions](/docs/general/metrics.md#general-guidelines) when creating instruments not explicitly defined in the specification. Semantic conventions for hardware are defined as following: diff --git a/docs/runtime/README.md b/docs/runtime/README.md index f04801dd0..6927e4212 100644 --- a/docs/runtime/README.md +++ b/docs/runtime/README.md @@ -30,7 +30,7 @@ discussion. Metrics specific to a certain runtime environment should be prefixed with the runtime's top-level namespace `{environment}.*`, e.g., `jvm.*` and follow the -[general metric semantic convention guidelines](/docs/general/metrics.md#general-metric-semantic-conventions). +[general metric semantic convention guidelines](/docs/general/metrics.md#general-guidelines). Authors of runtime instrumentations are responsible for the choice of `{environment}` to avoid ambiguity when interpreting a metric's name or values. @@ -42,7 +42,7 @@ such languages, consider using specific `{environment}` prefixes to avoid ambiguity, like `cpython.*` and `pypy.*`. Also consider the -[general metrics](/docs/general/metrics.md#general-metric-semantic-conventions), +[general metrics](/docs/general/metrics.md#general-guidelines), [system metrics](/docs/system/system-metrics.md) and [OS process metrics](/docs/system/process-metrics.md) semantic conventions when instrumenting runtime environments. diff --git a/docs/system/hardware-metrics.md b/docs/system/hardware-metrics.md index f54c28130..fb5496deb 100644 --- a/docs/system/hardware-metrics.md +++ b/docs/system/hardware-metrics.md @@ -7,7 +7,7 @@ linkTitle: Hardware **Status**: [Experimental][DocumentStatus] This document describes instruments and attributes for common hardware level -metrics in OpenTelemetry. Consider the [general metric semantic conventions](/docs/general/metrics.md#general-metric-semantic-conventions) +metrics in OpenTelemetry. Consider the [general metric semantic conventions](/docs/general/metrics.md#general-guidelines) when creating instruments not explicitly defined in the specification. This document is being converted to specific hardware metrics, parts of this document that have already been diff --git a/docs/system/process-metrics.md b/docs/system/process-metrics.md index 749f542b2..01564ce30 100644 --- a/docs/system/process-metrics.md +++ b/docs/system/process-metrics.md @@ -8,7 +8,7 @@ linkTitle: Process This document describes instruments and attributes for common OS process level metrics in OpenTelemetry. Also consider the [general metric semantic -conventions](/docs/general/metrics.md#general-metric-semantic-conventions) when creating +conventions](/docs/general/metrics.md#general-guidelines) when creating instruments not explicitly defined in this document. OS process metrics are not related to the runtime environment of the program, and should take measurements from the operating system. For runtime environment metrics see diff --git a/docs/system/system-metrics.md b/docs/system/system-metrics.md index 3404b1d54..6194ae0e7 100644 --- a/docs/system/system-metrics.md +++ b/docs/system/system-metrics.md @@ -8,7 +8,7 @@ linkTitle: System This document describes instruments and attributes for common system level metrics in OpenTelemetry. Consider the [general metric semantic -conventions](/docs/general/metrics.md#general-metric-semantic-conventions) when creating +conventions](/docs/general/metrics.md#general-guidelines) when creating instruments not explicitly defined in the specification. The `system.*` namespace SHOULD be exclusively used to report hosts' metrics.