Remove status documents and link to published specification. (#47)

This commit is contained in:
Josh Suereth 2023-05-23 12:02:09 -04:00 committed by GitHub
parent 4c5194ae78
commit 350b501c27
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
52 changed files with 189 additions and 128 deletions

View File

@ -1,3 +0,0 @@
# Document Status
Semantic Conventions follows the [Specification document status conventions](https://github.com/open-telemetry/opentelemetry-specification/tree/v1.21.0/specification/document-status.md).

View File

@ -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/tree/v1.21.0/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

View File

@ -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

View File

@ -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/tree/v1.21.0/specification/logs/bridge-api.md#emit-a-logrecord) and [events](https://github.com/open-telemetry/opentelemetry-specification/tree/v1.21.0/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

View File

@ -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/tree/v1.21.0/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

View File

@ -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

View File

@ -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

View File

@ -1,42 +0,0 @@
# Metric Requirement Levels
This document is the same as [the specification](https://github.com/open-telemetry/opentelemetry-specification/tree/v1.21.0/specification/metrics/metric-requirement-level.md).
**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:
- [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.
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.

View File

@ -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,7 +127,7 @@ 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
@ -135,7 +135,7 @@ 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,7 +215,7 @@ 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.
@ -223,3 +223,5 @@ any associated decrement, otherwise those increments and decrements will end up
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

View File

@ -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

View File

@ -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

View File

@ -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

View File

@ -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

View File

@ -1 +1,5 @@
# Instrumentation
**Status**: [Experimental][DocumentStatus]
[DocumentStatus]: https://github.com/open-telemetry/opentelemetry-specification/blob/v1.21.0/specification/document-status.md

View File

@ -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

View File

@ -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

View File

@ -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

View File

@ -4,7 +4,7 @@ linkTitle: Runtime Environment
# Semantic Conventions for Runtime Environment Metrics
**Status**: [Experimental](../../document-status.md)
**Status**: [Experimental][DocumentStatus]
This document includes semantic conventions for runtime environment level
metrics in OpenTelemetry. Also consider the [general
@ -77,7 +77,7 @@ consider, for example pthreads vs green thread implementations.
### Metric: `process.runtime.jvm.memory.usage`
This metric is [recommended](../metric-requirement-level.md#recommended).
This metric is [recommended][MetricRecommended].
This metric is obtained from [`MemoryPoolMXBean#getUsage()`](https://docs.oracle.com/javase/8/docs/api/java/lang/management/MemoryPoolMXBean.html#getUsage--).
<!-- semconv metric.process.runtime.jvm.memory.usage(metric_table) -->
@ -104,7 +104,7 @@ This metric is obtained from [`MemoryPoolMXBean#getUsage()`](https://docs.oracle
### Metric: `process.runtime.jvm.memory.init`
This metric is [recommended](../metric-requirement-level.md#recommended).
This metric is [recommended][MetricRecommended].
This metric is obtained from [`MemoryPoolMXBean#getUsage()`](https://docs.oracle.com/javase/8/docs/api/java/lang/management/MemoryPoolMXBean.html#getUsage--).
<!-- semconv metric.process.runtime.jvm.memory.init(metric_table) -->
@ -131,7 +131,7 @@ This metric is obtained from [`MemoryPoolMXBean#getUsage()`](https://docs.oracle
### Metric: `process.runtime.jvm.memory.committed`
This metric is [recommended](../metric-requirement-level.md#recommended).
This metric is [recommended][MetricRecommended].
This metric is obtained from [`MemoryPoolMXBean#getUsage()`](https://docs.oracle.com/javase/8/docs/api/java/lang/management/MemoryPoolMXBean.html#getUsage--).
<!-- semconv metric.process.runtime.jvm.memory.committed(metric_table) -->
@ -158,7 +158,7 @@ This metric is obtained from [`MemoryPoolMXBean#getUsage()`](https://docs.oracle
### Metric: `process.runtime.jvm.memory.limit`
This metric is [recommended](../metric-requirement-level.md#recommended).
This metric is [recommended][MetricRecommended].
This metric is obtained from [`MemoryPoolMXBean#getUsage()`](https://docs.oracle.com/javase/8/docs/api/java/lang/management/MemoryPoolMXBean.html#getUsage--).
<!-- semconv metric.process.runtime.jvm.memory.limit(metric_table) -->
@ -185,7 +185,7 @@ This metric is obtained from [`MemoryPoolMXBean#getUsage()`](https://docs.oracle
### Metric: `process.runtime.jvm.memory.usage_after_last_gc`
This metric is [recommended](../metric-requirement-level.md#recommended).
This metric is [recommended][MetricRecommended].
This metric is obtained from [`MemoryPoolMXBean#getCollectionUsage()`](https://docs.oracle.com/javase/8/docs/api/java/lang/management/MemoryPoolMXBean.html#getCollectionUsage--).
<!-- semconv metric.process.runtime.jvm.memory.usage_after_last_gc(metric_table) -->
@ -212,7 +212,7 @@ This metric is obtained from [`MemoryPoolMXBean#getCollectionUsage()`](https://d
### Metric: `process.runtime.jvm.gc.duration`
This metric is [recommended](../metric-requirement-level.md#recommended).
This metric is [recommended][MetricRecommended].
This metric is obtained by subscribing to
[`GarbageCollectionNotificationInfo`](https://docs.oracle.com/javase/8/docs/jre/api/management/extension/com/sun/management/GarbageCollectionNotificationInfo.html) events provided by [`GarbageCollectorMXBean`](https://docs.oracle.com/javase/8/docs/api/java/lang/management/GarbageCollectorMXBean.html). The duration value is obtained from [`GcInfo`](https://docs.oracle.com/javase/8/docs/jre/api/management/extension/com/sun/management/GcInfo.html#getDuration--)
@ -239,7 +239,7 @@ of `[]` (single bucket histogram capturing count, sum, min, max).
### Metric: `process.runtime.jvm.threads.count`
This metric is [recommended](../metric-requirement-level.md#recommended).
This metric is [recommended][MetricRecommended].
This metric is obtained from [`ThreadMXBean#getDaemonThreadCount()`](https://docs.oracle.com/javase/8/docs/api/java/lang/management/ThreadMXBean.html#getDaemonThreadCount--) and
[`ThreadMXBean#getThreadCount()`](https://docs.oracle.com/javase/8/docs/api/java/lang/management/ThreadMXBean.html#getThreadCount--).
@ -257,7 +257,7 @@ This metric is obtained from [`ThreadMXBean#getDaemonThreadCount()`](https://doc
### Metric: `process.runtime.jvm.classes.loaded`
This metric is [recommended](../metric-requirement-level.md#recommended).
This metric is [recommended][MetricRecommended].
This metric is obtained from [`ClassLoadingMXBean#getTotalLoadedClassCount()`](https://docs.oracle.com/javase/8/docs/api/java/lang/management/ClassLoadingMXBean.html#getTotalLoadedClassCount--).
<!-- semconv metric.process.runtime.jvm.classes.loaded(metric_table) -->
@ -271,7 +271,7 @@ This metric is obtained from [`ClassLoadingMXBean#getTotalLoadedClassCount()`](h
### Metric: `process.runtime.jvm.classes.unloaded`
This metric is [recommended](../metric-requirement-level.md#recommended).
This metric is [recommended][MetricRecommended].
This metric is obtained from [`ClassLoadingMXBean#getUnloadedClassCount()`](https://docs.oracle.com/javase/8/docs/api/java/lang/management/ClassLoadingMXBean.html#getUnloadedClassCount--).
<!-- semconv metric.process.runtime.jvm.classes.unloaded(metric_table) -->
@ -285,7 +285,7 @@ This metric is obtained from [`ClassLoadingMXBean#getUnloadedClassCount()`](http
### Metric: `process.runtime.jvm.classes.current_loaded`
This metric is [recommended](../metric-requirement-level.md#recommended).
This metric is [recommended][MetricRecommended].
This metric is obtained from [`ClassLoadingMXBean#getLoadedClassCount()`](https://docs.oracle.com/javase/8/docs/api/java/lang/management/ClassLoadingMXBean.html#getLoadedClassCount--).
<!-- semconv metric.process.runtime.jvm.classes.current_loaded(metric_table) -->
@ -299,7 +299,7 @@ This metric is obtained from [`ClassLoadingMXBean#getLoadedClassCount()`](https:
### Metric: `process.runtime.jvm.cpu.utilization`
This metric is [recommended](../metric-requirement-level.md#recommended).
This metric is [recommended][MetricRecommended].
This metric is obtained from [`com.sun.management.OperatingSystemMXBean#getProcessCpuLoad()`](https://docs.oracle.com/en/java/javase/17/docs/api/jdk.management/com/sun/management/OperatingSystemMXBean.html#getProcessCpuLoad()) on HotSpot
and [`com.ibm.lang.management.OperatingSystemMXBean#getProcessCpuLoad()`](https://www.ibm.com/docs/api/v1/content/SSYKE2_8.0.0/com.ibm.java.api.80.doc/com.ibm.lang.management/com/ibm/lang/management/OperatingSystemMXBean.html#getProcessCpuLoad--) on J9.
@ -314,7 +314,7 @@ and [`com.ibm.lang.management.OperatingSystemMXBean#getProcessCpuLoad()`](https:
### Metric: `process.runtime.jvm.system.cpu.utilization`
This metric is [recommended](../metric-requirement-level.md#recommended).
This metric is [recommended][MetricRecommended].
This metric is obtained from [`com.sun.management.OperatingSystemMXBean#getSystemCpuLoad()`](https://docs.oracle.com/en/java/javase/17/docs/api/jdk.management/com/sun/management/OperatingSystemMXBean.html#getSystemCpuLoad()) on Java version 8..13, [`com.sun.management.OperatingSystemMXBean#getCpuLoad()`](https://docs.oracle.com/en/java/javase/17/docs/api/jdk.management/com/sun/management/OperatingSystemMXBean.html#getCpuLoad()) on Java version 14+,
and [`com.ibm.lang.management.OperatingSystemMXBean#getSystemCpuLoad()`](https://www.ibm.com/docs/api/v1/content/SSYKE2_8.0.0/com.ibm.java.api.80.doc/com.ibm.lang.management/com/ibm/lang/management/OperatingSystemMXBean.html#getSystemCpuLoad--) on J9.
@ -329,7 +329,7 @@ and [`com.ibm.lang.management.OperatingSystemMXBean#getSystemCpuLoad()`](https:/
### Metric: `process.runtime.jvm.system.cpu.load_1m`
This metric is [recommended](../metric-requirement-level.md#recommended).
This metric is [recommended][MetricRecommended].
This metric is obtained from [`OperatingSystemMXBean#getSystemLoadAverage()`](https://docs.oracle.com/javase/8/docs/api/java/lang/management/OperatingSystemMXBean.html#getSystemLoadAverage--).
<!-- semconv metric.process.runtime.jvm.system.cpu.load_1m(metric_table) -->
@ -343,7 +343,7 @@ This metric is obtained from [`OperatingSystemMXBean#getSystemLoadAverage()`](ht
### Metric: `process.runtime.jvm.buffer.usage`
This metric is [recommended](../metric-requirement-level.md#recommended).
This metric is [recommended][MetricRecommended].
This metric is obtained from [`BufferPoolMXBean#getMemoryUsed()`](https://docs.oracle.com/javase/8/docs/api/java/lang/management/BufferPoolMXBean.html#getMemoryUsed--).
<!-- semconv metric.process.runtime.jvm.buffer.usage(metric_table) -->
@ -362,7 +362,7 @@ This metric is obtained from [`BufferPoolMXBean#getMemoryUsed()`](https://docs.o
### Metric: `process.runtime.jvm.buffer.limit`
This metric is [recommended](../metric-requirement-level.md#recommended).
This metric is [recommended][MetricRecommended].
This metric is obtained from [`BufferPoolMXBean#getTotalCapacity()`](https://docs.oracle.com/javase/8/docs/api/java/lang/management/BufferPoolMXBean.html#getTotalCapacity--).
<!-- semconv metric.process.runtime.jvm.buffer.limit(metric_table) -->
@ -381,7 +381,7 @@ This metric is obtained from [`BufferPoolMXBean#getTotalCapacity()`](https://doc
### Metric: `process.runtime.jvm.buffer.count`
This metric is [recommended](../metric-requirement-level.md#recommended).
This metric is [recommended][MetricRecommended].
This metric is obtained from [`BufferPoolMXBean#getCount()`](https://docs.oracle.com/javase/8/docs/api/java/lang/management/BufferPoolMXBean.html#getCount--).
<!-- semconv metric.process.runtime.jvm.buffer.count(metric_table) -->
@ -397,3 +397,6 @@ This metric is obtained from [`BufferPoolMXBean#getCount()`](https://docs.oracle
**[1]:** Pool names are generally obtained via [BufferPoolMXBean#getName()](https://docs.oracle.com/en/java/javase/11/docs/api/java.management/java/lang/management/BufferPoolMXBean.html#getName()).
<!-- endsemconv -->
[DocumentStatus]: https://github.com/open-telemetry/opentelemetry-specification/blob/v1.21.0/specification/document-status.md
[MetricRecommended]: https://github.com/open-telemetry/opentelemetry-specification/blob/v1.21.0/specification/metrics/metric-requirement-level.md#recommended

View File

@ -4,7 +4,7 @@ linkTitle: System
# Semantic Conventions for System Metrics
**Status**: [Experimental](../../document-status.md)
**Status**: [Experimental][DocumentStatus]
This document describes instruments and attributes for common system level
metrics in OpenTelemetry. Consider the [general metric semantic
@ -187,3 +187,5 @@ code](https://github.com/torvalds/linux/blob/e4cbce4d131753eca271d9d67f58c6377f2
An instrument for load average over 1 minute on Linux could be named
`system.linux.cpu.load_1m`, reusing the `cpu` name proposed above and having
an `{os}` prefix to split this metric across OSes.
[DocumentStatus]: https://github.com/open-telemetry/opentelemetry-specification/blob/v1.21.0/specification/document-status.md

View File

@ -1,6 +1,6 @@
# Resource Semantic Conventions
**Status**: [Mixed](../../document-status.md)
**Status**: [Mixed][DocumentStatus]
This document defines standard attributes for resources. These attributes are typically used in the [Resource](https://github.com/open-telemetry/opentelemetry-specification/tree/v1.21.0/specification/resource/sdk.md) and are also recommended to be used anywhere else where there is a need to describe a resource in a consistent manner. The majority of these attributes are inherited from
[OpenCensus Resource standard](https://github.com/census-instrumentation/opencensus-specs/blob/master/resource/StandardResources.md).
@ -36,7 +36,7 @@ This document defines standard attributes for resources. These attributes are ty
## Document Conventions
**Status**: [Stable](../../document-status.md)
**Status**: [Stable][DocumentStatus]
Attributes are grouped logically by the type of the concept that they described. Attributes in the same group have a common prefix that ends with a dot. For example all attributes that describe Kubernetes properties start with "k8s."
@ -45,7 +45,7 @@ should be included.
## Attributes with Special Handling
**Status**: [Stable](../../document-status.md)
**Status**: [Stable][DocumentStatus]
Given their significance some resource attributes are treated specifically as described below.
@ -66,7 +66,7 @@ as specified in the [Resource SDK specification](https://github.com/open-telemet
## Service
**Status**: [Stable](../../document-status.md)
**Status**: [Stable][DocumentStatus]
**type:** `service`
@ -82,7 +82,7 @@ as specified in the [Resource SDK specification](https://github.com/open-telemet
## Service (Experimental)
**Status**: [Experimental](../../document-status.md)
**Status**: [Experimental][DocumentStatus]
**type:** `service`
@ -116,7 +116,7 @@ service.name = Shop.shoppingcart
## Telemetry SDK
**Status**: [Stable](../../document-status.md)
**Status**: [Stable][DocumentStatus]
**type:** `telemetry.sdk`
@ -156,7 +156,7 @@ All custom identifiers SHOULD be stable across different versions of an implemen
## Telemetry SDK (Experimental)
**Status**: [Experimental](../../document-status.md)
**Status**: [Experimental][DocumentStatus]
**type:** `telemetry.sdk`
@ -170,7 +170,7 @@ All custom identifiers SHOULD be stable across different versions of an implemen
## Compute Unit
**Status**: [Experimental](../../document-status.md)
**Status**: [Experimental][DocumentStatus]
Attributes defining a compute unit (e.g. Container, Process, Function as a Service):
@ -181,7 +181,7 @@ Attributes defining a compute unit (e.g. Container, Process, Function as a Servi
## Compute Instance
**Status**: [Experimental](../../document-status.md)
**Status**: [Experimental][DocumentStatus]
Attributes defining a computing instance (e.g. host):
@ -189,7 +189,7 @@ Attributes defining a computing instance (e.g. host):
## Environment
**Status**: [Experimental](../../document-status.md)
**Status**: [Experimental][DocumentStatus]
Attributes defining a running environment (e.g. Operating System, Cloud, Data Center, Deployment Service):
@ -203,7 +203,7 @@ Attributes defining a running environment (e.g. Operating System, Cloud, Data Ce
## Version attributes
**Status**: [Stable](../../document-status.md)
**Status**: [Stable][DocumentStatus]
Version attributes, such as `service.version`, are values of type `string`. They are
the exact version used to identify an artifact. This may be a semantic version, e.g., `1.2.3`, git hash, e.g.,
@ -211,7 +211,7 @@ the exact version used to identify an artifact. This may be a semantic version,
## Cloud-Provider-Specific Attributes
**Status**: [Experimental](../../document-status.md)
**Status**: [Experimental][DocumentStatus]
Attributes that are only applicable to resources from a specific cloud provider. Currently, these
resources can only be defined for providers listed as a valid `cloud.provider` in
@ -224,3 +224,5 @@ Valid cloud providers are:
- [Microsoft Azure](https://azure.microsoft.com/) (`azure`)
- [Tencent Cloud](https://www.tencentcloud.com/) (`tencent_cloud`)
- [Heroku dyno](./cloud_provider/heroku.md)
[DocumentStatus]: https://github.com/open-telemetry/opentelemetry-specification/blob/v1.21.0/specification/document-status.md

View File

@ -1,6 +1,6 @@
# Browser
**Status**: [Experimental](../../document-status.md)
**Status**: [Experimental][DocumentStatus]
**type:** `browser`
@ -28,3 +28,5 @@ The list of possible values is defined in the [W3C User-Agent Client Hints speci
**[5]:** The user-agent value SHOULD be provided only from browsers that do not have a mechanism to retrieve brands and platform individually from the User-Agent Client Hints API. To retrieve the value, the legacy `navigator.userAgent` API can be used.
<!-- endsemconv -->
[DocumentStatus]: https://github.com/open-telemetry/opentelemetry-specification/blob/v1.21.0/specification/document-status.md

View File

@ -1,6 +1,6 @@
# Cloud
**Status**: [Experimental](../../document-status.md)
**Status**: [Experimental][DocumentStatus]
**type:** `cloud`
@ -83,3 +83,5 @@ The following well-known definitions MUST be used if you set this attribute and
| `tencent_cloud_eks` | Tencent Cloud Elastic Kubernetes Service (EKS) |
| `tencent_cloud_scf` | Tencent Cloud Serverless Cloud Function (SCF) |
<!-- endsemconv -->
[DocumentStatus]: https://github.com/open-telemetry/opentelemetry-specification/blob/v1.21.0/specification/document-status.md

View File

@ -1,6 +1,6 @@
# AWS Semantic Conventions
**Status**: [Experimental](../../../../document-status.md)
**Status**: [Experimental][DocumentStatus]
This directory defines standards for resource attributes that only apply to Amazon
Web Services (AWS) resources. If an attribute could apply to resources from more than one cloud
@ -20,3 +20,5 @@ Attributes that relate to an individual AWS service:
- [Elastic Container Service (ECS)](./ecs.md)
- [Elastic Kubernetes Service (EKS)](./eks.md)
[DocumentStatus]: https://github.com/open-telemetry/opentelemetry-specification/blob/v1.21.0/specification/document-status.md

View File

@ -1,6 +1,6 @@
# AWS ECS
**Status**: [Experimental](../../../../document-status.md)
**Status**: [Experimental][DocumentStatus]
**type:** `aws.ecs`
@ -23,3 +23,5 @@
| `ec2` | ec2 |
| `fargate` | fargate |
<!-- endsemconv -->
[DocumentStatus]: https://github.com/open-telemetry/opentelemetry-specification/blob/v1.21.0/specification/document-status.md

View File

@ -1,6 +1,6 @@
# AWS EKS
**Status**: [Experimental](../../../../document-status.md)
**Status**: [Experimental][DocumentStatus]
**type:** `aws.eks`
@ -11,3 +11,5 @@
|---|---|---|---|---|
| `aws.eks.cluster.arn` | string | The ARN of an EKS cluster. | `arn:aws:ecs:us-west-2:123456789123:cluster/my-cluster` | Recommended |
<!-- endsemconv -->
[DocumentStatus]: https://github.com/open-telemetry/opentelemetry-specification/blob/v1.21.0/specification/document-status.md

View File

@ -1,6 +1,6 @@
# AWS Logs
**Status**: [Experimental](../../../../document-status.md)
**Status**: [Experimental][DocumentStatus]
**Type:** `aws.log`
@ -20,3 +20,5 @@
**[3]:** See the [log stream ARN format documentation](https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/iam-access-control-overview-cwl.html#CWL_ARN_Format). One log group can contain several log streams, so these ARNs necessarily identify both a log group and a log stream.
<!-- endsemconv -->
[DocumentStatus]: https://github.com/open-telemetry/opentelemetry-specification/blob/v1.21.0/specification/document-status.md

View File

@ -1,5 +1,7 @@
# GCP Semantic Conventions
**Status**: [Experimental][DocumentStatus]
This directory defines standards for resource attributes that only apply to
Google Cloud Platform (GCP). If an attribute could apply to resources from more than one cloud
provider (like account ID, operating system, etc), it belongs in the parent
@ -8,3 +10,5 @@ provider (like account ID, operating system, etc), it belongs in the parent
## Services
- [Cloud Run](./cloud_run.md)
[DocumentStatus]: https://github.com/open-telemetry/opentelemetry-specification/blob/v1.21.0/specification/document-status.md

View File

@ -1,5 +1,7 @@
# Google Cloud Run
**Status**: [Experimental][DocumentStatus]
These conventions are recommended for resources running on Cloud Run.
**Type:** `gcp.cloud_run`
@ -12,3 +14,5 @@ These conventions are recommended for resources running on Cloud Run.
| `gcp.cloud_run.job.execution` | string | The name of the Cloud Run [execution](https://cloud.google.com/run/docs/managing/job-executions) being run for the Job, as set by the [`CLOUD_RUN_EXECUTION`](https://cloud.google.com/run/docs/container-contract#jobs-env-vars) environment variable. | `job-name-xxxx`; `sample-job-mdw84` | Recommended |
| `gcp.cloud_run.job.task_index` | int | The index for a task within an execution as provided by the [`CLOUD_RUN_TASK_INDEX`](https://cloud.google.com/run/docs/container-contract#jobs-env-vars) environment variable. | `0`; `1` | Recommended |
<!-- endsemconv -->
[DocumentStatus]: https://github.com/open-telemetry/opentelemetry-specification/blob/v1.21.0/specification/document-status.md

View File

@ -1,6 +1,6 @@
# Heroku
**Status**: [Experimental](../../../document-status.md)
**Status**: [Experimental][DocumentStatus]
**type:** `heroku`
@ -28,3 +28,5 @@
Additionally, [the `cloud.provider` resource attribute MUST be set to `heroku`](../cloud.md).
[Heroku dyno metadata]: https://devcenter.heroku.com/articles/dyno-metadata
[DocumentStatus]: https://github.com/open-telemetry/opentelemetry-specification/blob/v1.21.0/specification/document-status.md

View File

@ -1,6 +1,6 @@
# Container
**Status**: [Experimental](../../document-status.md)
**Status**: [Experimental][DocumentStatus]
**type:** `container`
@ -15,3 +15,5 @@
| `container.image.name` | string | Name of the image the container was built on. | `gcr.io/opentelemetry/operator` | Recommended |
| `container.image.tag` | string | Container image tag. | `0.1` | Recommended |
<!-- endsemconv -->
[DocumentStatus]: https://github.com/open-telemetry/opentelemetry-specification/blob/v1.21.0/specification/document-status.md

View File

@ -1,6 +1,6 @@
# Deployment
**Status**: [Experimental](../../document-status.md)
**Status**: [Experimental][DocumentStatus]
**type:** `deployment`
@ -11,3 +11,5 @@
|---|---|---|---|---|
| `deployment.environment` | string | Name of the [deployment environment](https://en.wikipedia.org/wiki/Deployment_environment) (aka deployment tier). | `staging`; `production` | Recommended |
<!-- endsemconv -->
[DocumentStatus]: https://github.com/open-telemetry/opentelemetry-specification/blob/v1.21.0/specification/document-status.md

View File

@ -1,6 +1,6 @@
# Device
**Status**: [Experimental](../../document-status.md)
**Status**: [Experimental][DocumentStatus]
**type:** `device`
@ -22,3 +22,5 @@
**[4]:** The Android OS provides this field via [Build](https://developer.android.com/reference/android/os/Build#MANUFACTURER). iOS apps SHOULD hardcode the value `Apple`.
<!-- endsemconv -->
[DocumentStatus]: https://github.com/open-telemetry/opentelemetry-specification/blob/v1.21.0/specification/document-status.md

View File

@ -1,6 +1,6 @@
# Function as a Service
**Status**: [Experimental](../../document-status.md)
**Status**: [Experimental][DocumentStatus]
**type:** `faas`
@ -79,3 +79,5 @@ Note: The resource attribute `faas.instance` differs from the span attribute `fa
There are cases where a FaaS resource attribute is better applied as a span
attribute instead.
See the [FaaS trace conventions](../../trace/semantic_conventions/faas.md) for more.
[DocumentStatus]: https://github.com/open-telemetry/opentelemetry-specification/blob/v1.21.0/specification/document-status.md

View File

@ -1,6 +1,6 @@
# Host
**Status**: [Experimental](../../document-status.md)
**Status**: [Experimental][DocumentStatus]
**type:** `host`
@ -56,3 +56,5 @@ systems can use the output of `dmidecode -t system`, `dmidecode -t baseboard`,
detector implementations MUST not collect `host.id` from privileged sources. If
privileged lookup of `host.id` is required, the value should be injected via the
`OTEL_RESOURCE_ATTRIBUTES` environment variable.
[DocumentStatus]: https://github.com/open-telemetry/opentelemetry-specification/blob/v1.21.0/specification/document-status.md

View File

@ -1,6 +1,6 @@
# Kubernetes
**Status**: [Experimental](../../document-status.md)
**Status**: [Experimental][DocumentStatus]
Useful resources to understand Kubernetes objects and metadata:
@ -209,3 +209,5 @@ A CronJob creates Jobs on a repeating schedule.
| `k8s.cronjob.uid` | string | The UID of the CronJob. | `275ecb36-5aa8-4c2a-9c47-d8bb681b9aff` | Recommended |
| `k8s.cronjob.name` | string | The name of the CronJob. | `opentelemetry` | Recommended |
<!-- endsemconv -->
[DocumentStatus]: https://github.com/open-telemetry/opentelemetry-specification/blob/v1.21.0/specification/document-status.md

View File

@ -1,6 +1,6 @@
# Operating System
**Status**: [Experimental](../../document-status.md)
**Status**: [Experimental][DocumentStatus]
**type:** `os`
@ -31,4 +31,6 @@ In case of virtualized environments, this is the operating system as it is obser
| `aix` | AIX (Advanced Interactive eXecutive) |
| `solaris` | SunOS, Oracle Solaris |
| `z_os` | IBM z/OS |
<!-- endsemconv -->
<!-- endsemconv -->
[DocumentStatus]: https://github.com/open-telemetry/opentelemetry-specification/blob/v1.21.0/specification/document-status.md

View File

@ -1,6 +1,6 @@
# Process and process runtime resources
**Status**: [Experimental](../../document-status.md)
**Status**: [Experimental][DocumentStatus]
<!-- Re-generate TOC with `markdown-toc --no-first-h1 -i` -->
@ -219,3 +219,5 @@ Examples for some Ruby runtimes
| --- | --- | --- | --- |
| MRI | ruby | 2.7.1 | ruby 2.7.1p83 (2020-03-31 revision a0c7c23c9c) [x86_64-darwin19] |
| TruffleRuby | truffleruby | 2.6.2 | truffleruby (Shopify) 20.0.0-dev-92ed3059, like ruby 2.6.2, GraalVM CE Native [x86_64-darwin] |
[DocumentStatus]: https://github.com/open-telemetry/opentelemetry-specification/blob/v1.21.0/specification/document-status.md

View File

@ -1,6 +1,6 @@
# Webengine
**Status**: [Experimental](../../document-status.md)
**Status**: [Experimental][DocumentStatus]
**type:** `webengine`
@ -22,3 +22,5 @@ The situations where there are multiple candidates, it is up to instrumentation
* Either Apache HTTP Server or `mod_wsgi` MAY be chosen as `webengine`, depending on the decision made by the instrumentation authors.
* Django SHOULD NOT be set as an `webengine` as the required information is already available in instrumentation library and setting this into `webengine` would duplicate the information.
[DocumentStatus]: https://github.com/open-telemetry/opentelemetry-specification/blob/v1.21.0/specification/document-status.md

View File

@ -1,6 +1,6 @@
# Trace Semantic Conventions
**Status**: [Experimental](../../document-status.md)
**Status**: [Experimental][DocumentStatus]
In OpenTelemetry spans can be created freely and its up to the implementor to
annotate them with attributes specific to the represented operation. Spans
@ -43,3 +43,5 @@ the past but was renamed (with a corresponding schema file).
When introducing a new event name check all existing schema files to make sure
the name does not appear as a key of any "rename_events" section (keys denote
old event names in rename operations).
[DocumentStatus]: https://github.com/open-telemetry/opentelemetry-specification/blob/v1.21.0/specification/document-status.md

View File

@ -1,6 +1,6 @@
# CloudEvents
**Status**: [Experimental](../../document-status.md)
**Status**: [Experimental][DocumentStatus]
<!-- Re-generate TOC with `markdown-toc --no-first-h1 -i` -->
@ -202,3 +202,5 @@ The following attributes are applicable to creation and processing Spans.
| `cloudevents.event_type` | string | The [event_type](https://github.com/cloudevents/spec/blob/v1.0.2/cloudevents/spec.md#type) contains a value describing the type of event related to the originating occurrence. | `com.github.pull_request.opened`; `com.example.object.deleted.v2` | Recommended |
| `cloudevents.event_subject` | string | The [subject](https://github.com/cloudevents/spec/blob/v1.0.2/cloudevents/spec.md#subject) of the event in the context of the event producer (identified by source). | `mynewfile.jpg` | Recommended |
<!-- endsemconv -->
[DocumentStatus]: https://github.com/open-telemetry/opentelemetry-specification/blob/v1.21.0/specification/document-status.md

View File

@ -1,6 +1,6 @@
# Semantic conventions for Compatibility components
**Status**: [Experimental](../../document-status.md)
**Status**: [Experimental][DocumentStatus]
This document defines trace semantic conventions used by the
compatibility components, e.g. OpenTracing Shim layer.
@ -34,3 +34,5 @@ between a child Span and a parent Span, as defined by
| `child_of` | The parent Span depends on the child Span in some capacity |
| `follows_from` | The parent Span does not depend in any way on the result of the child Span |
<!-- endsemconv -->
[DocumentStatus]: https://github.com/open-telemetry/opentelemetry-specification/blob/v1.21.0/specification/document-status.md

View File

@ -1,6 +1,6 @@
# Semantic conventions for database client calls
**Status**: [Experimental](../../document-status.md)
**Status**: [Experimental][DocumentStatus]
<!-- Re-generate TOC with `markdown-toc --no-first-h1 -i` -->
@ -362,3 +362,5 @@ Furthermore, `db.name` is not specified as there is no database name in Redis an
| `db.cosmosdb.status_code` | `201` |
| `db.cosmosdb.sub_status_code` | `0` |
| `db.cosmosdb.request_charge` | `7.43` |
[DocumentStatus]: https://github.com/open-telemetry/opentelemetry-specification/blob/v1.21.0/specification/document-status.md

View File

@ -1,6 +1,6 @@
# Semantic Conventions for Exceptions
**Status**: [Experimental](../../document-status.md)
**Status**: [Experimental][DocumentStatus]
This document defines semantic conventions for recording application
exceptions.
@ -105,3 +105,4 @@ grained information from a stacktrace, if necessary.
[telemetry-sdk-resource]: ../../resource/semantic_conventions/README.md#telemetry-sdk
[erlang-stacktrace]: https://www.erlang.org/doc/man/erl_error.html#format_exception-3
[elixir-stacktrace]: https://hexdocs.pm/elixir/1.14.3/Exception.html#format/3
[DocumentStatus]: https://github.com/open-telemetry/opentelemetry-specification/blob/v1.21.0/specification/document-status.md

View File

@ -1,6 +1,6 @@
# Semantic conventions for FaaS spans
**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 spans.
@ -255,3 +255,5 @@ This example shows the FaaS attributes for a (non-FaaS) process hosted on Google
| Resource | `faas.version` | n/a | `"semver:2.0.0"` |
| Resource | `faas.instance` | n/a | `"my-lambda-function:instance-0001"` |
| Resource | `cloud.resource_id` | n/a | `"arn:aws:lambda:us-west-2:123456789012:function:my-lambda-function"` |
[DocumentStatus]: https://github.com/open-telemetry/opentelemetry-specification/blob/v1.21.0/specification/document-status.md

View File

@ -1,6 +1,6 @@
# Semantic conventions for Feature Flags
**Status**: [Experimental](../../document-status.md)
**Status**: [Experimental][DocumentStatus]
This document defines semantic conventions for recording dynamic feature flag
evaluations within a transaction as span events.
@ -55,3 +55,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

View File

@ -1,6 +1,6 @@
# Semantic conventions for HTTP spans
**Status**: [Experimental](../../document-status.md)
**Status**: [Experimental][DocumentStatus]
This document defines semantic conventions for HTTP client and server Spans.
They can be used for http and https schemes
@ -454,3 +454,5 @@ GET /hello - 200 (CLIENT, trace=t2, span=s1, http.resend_count=1)
|
--- server (SERVER, trace=t2, span=s2)
```
[DocumentStatus]: https://github.com/open-telemetry/opentelemetry-specification/blob/v1.21.0/specification/document-status.md

View File

@ -1,6 +1,6 @@
# Instrumenting AWS Lambda
**Status**: [Experimental](../../../document-status.md)
**Status**: [Experimental][DocumentStatus]
This document defines how to apply semantic conventions when instrumenting an AWS Lambda request handler. AWS
Lambda largely follows the conventions for [FaaS][faas] while [HTTP](../http.md) conventions are also
@ -247,3 +247,5 @@ Note that [`cloud.resource_id`][cloud] currently cannot be populated as a resour
because it is not available until function invocation.
[environment variables]: https://docs.aws.amazon.com/lambda/latest/dg/configuration-envvars.html#configuration-envvars-runtime
[DocumentStatus]: https://github.com/open-telemetry/opentelemetry-specification/blob/v1.21.0/specification/document-status.md

View File

@ -1,6 +1,6 @@
# Semantic conventions for AWS SDK
**Status**: [Experimental](../../../document-status.md)
**Status**: [Experimental][DocumentStatus]
This document defines semantic conventions to apply when instrumenting the AWS SDK. They map request or response
parameters in AWS SDK API calls to attributes on a Span. The conventions have been collected over time based
@ -249,4 +249,6 @@ The `delete` attribute corresponds to the `--delete` parameter of the
and [upload-part-copy](https://docs.aws.amazon.com/cli/latest/reference/s3api/upload-part-copy.html) operations.
The `part_number` attribute corresponds to the `--part-number` parameter of the
[upload-part operation within the S3 API](https://docs.aws.amazon.com/cli/latest/reference/s3api/upload-part.html).
<!-- endsemconv -->
<!-- endsemconv -->
[DocumentStatus]: https://github.com/open-telemetry/opentelemetry-specification/blob/v1.21.0/specification/document-status.md

View File

@ -1,6 +1,6 @@
# Semantic conventions for GraphQL Server
**Status**: [Experimental](../../../document-status.md)
**Status**: [Experimental][DocumentStatus]
This document defines semantic conventions to apply when instrumenting the GraphQL implementation. They map GraphQL
operations to attributes on a Span.
@ -27,3 +27,5 @@ MAY be used as span name.
| `mutation` | GraphQL mutation |
| `subscription` | GraphQL subscription |
<!-- endsemconv -->
[DocumentStatus]: https://github.com/open-telemetry/opentelemetry-specification/blob/v1.21.0/specification/document-status.md

View File

@ -1,6 +1,6 @@
# Messaging systems
**Status**: [Experimental](../../document-status.md)
**Status**: [Experimental][DocumentStatus]
<!-- Re-generate TOC with `markdown-toc --no-first-h1 -i` -->
@ -574,3 +574,5 @@ Process C: | Span Recv1 | Span Recv2 |
| `messaging.operation` | | | `"receive"` | `"receive"` | `"process"` |
| `messaging.message.id` | `"a1"` | `"a2"` | `"a1"` | `"a2"` | |
| `messaging.batch.message_count` | | | 1 | 1 | 2 |
[DocumentStatus]: https://github.com/open-telemetry/opentelemetry-specification/blob/v1.21.0/specification/document-status.md

View File

@ -1,6 +1,6 @@
# Semantic conventions for RPC spans
**Status**: [Experimental](../../document-status.md)
**Status**: [Experimental][DocumentStatus]
This document defines how to describe remote procedure calls
(also called "remote method invocations" / "RMI") with spans.
@ -348,3 +348,5 @@ Conventions specific to [JSON RPC](https://www.jsonrpc.org/).
**[1]:** This is always required for jsonrpc. See the note in the general RPC conventions for more information.
<!-- endsemconv -->
[DocumentStatus]: https://github.com/open-telemetry/opentelemetry-specification/blob/v1.21.0/specification/document-status.md

View File

@ -1,6 +1,6 @@
# General attributes
**Status**: [Experimental](../../document-status.md)
**Status**: [Experimental][DocumentStatus]
The attributes described in this section are not specific to a particular operation but rather generic.
They may be used in any Span they apply to.
@ -377,4 +377,6 @@ about the span.
| `code.filepath` | string | The source code file name that identifies the code unit as uniquely as possible (preferably an absolute file path). | `/usr/local/MyApplication/content_root/app/index.php` | Recommended |
| `code.lineno` | int | The line number in `code.filepath` best representing the operation. It SHOULD point within the code unit named in `code.function`. | `42` | Recommended |
| `code.column` | int | The column number in `code.filepath` best representing the operation. It SHOULD point within the code unit named in `code.function`. | `16` | Recommended |
<!-- endsemconv -->
<!-- endsemconv -->
[DocumentStatus]: https://github.com/open-telemetry/opentelemetry-specification/blob/v1.21.0/specification/document-status.md