open-telemetry · arminru · May 23, 2023 · May 23, 2023 · May 23, 2023 · May 23, 2023
@@ -1,6 +1,6 @@
 # Log Attribute Semantic Conventions
 
-**Status**: [Experimental](../../document-status.md)
+**Status**: [Experimental][DocumentStatus]
 
 The following semantic conventions for logs are defined:
 
@@ -14,3 +14,5 @@ The following semantic conventions for events are defined:
 Apart from semantic conventions for logs, [traces](../../trace/semantic_conventions/README.md), and [metrics](../../metrics/semantic_conventions/README.md),
 OpenTelemetry also defines the concept of overarching [Resources](https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/resource/sdk.md) with their own
 [Resource Semantic Conventions](../../resource/semantic_conventions/README.md).
+
+[DocumentStatus]: https://github.com/open-telemetry/opentelemetry-specification/blob/v1.21.0/specification/document-status.md
@@ -1,6 +1,6 @@
 # Semantic Convention for event attributes
 
-**Status**: [Experimental](../../document-status.md)
+**Status**: [Experimental][DocumentStatus]
 
 This document describes the attributes of standalone Events that are represented
 in the data model by `LogRecord`s. Events are recorded as LogRecords that are shaped
@@ -43,3 +43,5 @@ unrelated events.
 | `device` | Events from mobile apps |
 | `k8s` | Events from Kubernetes |
 <!-- endsemconv -->
+
+[DocumentStatus]: https://github.com/open-telemetry/opentelemetry-specification/blob/v1.21.0/specification/document-status.md
@@ -1,6 +1,6 @@
 # Semantic Conventions for Exceptions
 
-**Status**: [Experimental](../../document-status.md)
+**Status**: [Experimental][DocumentStatus]
 
 This document defines semantic conventions for recording exceptions on
 [logs](https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/logs/bridge-api.md#emit-a-logrecord) and [events](https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/logs/event-api.md#emit-event)
@@ -48,3 +48,5 @@ The table below indicates which attributes should be added to the
 
 Same as [Trace Semantic Conventions for Exceptions - Stacktrace
 Representation](../../trace/semantic_conventions/exceptions.md#stacktrace-representation).
+
+[DocumentStatus]: https://github.com/open-telemetry/opentelemetry-specification/blob/v1.21.0/specification/document-status.md
@@ -1,6 +1,6 @@
 # Semantic Conventions for Feature Flag Evaluations
 
-**Status**: [Experimental](../../document-status.md)
+**Status**: [Experimental][DocumentStatus]
 
 This document defines semantic conventions for recording feature flag evaluations as
 a [log record](https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/logs/data-model.md#log-and-event-record-definition) emitted through the
@@ -51,3 +51,5 @@ A stringified version of the value can be used in situations where a
 semantic identifier is unavailable. String representation of the value
 should be determined by the implementer.
 <!-- endsemconv -->
+
+[DocumentStatus]: https://github.com/open-telemetry/opentelemetry-specification/blob/v1.21.0/specification/document-status.md
@@ -1,6 +1,6 @@
 # General attributes
 
-**Status**: [Experimental](../../document-status.md)
+**Status**: [Experimental][DocumentStatus]
 
 The attributes described in this section are rather generic.
 They may be used in any Log Record they apply to.
@@ -25,3 +25,5 @@ These attributes may be used for identifying a Log Record.
 **[1]:** If an id is provided, other log records with the same id will be considered duplicates and can be removed safely. This means, that two distinguishable log records MUST have different values.
 The id MAY be an [Universally Unique Lexicographically Sortable Identifier (ULID)](https://github.com/ulid/spec), but other identifiers (e.g. UUID) may be used as needed.
 <!-- endsemconv -->
+
+[DocumentStatus]: https://github.com/open-telemetry/opentelemetry-specification/blob/v1.21.0/specification/document-status.md
@@ -1,6 +1,6 @@
 # Semantic Conventions for Log Media
 
-**Status**: [Experimental](../../document-status.md)
+**Status**: [Experimental][DocumentStatus]
 
 This document describes attributes for log media in OpenTelemetry. Log media are mechanisms by which logs are transmitted. Types of media include files, streams, network protocols, and os-specific logging services such as journald and Windows Event Log.
 
@@ -43,3 +43,5 @@ As such, these should be recorded as Log Record attributes when applicable. They
 | Name                            | Notes and examples                                                                       |
 | ------------------------------- | ---------------------------------------------------------------------------------------- |
 | `log.iostream`        | The stream associated with the log. SHOULD be one of: `stdout`, `stderr` |
+
+[DocumentStatus]: https://github.com/open-telemetry/opentelemetry-specification/blob/v1.21.0/specification/document-status.md
@@ -5,7 +5,7 @@ linkTitle: Semantic Conventions
 <!-- omit in toc -->
 # Metrics Semantic Conventions
 
-**Status**: [Mixed](../../document-status.md)
+**Status**: [Mixed][DocumentStatus]
 
 <!-- toc -->
 
@@ -41,7 +41,7 @@ Conventions](../../resource/semantic_conventions/README.md).
 
 ## General Guidelines
 
-**Status**: [Experimental](../../document-status.md)
+**Status**: [Experimental][DocumentStatus]
 
 Metric names and attributes exist within a single universe and a single
 hierarchy. Metric names and attributes MUST be considered within the universe of
@@ -127,15 +127,15 @@ to the processes then to represent the count of the processes we can have a metr
 
 ## General Metric Semantic Conventions
 
-**Status**: [Mixed](../../document-status.md)
+**Status**: [Mixed][DocumentStatus]
 
 The following semantic conventions aim to keep naming consistent. They
 provide guidelines for most of the cases in this specification and should be
 followed for other instruments not explicitly defined in this document.
 
 ### Instrument Naming
 
-**Status**: [Experimental](../../document-status.md)
+**Status**: [Experimental][DocumentStatus]
 
 - **limit** - an instrument that measures the constant, known total amount of
 something should be called `entity.limit`. For example, `system.memory.limit`
@@ -180,7 +180,7 @@ instrument creation, but can be added if there is ambiguity.
 
 ### Instrument Units
 
-**Status**: [Stable](../../document-status.md)
+**Status**: [Stable][DocumentStatus]
 
 Units should follow the
 [Unified Code for Units of Measure](http://unitsofmeasure.org/ucum.html).
@@ -205,7 +205,7 @@ use `{packet}`, `{error}`, `{fault}`, etc.
 
 ### Instrument Types
 
-**Status**: [Stable](../../document-status.md)
+**Status**: [Stable][DocumentStatus]
 
 The semantic metric conventions specification is written to use the names of the synchronous instrument types,
 like `Counter` or `UpDownCounter`. However, compliant implementations MAY use the asynchronous equivalent instead,
@@ -215,11 +215,13 @@ implementation detail. Both choices are compliant with this specification.
 
 ### Consistent UpDownCounter timeseries
 
-**Status**: [Experimental](../../document-status.md)
+**Status**: [Experimental][DocumentStatus]
 
 When recording `UpDownCounter` metrics, the same attribute values used to record an increment SHOULD be used to record
 any associated decrement, otherwise those increments and decrements will end up as different timeseries.
 
 For example, if you are tracking `active_requests` with an `UpDownCounter`, and you are incrementing it each time a
 request starts and decrementing it each time a request ends, then any attributes which are not yet available when
 incrementing the counter at request start should not be used when decrementing the counter at request end.
+
+[DocumentStatus]: https://github.com/open-telemetry/opentelemetry-specification/blob/v1.21.0/specification/document-status.md
@@ -4,7 +4,7 @@ linkTitle: Database
 
 # Semantic Conventions for Database Metrics
 
-**Status**: [Experimental](../../document-status.md)
+**Status**: [Experimental][DocumentStatus]
 
 The conventions described in this section are specific to SQL and NoSQL clients.
 
@@ -59,3 +59,5 @@ Below is a table of the attributes that MUST be included on all connection pool
 | Name        | Type   | Description                                                                  | Examples       | Requirement Level |
 |-------------|--------|------------------------------------------------------------------------------|----------------|-------------------|
 | `pool.name` | string | The name of the connection pool; unique within the instrumented application. In case the connection pool implementation does not provide a name, then the [db.connection_string](/specification/trace/semantic_conventions/database.md#connection-level-attributes) should be used. | `myDataSource` | Required          |
+
+[DocumentStatus]: https://github.com/open-telemetry/opentelemetry-specification/blob/v1.21.0/specification/document-status.md
@@ -4,7 +4,7 @@ linkTitle: FaaS
 
 # Semantic Conventions for FaaS Metrics
 
-**Status**: [Experimental](../../document-status.md)
+**Status**: [Experimental][DocumentStatus]
 
 This document defines how to describe an instance of a function that runs without provisioning
 or managing of servers (also known as serverless functions or Function as a Service (FaaS)) with metrics.
@@ -81,3 +81,5 @@ FaaS providers. This list is not exhaustive.
 * [Azure Functions Metrics](https://docs.microsoft.com/azure/azure-monitor/platform/metrics-supported)
 * [Google CloudFunctions Metrics](https://cloud.google.com/monitoring/api/metrics_gcp#gcp-cloudfunctions)
 * [OpenFaas Metrics](https://docs.openfaas.com/architecture/metrics/)
+
+[DocumentStatus]: https://github.com/open-telemetry/opentelemetry-specification/blob/v1.21.0/specification/document-status.md
@@ -4,7 +4,7 @@ linkTitle: Hardware
 
 # Semantic Conventions for Hardware Metrics
 
-**Status**: [Experimental](../../document-status.md)
+**Status**: [Experimental][DocumentStatus]
 
 This document describes instruments and attributes for common hardware level
 metrics in OpenTelemetry. Consider the [general metric semantic conventions](README.md#general-metric-semantic-conventions)
@@ -387,3 +387,5 @@ Additional **Recommended** attributes:
 | Attribute Key     | Description            | Example    |
 | ----------------- | ---------------------- | ---------- |
 | `sensor_location` | Location of the sensor | `PS0 V3_3` |
+
+[DocumentStatus]: https://github.com/open-telemetry/opentelemetry-specification/blob/v1.21.0/specification/document-status.md
@@ -4,7 +4,7 @@ linkTitle: HTTP
 
 # Semantic Conventions for HTTP Metrics
 
-**Status**: [Experimental](../../document-status.md)
+**Status**: [Experimental][DocumentStatus]
 
 The conventions described in this section are HTTP specific. When HTTP operations occur,
 metric events about those operations will be generated and reported to provide insight into the
@@ -348,3 +348,5 @@ SHOULD NOT be set if capturing it would require an extra DNS lookup.
 
 **[4]:** If not default (`80` for `http` scheme, `443` for `https`).
 <!-- endsemconv -->
+
+[DocumentStatus]: https://github.com/open-telemetry/opentelemetry-specification/blob/v1.21.0/specification/document-status.md
@@ -1 +1,5 @@
 # Instrumentation
+
+**Status**: [Experimental][DocumentStatus]
+
+[DocumentStatus]: https://github.com/open-telemetry/opentelemetry-specification/blob/v1.21.0/specification/document-status.md
@@ -4,7 +4,7 @@ linkTitle: Kafka
 
 # Instrumenting Kafka
 
-**Status**: [Experimental](../../../document-status.md)
+**Status**: [Experimental][DocumentStatus]
 
 This document defines how to apply semantic conventions when instrumenting Kafka.
 
@@ -82,3 +82,5 @@ This document defines how to apply semantic conventions when instrumenting Kafka
 |                                               |               |            |     |         |                                                                 | `partition` | The number (integer) of the partition |
 | messaging.kafka.consumer.lag_sum              | Gauge         | Int64      | lag sum | `{lag sum}` | Current approximate sum of consumer group lag across all partitions of topic | `group` | The ID (string) of a consumer group |
 |                                               |               |            |         |             |                                                                              | `topic` | The ID (integer) of a topic |
+
+[DocumentStatus]: https://github.com/open-telemetry/opentelemetry-specification/blob/v1.21.0/specification/document-status.md
@@ -4,7 +4,7 @@ linkTitle: Process
 
 # Semantic Conventions for OS Process Metrics
 
-**Status**: [Experimental](../../document-status.md)
+**Status**: [Experimental][DocumentStatus]
 
 This document describes instruments and attributes for common OS process level
 metrics in OpenTelemetry. Also consider the [general metric semantic
@@ -47,3 +47,5 @@ Below is a table of Process metric instruments.
 ## Attributes
 
 Process metrics SHOULD be associated with a [`process`](../../resource/semantic_conventions/process.md#process) resource whose attributes provide additional context about the process.
+
+[DocumentStatus]: https://github.com/open-telemetry/opentelemetry-specification/blob/v1.21.0/specification/document-status.md
@@ -4,7 +4,7 @@ linkTitle: RPC
 
 # General RPC conventions
 
-**Status**: [Experimental](../../document-status.md)
+**Status**: [Experimental][DocumentStatus]
 
 The conventions described in this section are RPC specific. When RPC operations
 occur, measurements about those operations are recorded to instruments. The
@@ -220,3 +220,5 @@ Below is a table of attributes that SHOULD be included on client and server RPC
 | `data_loss` | data_loss |
 | `unauthenticated` | unauthenticated |
 <!-- endsemconv -->
+
+[DocumentStatus]: https://github.com/open-telemetry/opentelemetry-specification/blob/v1.21.0/specification/document-status.md