From 2add49d0f0aaef0f432a0d87de290df3387efb61 Mon Sep 17 00:00:00 2001 From: Daniel Dyla Date: Tue, 12 Nov 2024 13:59:16 -0700 Subject: [PATCH 1/2] Add enum value headers Add headers in order to separate enum value tables from the footnotes above. Fixes #1569 --- docs/attributes-registry/android.md | 2 + docs/attributes-registry/aspnetcore.md | 6 +++ docs/attributes-registry/aws.md | 2 + docs/attributes-registry/cicd.md | 2 + docs/attributes-registry/cloud.md | 4 ++ docs/attributes-registry/container.md | 2 + docs/attributes-registry/cpu.md | 2 + docs/attributes-registry/db.md | 16 +++++++ docs/attributes-registry/deployment.md | 2 + docs/attributes-registry/disk.md | 2 + docs/attributes-registry/dotnet.md | 2 + docs/attributes-registry/error.md | 2 + docs/attributes-registry/faas.md | 6 +++ docs/attributes-registry/gen-ai.md | 10 +++++ docs/attributes-registry/go.md | 2 + docs/attributes-registry/graphql.md | 2 + docs/attributes-registry/hardware.md | 4 ++ docs/attributes-registry/host.md | 2 + docs/attributes-registry/http.md | 6 +++ docs/attributes-registry/ios.md | 2 + docs/attributes-registry/jvm.md | 4 ++ docs/attributes-registry/k8s.md | 2 + docs/attributes-registry/linux.md | 2 + docs/attributes-registry/log.md | 2 + docs/attributes-registry/messaging.md | 10 +++++ docs/attributes-registry/network.md | 14 ++++++ docs/attributes-registry/nodejs.md | 2 + docs/attributes-registry/opentracing.md | 2 + docs/attributes-registry/os.md | 2 + docs/attributes-registry/otel.md | 2 + docs/attributes-registry/process.md | 6 +++ docs/attributes-registry/profile.md | 2 + docs/attributes-registry/rpc.md | 10 +++++ docs/attributes-registry/signalr.md | 4 ++ docs/attributes-registry/system.md | 20 +++++++++ docs/attributes-registry/telemetry.md | 2 + docs/attributes-registry/test.md | 4 ++ docs/attributes-registry/tls.md | 2 + docs/attributes-registry/v8js.md | 4 ++ docs/attributes-registry/vcs.md | 14 ++++++ docs/cicd/cicd-metrics.md | 20 +++++++++ docs/cloud-providers/aws-sdk.md | 2 + docs/database/cassandra.md | 4 ++ docs/database/cosmosdb.md | 10 +++++ docs/database/couchdb.md | 2 + docs/database/database-metrics.md | 10 +++++ docs/database/database-spans.md | 4 ++ docs/database/dynamodb.md | 26 +++++++++++ docs/database/elasticsearch.md | 4 ++ docs/database/hbase.md | 2 + docs/database/mariadb.md | 2 + docs/database/mongodb.md | 2 + docs/database/mssql.md | 2 + docs/database/mysql.md | 2 + docs/database/postgresql.md | 2 + docs/database/redis.md | 2 + docs/database/sql.md | 2 + docs/dns/dns-metrics.md | 2 + docs/dotnet/dotnet-aspnetcore-metrics.md | 10 +++++ docs/dotnet/dotnet-kestrel-metrics.md | 36 +++++++++++++++ docs/dotnet/dotnet-signalr-metrics.md | 8 ++++ docs/faas/faas-metrics.md | 18 ++++++++ docs/faas/faas-spans.md | 8 ++++ docs/gen-ai/azure-ai-inference.md | 4 ++ docs/gen-ai/gen-ai-events.md | 2 + docs/gen-ai/gen-ai-metrics.md | 26 +++++++++++ docs/gen-ai/gen-ai-spans.md | 6 +++ docs/gen-ai/openai.md | 8 ++++ docs/general/attributes.md | 8 ++++ docs/general/logs.md | 2 + docs/general/profiles.md | 2 + docs/general/trace-compatibility.md | 2 + docs/graphql/graphql-spans.md | 2 + docs/hardware/common.md | 14 ++++++ docs/http/http-metrics.md | 30 +++++++++++++ docs/http/http-spans.md | 12 +++++ docs/messaging/azure-messaging.md | 10 +++++ docs/messaging/gcp-pubsub.md | 4 ++ docs/messaging/kafka.md | 4 ++ docs/messaging/messaging-metrics.md | 18 ++++++++ docs/messaging/messaging-spans.md | 6 +++ docs/messaging/rabbitmq.md | 4 ++ docs/messaging/rocketmq.md | 8 ++++ docs/object-stores/s3.md | 2 + docs/resource/README.md | 2 + docs/resource/cloud-provider/aws/ecs.md | 2 + docs/resource/cloud.md | 4 ++ docs/resource/host.md | 2 + docs/resource/os.md | 2 + docs/rpc/connect-rpc.md | 2 + docs/rpc/grpc.md | 2 + docs/rpc/rpc-metrics.md | 6 +++ docs/rpc/rpc-spans.md | 14 ++++++ docs/runtime/dotnet-metrics.md | 10 +++++ docs/runtime/go-metrics.md | 2 + docs/runtime/jvm-metrics.md | 12 +++++ docs/runtime/nodejs-metrics.md | 2 + docs/runtime/v8js-metrics.md | 10 +++++ docs/system/container-metrics.md | 8 ++++ docs/system/process-metrics.md | 12 +++++ docs/system/system-metrics.md | 52 ++++++++++++++++++++++ templates/registry/markdown/enum_macros.j2 | 2 + 102 files changed, 688 insertions(+) diff --git a/docs/attributes-registry/android.md b/docs/attributes-registry/android.md index 4870e52fe3..18cb10b62d 100644 --- a/docs/attributes-registry/android.md +++ b/docs/attributes-registry/android.md @@ -27,6 +27,8 @@ This document defines attributes that represents an occurrence of a lifecycle tr **[1]:** The Android lifecycle states are defined in [Activity lifecycle callbacks](https://developer.android.com/guide/components/activities/activity-lifecycle#lc), and from which the `OS identifiers` are derived. +### `android.state` Values + `android.state` has the following list of well-known values. If one of them applies, then the respective value MUST be used; otherwise, a custom value MAY be used. | Value | Description | Stability | diff --git a/docs/attributes-registry/aspnetcore.md b/docs/attributes-registry/aspnetcore.md index 30ef935ff6..ebe9fd99d6 100644 --- a/docs/attributes-registry/aspnetcore.md +++ b/docs/attributes-registry/aspnetcore.md @@ -20,6 +20,8 @@ ASP.NET Core attributes | `aspnetcore.routing.is_fallback` | boolean | A value that indicates whether the matched route is a fallback route. | `true` | ![Stable](https://img.shields.io/badge/-stable-lightgreen) | | `aspnetcore.routing.match_status` | string | Match result - success or failure | `success`; `failure` | ![Stable](https://img.shields.io/badge/-stable-lightgreen) | +### `aspnetcore.diagnostics.exception.result` Values + `aspnetcore.diagnostics.exception.result` has the following list of well-known values. If one of them applies, then the respective value MUST be used; otherwise, a custom value MAY be used. | Value | Description | Stability | @@ -29,6 +31,8 @@ ASP.NET Core attributes | `skipped` | Exception handling was skipped because the response had started. | ![Stable](https://img.shields.io/badge/-stable-lightgreen) | | `unhandled` | Exception was not handled by the exception handling middleware. | ![Stable](https://img.shields.io/badge/-stable-lightgreen) | +### `aspnetcore.rate_limiting.result` Values + `aspnetcore.rate_limiting.result` has the following list of well-known values. If one of them applies, then the respective value MUST be used; otherwise, a custom value MAY be used. | Value | Description | Stability | @@ -38,6 +42,8 @@ ASP.NET Core attributes | `global_limiter` | Lease request was rejected by the global limiter | ![Stable](https://img.shields.io/badge/-stable-lightgreen) | | `request_canceled` | Lease request was canceled | ![Stable](https://img.shields.io/badge/-stable-lightgreen) | +### `aspnetcore.routing.match_status` Values + `aspnetcore.routing.match_status` has the following list of well-known values. If one of them applies, then the respective value MUST be used; otherwise, a custom value MAY be used. | Value | Description | Stability | diff --git a/docs/attributes-registry/aws.md b/docs/attributes-registry/aws.md index 90ca3fa8f3..4bef43ff32 100644 --- a/docs/attributes-registry/aws.md +++ b/docs/attributes-registry/aws.md @@ -65,6 +65,8 @@ This document defines attributes for AWS Elastic Container Service (ECS). | `aws.ecs.task.id` | string | The ID of a running ECS task. The ID MUST be extracted from `task.arn`. | `10838bed-421f-43ef-870a-f43feacbbb5b`; `23ebb8ac-c18f-46c6-8bbe-d55d0e37cfbd` | ![Experimental](https://img.shields.io/badge/-experimental-blue) | | `aws.ecs.task.revision` | string | The revision for the task definition used to create the ECS task. | `8`; `26` | ![Experimental](https://img.shields.io/badge/-experimental-blue) | +### `aws.ecs.launchtype` Values + `aws.ecs.launchtype` has the following list of well-known values. If one of them applies, then the respective value MUST be used; otherwise, a custom value MAY be used. | Value | Description | Stability | diff --git a/docs/attributes-registry/cicd.md b/docs/attributes-registry/cicd.md index e4c03c3558..6bb91c98c6 100644 --- a/docs/attributes-registry/cicd.md +++ b/docs/attributes-registry/cicd.md @@ -19,6 +19,8 @@ This group describes attributes specific to pipelines within a Continuous Integr | `cicd.pipeline.task.run.url.full` | string | The [URL](https://wikipedia.org/wiki/URL) of the pipeline run providing the complete address in order to locate and identify the pipeline run. | `https://github.com/open-telemetry/semantic-conventions/actions/runs/9753949763/job/26920038674?pr=1075` | ![Experimental](https://img.shields.io/badge/-experimental-blue) | | `cicd.pipeline.task.type` | string | The type of the task within a pipeline. | `build`; `test`; `deploy` | ![Experimental](https://img.shields.io/badge/-experimental-blue) | +### `cicd.pipeline.task.type` Values + `cicd.pipeline.task.type` has the following list of well-known values. If one of them applies, then the respective value MUST be used; otherwise, a custom value MAY be used. | Value | Description | Stability | diff --git a/docs/attributes-registry/cloud.md b/docs/attributes-registry/cloud.md index fdaf4919e2..a458d651ca 100644 --- a/docs/attributes-registry/cloud.md +++ b/docs/attributes-registry/cloud.md @@ -43,6 +43,8 @@ The following well-known definitions MUST be used if you set this attribute and This means that a span attribute MUST be used, as an Azure function app can host multiple functions that would usually share a TracerProvider. +### `cloud.platform` Values + `cloud.platform` has the following list of well-known values. If one of them applies, then the respective value MUST be used; otherwise, a custom value MAY be used. | Value | Description | Stability | @@ -76,6 +78,8 @@ The following well-known definitions MUST be used if you set this attribute and | `tencent_cloud_eks` | Tencent Cloud Elastic Kubernetes Service (EKS) | ![Experimental](https://img.shields.io/badge/-experimental-blue) | | `tencent_cloud_scf` | Tencent Cloud Serverless Cloud Function (SCF) | ![Experimental](https://img.shields.io/badge/-experimental-blue) | +### `cloud.provider` Values + `cloud.provider` has the following list of well-known values. If one of them applies, then the respective value MUST be used; otherwise, a custom value MAY be used. | Value | Description | Stability | diff --git a/docs/attributes-registry/container.md b/docs/attributes-registry/container.md index 439b079184..618feebcb6 100644 --- a/docs/attributes-registry/container.md +++ b/docs/attributes-registry/container.md @@ -50,6 +50,8 @@ Describes deprecated container attributes. | `container.cpu.state` | string | Deprecated, use `cpu.mode` instead. | `user`; `kernel` | ![Deprecated](https://img.shields.io/badge/-deprecated-red)
Replaced by `cpu.mode` | | `container.labels.` | string | Deprecated, use `container.label` instead. | `container.label.app=nginx` | ![Deprecated](https://img.shields.io/badge/-deprecated-red)
Replaced by `container.label`. | +### `container.cpu.state` Values + `container.cpu.state` has the following list of well-known values. If one of them applies, then the respective value MUST be used; otherwise, a custom value MAY be used. | Value | Description | Stability | diff --git a/docs/attributes-registry/cpu.md b/docs/attributes-registry/cpu.md index 70ea4139de..27d8b6ec60 100644 --- a/docs/attributes-registry/cpu.md +++ b/docs/attributes-registry/cpu.md @@ -14,6 +14,8 @@ Attributes specific to a cpu instance. |---|---|---|---|---| | `cpu.mode` | string | The mode of the CPU | `user`; `system` | ![Experimental](https://img.shields.io/badge/-experimental-blue) | +### `cpu.mode` Values + `cpu.mode` has the following list of well-known values. If one of them applies, then the respective value MUST be used; otherwise, a custom value MAY be used. | Value | Description | Stability | diff --git a/docs/attributes-registry/db.md b/docs/attributes-registry/db.md index bc6f42e7f4..51b46e9d07 100644 --- a/docs/attributes-registry/db.md +++ b/docs/attributes-registry/db.md @@ -91,6 +91,8 @@ This attribute has stability level RELEASE CANDIDATE. **[9]:** The actual DBMS may differ from the one identified by the client. For example, when using PostgreSQL client libraries to connect to a CockroachDB, the `db.system` is set to `postgresql` based on the instrumentation's best knowledge. This attribute has stability level RELEASE CANDIDATE. +### `db.client.connection.state` Values + `db.client.connection.state` has the following list of well-known values. If one of them applies, then the respective value MUST be used; otherwise, a custom value MAY be used. | Value | Description | Stability | @@ -98,6 +100,8 @@ This attribute has stability level RELEASE CANDIDATE. | `idle` | idle | ![Experimental](https://img.shields.io/badge/-experimental-blue) | | `used` | used | ![Experimental](https://img.shields.io/badge/-experimental-blue) | +### `db.system` Values + `db.system` has the following list of well-known values. If one of them applies, then the respective value MUST be used; otherwise, a custom value MAY be used. | Value | Description | Stability | @@ -170,6 +174,8 @@ This group defines attributes for Cassandra. | `db.cassandra.page_size` | int | The fetch size used for paging, i.e. how many rows will be returned at once. | `5000` | ![Experimental](https://img.shields.io/badge/-experimental-blue) | | `db.cassandra.speculative_execution_count` | int | The number of times a query was speculatively executed. Not set or `0` if the query was not executed speculatively. | `0`; `2` | ![Experimental](https://img.shields.io/badge/-experimental-blue) | +### `db.cassandra.consistency_level` Values + `db.cassandra.consistency_level` has the following list of well-known values. If one of them applies, then the respective value MUST be used; otherwise, a custom value MAY be used. | Value | Description | Stability | @@ -199,6 +205,8 @@ This group defines attributes for Azure Cosmos DB. | `db.cosmosdb.request_content_length` | int | Request payload size in bytes. | | ![Experimental](https://img.shields.io/badge/-experimental-blue) | | `db.cosmosdb.sub_status_code` | int | Cosmos DB sub status code. | `1000`; `1002` | ![Experimental](https://img.shields.io/badge/-experimental-blue) | +### `db.cosmosdb.connection_mode` Values + `db.cosmosdb.connection_mode` has the following list of well-known values. If one of them applies, then the respective value MUST be used; otherwise, a custom value MAY be used. | Value | Description | Stability | @@ -206,6 +214,8 @@ This group defines attributes for Azure Cosmos DB. | `direct` | Direct connection. | ![Experimental](https://img.shields.io/badge/-experimental-blue) | | `gateway` | Gateway (HTTP) connection. | ![Experimental](https://img.shields.io/badge/-experimental-blue) | +### `db.cosmosdb.consistency_level` Values + `db.cosmosdb.consistency_level` has the following list of well-known values. If one of them applies, then the respective value MUST be used; otherwise, a custom value MAY be used. | Value | Description | Stability | @@ -250,6 +260,8 @@ This group defines attributes for Elasticsearch. | `db.statement` | string | The database statement being executed. | `SELECT * FROM wuser_table`; `SET mykey "WuValue"` | ![Deprecated](https://img.shields.io/badge/-deprecated-red)
Replaced by `db.query.text`. | | `db.user` | string | Deprecated, no replacement at this time. | `readonly_user`; `reporting_user` | ![Deprecated](https://img.shields.io/badge/-deprecated-red)
No replacement at this time. | +### `db.cosmosdb.operation_type` Values + `db.cosmosdb.operation_type` has the following list of well-known values. If one of them applies, then the respective value MUST be used; otherwise, a custom value MAY be used. | Value | Description | Stability | @@ -281,6 +293,8 @@ This group defines attributes for Elasticsearch. | `pool.name` | string | Deprecated, use `db.client.connection.pool.name` instead. | `myDataSource` | ![Deprecated](https://img.shields.io/badge/-deprecated-red)
Replaced by `db.client.connection.pool.name`. | | `state` | string | Deprecated, use `db.client.connection.state` instead. | `idle` | ![Deprecated](https://img.shields.io/badge/-deprecated-red)
Replaced by `db.client.connection.state`. | +### `db.client.connections.state` Values + `db.client.connections.state` has the following list of well-known values. If one of them applies, then the respective value MUST be used; otherwise, a custom value MAY be used. | Value | Description | Stability | @@ -288,6 +302,8 @@ This group defines attributes for Elasticsearch. | `idle` | idle | ![Experimental](https://img.shields.io/badge/-experimental-blue) | | `used` | used | ![Experimental](https://img.shields.io/badge/-experimental-blue) | +### `state` Values + `state` has the following list of well-known values. If one of them applies, then the respective value MUST be used; otherwise, a custom value MAY be used. | Value | Description | Stability | diff --git a/docs/attributes-registry/deployment.md b/docs/attributes-registry/deployment.md index d687d2b880..e9509ce60b 100644 --- a/docs/attributes-registry/deployment.md +++ b/docs/attributes-registry/deployment.md @@ -28,6 +28,8 @@ considered to be identifying the same service: - `service.name=frontend`, `deployment.environment.name=production` - `service.name=frontend`, `deployment.environment.name=staging`. +### `deployment.status` Values + `deployment.status` has the following list of well-known values. If one of them applies, then the respective value MUST be used; otherwise, a custom value MAY be used. | Value | Description | Stability | diff --git a/docs/attributes-registry/disk.md b/docs/attributes-registry/disk.md index 3bd1c7ce5f..83bc459a1e 100644 --- a/docs/attributes-registry/disk.md +++ b/docs/attributes-registry/disk.md @@ -14,6 +14,8 @@ These attributes may be used for any disk related operation. |---|---|---|---|---| | `disk.io.direction` | string | The disk IO operation direction. | `read` | ![Experimental](https://img.shields.io/badge/-experimental-blue) | +### `disk.io.direction` Values + `disk.io.direction` has the following list of well-known values. If one of them applies, then the respective value MUST be used; otherwise, a custom value MAY be used. | Value | Description | Stability | diff --git a/docs/attributes-registry/dotnet.md b/docs/attributes-registry/dotnet.md index 0e806cbc49..cdda316933 100644 --- a/docs/attributes-registry/dotnet.md +++ b/docs/attributes-registry/dotnet.md @@ -14,6 +14,8 @@ This document defines .NET related attributes. |---|---|---|---|---| | `dotnet.gc.heap.generation` | string | Name of the garbage collector managed heap generation. | `gen0`; `gen1`; `gen2` | ![Experimental](https://img.shields.io/badge/-experimental-blue) | +### `dotnet.gc.heap.generation` Values + `dotnet.gc.heap.generation` has the following list of well-known values. If one of them applies, then the respective value MUST be used; otherwise, a custom value MAY be used. | Value | Description | Stability | diff --git a/docs/attributes-registry/error.md b/docs/attributes-registry/error.md index 80e6bdba72..42358b7347 100644 --- a/docs/attributes-registry/error.md +++ b/docs/attributes-registry/error.md @@ -34,6 +34,8 @@ it's RECOMMENDED to: - Use a domain-specific attribute - Set `error.type` to capture all errors, regardless of whether they are defined within the domain-specific set or not. +### `error.type` Values + `error.type` has the following list of well-known values. If one of them applies, then the respective value MUST be used; otherwise, a custom value MAY be used. | Value | Description | Stability | diff --git a/docs/attributes-registry/faas.md b/docs/attributes-registry/faas.md index a38c8ebffc..8fde51fea2 100644 --- a/docs/attributes-registry/faas.md +++ b/docs/attributes-registry/faas.md @@ -66,6 +66,8 @@ definition of function name MUST be used for this attribute [`K_REVISION` environment variable](https://cloud.google.com/functions/docs/env-var#runtime_environment_variables_set_automatically). - **Azure Functions:** Not applicable. Do not set this attribute. +### `faas.document.operation` Values + `faas.document.operation` has the following list of well-known values. If one of them applies, then the respective value MUST be used; otherwise, a custom value MAY be used. | Value | Description | Stability | @@ -74,6 +76,8 @@ definition of function name MUST be used for this attribute | `edit` | When an object is modified. | ![Experimental](https://img.shields.io/badge/-experimental-blue) | | `insert` | When a new object is created. | ![Experimental](https://img.shields.io/badge/-experimental-blue) | +### `faas.invoked_provider` Values + `faas.invoked_provider` has the following list of well-known values. If one of them applies, then the respective value MUST be used; otherwise, a custom value MAY be used. | Value | Description | Stability | @@ -84,6 +88,8 @@ definition of function name MUST be used for this attribute | `gcp` | Google Cloud Platform | ![Experimental](https://img.shields.io/badge/-experimental-blue) | | `tencent_cloud` | Tencent Cloud | ![Experimental](https://img.shields.io/badge/-experimental-blue) | +### `faas.trigger` Values + `faas.trigger` has the following list of well-known values. If one of them applies, then the respective value MUST be used; otherwise, a custom value MAY be used. | Value | Description | Stability | diff --git a/docs/attributes-registry/gen-ai.md b/docs/attributes-registry/gen-ai.md index 1381a437be..c8688d6d62 100644 --- a/docs/attributes-registry/gen-ai.md +++ b/docs/attributes-registry/gen-ai.md @@ -45,6 +45,8 @@ is set to `openai` based on the instrumentation's best knowledge. For custom model, a custom friendly name SHOULD be used. If none of these options apply, the `gen_ai.system` SHOULD be set to `_OTHER`. +### `gen_ai.operation.name` Values + `gen_ai.operation.name` has the following list of well-known values. If one of them applies, then the respective value MUST be used; otherwise, a custom value MAY be used. | Value | Description | Stability | @@ -52,6 +54,8 @@ If none of these options apply, the `gen_ai.system` SHOULD be set to `_OTHER`. | `chat` | Chat completion operation such as [OpenAI Chat API](https://platform.openai.com/docs/api-reference/chat) | ![Experimental](https://img.shields.io/badge/-experimental-blue) | | `text_completion` | Text completions operation such as [OpenAI Completions API (Legacy)](https://platform.openai.com/docs/api-reference/completions) | ![Experimental](https://img.shields.io/badge/-experimental-blue) | +### `gen_ai.system` Values + `gen_ai.system` has the following list of well-known values. If one of them applies, then the respective value MUST be used; otherwise, a custom value MAY be used. | Value | Description | Stability | @@ -62,6 +66,8 @@ If none of these options apply, the `gen_ai.system` SHOULD be set to `_OTHER`. | `openai` | OpenAI | ![Experimental](https://img.shields.io/badge/-experimental-blue) | | `vertex_ai` | Vertex AI | ![Experimental](https://img.shields.io/badge/-experimental-blue) | +### `gen_ai.token.type` Values + `gen_ai.token.type` has the following list of well-known values. If one of them applies, then the respective value MUST be used; otherwise, a custom value MAY be used. | Value | Description | Stability | @@ -81,6 +87,8 @@ Thie group defines attributes for OpenAI. | `gen_ai.openai.response.service_tier` | string | The service tier used for the response. | `scale`; `default` | ![Experimental](https://img.shields.io/badge/-experimental-blue) | | `gen_ai.openai.response.system_fingerprint` | string | A fingerprint to track any eventual change in the Generative AI environment. | `fp_44709d6fcb` | ![Experimental](https://img.shields.io/badge/-experimental-blue) | +### `gen_ai.openai.request.response_format` Values + `gen_ai.openai.request.response_format` has the following list of well-known values. If one of them applies, then the respective value MUST be used; otherwise, a custom value MAY be used. | Value | Description | Stability | @@ -89,6 +97,8 @@ Thie group defines attributes for OpenAI. | `json_schema` | JSON schema response format | ![Experimental](https://img.shields.io/badge/-experimental-blue) | | `text` | Text response format | ![Experimental](https://img.shields.io/badge/-experimental-blue) | +### `gen_ai.openai.request.service_tier` Values + `gen_ai.openai.request.service_tier` has the following list of well-known values. If one of them applies, then the respective value MUST be used; otherwise, a custom value MAY be used. | Value | Description | Stability | diff --git a/docs/attributes-registry/go.md b/docs/attributes-registry/go.md index d27bca24ce..79788db014 100644 --- a/docs/attributes-registry/go.md +++ b/docs/attributes-registry/go.md @@ -14,6 +14,8 @@ This document defines Go related attributes. |---|---|---|---|---| | `go.memory.type` | string | The type of memory. | `other`; `stack` | ![Experimental](https://img.shields.io/badge/-experimental-blue) | +### `go.memory.type` Values + `go.memory.type` has the following list of well-known values. If one of them applies, then the respective value MUST be used; otherwise, a custom value MAY be used. | Value | Description | Stability | diff --git a/docs/attributes-registry/graphql.md b/docs/attributes-registry/graphql.md index 1b08f50c53..082d5da473 100644 --- a/docs/attributes-registry/graphql.md +++ b/docs/attributes-registry/graphql.md @@ -18,6 +18,8 @@ This document defines attributes for GraphQL. **[1]:** The value may be sanitized to exclude sensitive information. +### `graphql.operation.type` Values + `graphql.operation.type` has the following list of well-known values. If one of them applies, then the respective value MUST be used; otherwise, a custom value MAY be used. | Value | Description | Stability | diff --git a/docs/attributes-registry/hardware.md b/docs/attributes-registry/hardware.md index 45b5a2d1f3..3a5d8f59b1 100644 --- a/docs/attributes-registry/hardware.md +++ b/docs/attributes-registry/hardware.md @@ -20,6 +20,8 @@ Attributes for hardware. **[1]:** Describes the category of the hardware component for which `hw.state` is being reported. For example, `hw.type=temperature` along with `hw.state=degraded` would indicate that the temperature of the hardware component has been reported as `degraded`. +### `hw.state` Values + `hw.state` has the following list of well-known values. If one of them applies, then the respective value MUST be used; otherwise, a custom value MAY be used. | Value | Description | Stability | @@ -28,6 +30,8 @@ Attributes for hardware. | `failed` | Failed | ![Experimental](https://img.shields.io/badge/-experimental-blue) | | `ok` | Ok | ![Experimental](https://img.shields.io/badge/-experimental-blue) | +### `hw.type` Values + `hw.type` has the following list of well-known values. If one of them applies, then the respective value MUST be used; otherwise, a custom value MAY be used. | Value | Description | Stability | diff --git a/docs/attributes-registry/host.md b/docs/attributes-registry/host.md index f3cec69aae..19ad1a494b 100644 --- a/docs/attributes-registry/host.md +++ b/docs/attributes-registry/host.md @@ -34,6 +34,8 @@ A host is defined as a computing instance. For example, physical servers, virtua **[3]:** MAC Addresses MUST be represented in [IEEE RA hexadecimal form](https://standards.ieee.org/wp-content/uploads/import/documents/tutorials/eui.pdf): as hyphen-separated octets in uppercase hexadecimal form from most to least significant. +### `host.arch` Values + `host.arch` has the following list of well-known values. If one of them applies, then the respective value MUST be used; otherwise, a custom value MAY be used. | Value | Description | Stability | diff --git a/docs/attributes-registry/http.md b/docs/attributes-registry/http.md index 57953b39be..2c209dd331 100644 --- a/docs/attributes-registry/http.md +++ b/docs/attributes-registry/http.md @@ -56,6 +56,8 @@ The attribute value MUST consist of either multiple header values as an array of **[5]:** MUST NOT be populated when this is not supported by the HTTP server framework as the route attribute should have low-cardinality and the URI path can NOT substitute it. SHOULD include the [application root](/docs/http/http-spans.md#http-server-definitions) if there is one. +### `http.connection.state` Values + `http.connection.state` has the following list of well-known values. If one of them applies, then the respective value MUST be used; otherwise, a custom value MAY be used. | Value | Description | Stability | @@ -63,6 +65,8 @@ SHOULD include the [application root](/docs/http/http-spans.md#http-server-defin | `active` | active state. | ![Experimental](https://img.shields.io/badge/-experimental-blue) | | `idle` | idle state. | ![Experimental](https://img.shields.io/badge/-experimental-blue) | +### `http.request.method` Values + `http.request.method` has the following list of well-known values. If one of them applies, then the respective value MUST be used; otherwise, a custom value MAY be used. | Value | Description | Stability | @@ -99,6 +103,8 @@ Describes deprecated HTTP attributes. | `http.url` | string | Deprecated, use `url.full` instead. | `https://www.foo.bar/search?q=OpenTelemetry#SemConv` | ![Deprecated](https://img.shields.io/badge/-deprecated-red)
Replaced by `url.full`. | | `http.user_agent` | string | Deprecated, use `user_agent.original` instead. | `CERN-LineMode/2.15 libwww/2.17b3`; `Mozilla/5.0 (iPhone; CPU iPhone OS 14_7_1 like Mac OS X) AppleWebKit/605.1.15 (KHTML, like Gecko) Version/14.1.2 Mobile/15E148 Safari/604.1` | ![Deprecated](https://img.shields.io/badge/-deprecated-red)
Replaced by `user_agent.original`. | +### `http.flavor` Values + `http.flavor` has the following list of well-known values. If one of them applies, then the respective value MUST be used; otherwise, a custom value MAY be used. | Value | Description | Stability | diff --git a/docs/attributes-registry/ios.md b/docs/attributes-registry/ios.md index a847e932eb..fcb61c35e2 100644 --- a/docs/attributes-registry/ios.md +++ b/docs/attributes-registry/ios.md @@ -16,6 +16,8 @@ The iOS platform on which the iOS application is running. **[1]:** The iOS lifecycle states are defined in the [UIApplicationDelegate documentation](https://developer.apple.com/documentation/uikit/uiapplicationdelegate#1656902), and from which the `OS terminology` column values are derived. +### `ios.state` Values + `ios.state` has the following list of well-known values. If one of them applies, then the respective value MUST be used; otherwise, a custom value MAY be used. | Value | Description | Stability | diff --git a/docs/attributes-registry/jvm.md b/docs/attributes-registry/jvm.md index 8a3d4e459c..317778a4d3 100644 --- a/docs/attributes-registry/jvm.md +++ b/docs/attributes-registry/jvm.md @@ -28,6 +28,8 @@ This document defines Java Virtual machine related attributes. **[4]:** Pool names are generally obtained via [MemoryPoolMXBean#getName()](https://docs.oracle.com/en/java/javase/11/docs/api/java.management/java/lang/management/MemoryPoolMXBean.html#getName()). +### `jvm.memory.type` Values + `jvm.memory.type` has the following list of well-known values. If one of them applies, then the respective value MUST be used; otherwise, a custom value MAY be used. | Value | Description | Stability | @@ -35,6 +37,8 @@ This document defines Java Virtual machine related attributes. | `heap` | Heap memory. | ![Stable](https://img.shields.io/badge/-stable-lightgreen) | | `non_heap` | Non-heap memory | ![Stable](https://img.shields.io/badge/-stable-lightgreen) | +### `jvm.thread.state` Values + `jvm.thread.state` has the following list of well-known values. If one of them applies, then the respective value MUST be used; otherwise, a custom value MAY be used. | Value | Description | Stability | diff --git a/docs/attributes-registry/k8s.md b/docs/attributes-registry/k8s.md index dcda4ed00a..0c282cb110 100644 --- a/docs/attributes-registry/k8s.md +++ b/docs/attributes-registry/k8s.md @@ -65,6 +65,8 @@ Which states: Therefore, UIDs between clusters should be extremely unlikely to conflict. +### `k8s.volume.type` Values + `k8s.volume.type` has the following list of well-known values. If one of them applies, then the respective value MUST be used; otherwise, a custom value MAY be used. | Value | Description | Stability | diff --git a/docs/attributes-registry/linux.md b/docs/attributes-registry/linux.md index 82c90fe1fb..fbd1d55dac 100644 --- a/docs/attributes-registry/linux.md +++ b/docs/attributes-registry/linux.md @@ -14,6 +14,8 @@ Describes Linux Memory attributes |---|---|---|---|---| | `linux.memory.slab.state` | string | The Linux Slab memory state | `reclaimable`; `unreclaimable` | ![Experimental](https://img.shields.io/badge/-experimental-blue) | +### `linux.memory.slab.state` Values + `linux.memory.slab.state` has the following list of well-known values. If one of them applies, then the respective value MUST be used; otherwise, a custom value MAY be used. | Value | Description | Stability | diff --git a/docs/attributes-registry/log.md b/docs/attributes-registry/log.md index 5371589ccf..9c44edadd7 100644 --- a/docs/attributes-registry/log.md +++ b/docs/attributes-registry/log.md @@ -18,6 +18,8 @@ This document defines log attributes |---|---|---|---|---| | `log.iostream` | string | The stream associated with the log. See below for a list of well-known values. | `stdout`; `stderr` | ![Experimental](https://img.shields.io/badge/-experimental-blue) | +### `log.iostream` Values + `log.iostream` has the following list of well-known values. If one of them applies, then the respective value MUST be used; otherwise, a custom value MAY be used. | Value | Description | Stability | diff --git a/docs/attributes-registry/messaging.md b/docs/attributes-registry/messaging.md index f199868334..899b7475c8 100644 --- a/docs/attributes-registry/messaging.md +++ b/docs/attributes-registry/messaging.md @@ -59,6 +59,8 @@ size should be used. **[9]:** The actual messaging system may differ from the one known by the client. For example, when using Kafka client libraries to communicate with Azure Event Hubs, the `messaging.system` is set to `kafka` based on the instrumentation's best knowledge. +### `messaging.operation.type` Values + `messaging.operation.type` has the following list of well-known values. If one of them applies, then the respective value MUST be used; otherwise, a custom value MAY be used. | Value | Description | Stability | @@ -71,6 +73,8 @@ size should be used. | `send` | One or more messages are provided for sending to an intermediary. If a single message is sent, the context of the "Send" span can be used as the creation context and no "Create" span needs to be created. | ![Experimental](https://img.shields.io/badge/-experimental-blue) | | `settle` | One or more messages are settled. | ![Experimental](https://img.shields.io/badge/-experimental-blue) | +### `messaging.system` Values + `messaging.system` has the following list of well-known values. If one of them applies, then the respective value MUST be used; otherwise, a custom value MAY be used. | Value | Description | Stability | @@ -142,6 +146,8 @@ This group describes attributes specific to RocketMQ. | `messaging.rocketmq.message.type` | string | Type of message. | `normal`; `fifo`; `delay` | ![Experimental](https://img.shields.io/badge/-experimental-blue) | | `messaging.rocketmq.namespace` | string | Namespace of RocketMQ resources, resources in different namespaces are individual. | `myNamespace` | ![Experimental](https://img.shields.io/badge/-experimental-blue) | +### `messaging.rocketmq.consumption_model` Values + `messaging.rocketmq.consumption_model` has the following list of well-known values. If one of them applies, then the respective value MUST be used; otherwise, a custom value MAY be used. | Value | Description | Stability | @@ -149,6 +155,8 @@ This group describes attributes specific to RocketMQ. | `broadcasting` | Broadcasting consumption model | ![Experimental](https://img.shields.io/badge/-experimental-blue) | | `clustering` | Clustering consumption model | ![Experimental](https://img.shields.io/badge/-experimental-blue) | +### `messaging.rocketmq.message.type` Values + `messaging.rocketmq.message.type` has the following list of well-known values. If one of them applies, then the respective value MUST be used; otherwise, a custom value MAY be used. | Value | Description | Stability | @@ -168,6 +176,8 @@ This group describes attributes specific to Azure Service Bus. | `messaging.servicebus.message.delivery_count` | int | Number of deliveries that have been attempted for this message. | `2` | ![Experimental](https://img.shields.io/badge/-experimental-blue) | | `messaging.servicebus.message.enqueued_time` | int | The UTC epoch seconds at which the message has been accepted and stored in the entity. | `1701393730` | ![Experimental](https://img.shields.io/badge/-experimental-blue) | +### `messaging.servicebus.disposition_status` Values + `messaging.servicebus.disposition_status` has the following list of well-known values. If one of them applies, then the respective value MUST be used; otherwise, a custom value MAY be used. | Value | Description | Stability | diff --git a/docs/attributes-registry/network.md b/docs/attributes-registry/network.md index a6c97b8cb2..f815a2c4dc 100644 --- a/docs/attributes-registry/network.md +++ b/docs/attributes-registry/network.md @@ -44,6 +44,8 @@ different processes could be listening on TCP port 12345 and UDP port 12345. **[4]:** The value SHOULD be normalized to lowercase. +### `network.connection.subtype` Values + `network.connection.subtype` has the following list of well-known values. If one of them applies, then the respective value MUST be used; otherwise, a custom value MAY be used. | Value | Description | Stability | @@ -70,6 +72,8 @@ different processes could be listening on TCP port 12345 and UDP port 12345. | `td_scdma` | TD-SCDMA | ![Experimental](https://img.shields.io/badge/-experimental-blue) | | `umts` | UMTS | ![Experimental](https://img.shields.io/badge/-experimental-blue) | +### `network.connection.type` Values + `network.connection.type` has the following list of well-known values. If one of them applies, then the respective value MUST be used; otherwise, a custom value MAY be used. | Value | Description | Stability | @@ -80,6 +84,8 @@ different processes could be listening on TCP port 12345 and UDP port 12345. | `wifi` | wifi | ![Experimental](https://img.shields.io/badge/-experimental-blue) | | `wired` | wired | ![Experimental](https://img.shields.io/badge/-experimental-blue) | +### `network.io.direction` Values + `network.io.direction` has the following list of well-known values. If one of them applies, then the respective value MUST be used; otherwise, a custom value MAY be used. | Value | Description | Stability | @@ -87,6 +93,8 @@ different processes could be listening on TCP port 12345 and UDP port 12345. | `receive` | receive | ![Experimental](https://img.shields.io/badge/-experimental-blue) | | `transmit` | transmit | ![Experimental](https://img.shields.io/badge/-experimental-blue) | +### `network.transport` Values + `network.transport` has the following list of well-known values. If one of them applies, then the respective value MUST be used; otherwise, a custom value MAY be used. | Value | Description | Stability | @@ -97,6 +105,8 @@ different processes could be listening on TCP port 12345 and UDP port 12345. | `udp` | UDP | ![Stable](https://img.shields.io/badge/-stable-lightgreen) | | `unix` | Unix domain socket | ![Stable](https://img.shields.io/badge/-stable-lightgreen) | +### `network.type` Values + `network.type` has the following list of well-known values. If one of them applies, then the respective value MUST be used; otherwise, a custom value MAY be used. | Value | Description | Stability | @@ -126,6 +136,8 @@ These attributes may be used for any network related operation. | `net.sock.peer.port` | int | Deprecated, use `network.peer.port`. | `65531` | ![Deprecated](https://img.shields.io/badge/-deprecated-red)
Replaced by `network.peer.port`. | | `net.transport` | string | Deprecated, use `network.transport`. | `ip_tcp`; `ip_udp`; `pipe` | ![Deprecated](https://img.shields.io/badge/-deprecated-red)
Replaced by `network.transport`. | +### `net.sock.family` Values + `net.sock.family` has the following list of well-known values. If one of them applies, then the respective value MUST be used; otherwise, a custom value MAY be used. | Value | Description | Stability | @@ -134,6 +146,8 @@ These attributes may be used for any network related operation. | `inet6` | IPv6 address | ![Experimental](https://img.shields.io/badge/-experimental-blue) | | `unix` | Unix domain socket path | ![Experimental](https://img.shields.io/badge/-experimental-blue) | +### `net.transport` Values + `net.transport` has the following list of well-known values. If one of them applies, then the respective value MUST be used; otherwise, a custom value MAY be used. | Value | Description | Stability | diff --git a/docs/attributes-registry/nodejs.md b/docs/attributes-registry/nodejs.md index 76cfd152e8..d3dda637d1 100644 --- a/docs/attributes-registry/nodejs.md +++ b/docs/attributes-registry/nodejs.md @@ -14,6 +14,8 @@ Describes Node.js related attributes. |---|---|---|---|---| | `nodejs.eventloop.state` | string | The state of event loop time. | `active`; `idle` | ![Experimental](https://img.shields.io/badge/-experimental-blue) | +### `nodejs.eventloop.state` Values + `nodejs.eventloop.state` has the following list of well-known values. If one of them applies, then the respective value MUST be used; otherwise, a custom value MAY be used. | Value | Description | Stability | diff --git a/docs/attributes-registry/opentracing.md b/docs/attributes-registry/opentracing.md index ce73840fcd..9054676910 100644 --- a/docs/attributes-registry/opentracing.md +++ b/docs/attributes-registry/opentracing.md @@ -16,6 +16,8 @@ Attributes used by the OpenTracing Shim layer. **[1]:** The causal relationship between a child Span and a parent Span. +### `opentracing.ref_type` Values + `opentracing.ref_type` has the following list of well-known values. If one of them applies, then the respective value MUST be used; otherwise, a custom value MAY be used. | Value | Description | Stability | diff --git a/docs/attributes-registry/os.md b/docs/attributes-registry/os.md index 9c1a841805..e1d651a10e 100644 --- a/docs/attributes-registry/os.md +++ b/docs/attributes-registry/os.md @@ -18,6 +18,8 @@ The operating system (OS) on which the process represented by this resource is r | `os.type` | string | The operating system type. | `windows`; `linux`; `darwin` | ![Experimental](https://img.shields.io/badge/-experimental-blue) | | `os.version` | string | The version string of the operating system as defined in [Version Attributes](/docs/resource/README.md#version-attributes). | `14.2.1`; `18.04.1` | ![Experimental](https://img.shields.io/badge/-experimental-blue) | +### `os.type` Values + `os.type` has the following list of well-known values. If one of them applies, then the respective value MUST be used; otherwise, a custom value MAY be used. | Value | Description | Stability | diff --git a/docs/attributes-registry/otel.md b/docs/attributes-registry/otel.md index 44076a1e63..a4ef0c4676 100644 --- a/docs/attributes-registry/otel.md +++ b/docs/attributes-registry/otel.md @@ -19,6 +19,8 @@ Attributes reserved for OpenTelemetry | `otel.status_code` | string | Name of the code, either "OK" or "ERROR". MUST NOT be set if the status code is UNSET. | `OK`; `ERROR` | ![Stable](https://img.shields.io/badge/-stable-lightgreen) | | `otel.status_description` | string | Description of the Status if it has a value, otherwise not set. | `resource not found` | ![Stable](https://img.shields.io/badge/-stable-lightgreen) | +### `otel.status_code` Values + `otel.status_code` has the following list of well-known values. If one of them applies, then the respective value MUST be used; otherwise, a custom value MAY be used. | Value | Description | Stability | diff --git a/docs/attributes-registry/process.md b/docs/attributes-registry/process.md index 19f60d94b6..1859344e19 100644 --- a/docs/attributes-registry/process.md +++ b/docs/attributes-registry/process.md @@ -54,6 +54,8 @@ An operating system process. **[3]:** The process ID within a PID namespace. This is not necessarily unique across all processes on the host but it is unique within the process namespace that the process exists within. +### `process.context_switch_type` Values + `process.context_switch_type` has the following list of well-known values. If one of them applies, then the respective value MUST be used; otherwise, a custom value MAY be used. | Value | Description | Stability | @@ -61,6 +63,8 @@ An operating system process. | `involuntary` | involuntary | ![Experimental](https://img.shields.io/badge/-experimental-blue) | | `voluntary` | voluntary | ![Experimental](https://img.shields.io/badge/-experimental-blue) | +### `process.paging.fault_type` Values + `process.paging.fault_type` has the following list of well-known values. If one of them applies, then the respective value MUST be used; otherwise, a custom value MAY be used. | Value | Description | Stability | @@ -77,6 +81,8 @@ Deprecated process attributes. | `process.cpu.state` | string | Deprecated, use `cpu.mode` instead. | `system`; `user`; `wait` | ![Deprecated](https://img.shields.io/badge/-deprecated-red)
Replaced by `cpu.mode` | | `process.executable.build_id.profiling` | string | "Deprecated, use `process.executable.build_id.htlhash` instead." | `600DCAFE4A110000F2BF38C493F5FB92` | ![Deprecated](https://img.shields.io/badge/-deprecated-red)
Replaced by `process.executable.build_id.htlhash` | +### `process.cpu.state` Values + `process.cpu.state` has the following list of well-known values. If one of them applies, then the respective value MUST be used; otherwise, a custom value MAY be used. | Value | Description | Stability | diff --git a/docs/attributes-registry/profile.md b/docs/attributes-registry/profile.md index cb21193a68..99f5dcee66 100644 --- a/docs/attributes-registry/profile.md +++ b/docs/attributes-registry/profile.md @@ -14,6 +14,8 @@ Describes the origin of a single frame in a Profile. |---|---|---|---|---| | `profile.frame.type` | string | Describes the interpreter or compiler of a single frame. | `cpython` | ![Experimental](https://img.shields.io/badge/-experimental-blue) | +### `profile.frame.type` Values + `profile.frame.type` has the following list of well-known values. If one of them applies, then the respective value MUST be used; otherwise, a custom value MAY be used. | Value | Description | Stability | diff --git a/docs/attributes-registry/rpc.md b/docs/attributes-registry/rpc.md index 2dc4810d0b..d791e0c56d 100644 --- a/docs/attributes-registry/rpc.md +++ b/docs/attributes-registry/rpc.md @@ -47,6 +47,8 @@ This document defines attributes for remote procedure calls. **[7]:** This is the logical name of the service from the RPC interface perspective, which can be different from the name of any implementing class. The `code.namespace` attribute may be used to store the latter (despite the attribute name, it may include a class name; e.g., class with method actually executing the call on the server side, RPC client stub class on the client side). +### `rpc.connect_rpc.error_code` Values + `rpc.connect_rpc.error_code` has the following list of well-known values. If one of them applies, then the respective value MUST be used; otherwise, a custom value MAY be used. | Value | Description | Stability | @@ -68,6 +70,8 @@ This document defines attributes for remote procedure calls. | `unimplemented` | unimplemented | ![Experimental](https://img.shields.io/badge/-experimental-blue) | | `unknown` | unknown | ![Experimental](https://img.shields.io/badge/-experimental-blue) | +### `rpc.grpc.status_code` Values + `rpc.grpc.status_code` has the following list of well-known values. If one of them applies, then the respective value MUST be used; otherwise, a custom value MAY be used. | Value | Description | Stability | @@ -90,6 +94,8 @@ This document defines attributes for remote procedure calls. | `15` | DATA_LOSS | ![Experimental](https://img.shields.io/badge/-experimental-blue) | | `16` | UNAUTHENTICATED | ![Experimental](https://img.shields.io/badge/-experimental-blue) | +### `rpc.message.type` Values + `rpc.message.type` has the following list of well-known values. If one of them applies, then the respective value MUST be used; otherwise, a custom value MAY be used. | Value | Description | Stability | @@ -97,6 +103,8 @@ This document defines attributes for remote procedure calls. | `RECEIVED` | received | ![Experimental](https://img.shields.io/badge/-experimental-blue) | | `SENT` | sent | ![Experimental](https://img.shields.io/badge/-experimental-blue) | +### `rpc.system` Values + `rpc.system` has the following list of well-known values. If one of them applies, then the respective value MUST be used; otherwise, a custom value MAY be used. | Value | Description | Stability | @@ -118,6 +126,8 @@ Deprecated rpc message attributes. | `message.type` | string | Deprecated, use `rpc.message.type` instead. | `SENT`; `RECEIVED` | ![Deprecated](https://img.shields.io/badge/-deprecated-red)
Replaced by `rpc.message.type`. | | `message.uncompressed_size` | int | Deprecated, use `rpc.message.uncompressed_size` instead. | | ![Deprecated](https://img.shields.io/badge/-deprecated-red)
Replaced by `rpc.message.uncompressed_size`. | +### `message.type` Values + `message.type` has the following list of well-known values. If one of them applies, then the respective value MUST be used; otherwise, a custom value MAY be used. | Value | Description | Stability | diff --git a/docs/attributes-registry/signalr.md b/docs/attributes-registry/signalr.md index d1535b3bf3..6aba27de10 100644 --- a/docs/attributes-registry/signalr.md +++ b/docs/attributes-registry/signalr.md @@ -15,6 +15,8 @@ SignalR attributes | `signalr.connection.status` | string | SignalR HTTP connection closure status. | `app_shutdown`; `timeout` | ![Stable](https://img.shields.io/badge/-stable-lightgreen) | | `signalr.transport` | string | [SignalR transport type](https://github.com/dotnet/aspnetcore/blob/main/src/SignalR/docs/specs/TransportProtocols.md) | `web_sockets`; `long_polling` | ![Stable](https://img.shields.io/badge/-stable-lightgreen) | +### `signalr.connection.status` Values + `signalr.connection.status` has the following list of well-known values. If one of them applies, then the respective value MUST be used; otherwise, a custom value MAY be used. | Value | Description | Stability | @@ -23,6 +25,8 @@ SignalR attributes | `normal_closure` | The connection was closed normally. | ![Stable](https://img.shields.io/badge/-stable-lightgreen) | | `timeout` | The connection was closed due to a timeout. | ![Stable](https://img.shields.io/badge/-stable-lightgreen) | +### `signalr.transport` Values + `signalr.transport` has the following list of well-known values. If one of them applies, then the respective value MUST be used; otherwise, a custom value MAY be used. | Value | Description | Stability | diff --git a/docs/attributes-registry/system.md b/docs/attributes-registry/system.md index a94bda9e14..57cdc6e3ea 100644 --- a/docs/attributes-registry/system.md +++ b/docs/attributes-registry/system.md @@ -42,6 +42,8 @@ Describes Filesystem attributes | `system.filesystem.state` | string | The filesystem state | `used` | ![Experimental](https://img.shields.io/badge/-experimental-blue) | | `system.filesystem.type` | string | The filesystem type | `ext4` | ![Experimental](https://img.shields.io/badge/-experimental-blue) | +### `system.filesystem.state` Values + `system.filesystem.state` has the following list of well-known values. If one of them applies, then the respective value MUST be used; otherwise, a custom value MAY be used. | Value | Description | Stability | @@ -50,6 +52,8 @@ Describes Filesystem attributes | `reserved` | reserved | ![Experimental](https://img.shields.io/badge/-experimental-blue) | | `used` | used | ![Experimental](https://img.shields.io/badge/-experimental-blue) | +### `system.filesystem.type` Values + `system.filesystem.type` has the following list of well-known values. If one of them applies, then the respective value MUST be used; otherwise, a custom value MAY be used. | Value | Description | Stability | @@ -69,6 +73,8 @@ Describes System Memory attributes |---|---|---|---|---| | `system.memory.state` | string | The memory state | `free`; `cached` | ![Experimental](https://img.shields.io/badge/-experimental-blue) | +### `system.memory.state` Values + `system.memory.state` has the following list of well-known values. If one of them applies, then the respective value MUST be used; otherwise, a custom value MAY be used. | Value | Description | Stability | @@ -87,6 +93,8 @@ Describes Network attributes |---|---|---|---|---| | `system.network.state` | string | A stateless protocol MUST NOT set this attribute | `close_wait` | ![Experimental](https://img.shields.io/badge/-experimental-blue) | +### `system.network.state` Values + `system.network.state` has the following list of well-known values. If one of them applies, then the respective value MUST be used; otherwise, a custom value MAY be used. | Value | Description | Stability | @@ -114,6 +122,8 @@ Describes System Memory Paging attributes | `system.paging.state` | string | The memory paging state | `free` | ![Experimental](https://img.shields.io/badge/-experimental-blue) | | `system.paging.type` | string | The memory paging type | `minor` | ![Experimental](https://img.shields.io/badge/-experimental-blue) | +### `system.paging.direction` Values + `system.paging.direction` has the following list of well-known values. If one of them applies, then the respective value MUST be used; otherwise, a custom value MAY be used. | Value | Description | Stability | @@ -121,6 +131,8 @@ Describes System Memory Paging attributes | `in` | in | ![Experimental](https://img.shields.io/badge/-experimental-blue) | | `out` | out | ![Experimental](https://img.shields.io/badge/-experimental-blue) | +### `system.paging.state` Values + `system.paging.state` has the following list of well-known values. If one of them applies, then the respective value MUST be used; otherwise, a custom value MAY be used. | Value | Description | Stability | @@ -128,6 +140,8 @@ Describes System Memory Paging attributes | `free` | free | ![Experimental](https://img.shields.io/badge/-experimental-blue) | | `used` | used | ![Experimental](https://img.shields.io/badge/-experimental-blue) | +### `system.paging.type` Values + `system.paging.type` has the following list of well-known values. If one of them applies, then the respective value MUST be used; otherwise, a custom value MAY be used. | Value | Description | Stability | @@ -143,6 +157,8 @@ Describes System Process attributes |---|---|---|---|---| | `system.process.status` | string | The process state, e.g., [Linux Process State Codes](https://man7.org/linux/man-pages/man1/ps.1.html#PROCESS_STATE_CODES) | `running` | ![Experimental](https://img.shields.io/badge/-experimental-blue) | +### `system.process.status` Values + `system.process.status` has the following list of well-known values. If one of them applies, then the respective value MUST be used; otherwise, a custom value MAY be used. | Value | Description | Stability | @@ -161,6 +177,8 @@ Deprecated system attributes. | `system.cpu.state` | string | Deprecated, use `cpu.mode` instead. | `idle`; `interrupt` | ![Deprecated](https://img.shields.io/badge/-deprecated-red)
Replaced by `cpu.mode` | | `system.processes.status` | string | Deprecated, use `system.process.status` instead. | `running` | ![Deprecated](https://img.shields.io/badge/-deprecated-red)
Replaced by `system.process.status`. | +### `system.cpu.state` Values + `system.cpu.state` has the following list of well-known values. If one of them applies, then the respective value MUST be used; otherwise, a custom value MAY be used. | Value | Description | Stability | @@ -173,6 +191,8 @@ Deprecated system attributes. | `system` | system | ![Experimental](https://img.shields.io/badge/-experimental-blue) | | `user` | user | ![Experimental](https://img.shields.io/badge/-experimental-blue) | +### `system.processes.status` Values + `system.processes.status` has the following list of well-known values. If one of them applies, then the respective value MUST be used; otherwise, a custom value MAY be used. | Value | Description | Stability | diff --git a/docs/attributes-registry/telemetry.md b/docs/attributes-registry/telemetry.md index 39d1a8de55..beaca80b93 100644 --- a/docs/attributes-registry/telemetry.md +++ b/docs/attributes-registry/telemetry.md @@ -28,6 +28,8 @@ or another suitable identifier depending on the language. The identifier `opentelemetry` is reserved and MUST NOT be used in this case. All custom identifiers SHOULD be stable across different versions of an implementation. +### `telemetry.sdk.language` Values + `telemetry.sdk.language` has the following list of well-known values. If one of them applies, then the respective value MUST be used; otherwise, a custom value MAY be used. | Value | Description | Stability | diff --git a/docs/attributes-registry/test.md b/docs/attributes-registry/test.md index 0be8824c4b..b2b715eadf 100644 --- a/docs/attributes-registry/test.md +++ b/docs/attributes-registry/test.md @@ -17,6 +17,8 @@ This group describes attributes specific to [software tests](https://wikipedia.o | `test.suite.name` | string | The human readable name of a [test suite](https://wikipedia.org/wiki/Test_suite). | `TestSuite1` | ![Experimental](https://img.shields.io/badge/-experimental-blue) | | `test.suite.run.status` | string | The status of the test suite run. | `success`; `failure`; `skipped`; `aborted`; `timed_out`; `in_progress` | ![Experimental](https://img.shields.io/badge/-experimental-blue) | +### `test.case.result.status` Values + `test.case.result.status` has the following list of well-known values. If one of them applies, then the respective value MUST be used; otherwise, a custom value MAY be used. | Value | Description | Stability | @@ -24,6 +26,8 @@ This group describes attributes specific to [software tests](https://wikipedia.o | `fail` | fail | ![Experimental](https://img.shields.io/badge/-experimental-blue) | | `pass` | pass | ![Experimental](https://img.shields.io/badge/-experimental-blue) | +### `test.suite.run.status` Values + `test.suite.run.status` has the following list of well-known values. If one of them applies, then the respective value MUST be used; otherwise, a custom value MAY be used. | Value | Description | Stability | diff --git a/docs/attributes-registry/tls.md b/docs/attributes-registry/tls.md index 2002a76972..368a38e129 100644 --- a/docs/attributes-registry/tls.md +++ b/docs/attributes-registry/tls.md @@ -46,6 +46,8 @@ This document defines semantic convention attributes in the TLS namespace. **[1]:** The values allowed for `tls.cipher` MUST be one of the `Descriptions` of the [registered TLS Cipher Suits](https://www.iana.org/assignments/tls-parameters/tls-parameters.xhtml#table-tls-parameters-4). +### `tls.protocol.name` Values + `tls.protocol.name` has the following list of well-known values. If one of them applies, then the respective value MUST be used; otherwise, a custom value MAY be used. | Value | Description | Stability | diff --git a/docs/attributes-registry/v8js.md b/docs/attributes-registry/v8js.md index 3ca30207c9..ecd11cb497 100644 --- a/docs/attributes-registry/v8js.md +++ b/docs/attributes-registry/v8js.md @@ -17,6 +17,8 @@ Describes V8 JS Engine Runtime related attributes. **[1]:** Value can be retrieved from value `space_name` of [`v8.getHeapSpaceStatistics()`](https://nodejs.org/api/v8.html#v8getheapspacestatistics) +### `v8js.gc.type` Values + `v8js.gc.type` has the following list of well-known values. If one of them applies, then the respective value MUST be used; otherwise, a custom value MAY be used. | Value | Description | Stability | @@ -26,6 +28,8 @@ Describes V8 JS Engine Runtime related attributes. | `minor` | Minor (Scavenge). | ![Experimental](https://img.shields.io/badge/-experimental-blue) | | `weakcb` | Weak Callbacks (Process Weak Callbacks). | ![Experimental](https://img.shields.io/badge/-experimental-blue) | +### `v8js.heap.space.name` Values + `v8js.heap.space.name` has the following list of well-known values. If one of them applies, then the respective value MUST be used; otherwise, a custom value MAY be used. | Value | Description | Stability | diff --git a/docs/attributes-registry/vcs.md b/docs/attributes-registry/vcs.md index 15fc8f3f4e..6f4779d788 100644 --- a/docs/attributes-registry/vcs.md +++ b/docs/attributes-registry/vcs.md @@ -49,6 +49,8 @@ it is identical to the `ref.head.name`, it SHOULD still be included. It is up to the implementer to decide which value to set as the revision based on the VCS system and situational context. +### `vcs.change.state` Values + `vcs.change.state` has the following list of well-known values. If one of them applies, then the respective value MUST be used; otherwise, a custom value MAY be used. | Value | Description | Stability | @@ -58,6 +60,8 @@ based on the VCS system and situational context. | `open` | Open means the change is currently active and under review. It hasn't been merged into the target branch yet, and it's still possible to make changes or add comments. | ![Experimental](https://img.shields.io/badge/-experimental-blue) | | `wip` | WIP (work-in-progress, draft) means the change is still in progress and not yet ready for a full review. It might still undergo significant changes. | ![Experimental](https://img.shields.io/badge/-experimental-blue) | +### `vcs.line_change.type` Values + `vcs.line_change.type` has the following list of well-known values. If one of them applies, then the respective value MUST be used; otherwise, a custom value MAY be used. | Value | Description | Stability | @@ -65,6 +69,8 @@ based on the VCS system and situational context. | `added` | How many lines were added. | ![Experimental](https://img.shields.io/badge/-experimental-blue) | | `removed` | How many lines were removed. | ![Experimental](https://img.shields.io/badge/-experimental-blue) | +### `vcs.ref.base.type` Values + `vcs.ref.base.type` has the following list of well-known values. If one of them applies, then the respective value MUST be used; otherwise, a custom value MAY be used. | Value | Description | Stability | @@ -72,6 +78,8 @@ based on the VCS system and situational context. | `branch` | [branch](https://git-scm.com/docs/gitglossary#Documentation/gitglossary.txt-aiddefbranchabranch) | ![Experimental](https://img.shields.io/badge/-experimental-blue) | | `tag` | [tag](https://git-scm.com/docs/gitglossary#Documentation/gitglossary.txt-aiddeftagatag) | ![Experimental](https://img.shields.io/badge/-experimental-blue) | +### `vcs.ref.head.type` Values + `vcs.ref.head.type` has the following list of well-known values. If one of them applies, then the respective value MUST be used; otherwise, a custom value MAY be used. | Value | Description | Stability | @@ -79,6 +87,8 @@ based on the VCS system and situational context. | `branch` | [branch](https://git-scm.com/docs/gitglossary#Documentation/gitglossary.txt-aiddefbranchabranch) | ![Experimental](https://img.shields.io/badge/-experimental-blue) | | `tag` | [tag](https://git-scm.com/docs/gitglossary#Documentation/gitglossary.txt-aiddeftagatag) | ![Experimental](https://img.shields.io/badge/-experimental-blue) | +### `vcs.ref.type` Values + `vcs.ref.type` has the following list of well-known values. If one of them applies, then the respective value MUST be used; otherwise, a custom value MAY be used. | Value | Description | Stability | @@ -86,6 +96,8 @@ based on the VCS system and situational context. | `branch` | [branch](https://git-scm.com/docs/gitglossary#Documentation/gitglossary.txt-aiddefbranchabranch) | ![Experimental](https://img.shields.io/badge/-experimental-blue) | | `tag` | [tag](https://git-scm.com/docs/gitglossary#Documentation/gitglossary.txt-aiddeftagatag) | ![Experimental](https://img.shields.io/badge/-experimental-blue) | +### `vcs.revision_delta.direction` Values + `vcs.revision_delta.direction` has the following list of well-known values. If one of them applies, then the respective value MUST be used; otherwise, a custom value MAY be used. | Value | Description | Stability | @@ -105,6 +117,8 @@ based on the VCS system and situational context. | `vcs.repository.ref.revision` | string | Deprecated, use `vcs.ref.head.revision` instead. | `9d59409acf479dfa0df1aa568182e43e43df8bbe28d60fcf2bc52e30068802cc`; `main`; `123`; `HEAD` | ![Deprecated](https://img.shields.io/badge/-deprecated-red)
Deprecated, use `vcs.ref.head.revision` instead. | | `vcs.repository.ref.type` | string | Deprecated, use `vcs.ref.head.type` instead. | `branch`; `tag` | ![Deprecated](https://img.shields.io/badge/-deprecated-red)
Deprecated, use `vcs.ref.head.type` instead. | +### `vcs.repository.ref.type` Values + `vcs.repository.ref.type` has the following list of well-known values. If one of them applies, then the respective value MUST be used; otherwise, a custom value MAY be used. | Value | Description | Stability | diff --git a/docs/cicd/cicd-metrics.md b/docs/cicd/cicd-metrics.md index a0b3244681..029f22d957 100644 --- a/docs/cicd/cicd-metrics.md +++ b/docs/cicd/cicd-metrics.md @@ -50,6 +50,8 @@ This metric is [recommended][MetricRecommended]. | [`vcs.change.state`](/docs/attributes-registry/vcs.md) | string | The state of the change (pull request/merge request/changelist). | `open`; `closed`; `merged` | `Required` | ![Experimental](https://img.shields.io/badge/-experimental-blue) | | [`vcs.repository.url.full`](/docs/attributes-registry/vcs.md) | string | The [URL](https://wikipedia.org/wiki/URL) of the repository providing the complete address in order to locate and identify the repository. | `https://github.com/opentelemetry/open-telemetry-collector-contrib`; `https://gitlab.com/my-org/my-project/my-projects-project/repo` | `Required` | ![Experimental](https://img.shields.io/badge/-experimental-blue) | +### `vcs.change.state` Values + `vcs.change.state` has the following list of well-known values. If one of them applies, then the respective value MUST be used; otherwise, a custom value MAY be used. | Value | Description | Stability | @@ -85,6 +87,8 @@ This metric is [recommended][MetricRecommended]. | [`vcs.ref.head.name`](/docs/attributes-registry/vcs.md) | string | The name of the [reference](https://git-scm.com/docs/gitglossary#def_ref) such as **branch** or **tag** in the repository. | `my-feature-branch`; `tag-1-test` | `Required` | ![Experimental](https://img.shields.io/badge/-experimental-blue) | | [`vcs.repository.url.full`](/docs/attributes-registry/vcs.md) | string | The [URL](https://wikipedia.org/wiki/URL) of the repository providing the complete address in order to locate and identify the repository. | `https://github.com/opentelemetry/open-telemetry-collector-contrib`; `https://gitlab.com/my-org/my-project/my-projects-project/repo` | `Required` | ![Experimental](https://img.shields.io/badge/-experimental-blue) | +### `vcs.change.state` Values + `vcs.change.state` has the following list of well-known values. If one of them applies, then the respective value MUST be used; otherwise, a custom value MAY be used. | Value | Description | Stability | @@ -164,6 +168,8 @@ This metric is [recommended][MetricRecommended]. | [`vcs.ref.type`](/docs/attributes-registry/vcs.md) | string | The type of the [reference](https://git-scm.com/docs/gitglossary#def_ref) in the repository. | `branch`; `tag` | `Required` | ![Experimental](https://img.shields.io/badge/-experimental-blue) | | [`vcs.repository.url.full`](/docs/attributes-registry/vcs.md) | string | The [URL](https://wikipedia.org/wiki/URL) of the repository providing the complete address in order to locate and identify the repository. | `https://github.com/opentelemetry/open-telemetry-collector-contrib`; `https://gitlab.com/my-org/my-project/my-projects-project/repo` | `Required` | ![Experimental](https://img.shields.io/badge/-experimental-blue) | +### `vcs.ref.type` Values + `vcs.ref.type` has the following list of well-known values. If one of them applies, then the respective value MUST be used; otherwise, a custom value MAY be used. | Value | Description | Stability | @@ -205,6 +211,8 @@ If number of lines added/removed should be calculated from the start of time, th | [`vcs.repository.url.full`](/docs/attributes-registry/vcs.md) | string | The [URL](https://wikipedia.org/wiki/URL) of the repository providing the complete address in order to locate and identify the repository. | `https://github.com/opentelemetry/open-telemetry-collector-contrib`; `https://gitlab.com/my-org/my-project/my-projects-project/repo` | `Required` | ![Experimental](https://img.shields.io/badge/-experimental-blue) | | [`vcs.change.id`](/docs/attributes-registry/vcs.md) | string | The ID of the change (pull request/merge request/changelist) if applicable. This is usually a unique (within repository) identifier generated by the VCS system. | `123` | `Conditionally Required` if a change is associate with the ref. | ![Experimental](https://img.shields.io/badge/-experimental-blue) | +### `vcs.line_change.type` Values + `vcs.line_change.type` has the following list of well-known values. If one of them applies, then the respective value MUST be used; otherwise, a custom value MAY be used. | Value | Description | Stability | @@ -212,6 +220,8 @@ If number of lines added/removed should be calculated from the start of time, th | `added` | How many lines were added. | ![Experimental](https://img.shields.io/badge/-experimental-blue) | | `removed` | How many lines were removed. | ![Experimental](https://img.shields.io/badge/-experimental-blue) | +### `vcs.ref.base.type` Values + `vcs.ref.base.type` has the following list of well-known values. If one of them applies, then the respective value MUST be used; otherwise, a custom value MAY be used. | Value | Description | Stability | @@ -219,6 +229,8 @@ If number of lines added/removed should be calculated from the start of time, th | `branch` | [branch](https://git-scm.com/docs/gitglossary#Documentation/gitglossary.txt-aiddefbranchabranch) | ![Experimental](https://img.shields.io/badge/-experimental-blue) | | `tag` | [tag](https://git-scm.com/docs/gitglossary#Documentation/gitglossary.txt-aiddeftagatag) | ![Experimental](https://img.shields.io/badge/-experimental-blue) | +### `vcs.ref.head.type` Values + `vcs.ref.head.type` has the following list of well-known values. If one of them applies, then the respective value MUST be used; otherwise, a custom value MAY be used. | Value | Description | Stability | @@ -259,6 +271,8 @@ instrumentation SHOULD report two measurements: 3 and 2 (both positive numbers) | [`vcs.revision_delta.direction`](/docs/attributes-registry/vcs.md) | string | The type of revision comparison. | `ahead`; `behind` | `Required` | ![Experimental](https://img.shields.io/badge/-experimental-blue) | | [`vcs.change.id`](/docs/attributes-registry/vcs.md) | string | The ID of the change (pull request/merge request/changelist) if applicable. This is usually a unique (within repository) identifier generated by the VCS system. | `123` | `Conditionally Required` if a change is associate with the ref. | ![Experimental](https://img.shields.io/badge/-experimental-blue) | +### `vcs.ref.base.type` Values + `vcs.ref.base.type` has the following list of well-known values. If one of them applies, then the respective value MUST be used; otherwise, a custom value MAY be used. | Value | Description | Stability | @@ -266,6 +280,8 @@ instrumentation SHOULD report two measurements: 3 and 2 (both positive numbers) | `branch` | [branch](https://git-scm.com/docs/gitglossary#Documentation/gitglossary.txt-aiddefbranchabranch) | ![Experimental](https://img.shields.io/badge/-experimental-blue) | | `tag` | [tag](https://git-scm.com/docs/gitglossary#Documentation/gitglossary.txt-aiddeftagatag) | ![Experimental](https://img.shields.io/badge/-experimental-blue) | +### `vcs.ref.head.type` Values + `vcs.ref.head.type` has the following list of well-known values. If one of them applies, then the respective value MUST be used; otherwise, a custom value MAY be used. | Value | Description | Stability | @@ -273,6 +289,8 @@ instrumentation SHOULD report two measurements: 3 and 2 (both positive numbers) | `branch` | [branch](https://git-scm.com/docs/gitglossary#Documentation/gitglossary.txt-aiddefbranchabranch) | ![Experimental](https://img.shields.io/badge/-experimental-blue) | | `tag` | [tag](https://git-scm.com/docs/gitglossary#Documentation/gitglossary.txt-aiddeftagatag) | ![Experimental](https://img.shields.io/badge/-experimental-blue) | +### `vcs.revision_delta.direction` Values + `vcs.revision_delta.direction` has the following list of well-known values. If one of them applies, then the respective value MUST be used; otherwise, a custom value MAY be used. | Value | Description | Stability | @@ -306,6 +324,8 @@ This metric is [recommended][MetricRecommended]. | [`vcs.ref.head.type`](/docs/attributes-registry/vcs.md) | string | The type of the [reference](https://git-scm.com/docs/gitglossary#def_ref) in the repository. | `branch`; `tag` | `Required` | ![Experimental](https://img.shields.io/badge/-experimental-blue) | | [`vcs.repository.url.full`](/docs/attributes-registry/vcs.md) | string | The [URL](https://wikipedia.org/wiki/URL) of the repository providing the complete address in order to locate and identify the repository. | `https://github.com/opentelemetry/open-telemetry-collector-contrib`; `https://gitlab.com/my-org/my-project/my-projects-project/repo` | `Required` | ![Experimental](https://img.shields.io/badge/-experimental-blue) | +### `vcs.ref.head.type` Values + `vcs.ref.head.type` has the following list of well-known values. If one of them applies, then the respective value MUST be used; otherwise, a custom value MAY be used. | Value | Description | Stability | diff --git a/docs/cloud-providers/aws-sdk.md b/docs/cloud-providers/aws-sdk.md index 84b936b71d..87fc0533ca 100644 --- a/docs/cloud-providers/aws-sdk.md +++ b/docs/cloud-providers/aws-sdk.md @@ -42,6 +42,8 @@ with the naming guidelines for RPC client spans. **[2]:** This is the logical name of the service from the RPC interface perspective, which can be different from the name of any implementing class. The `code.namespace` attribute may be used to store the latter (despite the attribute name, it may include a class name; e.g., class with method actually executing the call on the server side, RPC client stub class on the client side). +### `rpc.system` Values + `rpc.system` has the following list of well-known values. If one of them applies, then the respective value MUST be used; otherwise, a custom value MAY be used. | Value | Description | Stability | diff --git a/docs/database/cassandra.md b/docs/database/cassandra.md index b1ac94a8a8..eaca2aa4e1 100644 --- a/docs/database/cassandra.md +++ b/docs/database/cassandra.md @@ -132,6 +132,8 @@ and SHOULD be provided **at span creation time** (if provided at all): * [`server.address`](/docs/attributes-registry/server.md) * [`server.port`](/docs/attributes-registry/server.md) +### `db.cassandra.consistency_level` Values + `db.cassandra.consistency_level` has the following list of well-known values. If one of them applies, then the respective value MUST be used; otherwise, a custom value MAY be used. | Value | Description | Stability | @@ -148,6 +150,8 @@ and SHOULD be provided **at span creation time** (if provided at all): | `three` | three | ![Experimental](https://img.shields.io/badge/-experimental-blue) | | `two` | two | ![Experimental](https://img.shields.io/badge/-experimental-blue) | +### `error.type` Values + `error.type` has the following list of well-known values. If one of them applies, then the respective value MUST be used; otherwise, a custom value MAY be used. | Value | Description | Stability | diff --git a/docs/database/cosmosdb.md b/docs/database/cosmosdb.md index 272bce2ab7..a6941891fc 100644 --- a/docs/database/cosmosdb.md +++ b/docs/database/cosmosdb.md @@ -240,6 +240,8 @@ and SHOULD be provided **at span creation time** (if provided at all): * [`server.address`](/docs/attributes-registry/server.md) * [`server.port`](/docs/attributes-registry/server.md) +### `db.cosmosdb.connection_mode` Values + `db.cosmosdb.connection_mode` has the following list of well-known values. If one of them applies, then the respective value MUST be used; otherwise, a custom value MAY be used. | Value | Description | Stability | @@ -247,6 +249,8 @@ and SHOULD be provided **at span creation time** (if provided at all): | `direct` | Direct connection. | ![Experimental](https://img.shields.io/badge/-experimental-blue) | | `gateway` | Gateway (HTTP) connection. | ![Experimental](https://img.shields.io/badge/-experimental-blue) | +### `db.cosmosdb.consistency_level` Values + `db.cosmosdb.consistency_level` has the following list of well-known values. If one of them applies, then the respective value MUST be used; otherwise, a custom value MAY be used. | Value | Description | Stability | @@ -257,6 +261,8 @@ and SHOULD be provided **at span creation time** (if provided at all): | `Session` | session | ![Experimental](https://img.shields.io/badge/-experimental-blue) | | `Strong` | strong | ![Experimental](https://img.shields.io/badge/-experimental-blue) | +### `error.type` Values + `error.type` has the following list of well-known values. If one of them applies, then the respective value MUST be used; otherwise, a custom value MAY be used. | Value | Description | Stability | @@ -381,6 +387,8 @@ Instrumentations SHOULD document how `error.type` is populated. **[9]:** When observed from the client side, and when communicating through an intermediary, `server.address` SHOULD represent the server address behind any intermediaries, for example proxies, if it's available. +### `db.cosmosdb.consistency_level` Values + `db.cosmosdb.consistency_level` has the following list of well-known values. If one of them applies, then the respective value MUST be used; otherwise, a custom value MAY be used. | Value | Description | Stability | @@ -391,6 +399,8 @@ Instrumentations SHOULD document how `error.type` is populated. | `Session` | session | ![Experimental](https://img.shields.io/badge/-experimental-blue) | | `Strong` | strong | ![Experimental](https://img.shields.io/badge/-experimental-blue) | +### `error.type` Values + `error.type` has the following list of well-known values. If one of them applies, then the respective value MUST be used; otherwise, a custom value MAY be used. | Value | Description | Stability | diff --git a/docs/database/couchdb.md b/docs/database/couchdb.md index 2d5ba06070..388fe61909 100644 --- a/docs/database/couchdb.md +++ b/docs/database/couchdb.md @@ -58,6 +58,8 @@ and SHOULD be provided **at span creation time** (if provided at all): * [`server.address`](/docs/attributes-registry/server.md) * [`server.port`](/docs/attributes-registry/server.md) +### `error.type` Values + `error.type` has the following list of well-known values. If one of them applies, then the respective value MUST be used; otherwise, a custom value MAY be used. | Value | Description | Stability | diff --git a/docs/database/database-metrics.md b/docs/database/database-metrics.md index 145dff3c29..cee0d097c0 100644 --- a/docs/database/database-metrics.md +++ b/docs/database/database-metrics.md @@ -169,6 +169,8 @@ For batch operations, if the individual operations are known to have the same qu Even though parameterized query text can potentially have sensitive data, by using a parameterized query the user is giving a strong signal that any sensitive data will be passed as parameter values, and the benefit to observability of capturing the static part of the query text by default outweighs the risk. This attribute has stability level RELEASE CANDIDATE. +### `db.system` Values + `db.system` has the following list of well-known values. If one of them applies, then the respective value MUST be used; otherwise, a custom value MAY be used. | Value | Description | Stability | @@ -223,6 +225,8 @@ This attribute has stability level RELEASE CANDIDATE. | `trino` | Trino | ![Experimental](https://img.shields.io/badge/-experimental-blue) | | `vertica` | Vertica | ![Experimental](https://img.shields.io/badge/-experimental-blue) | +### `error.type` Values + `error.type` has the following list of well-known values. If one of them applies, then the respective value MUST be used; otherwise, a custom value MAY be used. | Value | Description | Stability | @@ -354,6 +358,8 @@ For batch operations, if the individual operations are known to have the same qu Even though parameterized query text can potentially have sensitive data, by using a parameterized query the user is giving a strong signal that any sensitive data will be passed as parameter values, and the benefit to observability of capturing the static part of the query text by default outweighs the risk. This attribute has stability level RELEASE CANDIDATE. +### `db.system` Values + `db.system` has the following list of well-known values. If one of them applies, then the respective value MUST be used; otherwise, a custom value MAY be used. | Value | Description | Stability | @@ -408,6 +414,8 @@ This attribute has stability level RELEASE CANDIDATE. | `trino` | Trino | ![Experimental](https://img.shields.io/badge/-experimental-blue) | | `vertica` | Vertica | ![Experimental](https://img.shields.io/badge/-experimental-blue) | +### `error.type` Values + `error.type` has the following list of well-known values. If one of them applies, then the respective value MUST be used; otherwise, a custom value MAY be used. | Value | Description | Stability | @@ -443,6 +451,8 @@ This metric is [required][MetricRequired]. | [`db.client.connection.pool.name`](/docs/attributes-registry/db.md) | string | The name of the connection pool; unique within the instrumented application. In case the connection pool implementation doesn't provide a name, instrumentation SHOULD use a combination of parameters that would make the name unique, for example, combining attributes `server.address`, `server.port`, and `db.namespace`, formatted as `server.address:server.port/db.namespace`. Instrumentations that generate connection pool name following different patterns SHOULD document it. | `myDataSource` | `Required` | ![Experimental](https://img.shields.io/badge/-experimental-blue) | | [`db.client.connection.state`](/docs/attributes-registry/db.md) | string | The state of a connection in the pool | `idle` | `Required` | ![Experimental](https://img.shields.io/badge/-experimental-blue) | +### `db.client.connection.state` Values + `db.client.connection.state` has the following list of well-known values. If one of them applies, then the respective value MUST be used; otherwise, a custom value MAY be used. | Value | Description | Stability | diff --git a/docs/database/database-spans.md b/docs/database/database-spans.md index 88cd2ea50b..fca5caccb9 100644 --- a/docs/database/database-spans.md +++ b/docs/database/database-spans.md @@ -209,6 +209,8 @@ and SHOULD be provided **at span creation time** (if provided at all): * [`server.address`](/docs/attributes-registry/server.md) * [`server.port`](/docs/attributes-registry/server.md) +### `db.system` Values + `db.system` has the following list of well-known values. If one of them applies, then the respective value MUST be used; otherwise, a custom value MAY be used. | Value | Description | Stability | @@ -263,6 +265,8 @@ and SHOULD be provided **at span creation time** (if provided at all): | `trino` | Trino | ![Experimental](https://img.shields.io/badge/-experimental-blue) | | `vertica` | Vertica | ![Experimental](https://img.shields.io/badge/-experimental-blue) | +### `error.type` Values + `error.type` has the following list of well-known values. If one of them applies, then the respective value MUST be used; otherwise, a custom value MAY be used. | Value | Description | Stability | diff --git a/docs/database/dynamodb.md b/docs/database/dynamodb.md index 5c55d6ce8c..9d579ff5dc 100644 --- a/docs/database/dynamodb.md +++ b/docs/database/dynamodb.md @@ -33,6 +33,8 @@ The Semantic Conventions for [AWS DynamoDB](https://aws.amazon.com/dynamodb/) ex **[2]:** This is the logical name of the service from the RPC interface perspective, which can be different from the name of any implementing class. The `code.namespace` attribute may be used to store the latter (despite the attribute name, it may include a class name; e.g., class with method actually executing the call on the server side, RPC client stub class on the client side). +### `rpc.system` Values + `rpc.system` has the following list of well-known values. If one of them applies, then the respective value MUST be used; otherwise, a custom value MAY be used. | Value | Description | Stability | @@ -71,6 +73,8 @@ The Semantic Conventions for [AWS DynamoDB](https://aws.amazon.com/dynamodb/) ex **[2]:** This is the logical name of the service from the RPC interface perspective, which can be different from the name of any implementing class. The `code.namespace` attribute may be used to store the latter (despite the attribute name, it may include a class name; e.g., class with method actually executing the call on the server side, RPC client stub class on the client side). +### `rpc.system` Values + `rpc.system` has the following list of well-known values. If one of them applies, then the respective value MUST be used; otherwise, a custom value MAY be used. | Value | Description | Stability | @@ -113,6 +117,8 @@ The Semantic Conventions for [AWS DynamoDB](https://aws.amazon.com/dynamodb/) ex **[2]:** This is the logical name of the service from the RPC interface perspective, which can be different from the name of any implementing class. The `code.namespace` attribute may be used to store the latter (despite the attribute name, it may include a class name; e.g., class with method actually executing the call on the server side, RPC client stub class on the client side). +### `rpc.system` Values + `rpc.system` has the following list of well-known values. If one of them applies, then the respective value MUST be used; otherwise, a custom value MAY be used. | Value | Description | Stability | @@ -151,6 +157,8 @@ The Semantic Conventions for [AWS DynamoDB](https://aws.amazon.com/dynamodb/) ex **[2]:** This is the logical name of the service from the RPC interface perspective, which can be different from the name of any implementing class. The `code.namespace` attribute may be used to store the latter (despite the attribute name, it may include a class name; e.g., class with method actually executing the call on the server side, RPC client stub class on the client side). +### `rpc.system` Values + `rpc.system` has the following list of well-known values. If one of them applies, then the respective value MUST be used; otherwise, a custom value MAY be used. | Value | Description | Stability | @@ -187,6 +195,8 @@ The Semantic Conventions for [AWS DynamoDB](https://aws.amazon.com/dynamodb/) ex **[2]:** This is the logical name of the service from the RPC interface perspective, which can be different from the name of any implementing class. The `code.namespace` attribute may be used to store the latter (despite the attribute name, it may include a class name; e.g., class with method actually executing the call on the server side, RPC client stub class on the client side). +### `rpc.system` Values + `rpc.system` has the following list of well-known values. If one of them applies, then the respective value MUST be used; otherwise, a custom value MAY be used. | Value | Description | Stability | @@ -223,6 +233,8 @@ The Semantic Conventions for [AWS DynamoDB](https://aws.amazon.com/dynamodb/) ex **[2]:** This is the logical name of the service from the RPC interface perspective, which can be different from the name of any implementing class. The `code.namespace` attribute may be used to store the latter (despite the attribute name, it may include a class name; e.g., class with method actually executing the call on the server side, RPC client stub class on the client side). +### `rpc.system` Values + `rpc.system` has the following list of well-known values. If one of them applies, then the respective value MUST be used; otherwise, a custom value MAY be used. | Value | Description | Stability | @@ -262,6 +274,8 @@ The Semantic Conventions for [AWS DynamoDB](https://aws.amazon.com/dynamodb/) ex **[2]:** This is the logical name of the service from the RPC interface perspective, which can be different from the name of any implementing class. The `code.namespace` attribute may be used to store the latter (despite the attribute name, it may include a class name; e.g., class with method actually executing the call on the server side, RPC client stub class on the client side). +### `rpc.system` Values + `rpc.system` has the following list of well-known values. If one of them applies, then the respective value MUST be used; otherwise, a custom value MAY be used. | Value | Description | Stability | @@ -300,6 +314,8 @@ The Semantic Conventions for [AWS DynamoDB](https://aws.amazon.com/dynamodb/) ex **[2]:** This is the logical name of the service from the RPC interface perspective, which can be different from the name of any implementing class. The `code.namespace` attribute may be used to store the latter (despite the attribute name, it may include a class name; e.g., class with method actually executing the call on the server side, RPC client stub class on the client side). +### `rpc.system` Values + `rpc.system` has the following list of well-known values. If one of them applies, then the respective value MUST be used; otherwise, a custom value MAY be used. | Value | Description | Stability | @@ -338,6 +354,8 @@ The Semantic Conventions for [AWS DynamoDB](https://aws.amazon.com/dynamodb/) ex **[2]:** This is the logical name of the service from the RPC interface perspective, which can be different from the name of any implementing class. The `code.namespace` attribute may be used to store the latter (despite the attribute name, it may include a class name; e.g., class with method actually executing the call on the server side, RPC client stub class on the client side). +### `rpc.system` Values + `rpc.system` has the following list of well-known values. If one of them applies, then the respective value MUST be used; otherwise, a custom value MAY be used. | Value | Description | Stability | @@ -382,6 +400,8 @@ The Semantic Conventions for [AWS DynamoDB](https://aws.amazon.com/dynamodb/) ex **[2]:** This is the logical name of the service from the RPC interface perspective, which can be different from the name of any implementing class. The `code.namespace` attribute may be used to store the latter (despite the attribute name, it may include a class name; e.g., class with method actually executing the call on the server side, RPC client stub class on the client side). +### `rpc.system` Values + `rpc.system` has the following list of well-known values. If one of them applies, then the respective value MUST be used; otherwise, a custom value MAY be used. | Value | Description | Stability | @@ -429,6 +449,8 @@ The Semantic Conventions for [AWS DynamoDB](https://aws.amazon.com/dynamodb/) ex **[2]:** This is the logical name of the service from the RPC interface perspective, which can be different from the name of any implementing class. The `code.namespace` attribute may be used to store the latter (despite the attribute name, it may include a class name; e.g., class with method actually executing the call on the server side, RPC client stub class on the client side). +### `rpc.system` Values + `rpc.system` has the following list of well-known values. If one of them applies, then the respective value MUST be used; otherwise, a custom value MAY be used. | Value | Description | Stability | @@ -467,6 +489,8 @@ The Semantic Conventions for [AWS DynamoDB](https://aws.amazon.com/dynamodb/) ex **[2]:** This is the logical name of the service from the RPC interface perspective, which can be different from the name of any implementing class. The `code.namespace` attribute may be used to store the latter (despite the attribute name, it may include a class name; e.g., class with method actually executing the call on the server side, RPC client stub class on the client side). +### `rpc.system` Values + `rpc.system` has the following list of well-known values. If one of them applies, then the respective value MUST be used; otherwise, a custom value MAY be used. | Value | Description | Stability | @@ -508,6 +532,8 @@ The Semantic Conventions for [AWS DynamoDB](https://aws.amazon.com/dynamodb/) ex **[2]:** This is the logical name of the service from the RPC interface perspective, which can be different from the name of any implementing class. The `code.namespace` attribute may be used to store the latter (despite the attribute name, it may include a class name; e.g., class with method actually executing the call on the server side, RPC client stub class on the client side). +### `rpc.system` Values + `rpc.system` has the following list of well-known values. If one of them applies, then the respective value MUST be used; otherwise, a custom value MAY be used. | Value | Description | Stability | diff --git a/docs/database/elasticsearch.md b/docs/database/elasticsearch.md index ea8f7c0bb7..d466ed4b93 100644 --- a/docs/database/elasticsearch.md +++ b/docs/database/elasticsearch.md @@ -124,12 +124,16 @@ and SHOULD be provided **at span creation time** (if provided at all): * [`server.port`](/docs/attributes-registry/server.md) * [`url.full`](/docs/attributes-registry/url.md) +### `error.type` Values + `error.type` has the following list of well-known values. If one of them applies, then the respective value MUST be used; otherwise, a custom value MAY be used. | Value | Description | Stability | |---|---|---| | `_OTHER` | A fallback error value to be used when the instrumentation doesn't define a custom value. | ![Stable](https://img.shields.io/badge/-stable-lightgreen) | +### `http.request.method` Values + `http.request.method` has the following list of well-known values. If one of them applies, then the respective value MUST be used; otherwise, a custom value MAY be used. | Value | Description | Stability | diff --git a/docs/database/hbase.md b/docs/database/hbase.md index 62bc5a78a5..60d4d9b4be 100644 --- a/docs/database/hbase.md +++ b/docs/database/hbase.md @@ -78,6 +78,8 @@ and SHOULD be provided **at span creation time** (if provided at all): * [`server.address`](/docs/attributes-registry/server.md) * [`server.port`](/docs/attributes-registry/server.md) +### `error.type` Values + `error.type` has the following list of well-known values. If one of them applies, then the respective value MUST be used; otherwise, a custom value MAY be used. | Value | Description | Stability | diff --git a/docs/database/mariadb.md b/docs/database/mariadb.md index 5df5167326..52721048d9 100644 --- a/docs/database/mariadb.md +++ b/docs/database/mariadb.md @@ -145,6 +145,8 @@ and SHOULD be provided **at span creation time** (if provided at all): * [`server.address`](/docs/attributes-registry/server.md) * [`server.port`](/docs/attributes-registry/server.md) +### `error.type` Values + `error.type` has the following list of well-known values. If one of them applies, then the respective value MUST be used; otherwise, a custom value MAY be used. | Value | Description | Stability | diff --git a/docs/database/mongodb.md b/docs/database/mongodb.md index 2d4c9a6f85..3bb4d0c721 100644 --- a/docs/database/mongodb.md +++ b/docs/database/mongodb.md @@ -76,6 +76,8 @@ and SHOULD be provided **at span creation time** (if provided at all): * [`server.address`](/docs/attributes-registry/server.md) * [`server.port`](/docs/attributes-registry/server.md) +### `error.type` Values + `error.type` has the following list of well-known values. If one of them applies, then the respective value MUST be used; otherwise, a custom value MAY be used. | Value | Description | Stability | diff --git a/docs/database/mssql.md b/docs/database/mssql.md index a2b2f8a313..f02a240705 100644 --- a/docs/database/mssql.md +++ b/docs/database/mssql.md @@ -115,6 +115,8 @@ and SHOULD be provided **at span creation time** (if provided at all): * [`server.address`](/docs/attributes-registry/server.md) * [`server.port`](/docs/attributes-registry/server.md) +### `error.type` Values + `error.type` has the following list of well-known values. If one of them applies, then the respective value MUST be used; otherwise, a custom value MAY be used. | Value | Description | Stability | diff --git a/docs/database/mysql.md b/docs/database/mysql.md index 63f2a65692..2572b22097 100644 --- a/docs/database/mysql.md +++ b/docs/database/mysql.md @@ -145,6 +145,8 @@ and SHOULD be provided **at span creation time** (if provided at all): * [`server.address`](/docs/attributes-registry/server.md) * [`server.port`](/docs/attributes-registry/server.md) +### `error.type` Values + `error.type` has the following list of well-known values. If one of them applies, then the respective value MUST be used; otherwise, a custom value MAY be used. | Value | Description | Stability | diff --git a/docs/database/postgresql.md b/docs/database/postgresql.md index b4117a9616..b2be81023c 100644 --- a/docs/database/postgresql.md +++ b/docs/database/postgresql.md @@ -152,6 +152,8 @@ and SHOULD be provided **at span creation time** (if provided at all): * [`server.address`](/docs/attributes-registry/server.md) * [`server.port`](/docs/attributes-registry/server.md) +### `error.type` Values + `error.type` has the following list of well-known values. If one of them applies, then the respective value MUST be used; otherwise, a custom value MAY be used. | Value | Description | Stability | diff --git a/docs/database/redis.md b/docs/database/redis.md index ac849ee48c..4acec2ac28 100644 --- a/docs/database/redis.md +++ b/docs/database/redis.md @@ -98,6 +98,8 @@ and SHOULD be provided **at span creation time** (if provided at all): * [`server.address`](/docs/attributes-registry/server.md) * [`server.port`](/docs/attributes-registry/server.md) +### `error.type` Values + `error.type` has the following list of well-known values. If one of them applies, then the respective value MUST be used; otherwise, a custom value MAY be used. | Value | Description | Stability | diff --git a/docs/database/sql.md b/docs/database/sql.md index ff4f78af70..66e9ce51d4 100644 --- a/docs/database/sql.md +++ b/docs/database/sql.md @@ -176,6 +176,8 @@ and SHOULD be provided **at span creation time** (if provided at all): * [`server.address`](/docs/attributes-registry/server.md) * [`server.port`](/docs/attributes-registry/server.md) +### `error.type` Values + `error.type` has the following list of well-known values. If one of them applies, then the respective value MUST be used; otherwise, a custom value MAY be used. | Value | Description | Stability | diff --git a/docs/dns/dns-metrics.md b/docs/dns/dns-metrics.md index ca0c7555e7..04fe4cba31 100644 --- a/docs/dns/dns-metrics.md +++ b/docs/dns/dns-metrics.md @@ -47,6 +47,8 @@ of `[ 0.005, 0.01, 0.025, 0.05, 0.075, 0.1, 0.25, 0.5, 0.75, 1, 2.5, 5, 7.5, 10 **[2]:** Instrumentations SHOULD use error code such as one of errors reported by `getaddrinfo`([Linux or other POSIX systems](https://man7.org/linux/man-pages/man3/getaddrinfo.3.html) / [Windows](https://learn.microsoft.com/windows/win32/api/ws2tcpip/nf-ws2tcpip-getaddrinfo)) or one reported by the runtime or client library. If error code is not available, the full name of exception type SHOULD be used. +### `error.type` Values + `error.type` has the following list of well-known values. If one of them applies, then the respective value MUST be used; otherwise, a custom value MAY be used. | Value | Description | Stability | diff --git a/docs/dotnet/dotnet-aspnetcore-metrics.md b/docs/dotnet/dotnet-aspnetcore-metrics.md index 8b7cfdcb1a..20d23f455b 100644 --- a/docs/dotnet/dotnet-aspnetcore-metrics.md +++ b/docs/dotnet/dotnet-aspnetcore-metrics.md @@ -54,6 +54,8 @@ All routing metrics are reported by the `Microsoft.AspNetCore.Routing` meter. **[1]:** MUST NOT be populated when this is not supported by the HTTP server framework as the route attribute should have low-cardinality and the URI path can NOT substitute it. SHOULD include the [application root](/docs/http/http-spans.md#http-server-definitions) if there is one. +### `aspnetcore.routing.match_status` Values + `aspnetcore.routing.match_status` has the following list of well-known values. If one of them applies, then the respective value MUST be used; otherwise, a custom value MAY be used. | Value | Description | Stability | @@ -113,6 +115,8 @@ it's RECOMMENDED to: **[2]:** if and only if the exception was handled by this handler. +### `aspnetcore.diagnostics.exception.result` Values + `aspnetcore.diagnostics.exception.result` has the following list of well-known values. If one of them applies, then the respective value MUST be used; otherwise, a custom value MAY be used. | Value | Description | Stability | @@ -122,6 +126,8 @@ it's RECOMMENDED to: | `skipped` | Exception handling was skipped because the response had started. | ![Stable](https://img.shields.io/badge/-stable-lightgreen) | | `unhandled` | Exception was not handled by the exception handling middleware. | ![Stable](https://img.shields.io/badge/-stable-lightgreen) | +### `error.type` Values + `error.type` has the following list of well-known values. If one of them applies, then the respective value MUST be used; otherwise, a custom value MAY be used. | Value | Description | Stability | @@ -245,6 +251,8 @@ of `[ 0.005, 0.01, 0.025, 0.05, 0.075, 0.1, 0.25, 0.5, 0.75, 1, 2.5, 5, 7.5, 10 **[1]:** if the matched endpoint for the request had a rate-limiting policy. +### `aspnetcore.rate_limiting.result` Values + `aspnetcore.rate_limiting.result` has the following list of well-known values. If one of them applies, then the respective value MUST be used; otherwise, a custom value MAY be used. | Value | Description | Stability | @@ -286,6 +294,8 @@ Meter name: `Microsoft.AspNetCore.RateLimiting`; Added in: ASP.NET Core 8.0 **[1]:** if the matched endpoint for the request had a rate-limiting policy. +### `aspnetcore.rate_limiting.result` Values + `aspnetcore.rate_limiting.result` has the following list of well-known values. If one of them applies, then the respective value MUST be used; otherwise, a custom value MAY be used. | Value | Description | Stability | diff --git a/docs/dotnet/dotnet-kestrel-metrics.md b/docs/dotnet/dotnet-kestrel-metrics.md index 73e454c421..04f0edc983 100644 --- a/docs/dotnet/dotnet-kestrel-metrics.md +++ b/docs/dotnet/dotnet-kestrel-metrics.md @@ -64,6 +64,8 @@ different processes could be listening on TCP port 12345 and UDP port 12345. **[4]:** When observed from the client side, and when communicating through an intermediary, `server.port` SHOULD represent the server port behind any intermediaries, for example proxies, if it's available. +### `network.transport` Values + `network.transport` has the following list of well-known values. If one of them applies, then the respective value MUST be used; otherwise, a custom value MAY be used. | Value | Description | Stability | @@ -74,6 +76,8 @@ different processes could be listening on TCP port 12345 and UDP port 12345. | `udp` | UDP | ![Stable](https://img.shields.io/badge/-stable-lightgreen) | | `unix` | Unix domain socket | ![Stable](https://img.shields.io/badge/-stable-lightgreen) | +### `network.type` Values + `network.type` has the following list of well-known values. If one of them applies, then the respective value MUST be used; otherwise, a custom value MAY be used. | Value | Description | Stability | @@ -134,12 +138,16 @@ different processes could be listening on TCP port 12345 and UDP port 12345. **[7]:** When observed from the client side, and when communicating through an intermediary, `server.port` SHOULD represent the server port behind any intermediaries, for example proxies, if it's available. +### `error.type` Values + `error.type` has the following list of well-known values. If one of them applies, then the respective value MUST be used; otherwise, a custom value MAY be used. | Value | Description | Stability | |---|---|---| | `_OTHER` | A fallback error value to be used when the instrumentation doesn't define a custom value. | ![Stable](https://img.shields.io/badge/-stable-lightgreen) | +### `network.transport` Values + `network.transport` has the following list of well-known values. If one of them applies, then the respective value MUST be used; otherwise, a custom value MAY be used. | Value | Description | Stability | @@ -150,6 +158,8 @@ different processes could be listening on TCP port 12345 and UDP port 12345. | `udp` | UDP | ![Stable](https://img.shields.io/badge/-stable-lightgreen) | | `unix` | Unix domain socket | ![Stable](https://img.shields.io/badge/-stable-lightgreen) | +### `network.type` Values + `network.type` has the following list of well-known values. If one of them applies, then the respective value MUST be used; otherwise, a custom value MAY be used. | Value | Description | Stability | @@ -197,6 +207,8 @@ different processes could be listening on TCP port 12345 and UDP port 12345. **[4]:** When observed from the client side, and when communicating through an intermediary, `server.port` SHOULD represent the server port behind any intermediaries, for example proxies, if it's available. +### `network.transport` Values + `network.transport` has the following list of well-known values. If one of them applies, then the respective value MUST be used; otherwise, a custom value MAY be used. | Value | Description | Stability | @@ -207,6 +219,8 @@ different processes could be listening on TCP port 12345 and UDP port 12345. | `udp` | UDP | ![Stable](https://img.shields.io/badge/-stable-lightgreen) | | `unix` | Unix domain socket | ![Stable](https://img.shields.io/badge/-stable-lightgreen) | +### `network.type` Values + `network.type` has the following list of well-known values. If one of them applies, then the respective value MUST be used; otherwise, a custom value MAY be used. | Value | Description | Stability | @@ -253,6 +267,8 @@ different processes could be listening on TCP port 12345 and UDP port 12345. **[4]:** When observed from the client side, and when communicating through an intermediary, `server.port` SHOULD represent the server port behind any intermediaries, for example proxies, if it's available. +### `network.transport` Values + `network.transport` has the following list of well-known values. If one of them applies, then the respective value MUST be used; otherwise, a custom value MAY be used. | Value | Description | Stability | @@ -263,6 +279,8 @@ different processes could be listening on TCP port 12345 and UDP port 12345. | `udp` | UDP | ![Stable](https://img.shields.io/badge/-stable-lightgreen) | | `unix` | Unix domain socket | ![Stable](https://img.shields.io/badge/-stable-lightgreen) | +### `network.type` Values + `network.type` has the following list of well-known values. If one of them applies, then the respective value MUST be used; otherwise, a custom value MAY be used. | Value | Description | Stability | @@ -315,6 +333,8 @@ different processes could be listening on TCP port 12345 and UDP port 12345. **[6]:** When observed from the client side, and when communicating through an intermediary, `server.port` SHOULD represent the server port behind any intermediaries, for example proxies, if it's available. +### `network.transport` Values + `network.transport` has the following list of well-known values. If one of them applies, then the respective value MUST be used; otherwise, a custom value MAY be used. | Value | Description | Stability | @@ -325,6 +345,8 @@ different processes could be listening on TCP port 12345 and UDP port 12345. | `udp` | UDP | ![Stable](https://img.shields.io/badge/-stable-lightgreen) | | `unix` | Unix domain socket | ![Stable](https://img.shields.io/badge/-stable-lightgreen) | +### `network.type` Values + `network.type` has the following list of well-known values. If one of them applies, then the respective value MUST be used; otherwise, a custom value MAY be used. | Value | Description | Stability | @@ -373,6 +395,8 @@ different processes could be listening on TCP port 12345 and UDP port 12345. **[4]:** When observed from the client side, and when communicating through an intermediary, `server.port` SHOULD represent the server port behind any intermediaries, for example proxies, if it's available. +### `network.transport` Values + `network.transport` has the following list of well-known values. If one of them applies, then the respective value MUST be used; otherwise, a custom value MAY be used. | Value | Description | Stability | @@ -383,6 +407,8 @@ different processes could be listening on TCP port 12345 and UDP port 12345. | `udp` | UDP | ![Stable](https://img.shields.io/badge/-stable-lightgreen) | | `unix` | Unix domain socket | ![Stable](https://img.shields.io/badge/-stable-lightgreen) | +### `network.type` Values + `network.type` has the following list of well-known values. If one of them applies, then the respective value MUST be used; otherwise, a custom value MAY be used. | Value | Description | Stability | @@ -437,12 +463,16 @@ different processes could be listening on TCP port 12345 and UDP port 12345. **[5]:** When observed from the client side, and when communicating through an intermediary, `server.port` SHOULD represent the server port behind any intermediaries, for example proxies, if it's available. +### `error.type` Values + `error.type` has the following list of well-known values. If one of them applies, then the respective value MUST be used; otherwise, a custom value MAY be used. | Value | Description | Stability | |---|---|---| | `_OTHER` | A fallback error value to be used when the instrumentation doesn't define a custom value. | ![Stable](https://img.shields.io/badge/-stable-lightgreen) | +### `network.transport` Values + `network.transport` has the following list of well-known values. If one of them applies, then the respective value MUST be used; otherwise, a custom value MAY be used. | Value | Description | Stability | @@ -453,6 +483,8 @@ different processes could be listening on TCP port 12345 and UDP port 12345. | `udp` | UDP | ![Stable](https://img.shields.io/badge/-stable-lightgreen) | | `unix` | Unix domain socket | ![Stable](https://img.shields.io/badge/-stable-lightgreen) | +### `network.type` Values + `network.type` has the following list of well-known values. If one of them applies, then the respective value MUST be used; otherwise, a custom value MAY be used. | Value | Description | Stability | @@ -499,6 +531,8 @@ different processes could be listening on TCP port 12345 and UDP port 12345. **[4]:** When observed from the client side, and when communicating through an intermediary, `server.port` SHOULD represent the server port behind any intermediaries, for example proxies, if it's available. +### `network.transport` Values + `network.transport` has the following list of well-known values. If one of them applies, then the respective value MUST be used; otherwise, a custom value MAY be used. | Value | Description | Stability | @@ -509,6 +543,8 @@ different processes could be listening on TCP port 12345 and UDP port 12345. | `udp` | UDP | ![Stable](https://img.shields.io/badge/-stable-lightgreen) | | `unix` | Unix domain socket | ![Stable](https://img.shields.io/badge/-stable-lightgreen) | +### `network.type` Values + `network.type` has the following list of well-known values. If one of them applies, then the respective value MUST be used; otherwise, a custom value MAY be used. | Value | Description | Stability | diff --git a/docs/dotnet/dotnet-signalr-metrics.md b/docs/dotnet/dotnet-signalr-metrics.md index d398ef6780..be57027eac 100644 --- a/docs/dotnet/dotnet-signalr-metrics.md +++ b/docs/dotnet/dotnet-signalr-metrics.md @@ -39,6 +39,8 @@ of `[ 0.01, 0.02, 0.05, 0.1, 0.2, 0.5, 1, 2, 5, 10, 30, 60, 120, 300 ]`. | [`signalr.connection.status`](/docs/attributes-registry/signalr.md) | string | SignalR HTTP connection closure status. | `app_shutdown`; `timeout` | `Recommended` | ![Stable](https://img.shields.io/badge/-stable-lightgreen) | | [`signalr.transport`](/docs/attributes-registry/signalr.md) | string | [SignalR transport type](https://github.com/dotnet/aspnetcore/blob/main/src/SignalR/docs/specs/TransportProtocols.md) | `web_sockets`; `long_polling` | `Recommended` | ![Stable](https://img.shields.io/badge/-stable-lightgreen) | +### `signalr.connection.status` Values + `signalr.connection.status` has the following list of well-known values. If one of them applies, then the respective value MUST be used; otherwise, a custom value MAY be used. | Value | Description | Stability | @@ -47,6 +49,8 @@ of `[ 0.01, 0.02, 0.05, 0.1, 0.2, 0.5, 1, 2, 5, 10, 30, 60, 120, 300 ]`. | `normal_closure` | The connection was closed normally. | ![Stable](https://img.shields.io/badge/-stable-lightgreen) | | `timeout` | The connection was closed due to a timeout. | ![Stable](https://img.shields.io/badge/-stable-lightgreen) | +### `signalr.transport` Values + `signalr.transport` has the following list of well-known values. If one of them applies, then the respective value MUST be used; otherwise, a custom value MAY be used. | Value | Description | Stability | @@ -80,6 +84,8 @@ of `[ 0.01, 0.02, 0.05, 0.1, 0.2, 0.5, 1, 2, 5, 10, 30, 60, 120, 300 ]`. | [`signalr.connection.status`](/docs/attributes-registry/signalr.md) | string | SignalR HTTP connection closure status. | `app_shutdown`; `timeout` | `Recommended` | ![Stable](https://img.shields.io/badge/-stable-lightgreen) | | [`signalr.transport`](/docs/attributes-registry/signalr.md) | string | [SignalR transport type](https://github.com/dotnet/aspnetcore/blob/main/src/SignalR/docs/specs/TransportProtocols.md) | `web_sockets`; `long_polling` | `Recommended` | ![Stable](https://img.shields.io/badge/-stable-lightgreen) | +### `signalr.connection.status` Values + `signalr.connection.status` has the following list of well-known values. If one of them applies, then the respective value MUST be used; otherwise, a custom value MAY be used. | Value | Description | Stability | @@ -88,6 +94,8 @@ of `[ 0.01, 0.02, 0.05, 0.1, 0.2, 0.5, 1, 2, 5, 10, 30, 60, 120, 300 ]`. | `normal_closure` | The connection was closed normally. | ![Stable](https://img.shields.io/badge/-stable-lightgreen) | | `timeout` | The connection was closed due to a timeout. | ![Stable](https://img.shields.io/badge/-stable-lightgreen) | +### `signalr.transport` Values + `signalr.transport` has the following list of well-known values. If one of them applies, then the respective value MUST be used; otherwise, a custom value MAY be used. | Value | Description | Stability | diff --git a/docs/faas/faas-metrics.md b/docs/faas/faas-metrics.md index d6dbb135c9..cbaed087ed 100644 --- a/docs/faas/faas-metrics.md +++ b/docs/faas/faas-metrics.md @@ -64,6 +64,8 @@ of `[ 0.005, 0.01, 0.025, 0.05, 0.075, 0.1, 0.25, 0.5, 0.75, 1, 2.5, 5, 7.5, 10 |---|---|---|---|---|---| | [`faas.trigger`](/docs/attributes-registry/faas.md) | string | Type of the trigger which caused this function invocation. | `datasource`; `http`; `pubsub` | `Recommended` | ![Experimental](https://img.shields.io/badge/-experimental-blue) | +### `faas.trigger` Values + `faas.trigger` has the following list of well-known values. If one of them applies, then the respective value MUST be used; otherwise, a custom value MAY be used. | Value | Description | Stability | @@ -102,6 +104,8 @@ of `[ 0.005, 0.01, 0.025, 0.05, 0.075, 0.1, 0.25, 0.5, 0.75, 1, 2.5, 5, 7.5, 10 |---|---|---|---|---|---| | [`faas.trigger`](/docs/attributes-registry/faas.md) | string | Type of the trigger which caused this function invocation. | `datasource`; `http`; `pubsub` | `Recommended` | ![Experimental](https://img.shields.io/badge/-experimental-blue) | +### `faas.trigger` Values + `faas.trigger` has the following list of well-known values. If one of them applies, then the respective value MUST be used; otherwise, a custom value MAY be used. | Value | Description | Stability | @@ -136,6 +140,8 @@ This metric is [recommended][MetricRecommended]. |---|---|---|---|---|---| | [`faas.trigger`](/docs/attributes-registry/faas.md) | string | Type of the trigger which caused this function invocation. | `datasource`; `http`; `pubsub` | `Recommended` | ![Experimental](https://img.shields.io/badge/-experimental-blue) | +### `faas.trigger` Values + `faas.trigger` has the following list of well-known values. If one of them applies, then the respective value MUST be used; otherwise, a custom value MAY be used. | Value | Description | Stability | @@ -170,6 +176,8 @@ This metric is [recommended][MetricRecommended]. |---|---|---|---|---|---| | [`faas.trigger`](/docs/attributes-registry/faas.md) | string | Type of the trigger which caused this function invocation. | `datasource`; `http`; `pubsub` | `Recommended` | ![Experimental](https://img.shields.io/badge/-experimental-blue) | +### `faas.trigger` Values + `faas.trigger` has the following list of well-known values. If one of them applies, then the respective value MUST be used; otherwise, a custom value MAY be used. | Value | Description | Stability | @@ -204,6 +212,8 @@ This metric is [recommended][MetricRecommended]. |---|---|---|---|---|---| | [`faas.trigger`](/docs/attributes-registry/faas.md) | string | Type of the trigger which caused this function invocation. | `datasource`; `http`; `pubsub` | `Recommended` | ![Experimental](https://img.shields.io/badge/-experimental-blue) | +### `faas.trigger` Values + `faas.trigger` has the following list of well-known values. If one of them applies, then the respective value MUST be used; otherwise, a custom value MAY be used. | Value | Description | Stability | @@ -238,6 +248,8 @@ This metric is [recommended][MetricRecommended]. |---|---|---|---|---|---| | [`faas.trigger`](/docs/attributes-registry/faas.md) | string | Type of the trigger which caused this function invocation. | `datasource`; `http`; `pubsub` | `Recommended` | ![Experimental](https://img.shields.io/badge/-experimental-blue) | +### `faas.trigger` Values + `faas.trigger` has the following list of well-known values. If one of them applies, then the respective value MUST be used; otherwise, a custom value MAY be used. | Value | Description | Stability | @@ -272,6 +284,8 @@ This metric is [recommended][MetricRecommended]. |---|---|---|---|---|---| | [`faas.trigger`](/docs/attributes-registry/faas.md) | string | Type of the trigger which caused this function invocation. | `datasource`; `http`; `pubsub` | `Recommended` | ![Experimental](https://img.shields.io/badge/-experimental-blue) | +### `faas.trigger` Values + `faas.trigger` has the following list of well-known values. If one of them applies, then the respective value MUST be used; otherwise, a custom value MAY be used. | Value | Description | Stability | @@ -310,6 +324,8 @@ of `[ 0.005, 0.01, 0.025, 0.05, 0.075, 0.1, 0.25, 0.5, 0.75, 1, 2.5, 5, 7.5, 10 |---|---|---|---|---|---| | [`faas.trigger`](/docs/attributes-registry/faas.md) | string | Type of the trigger which caused this function invocation. | `datasource`; `http`; `pubsub` | `Recommended` | ![Experimental](https://img.shields.io/badge/-experimental-blue) | +### `faas.trigger` Values + `faas.trigger` has the following list of well-known values. If one of them applies, then the respective value MUST be used; otherwise, a custom value MAY be used. | Value | Description | Stability | @@ -344,6 +360,8 @@ This metric is [recommended][MetricRecommended]. |---|---|---|---|---|---| | [`faas.trigger`](/docs/attributes-registry/faas.md) | string | Type of the trigger which caused this function invocation. | `datasource`; `http`; `pubsub` | `Recommended` | ![Experimental](https://img.shields.io/badge/-experimental-blue) | +### `faas.trigger` Values + `faas.trigger` has the following list of well-known values. If one of them applies, then the respective value MUST be used; otherwise, a custom value MAY be used. | Value | Description | Stability | diff --git a/docs/faas/faas-spans.md b/docs/faas/faas-spans.md index 764eadaa81..02a0764ead 100644 --- a/docs/faas/faas-spans.md +++ b/docs/faas/faas-spans.md @@ -79,6 +79,8 @@ trigger that corresponding incoming would have (i.e., this has nothing to do with the underlying transport used to make the API call to invoke the lambda, which is often HTTP). +### `faas.trigger` Values + `faas.trigger` has the following list of well-known values. If one of them applies, then the respective value MUST be used; otherwise, a custom value MAY be used. | Value | Description | Stability | @@ -151,6 +153,8 @@ trigger that corresponding incoming would have (i.e., this has nothing to do with the underlying transport used to make the API call to invoke the lambda, which is often HTTP). +### `faas.trigger` Values + `faas.trigger` has the following list of well-known values. If one of them applies, then the respective value MUST be used; otherwise, a custom value MAY be used. | Value | Description | Stability | @@ -209,6 +213,8 @@ which the invoked FaaS instance reports about itself, if it's instrumented. **[4]:** For some cloud providers, like AWS or GCP, the region in which a function is hosted is essential to uniquely identify the function and also part of its endpoint. Since it's part of the endpoint being called, the region is always known to clients. In these cases, `faas.invoked_region` MUST be set accordingly. If the region is unknown to the client or not required for identifying the invoked function, setting `faas.invoked_region` is optional. +### `faas.invoked_provider` Values + `faas.invoked_provider` has the following list of well-known values. If one of them applies, then the respective value MUST be used; otherwise, a custom value MAY be used. | Value | Description | Stability | @@ -250,6 +256,8 @@ FaaS instrumentations that produce `faas` spans with trigger `datasource`, SHOUL | [`faas.document.name`](/docs/attributes-registry/faas.md) | string | The document name/table subjected to the operation. For example, in Cloud Storage or S3 is the name of the file, and in Cosmos DB the table name. | `myFile.txt`; `myTableName` | `Recommended` | ![Experimental](https://img.shields.io/badge/-experimental-blue) | | [`faas.document.time`](/docs/attributes-registry/faas.md) | string | A string containing the time when the data was accessed in the [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format expressed in [UTC](https://www.w3.org/TR/NOTE-datetime). | `2020-01-23T13:47:06Z` | `Recommended` | ![Experimental](https://img.shields.io/badge/-experimental-blue) | +### `faas.document.operation` Values + `faas.document.operation` has the following list of well-known values. If one of them applies, then the respective value MUST be used; otherwise, a custom value MAY be used. | Value | Description | Stability | diff --git a/docs/gen-ai/azure-ai-inference.md b/docs/gen-ai/azure-ai-inference.md index 7275e19c67..becd2422d4 100644 --- a/docs/gen-ai/azure-ai-inference.md +++ b/docs/gen-ai/azure-ai-inference.md @@ -57,12 +57,16 @@ Instrumentations SHOULD document the list of errors they report. **[7]:** When observed from the client side, and when communicating through an intermediary, `server.address` SHOULD represent the server address behind any intermediaries, for example proxies, if it's available. +### `error.type` Values + `error.type` has the following list of well-known values. If one of them applies, then the respective value MUST be used; otherwise, a custom value MAY be used. | Value | Description | Stability | |---|---|---| | `_OTHER` | A fallback error value to be used when the instrumentation doesn't define a custom value. | ![Stable](https://img.shields.io/badge/-stable-lightgreen) | +### `gen_ai.operation.name` Values + `gen_ai.operation.name` has the following list of well-known values. If one of them applies, then the respective value MUST be used; otherwise, a custom value MAY be used. | Value | Description | Stability | diff --git a/docs/gen-ai/gen-ai-events.md b/docs/gen-ai/gen-ai-events.md index 44eeadc31d..37dd15f8e5 100644 --- a/docs/gen-ai/gen-ai-events.md +++ b/docs/gen-ai/gen-ai-events.md @@ -75,6 +75,8 @@ is set to `openai` based on the instrumentation's best knowledge. For custom model, a custom friendly name SHOULD be used. If none of these options apply, the `gen_ai.system` SHOULD be set to `_OTHER`. +### `gen_ai.system` Values + `gen_ai.system` has the following list of well-known values. If one of them applies, then the respective value MUST be used; otherwise, a custom value MAY be used. | Value | Description | Stability | diff --git a/docs/gen-ai/gen-ai-metrics.md b/docs/gen-ai/gen-ai-metrics.md index c8cba89124..0981a02221 100644 --- a/docs/gen-ai/gen-ai-metrics.md +++ b/docs/gen-ai/gen-ai-metrics.md @@ -85,6 +85,8 @@ If none of these options apply, the `gen_ai.system` SHOULD be set to `_OTHER`. **[4]:** When observed from the client side, and when communicating through an intermediary, `server.address` SHOULD represent the server address behind any intermediaries, for example proxies, if it's available. +### `gen_ai.operation.name` Values + `gen_ai.operation.name` has the following list of well-known values. If one of them applies, then the respective value MUST be used; otherwise, a custom value MAY be used. | Value | Description | Stability | @@ -92,6 +94,8 @@ If none of these options apply, the `gen_ai.system` SHOULD be set to `_OTHER`. | `chat` | Chat completion operation such as [OpenAI Chat API](https://platform.openai.com/docs/api-reference/chat) | ![Experimental](https://img.shields.io/badge/-experimental-blue) | | `text_completion` | Text completions operation such as [OpenAI Completions API (Legacy)](https://platform.openai.com/docs/api-reference/completions) | ![Experimental](https://img.shields.io/badge/-experimental-blue) | +### `gen_ai.system` Values + `gen_ai.system` has the following list of well-known values. If one of them applies, then the respective value MUST be used; otherwise, a custom value MAY be used. | Value | Description | Stability | @@ -102,6 +106,8 @@ If none of these options apply, the `gen_ai.system` SHOULD be set to `_OTHER`. | `openai` | OpenAI | ![Experimental](https://img.shields.io/badge/-experimental-blue) | | `vertex_ai` | Vertex AI | ![Experimental](https://img.shields.io/badge/-experimental-blue) | +### `gen_ai.token.type` Values + `gen_ai.token.type` has the following list of well-known values. If one of them applies, then the respective value MUST be used; otherwise, a custom value MAY be used. | Value | Description | Stability | @@ -161,12 +167,16 @@ Instrumentations SHOULD document the list of errors they report. **[5]:** When observed from the client side, and when communicating through an intermediary, `server.address` SHOULD represent the server address behind any intermediaries, for example proxies, if it's available. +### `error.type` Values + `error.type` has the following list of well-known values. If one of them applies, then the respective value MUST be used; otherwise, a custom value MAY be used. | Value | Description | Stability | |---|---|---| | `_OTHER` | A fallback error value to be used when the instrumentation doesn't define a custom value. | ![Stable](https://img.shields.io/badge/-stable-lightgreen) | +### `gen_ai.operation.name` Values + `gen_ai.operation.name` has the following list of well-known values. If one of them applies, then the respective value MUST be used; otherwise, a custom value MAY be used. | Value | Description | Stability | @@ -174,6 +184,8 @@ Instrumentations SHOULD document the list of errors they report. | `chat` | Chat completion operation such as [OpenAI Chat API](https://platform.openai.com/docs/api-reference/chat) | ![Experimental](https://img.shields.io/badge/-experimental-blue) | | `text_completion` | Text completions operation such as [OpenAI Completions API (Legacy)](https://platform.openai.com/docs/api-reference/completions) | ![Experimental](https://img.shields.io/badge/-experimental-blue) | +### `gen_ai.system` Values + `gen_ai.system` has the following list of well-known values. If one of them applies, then the respective value MUST be used; otherwise, a custom value MAY be used. | Value | Description | Stability | @@ -243,12 +255,16 @@ Instrumentations SHOULD document the list of errors they report. **[5]:** When observed from the client side, and when communicating through an intermediary, `server.address` SHOULD represent the server address behind any intermediaries, for example proxies, if it's available. +### `error.type` Values + `error.type` has the following list of well-known values. If one of them applies, then the respective value MUST be used; otherwise, a custom value MAY be used. | Value | Description | Stability | |---|---|---| | `_OTHER` | A fallback error value to be used when the instrumentation doesn't define a custom value. | ![Stable](https://img.shields.io/badge/-stable-lightgreen) | +### `gen_ai.operation.name` Values + `gen_ai.operation.name` has the following list of well-known values. If one of them applies, then the respective value MUST be used; otherwise, a custom value MAY be used. | Value | Description | Stability | @@ -256,6 +272,8 @@ Instrumentations SHOULD document the list of errors they report. | `chat` | Chat completion operation such as [OpenAI Chat API](https://platform.openai.com/docs/api-reference/chat) | ![Experimental](https://img.shields.io/badge/-experimental-blue) | | `text_completion` | Text completions operation such as [OpenAI Completions API (Legacy)](https://platform.openai.com/docs/api-reference/completions) | ![Experimental](https://img.shields.io/badge/-experimental-blue) | +### `gen_ai.system` Values + `gen_ai.system` has the following list of well-known values. If one of them applies, then the respective value MUST be used; otherwise, a custom value MAY be used. | Value | Description | Stability | @@ -320,6 +338,8 @@ If none of these options apply, the `gen_ai.system` SHOULD be set to `_OTHER`. **[4]:** When observed from the client side, and when communicating through an intermediary, `server.address` SHOULD represent the server address behind any intermediaries, for example proxies, if it's available. +### `gen_ai.operation.name` Values + `gen_ai.operation.name` has the following list of well-known values. If one of them applies, then the respective value MUST be used; otherwise, a custom value MAY be used. | Value | Description | Stability | @@ -327,6 +347,8 @@ If none of these options apply, the `gen_ai.system` SHOULD be set to `_OTHER`. | `chat` | Chat completion operation such as [OpenAI Chat API](https://platform.openai.com/docs/api-reference/chat) | ![Experimental](https://img.shields.io/badge/-experimental-blue) | | `text_completion` | Text completions operation such as [OpenAI Completions API (Legacy)](https://platform.openai.com/docs/api-reference/completions) | ![Experimental](https://img.shields.io/badge/-experimental-blue) | +### `gen_ai.system` Values + `gen_ai.system` has the following list of well-known values. If one of them applies, then the respective value MUST be used; otherwise, a custom value MAY be used. | Value | Description | Stability | @@ -390,6 +412,8 @@ If none of these options apply, the `gen_ai.system` SHOULD be set to `_OTHER`. **[4]:** When observed from the client side, and when communicating through an intermediary, `server.address` SHOULD represent the server address behind any intermediaries, for example proxies, if it's available. +### `gen_ai.operation.name` Values + `gen_ai.operation.name` has the following list of well-known values. If one of them applies, then the respective value MUST be used; otherwise, a custom value MAY be used. | Value | Description | Stability | @@ -397,6 +421,8 @@ If none of these options apply, the `gen_ai.system` SHOULD be set to `_OTHER`. | `chat` | Chat completion operation such as [OpenAI Chat API](https://platform.openai.com/docs/api-reference/chat) | ![Experimental](https://img.shields.io/badge/-experimental-blue) | | `text_completion` | Text completions operation such as [OpenAI Completions API (Legacy)](https://platform.openai.com/docs/api-reference/completions) | ![Experimental](https://img.shields.io/badge/-experimental-blue) | +### `gen_ai.system` Values + `gen_ai.system` has the following list of well-known values. If one of them applies, then the respective value MUST be used; otherwise, a custom value MAY be used. | Value | Description | Stability | diff --git a/docs/gen-ai/gen-ai-spans.md b/docs/gen-ai/gen-ai-spans.md index 4bea84e4d5..54e439407d 100644 --- a/docs/gen-ai/gen-ai-spans.md +++ b/docs/gen-ai/gen-ai-spans.md @@ -86,12 +86,16 @@ Instrumentations SHOULD document the list of errors they report. **[7]:** When observed from the client side, and when communicating through an intermediary, `server.address` SHOULD represent the server address behind any intermediaries, for example proxies, if it's available. +### `error.type` Values + `error.type` has the following list of well-known values. If one of them applies, then the respective value MUST be used; otherwise, a custom value MAY be used. | Value | Description | Stability | |---|---|---| | `_OTHER` | A fallback error value to be used when the instrumentation doesn't define a custom value. | ![Stable](https://img.shields.io/badge/-stable-lightgreen) | +### `gen_ai.operation.name` Values + `gen_ai.operation.name` has the following list of well-known values. If one of them applies, then the respective value MUST be used; otherwise, a custom value MAY be used. | Value | Description | Stability | @@ -99,6 +103,8 @@ Instrumentations SHOULD document the list of errors they report. | `chat` | Chat completion operation such as [OpenAI Chat API](https://platform.openai.com/docs/api-reference/chat) | ![Experimental](https://img.shields.io/badge/-experimental-blue) | | `text_completion` | Text completions operation such as [OpenAI Completions API (Legacy)](https://platform.openai.com/docs/api-reference/completions) | ![Experimental](https://img.shields.io/badge/-experimental-blue) | +### `gen_ai.system` Values + `gen_ai.system` has the following list of well-known values. If one of them applies, then the respective value MUST be used; otherwise, a custom value MAY be used. | Value | Description | Stability | diff --git a/docs/gen-ai/openai.md b/docs/gen-ai/openai.md index 7d77082b70..5d74e5970d 100644 --- a/docs/gen-ai/openai.md +++ b/docs/gen-ai/openai.md @@ -76,12 +76,16 @@ Instrumentations SHOULD document the list of errors they report. **[8]:** When observed from the client side, and when communicating through an intermediary, `server.address` SHOULD represent the server address behind any intermediaries, for example proxies, if it's available. +### `error.type` Values + `error.type` has the following list of well-known values. If one of them applies, then the respective value MUST be used; otherwise, a custom value MAY be used. | Value | Description | Stability | |---|---|---| | `_OTHER` | A fallback error value to be used when the instrumentation doesn't define a custom value. | ![Stable](https://img.shields.io/badge/-stable-lightgreen) | +### `gen_ai.openai.request.response_format` Values + `gen_ai.openai.request.response_format` has the following list of well-known values. If one of them applies, then the respective value MUST be used; otherwise, a custom value MAY be used. | Value | Description | Stability | @@ -90,6 +94,8 @@ Instrumentations SHOULD document the list of errors they report. | `json_schema` | JSON schema response format | ![Experimental](https://img.shields.io/badge/-experimental-blue) | | `text` | Text response format | ![Experimental](https://img.shields.io/badge/-experimental-blue) | +### `gen_ai.openai.request.service_tier` Values + `gen_ai.openai.request.service_tier` has the following list of well-known values. If one of them applies, then the respective value MUST be used; otherwise, a custom value MAY be used. | Value | Description | Stability | @@ -97,6 +103,8 @@ Instrumentations SHOULD document the list of errors they report. | `auto` | The system will utilize scale tier credits until they are exhausted. | ![Experimental](https://img.shields.io/badge/-experimental-blue) | | `default` | The system will utilize the default scale tier. | ![Experimental](https://img.shields.io/badge/-experimental-blue) | +### `gen_ai.operation.name` Values + `gen_ai.operation.name` has the following list of well-known values. If one of them applies, then the respective value MUST be used; otherwise, a custom value MAY be used. | Value | Description | Stability | diff --git a/docs/general/attributes.md b/docs/general/attributes.md index 118dffed70..2689e463e8 100644 --- a/docs/general/attributes.md +++ b/docs/general/attributes.md @@ -226,6 +226,8 @@ different processes could be listening on TCP port 12345 and UDP port 12345. **[4]:** The value SHOULD be normalized to lowercase. +### `network.transport` Values + `network.transport` has the following list of well-known values. If one of them applies, then the respective value MUST be used; otherwise, a custom value MAY be used. | Value | Description | Stability | @@ -236,6 +238,8 @@ different processes could be listening on TCP port 12345 and UDP port 12345. | `udp` | UDP | ![Stable](https://img.shields.io/badge/-stable-lightgreen) | | `unix` | Unix domain socket | ![Stable](https://img.shields.io/badge/-stable-lightgreen) | +### `network.type` Values + `network.type` has the following list of well-known values. If one of them applies, then the respective value MUST be used; otherwise, a custom value MAY be used. | Value | Description | Stability | @@ -305,6 +309,8 @@ Note that `network.local.*` attributes are not included in these examples since | [`network.connection.subtype`](/docs/attributes-registry/network.md) | string | This describes more details regarding the connection.type. It may be the type of cell technology connection, but it could be used for describing details about a wifi connection. | `LTE` | `Recommended` | ![Experimental](https://img.shields.io/badge/-experimental-blue) | | [`network.connection.type`](/docs/attributes-registry/network.md) | string | The internet connection type. | `wifi` | `Recommended` | ![Experimental](https://img.shields.io/badge/-experimental-blue) | +### `network.connection.subtype` Values + `network.connection.subtype` has the following list of well-known values. If one of them applies, then the respective value MUST be used; otherwise, a custom value MAY be used. | Value | Description | Stability | @@ -331,6 +337,8 @@ Note that `network.local.*` attributes are not included in these examples since | `td_scdma` | TD-SCDMA | ![Experimental](https://img.shields.io/badge/-experimental-blue) | | `umts` | UMTS | ![Experimental](https://img.shields.io/badge/-experimental-blue) | +### `network.connection.type` Values + `network.connection.type` has the following list of well-known values. If one of them applies, then the respective value MUST be used; otherwise, a custom value MAY be used. | Value | Description | Stability | diff --git a/docs/general/logs.md b/docs/general/logs.md index 4f3f8e9af8..7a9ca9dc36 100644 --- a/docs/general/logs.md +++ b/docs/general/logs.md @@ -103,6 +103,8 @@ As such, these should be recorded as Log Record attributes when applicable. They |---|---|---|---|---|---| | [`log.iostream`](/docs/attributes-registry/log.md) | string | The stream associated with the log. See below for a list of well-known values. | `stdout`; `stderr` | `Opt-In` | ![Experimental](https://img.shields.io/badge/-experimental-blue) | +### `log.iostream` Values + `log.iostream` has the following list of well-known values. If one of them applies, then the respective value MUST be used; otherwise, a custom value MAY be used. | Value | Description | Stability | diff --git a/docs/general/profiles.md b/docs/general/profiles.md index 5a6c0f3666..3524eba4e4 100644 --- a/docs/general/profiles.md +++ b/docs/general/profiles.md @@ -30,6 +30,8 @@ They may be used in any Profiles record they apply to. |---|---|---|---|---|---| | [`profile.frame.type`](/docs/attributes-registry/profile.md) | string | Describes the interpreter or compiler of a single frame. | `cpython` | `Recommended` | ![Experimental](https://img.shields.io/badge/-experimental-blue) | +### `profile.frame.type` Values + `profile.frame.type` has the following list of well-known values. If one of them applies, then the respective value MUST be used; otherwise, a custom value MAY be used. | Value | Description | Stability | diff --git a/docs/general/trace-compatibility.md b/docs/general/trace-compatibility.md index c3a22cf2e3..d47ecad523 100644 --- a/docs/general/trace-compatibility.md +++ b/docs/general/trace-compatibility.md @@ -37,6 +37,8 @@ between a child Span and a parent Span, as defined by **[1]:** The causal relationship between a child Span and a parent Span. +### `opentracing.ref_type` Values + `opentracing.ref_type` has the following list of well-known values. If one of them applies, then the respective value MUST be used; otherwise, a custom value MAY be used. | Value | Description | Stability | diff --git a/docs/graphql/graphql-spans.md b/docs/graphql/graphql-spans.md index 6eee813b07..fdf34c4ac4 100644 --- a/docs/graphql/graphql-spans.md +++ b/docs/graphql/graphql-spans.md @@ -37,6 +37,8 @@ the span SHOULD be named `GraphQL Operation`. **[1]:** The value may be sanitized to exclude sensitive information. +### `graphql.operation.type` Values + `graphql.operation.type` has the following list of well-known values. If one of them applies, then the respective value MUST be used; otherwise, a custom value MAY be used. | Value | Description | Stability | diff --git a/docs/hardware/common.md b/docs/hardware/common.md index e8b924af71..2b8821b2ea 100644 --- a/docs/hardware/common.md +++ b/docs/hardware/common.md @@ -42,6 +42,8 @@ monitored component: **[1]:** Describes the category of the hardware component for which `hw.state` is being reported. For example, `hw.type=temperature` along with `hw.state=degraded` would indicate that the temperature of the hardware component has been reported as `degraded`. +### `hw.type` Values + `hw.type` has the following list of well-known values. If one of them applies, then the respective value MUST be used; otherwise, a custom value MAY be used. | Value | Description | Stability | @@ -90,6 +92,8 @@ This metric is [recommended][MetricRecommended]. **[1]:** Describes the category of the hardware component for which `hw.state` is being reported. For example, `hw.type=temperature` along with `hw.state=degraded` would indicate that the temperature of the hardware component has been reported as `degraded`. +### `hw.type` Values + `hw.type` has the following list of well-known values. If one of them applies, then the respective value MUST be used; otherwise, a custom value MAY be used. | Value | Description | Stability | @@ -141,12 +145,16 @@ This metric is [recommended][MetricRecommended]. **[2]:** The `error.type` SHOULD match the error code reported by the component, the canonical name of the error, or another low-cardinality error identifier. Instrumentations SHOULD document the list of errors they report. +### `error.type` Values + `error.type` has the following list of well-known values. If one of them applies, then the respective value MUST be used; otherwise, a custom value MAY be used. | Value | Description | Stability | |---|---|---| | `_OTHER` | A fallback error value to be used when the instrumentation doesn't define a custom value. | ![Stable](https://img.shields.io/badge/-stable-lightgreen) | +### `hw.type` Values + `hw.type` has the following list of well-known values. If one of them applies, then the respective value MUST be used; otherwise, a custom value MAY be used. | Value | Description | Stability | @@ -197,6 +205,8 @@ This metric is [recommended][MetricRecommended]. **[1]:** Describes the category of the hardware component for which `hw.state` is being reported. For example, `hw.type=temperature` along with `hw.state=degraded` would indicate that the temperature of the hardware component has been reported as `degraded`. +### `hw.type` Values + `hw.type` has the following list of well-known values. If one of them applies, then the respective value MUST be used; otherwise, a custom value MAY be used. | Value | Description | Stability | @@ -248,6 +258,8 @@ This metric is [recommended][MetricRecommended]. **[1]:** Describes the category of the hardware component for which `hw.state` is being reported. For example, `hw.type=temperature` along with `hw.state=degraded` would indicate that the temperature of the hardware component has been reported as `degraded`. +### `hw.state` Values + `hw.state` has the following list of well-known values. If one of them applies, then the respective value MUST be used; otherwise, a custom value MAY be used. | Value | Description | Stability | @@ -256,6 +268,8 @@ This metric is [recommended][MetricRecommended]. | `failed` | Failed | ![Experimental](https://img.shields.io/badge/-experimental-blue) | | `ok` | Ok | ![Experimental](https://img.shields.io/badge/-experimental-blue) | +### `hw.type` Values + `hw.type` has the following list of well-known values. If one of them applies, then the respective value MUST be used; otherwise, a custom value MAY be used. | Value | Description | Stability | diff --git a/docs/http/http-metrics.md b/docs/http/http-metrics.md index 94f4683f73..a008168525 100644 --- a/docs/http/http-metrics.md +++ b/docs/http/http-metrics.md @@ -143,12 +143,16 @@ SHOULD include the [application root](/docs/http/http-spans.md#http-server-defin > Since this attribute is based on HTTP headers, opting in to it may allow an attacker > to trigger cardinality limits, degrading the usefulness of the metric. +### `error.type` Values + `error.type` has the following list of well-known values. If one of them applies, then the respective value MUST be used; otherwise, a custom value MAY be used. | Value | Description | Stability | |---|---|---| | `_OTHER` | A fallback error value to be used when the instrumentation doesn't define a custom value. | ![Stable](https://img.shields.io/badge/-stable-lightgreen) | +### `http.request.method` Values + `http.request.method` has the following list of well-known values. If one of them applies, then the respective value MUST be used; otherwise, a custom value MAY be used. | Value | Description | Stability | @@ -216,6 +220,8 @@ Tracing instrumentations that do so, MUST also set `http.request.method_original > Since this attribute is based on HTTP headers, opting in to it may allow an attacker > to trigger cardinality limits, degrading the usefulness of the metric. +### `http.request.method` Values + `http.request.method` has the following list of well-known values. If one of them applies, then the respective value MUST be used; otherwise, a custom value MAY be used. | Value | Description | Stability | @@ -318,12 +324,16 @@ SHOULD include the [application root](/docs/http/http-spans.md#http-server-defin > Since this attribute is based on HTTP headers, opting in to it may allow an attacker > to trigger cardinality limits, degrading the usefulness of the metric. +### `error.type` Values + `error.type` has the following list of well-known values. If one of them applies, then the respective value MUST be used; otherwise, a custom value MAY be used. | Value | Description | Stability | |---|---|---| | `_OTHER` | A fallback error value to be used when the instrumentation doesn't define a custom value. | ![Stable](https://img.shields.io/badge/-stable-lightgreen) | +### `http.request.method` Values + `http.request.method` has the following list of well-known values. If one of them applies, then the respective value MUST be used; otherwise, a custom value MAY be used. | Value | Description | Stability | @@ -426,12 +436,16 @@ SHOULD include the [application root](/docs/http/http-spans.md#http-server-defin > Since this attribute is based on HTTP headers, opting in to it may allow an attacker > to trigger cardinality limits, degrading the usefulness of the metric. +### `error.type` Values + `error.type` has the following list of well-known values. If one of them applies, then the respective value MUST be used; otherwise, a custom value MAY be used. | Value | Description | Stability | |---|---|---| | `_OTHER` | A fallback error value to be used when the instrumentation doesn't define a custom value. | ![Stable](https://img.shields.io/badge/-stable-lightgreen) | +### `http.request.method` Values + `http.request.method` has the following list of well-known values. If one of them applies, then the respective value MUST be used; otherwise, a custom value MAY be used. | Value | Description | Stability | @@ -531,12 +545,16 @@ If the request has completed successfully, instrumentations SHOULD NOT set `erro **[8]:** The `url.template` MUST have low cardinality. It is not usually available on HTTP clients, but may be known by the application or specialized HTTP instrumentation. +### `error.type` Values + `error.type` has the following list of well-known values. If one of them applies, then the respective value MUST be used; otherwise, a custom value MAY be used. | Value | Description | Stability | |---|---|---| | `_OTHER` | A fallback error value to be used when the instrumentation doesn't define a custom value. | ![Stable](https://img.shields.io/badge/-stable-lightgreen) | +### `http.request.method` Values + `http.request.method` has the following list of well-known values. If one of them applies, then the respective value MUST be used; otherwise, a custom value MAY be used. | Value | Description | Stability | @@ -630,12 +648,16 @@ If the request has completed successfully, instrumentations SHOULD NOT set `erro **[8]:** If protocol version is subject to negotiation (for example using [ALPN](https://www.rfc-editor.org/rfc/rfc7301.html)), this attribute SHOULD be set to the negotiated version. If the actual protocol version is not known, this attribute SHOULD NOT be set. +### `error.type` Values + `error.type` has the following list of well-known values. If one of them applies, then the respective value MUST be used; otherwise, a custom value MAY be used. | Value | Description | Stability | |---|---|---| | `_OTHER` | A fallback error value to be used when the instrumentation doesn't define a custom value. | ![Stable](https://img.shields.io/badge/-stable-lightgreen) | +### `http.request.method` Values + `http.request.method` has the following list of well-known values. If one of them applies, then the respective value MUST be used; otherwise, a custom value MAY be used. | Value | Description | Stability | @@ -729,12 +751,16 @@ If the request has completed successfully, instrumentations SHOULD NOT set `erro **[8]:** If protocol version is subject to negotiation (for example using [ALPN](https://www.rfc-editor.org/rfc/rfc7301.html)), this attribute SHOULD be set to the negotiated version. If the actual protocol version is not known, this attribute SHOULD NOT be set. +### `error.type` Values + `error.type` has the following list of well-known values. If one of them applies, then the respective value MUST be used; otherwise, a custom value MAY be used. | Value | Description | Stability | |---|---|---| | `_OTHER` | A fallback error value to be used when the instrumentation doesn't define a custom value. | ![Stable](https://img.shields.io/badge/-stable-lightgreen) | +### `http.request.method` Values + `http.request.method` has the following list of well-known values. If one of them applies, then the respective value MUST be used; otherwise, a custom value MAY be used. | Value | Description | Stability | @@ -785,6 +811,8 @@ This metric is optional. **[3]:** If protocol version is subject to negotiation (for example using [ALPN](https://www.rfc-editor.org/rfc/rfc7301.html)), this attribute SHOULD be set to the negotiated version. If the actual protocol version is not known, this attribute SHOULD NOT be set. +### `http.connection.state` Values + `http.connection.state` has the following list of well-known values. If one of them applies, then the respective value MUST be used; otherwise, a custom value MAY be used. | Value | Description | Stability | @@ -881,6 +909,8 @@ HTTP method names are case-sensitive and `http.request.method` attribute value M Instrumentations for specific web frameworks that consider HTTP methods to be case insensitive, SHOULD populate a canonical equivalent. Tracing instrumentations that do so, MUST also set `http.request.method_original` to the original value. +### `http.request.method` Values + `http.request.method` has the following list of well-known values. If one of them applies, then the respective value MUST be used; otherwise, a custom value MAY be used. | Value | Description | Stability | diff --git a/docs/http/http-spans.md b/docs/http/http-spans.md index 9ee978c94f..eb199a0501 100644 --- a/docs/http/http-spans.md +++ b/docs/http/http-spans.md @@ -253,12 +253,16 @@ and SHOULD be provided **at span creation time** (if provided at all): * [`server.port`](/docs/attributes-registry/server.md) * [`url.full`](/docs/attributes-registry/url.md) +### `error.type` Values + `error.type` has the following list of well-known values. If one of them applies, then the respective value MUST be used; otherwise, a custom value MAY be used. | Value | Description | Stability | |---|---|---| | `_OTHER` | A fallback error value to be used when the instrumentation doesn't define a custom value. | ![Stable](https://img.shields.io/badge/-stable-lightgreen) | +### `http.request.method` Values + `http.request.method` has the following list of well-known values. If one of them applies, then the respective value MUST be used; otherwise, a custom value MAY be used. | Value | Description | Stability | @@ -274,6 +278,8 @@ and SHOULD be provided **at span creation time** (if provided at all): | `PUT` | PUT method. | ![Stable](https://img.shields.io/badge/-stable-lightgreen) | | `TRACE` | TRACE method. | ![Stable](https://img.shields.io/badge/-stable-lightgreen) | +### `network.transport` Values + `network.transport` has the following list of well-known values. If one of them applies, then the respective value MUST be used; otherwise, a custom value MAY be used. | Value | Description | Stability | @@ -498,12 +504,16 @@ and SHOULD be provided **at span creation time** (if provided at all): * [`url.scheme`](/docs/attributes-registry/url.md) * [`user_agent.original`](/docs/attributes-registry/user-agent.md) +### `error.type` Values + `error.type` has the following list of well-known values. If one of them applies, then the respective value MUST be used; otherwise, a custom value MAY be used. | Value | Description | Stability | |---|---|---| | `_OTHER` | A fallback error value to be used when the instrumentation doesn't define a custom value. | ![Stable](https://img.shields.io/badge/-stable-lightgreen) | +### `http.request.method` Values + `http.request.method` has the following list of well-known values. If one of them applies, then the respective value MUST be used; otherwise, a custom value MAY be used. | Value | Description | Stability | @@ -519,6 +529,8 @@ and SHOULD be provided **at span creation time** (if provided at all): | `PUT` | PUT method. | ![Stable](https://img.shields.io/badge/-stable-lightgreen) | | `TRACE` | TRACE method. | ![Stable](https://img.shields.io/badge/-stable-lightgreen) | +### `network.transport` Values + `network.transport` has the following list of well-known values. If one of them applies, then the respective value MUST be used; otherwise, a custom value MAY be used. | Value | Description | Stability | diff --git a/docs/messaging/azure-messaging.md b/docs/messaging/azure-messaging.md index 9a0322cb90..181bcf4253 100644 --- a/docs/messaging/azure-messaging.md +++ b/docs/messaging/azure-messaging.md @@ -124,12 +124,16 @@ and SHOULD be provided **at span creation time** (if provided at all): * [`server.address`](/docs/attributes-registry/server.md) * [`server.port`](/docs/attributes-registry/server.md) +### `error.type` Values + `error.type` has the following list of well-known values. If one of them applies, then the respective value MUST be used; otherwise, a custom value MAY be used. | Value | Description | Stability | |---|---|---| | `_OTHER` | A fallback error value to be used when the instrumentation doesn't define a custom value. | ![Stable](https://img.shields.io/badge/-stable-lightgreen) | +### `messaging.operation.type` Values + `messaging.operation.type` has the following list of well-known values. If one of them applies, then the respective value MUST be used; otherwise, a custom value MAY be used. | Value | Description | Stability | @@ -140,6 +144,8 @@ and SHOULD be provided **at span creation time** (if provided at all): | `send` | One or more messages are provided for sending to an intermediary. If a single message is sent, the context of the "Send" span can be used as the creation context and no "Create" span needs to be created. | ![Experimental](https://img.shields.io/badge/-experimental-blue) | | `settle` | One or more messages are settled. | ![Experimental](https://img.shields.io/badge/-experimental-blue) | +### `messaging.servicebus.disposition_status` Values + `messaging.servicebus.disposition_status` has the following list of well-known values. If one of them applies, then the respective value MUST be used; otherwise, a custom value MAY be used. | Value | Description | Stability | @@ -240,12 +246,16 @@ and SHOULD be provided **at span creation time** (if provided at all): * [`server.address`](/docs/attributes-registry/server.md) * [`server.port`](/docs/attributes-registry/server.md) +### `error.type` Values + `error.type` has the following list of well-known values. If one of them applies, then the respective value MUST be used; otherwise, a custom value MAY be used. | Value | Description | Stability | |---|---|---| | `_OTHER` | A fallback error value to be used when the instrumentation doesn't define a custom value. | ![Stable](https://img.shields.io/badge/-stable-lightgreen) | +### `messaging.operation.type` Values + `messaging.operation.type` has the following list of well-known values. If one of them applies, then the respective value MUST be used; otherwise, a custom value MAY be used. | Value | Description | Stability | diff --git a/docs/messaging/gcp-pubsub.md b/docs/messaging/gcp-pubsub.md index 84483b0d2c..9d302b9ba2 100644 --- a/docs/messaging/gcp-pubsub.md +++ b/docs/messaging/gcp-pubsub.md @@ -119,12 +119,16 @@ and SHOULD be provided **at span creation time** (if provided at all): * [`server.address`](/docs/attributes-registry/server.md) * [`server.port`](/docs/attributes-registry/server.md) +### `error.type` Values + `error.type` has the following list of well-known values. If one of them applies, then the respective value MUST be used; otherwise, a custom value MAY be used. | Value | Description | Stability | |---|---|---| | `_OTHER` | A fallback error value to be used when the instrumentation doesn't define a custom value. | ![Stable](https://img.shields.io/badge/-stable-lightgreen) | +### `messaging.operation.type` Values + `messaging.operation.type` has the following list of well-known values. If one of them applies, then the respective value MUST be used; otherwise, a custom value MAY be used. | Value | Description | Stability | diff --git a/docs/messaging/kafka.md b/docs/messaging/kafka.md index 1e0797db8b..43e65fcd9b 100644 --- a/docs/messaging/kafka.md +++ b/docs/messaging/kafka.md @@ -128,12 +128,16 @@ and SHOULD be provided **at span creation time** (if provided at all): * [`server.address`](/docs/attributes-registry/server.md) * [`server.port`](/docs/attributes-registry/server.md) +### `error.type` Values + `error.type` has the following list of well-known values. If one of them applies, then the respective value MUST be used; otherwise, a custom value MAY be used. | Value | Description | Stability | |---|---|---| | `_OTHER` | A fallback error value to be used when the instrumentation doesn't define a custom value. | ![Stable](https://img.shields.io/badge/-stable-lightgreen) | +### `messaging.operation.type` Values + `messaging.operation.type` has the following list of well-known values. If one of them applies, then the respective value MUST be used; otherwise, a custom value MAY be used. | Value | Description | Stability | diff --git a/docs/messaging/messaging-metrics.md b/docs/messaging/messaging-metrics.md index d083e0ec3e..b5ced69611 100644 --- a/docs/messaging/messaging-metrics.md +++ b/docs/messaging/messaging-metrics.md @@ -122,12 +122,16 @@ the broker doesn't have such notion, the destination name SHOULD uniquely identi **[10]:** When observed from the client side, and when communicating through an intermediary, `server.port` SHOULD represent the server port behind any intermediaries, for example proxies, if it's available. +### `error.type` Values + `error.type` has the following list of well-known values. If one of them applies, then the respective value MUST be used; otherwise, a custom value MAY be used. | Value | Description | Stability | |---|---|---| | `_OTHER` | A fallback error value to be used when the instrumentation doesn't define a custom value. | ![Stable](https://img.shields.io/badge/-stable-lightgreen) | +### `messaging.operation.type` Values + `messaging.operation.type` has the following list of well-known values. If one of them applies, then the respective value MUST be used; otherwise, a custom value MAY be used. | Value | Description | Stability | @@ -138,6 +142,8 @@ the broker doesn't have such notion, the destination name SHOULD uniquely identi | `send` | One or more messages are provided for sending to an intermediary. If a single message is sent, the context of the "Send" span can be used as the creation context and no "Create" span needs to be created. | ![Experimental](https://img.shields.io/badge/-experimental-blue) | | `settle` | One or more messages are settled. | ![Experimental](https://img.shields.io/badge/-experimental-blue) | +### `messaging.system` Values + `messaging.system` has the following list of well-known values. If one of them applies, then the respective value MUST be used; otherwise, a custom value MAY be used. | Value | Description | Stability | @@ -222,12 +228,16 @@ the broker doesn't have such notion, the destination name SHOULD uniquely identi **[7]:** When observed from the client side, and when communicating through an intermediary, `server.port` SHOULD represent the server port behind any intermediaries, for example proxies, if it's available. +### `error.type` Values + `error.type` has the following list of well-known values. If one of them applies, then the respective value MUST be used; otherwise, a custom value MAY be used. | Value | Description | Stability | |---|---|---| | `_OTHER` | A fallback error value to be used when the instrumentation doesn't define a custom value. | ![Stable](https://img.shields.io/badge/-stable-lightgreen) | +### `messaging.system` Values + `messaging.system` has the following list of well-known values. If one of them applies, then the respective value MUST be used; otherwise, a custom value MAY be used. | Value | Description | Stability | @@ -319,12 +329,16 @@ the broker doesn't have such notion, the destination name SHOULD uniquely identi **[9]:** When observed from the client side, and when communicating through an intermediary, `server.port` SHOULD represent the server port behind any intermediaries, for example proxies, if it's available. +### `error.type` Values + `error.type` has the following list of well-known values. If one of them applies, then the respective value MUST be used; otherwise, a custom value MAY be used. | Value | Description | Stability | |---|---|---| | `_OTHER` | A fallback error value to be used when the instrumentation doesn't define a custom value. | ![Stable](https://img.shields.io/badge/-stable-lightgreen) | +### `messaging.system` Values + `messaging.system` has the following list of well-known values. If one of them applies, then the respective value MUST be used; otherwise, a custom value MAY be used. | Value | Description | Stability | @@ -419,12 +433,16 @@ the broker doesn't have such notion, the destination name SHOULD uniquely identi **[9]:** When observed from the client side, and when communicating through an intermediary, `server.port` SHOULD represent the server port behind any intermediaries, for example proxies, if it's available. +### `error.type` Values + `error.type` has the following list of well-known values. If one of them applies, then the respective value MUST be used; otherwise, a custom value MAY be used. | Value | Description | Stability | |---|---|---| | `_OTHER` | A fallback error value to be used when the instrumentation doesn't define a custom value. | ![Stable](https://img.shields.io/badge/-stable-lightgreen) | +### `messaging.system` Values + `messaging.system` has the following list of well-known values. If one of them applies, then the respective value MUST be used; otherwise, a custom value MAY be used. | Value | Description | Stability | diff --git a/docs/messaging/messaging-spans.md b/docs/messaging/messaging-spans.md index cb45f8b28c..64dd9ce500 100644 --- a/docs/messaging/messaging-spans.md +++ b/docs/messaging/messaging-spans.md @@ -460,12 +460,16 @@ and SHOULD be provided **at span creation time** (if provided at all): * [`server.address`](/docs/attributes-registry/server.md) * [`server.port`](/docs/attributes-registry/server.md) +### `error.type` Values + `error.type` has the following list of well-known values. If one of them applies, then the respective value MUST be used; otherwise, a custom value MAY be used. | Value | Description | Stability | |---|---|---| | `_OTHER` | A fallback error value to be used when the instrumentation doesn't define a custom value. | ![Stable](https://img.shields.io/badge/-stable-lightgreen) | +### `messaging.operation.type` Values + `messaging.operation.type` has the following list of well-known values. If one of them applies, then the respective value MUST be used; otherwise, a custom value MAY be used. | Value | Description | Stability | @@ -476,6 +480,8 @@ and SHOULD be provided **at span creation time** (if provided at all): | `send` | One or more messages are provided for sending to an intermediary. If a single message is sent, the context of the "Send" span can be used as the creation context and no "Create" span needs to be created. | ![Experimental](https://img.shields.io/badge/-experimental-blue) | | `settle` | One or more messages are settled. | ![Experimental](https://img.shields.io/badge/-experimental-blue) | +### `messaging.system` Values + `messaging.system` has the following list of well-known values. If one of them applies, then the respective value MUST be used; otherwise, a custom value MAY be used. | Value | Description | Stability | diff --git a/docs/messaging/rabbitmq.md b/docs/messaging/rabbitmq.md index c7d95f3a62..006d4e9999 100644 --- a/docs/messaging/rabbitmq.md +++ b/docs/messaging/rabbitmq.md @@ -111,12 +111,16 @@ and SHOULD be provided **at span creation time** (if provided at all): * [`server.address`](/docs/attributes-registry/server.md) * [`server.port`](/docs/attributes-registry/server.md) +### `error.type` Values + `error.type` has the following list of well-known values. If one of them applies, then the respective value MUST be used; otherwise, a custom value MAY be used. | Value | Description | Stability | |---|---|---| | `_OTHER` | A fallback error value to be used when the instrumentation doesn't define a custom value. | ![Stable](https://img.shields.io/badge/-stable-lightgreen) | +### `messaging.operation.type` Values + `messaging.operation.type` has the following list of well-known values. If one of them applies, then the respective value MUST be used; otherwise, a custom value MAY be used. | Value | Description | Stability | diff --git a/docs/messaging/rocketmq.md b/docs/messaging/rocketmq.md index 8574b36f4b..79598d1f5a 100644 --- a/docs/messaging/rocketmq.md +++ b/docs/messaging/rocketmq.md @@ -123,12 +123,16 @@ and SHOULD be provided **at span creation time** (if provided at all): * [`server.address`](/docs/attributes-registry/server.md) * [`server.port`](/docs/attributes-registry/server.md) +### `error.type` Values + `error.type` has the following list of well-known values. If one of them applies, then the respective value MUST be used; otherwise, a custom value MAY be used. | Value | Description | Stability | |---|---|---| | `_OTHER` | A fallback error value to be used when the instrumentation doesn't define a custom value. | ![Stable](https://img.shields.io/badge/-stable-lightgreen) | +### `messaging.operation.type` Values + `messaging.operation.type` has the following list of well-known values. If one of them applies, then the respective value MUST be used; otherwise, a custom value MAY be used. | Value | Description | Stability | @@ -139,6 +143,8 @@ and SHOULD be provided **at span creation time** (if provided at all): | `send` | One or more messages are provided for sending to an intermediary. If a single message is sent, the context of the "Send" span can be used as the creation context and no "Create" span needs to be created. | ![Experimental](https://img.shields.io/badge/-experimental-blue) | | `settle` | One or more messages are settled. | ![Experimental](https://img.shields.io/badge/-experimental-blue) | +### `messaging.rocketmq.consumption_model` Values + `messaging.rocketmq.consumption_model` has the following list of well-known values. If one of them applies, then the respective value MUST be used; otherwise, a custom value MAY be used. | Value | Description | Stability | @@ -146,6 +152,8 @@ and SHOULD be provided **at span creation time** (if provided at all): | `broadcasting` | Broadcasting consumption model | ![Experimental](https://img.shields.io/badge/-experimental-blue) | | `clustering` | Clustering consumption model | ![Experimental](https://img.shields.io/badge/-experimental-blue) | +### `messaging.rocketmq.message.type` Values + `messaging.rocketmq.message.type` has the following list of well-known values. If one of them applies, then the respective value MUST be used; otherwise, a custom value MAY be used. | Value | Description | Stability | diff --git a/docs/object-stores/s3.md b/docs/object-stores/s3.md index cb5a1ec093..50895c6919 100644 --- a/docs/object-stores/s3.md +++ b/docs/object-stores/s3.md @@ -81,6 +81,8 @@ This applies in particular to the following operations: **[8]:** This is the logical name of the service from the RPC interface perspective, which can be different from the name of any implementing class. The `code.namespace` attribute may be used to store the latter (despite the attribute name, it may include a class name; e.g., class with method actually executing the call on the server side, RPC client stub class on the client side). +### `rpc.system` Values + `rpc.system` has the following list of well-known values. If one of them applies, then the respective value MUST be used; otherwise, a custom value MAY be used. | Value | Description | Stability | diff --git a/docs/resource/README.md b/docs/resource/README.md index ec6365d9e5..a29d46a762 100644 --- a/docs/resource/README.md +++ b/docs/resource/README.md @@ -172,6 +172,8 @@ or another suitable identifier depending on the language. The identifier `opentelemetry` is reserved and MUST NOT be used in this case. All custom identifiers SHOULD be stable across different versions of an implementation. +### `telemetry.sdk.language` Values + `telemetry.sdk.language` has the following list of well-known values. If one of them applies, then the respective value MUST be used; otherwise, a custom value MAY be used. | Value | Description | Stability | diff --git a/docs/resource/cloud-provider/aws/ecs.md b/docs/resource/cloud-provider/aws/ecs.md index aacafb958f..ccce7e7dbd 100644 --- a/docs/resource/cloud-provider/aws/ecs.md +++ b/docs/resource/cloud-provider/aws/ecs.md @@ -24,6 +24,8 @@ | [`aws.ecs.task.family`](/docs/attributes-registry/aws.md) | string | The family name of the [ECS task definition](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task_definitions.html) used to create the ECS task. | `opentelemetry-family` | `Recommended` | ![Experimental](https://img.shields.io/badge/-experimental-blue) | | [`aws.ecs.task.revision`](/docs/attributes-registry/aws.md) | string | The revision for the task definition used to create the ECS task. | `8`; `26` | `Recommended` | ![Experimental](https://img.shields.io/badge/-experimental-blue) | +### `aws.ecs.launchtype` Values + `aws.ecs.launchtype` has the following list of well-known values. If one of them applies, then the respective value MUST be used; otherwise, a custom value MAY be used. | Value | Description | Stability | diff --git a/docs/resource/cloud.md b/docs/resource/cloud.md index 13eeaec65f..6489543349 100644 --- a/docs/resource/cloud.md +++ b/docs/resource/cloud.md @@ -47,6 +47,8 @@ The following well-known definitions MUST be used if you set this attribute and This means that a span attribute MUST be used, as an Azure function app can host multiple functions that would usually share a TracerProvider. +### `cloud.platform` Values + `cloud.platform` has the following list of well-known values. If one of them applies, then the respective value MUST be used; otherwise, a custom value MAY be used. | Value | Description | Stability | @@ -80,6 +82,8 @@ The following well-known definitions MUST be used if you set this attribute and | `tencent_cloud_eks` | Tencent Cloud Elastic Kubernetes Service (EKS) | ![Experimental](https://img.shields.io/badge/-experimental-blue) | | `tencent_cloud_scf` | Tencent Cloud Serverless Cloud Function (SCF) | ![Experimental](https://img.shields.io/badge/-experimental-blue) | +### `cloud.provider` Values + `cloud.provider` has the following list of well-known values. If one of them applies, then the respective value MUST be used; otherwise, a custom value MAY be used. | Value | Description | Stability | diff --git a/docs/resource/host.md b/docs/resource/host.md index fe08de147b..c6c8baca4d 100644 --- a/docs/resource/host.md +++ b/docs/resource/host.md @@ -59,6 +59,8 @@ privileged lookup of `host.id` is required, the value should be injected via the **[3]:** MAC Addresses MUST be represented in [IEEE RA hexadecimal form](https://standards.ieee.org/wp-content/uploads/import/documents/tutorials/eui.pdf): as hyphen-separated octets in uppercase hexadecimal form from most to least significant. +### `host.arch` Values + `host.arch` has the following list of well-known values. If one of them applies, then the respective value MUST be used; otherwise, a custom value MAY be used. | Value | Description | Stability | diff --git a/docs/resource/os.md b/docs/resource/os.md index 6a5c2c16c0..2825928ee3 100644 --- a/docs/resource/os.md +++ b/docs/resource/os.md @@ -32,6 +32,8 @@ In case of virtualized environments, this is the operating system as it is obser | MacOS | `ProductBuildVersion` from `/System/Library/CoreServices/SystemVersion.plist` | `ProductBuildVersion` from `/System/Library/CoreServices/ServerVersion.plist` | | Linux | `BUILD_ID` from `/etc/os-release` | `BUILD_ID` from `/usr/lib/os-release`;
contents of `/proc/sys/kernel/osrelease`| +### `os.type` Values + `os.type` has the following list of well-known values. If one of them applies, then the respective value MUST be used; otherwise, a custom value MAY be used. | Value | Description | Stability | diff --git a/docs/rpc/connect-rpc.md b/docs/rpc/connect-rpc.md index 062cc07fd7..cea0a72c3b 100644 --- a/docs/rpc/connect-rpc.md +++ b/docs/rpc/connect-rpc.md @@ -35,6 +35,8 @@ Below is a table of attributes that SHOULD be included on client and server Conn **[3]:** Instrumentations SHOULD require an explicit configuration of which metadata values are to be captured. Including all response metadata values can be a security risk - explicit configuration helps avoid leaking sensitive information. +### `rpc.connect_rpc.error_code` Values + `rpc.connect_rpc.error_code` has the following list of well-known values. If one of them applies, then the respective value MUST be used; otherwise, a custom value MAY be used. | Value | Description | Stability | diff --git a/docs/rpc/grpc.md b/docs/rpc/grpc.md index f5e4a92a0c..123911faaa 100644 --- a/docs/rpc/grpc.md +++ b/docs/rpc/grpc.md @@ -33,6 +33,8 @@ Below is a table of attributes that SHOULD be included on client and server gRPC **[2]:** Instrumentations SHOULD require an explicit configuration of which metadata values are to be captured. Including all response metadata values can be a security risk - explicit configuration helps avoid leaking sensitive information. +### `rpc.grpc.status_code` Values + `rpc.grpc.status_code` has the following list of well-known values. If one of them applies, then the respective value MUST be used; otherwise, a custom value MAY be used. | Value | Description | Stability | diff --git a/docs/rpc/rpc-metrics.md b/docs/rpc/rpc-metrics.md index ad2653f792..d545a79a1b 100644 --- a/docs/rpc/rpc-metrics.md +++ b/docs/rpc/rpc-metrics.md @@ -349,6 +349,8 @@ different processes could be listening on TCP port 12345 and UDP port 12345. **[6]:** When observed from the client side, and when communicating through an intermediary, `server.port` SHOULD represent the server port behind any intermediaries, for example proxies, if it's available. +### `network.transport` Values + `network.transport` has the following list of well-known values. If one of them applies, then the respective value MUST be used; otherwise, a custom value MAY be used. | Value | Description | Stability | @@ -359,6 +361,8 @@ different processes could be listening on TCP port 12345 and UDP port 12345. | `udp` | UDP | ![Stable](https://img.shields.io/badge/-stable-lightgreen) | | `unix` | Unix domain socket | ![Stable](https://img.shields.io/badge/-stable-lightgreen) | +### `network.type` Values + `network.type` has the following list of well-known values. If one of them applies, then the respective value MUST be used; otherwise, a custom value MAY be used. | Value | Description | Stability | @@ -366,6 +370,8 @@ different processes could be listening on TCP port 12345 and UDP port 12345. | `ipv4` | IPv4 | ![Stable](https://img.shields.io/badge/-stable-lightgreen) | | `ipv6` | IPv6 | ![Stable](https://img.shields.io/badge/-stable-lightgreen) | +### `rpc.system` Values + `rpc.system` has the following list of well-known values. If one of them applies, then the respective value MUST be used; otherwise, a custom value MAY be used. | Value | Description | Stability | diff --git a/docs/rpc/rpc-spans.md b/docs/rpc/rpc-spans.md index f04c37a118..de6d9824dc 100644 --- a/docs/rpc/rpc-spans.md +++ b/docs/rpc/rpc-spans.md @@ -132,6 +132,8 @@ different processes could be listening on TCP port 12345 and UDP port 12345. **[7]:** This is the logical name of the service from the RPC interface perspective, which can be different from the name of any implementing class. The `code.namespace` attribute may be used to store the latter (despite the attribute name, it may include a class name; e.g., class with method actually executing the call on the server side, RPC client stub class on the client side). +### `network.transport` Values + `network.transport` has the following list of well-known values. If one of them applies, then the respective value MUST be used; otherwise, a custom value MAY be used. | Value | Description | Stability | @@ -142,6 +144,8 @@ different processes could be listening on TCP port 12345 and UDP port 12345. | `udp` | UDP | ![Stable](https://img.shields.io/badge/-stable-lightgreen) | | `unix` | Unix domain socket | ![Stable](https://img.shields.io/badge/-stable-lightgreen) | +### `network.type` Values + `network.type` has the following list of well-known values. If one of them applies, then the respective value MUST be used; otherwise, a custom value MAY be used. | Value | Description | Stability | @@ -149,6 +153,8 @@ different processes could be listening on TCP port 12345 and UDP port 12345. | `ipv4` | IPv4 | ![Stable](https://img.shields.io/badge/-stable-lightgreen) | | `ipv6` | IPv6 | ![Stable](https://img.shields.io/badge/-stable-lightgreen) | +### `rpc.system` Values + `rpc.system` has the following list of well-known values. If one of them applies, then the respective value MUST be used; otherwise, a custom value MAY be used. | Value | Description | Stability | @@ -209,6 +215,8 @@ different processes could be listening on TCP port 12345 and UDP port 12345. **[9]:** This is the logical name of the service from the RPC interface perspective, which can be different from the name of any implementing class. The `code.namespace` attribute may be used to store the latter (despite the attribute name, it may include a class name; e.g., class with method actually executing the call on the server side, RPC client stub class on the client side). +### `network.transport` Values + `network.transport` has the following list of well-known values. If one of them applies, then the respective value MUST be used; otherwise, a custom value MAY be used. | Value | Description | Stability | @@ -219,6 +227,8 @@ different processes could be listening on TCP port 12345 and UDP port 12345. | `udp` | UDP | ![Stable](https://img.shields.io/badge/-stable-lightgreen) | | `unix` | Unix domain socket | ![Stable](https://img.shields.io/badge/-stable-lightgreen) | +### `network.type` Values + `network.type` has the following list of well-known values. If one of them applies, then the respective value MUST be used; otherwise, a custom value MAY be used. | Value | Description | Stability | @@ -226,6 +236,8 @@ different processes could be listening on TCP port 12345 and UDP port 12345. | `ipv4` | IPv4 | ![Stable](https://img.shields.io/badge/-stable-lightgreen) | | `ipv6` | IPv6 | ![Stable](https://img.shields.io/badge/-stable-lightgreen) | +### `rpc.system` Values + `rpc.system` has the following list of well-known values. If one of them applies, then the respective value MUST be used; otherwise, a custom value MAY be used. | Value | Description | Stability | @@ -269,6 +281,8 @@ In the lifetime of an RPC stream, an event for each message sent/received on cli **[1]:** This way we guarantee that the values will be consistent between different implementations. +### `rpc.message.type` Values + `rpc.message.type` has the following list of well-known values. If one of them applies, then the respective value MUST be used; otherwise, a custom value MAY be used. | Value | Description | Stability | diff --git a/docs/runtime/dotnet-metrics.md b/docs/runtime/dotnet-metrics.md index a8bc36f8d8..2704610ea5 100644 --- a/docs/runtime/dotnet-metrics.md +++ b/docs/runtime/dotnet-metrics.md @@ -92,6 +92,8 @@ This metric reports the same values as accessing the corresponding processor tim |---|---|---|---|---|---| | [`cpu.mode`](/docs/attributes-registry/cpu.md) | string | The mode of the CPU | `user`; `system` | `Required` | ![Experimental](https://img.shields.io/badge/-experimental-blue) | +### `cpu.mode` Values + `cpu.mode` has the following list of well-known values. If one of them applies, then the respective value MUST be used; otherwise, a custom value MAY be used. | Value | Description | Stability | @@ -161,6 +163,8 @@ This metric uses the [`GC.CollectionCount(int generation)`](https://learn.micros |---|---|---|---|---|---| | [`dotnet.gc.heap.generation`](/docs/attributes-registry/dotnet.md) | string | Name of the garbage collector managed heap generation. | `gen0`; `gen1`; `gen2` | `Required` | ![Experimental](https://img.shields.io/badge/-experimental-blue) | +### `dotnet.gc.heap.generation` Values + `dotnet.gc.heap.generation` has the following list of well-known values. If one of them applies, then the respective value MUST be used; otherwise, a custom value MAY be used. | Value | Description | Stability | @@ -244,6 +248,8 @@ This metric reports the same values as calling [`GC.GetGCMemoryInfo().Generation |---|---|---|---|---|---| | [`dotnet.gc.heap.generation`](/docs/attributes-registry/dotnet.md) | string | Name of the garbage collector managed heap generation. | `gen0`; `gen1`; `gen2` | `Required` | ![Experimental](https://img.shields.io/badge/-experimental-blue) | +### `dotnet.gc.heap.generation` Values + `dotnet.gc.heap.generation` has the following list of well-known values. If one of them applies, then the respective value MUST be used; otherwise, a custom value MAY be used. | Value | Description | Stability | @@ -281,6 +287,8 @@ This metric reports the same values as calling [`GC.GetGCMemoryInfo().Generation |---|---|---|---|---|---| | [`dotnet.gc.heap.generation`](/docs/attributes-registry/dotnet.md) | string | Name of the garbage collector managed heap generation. | `gen0`; `gen1`; `gen2` | `Required` | ![Experimental](https://img.shields.io/badge/-experimental-blue) | +### `dotnet.gc.heap.generation` Values + `dotnet.gc.heap.generation` has the following list of well-known values. If one of them applies, then the respective value MUST be used; otherwise, a custom value MAY be used. | Value | Description | Stability | @@ -566,6 +574,8 @@ This metric reports the same values as counting calls to [`AppDomain.CurrentDoma |---|---|---|---|---|---| | [`error.type`](/docs/attributes-registry/error.md) | string | Describes a class of error the operation ended with. | `System.OperationCanceledException`; `Contoso.MyException` | `Required` | ![Stable](https://img.shields.io/badge/-stable-lightgreen) | +### `error.type` Values + `error.type` has the following list of well-known values. If one of them applies, then the respective value MUST be used; otherwise, a custom value MAY be used. | Value | Description | Stability | diff --git a/docs/runtime/go-metrics.md b/docs/runtime/go-metrics.md index 6391e16bc4..460ccaad20 100644 --- a/docs/runtime/go-metrics.md +++ b/docs/runtime/go-metrics.md @@ -56,6 +56,8 @@ This metric is [recommended][MetricRecommended]. |---|---|---|---|---|---| | [`go.memory.type`](/docs/attributes-registry/go.md) | string | The type of memory. | `other`; `stack` | `Recommended` | ![Experimental](https://img.shields.io/badge/-experimental-blue) | +### `go.memory.type` Values + `go.memory.type` has the following list of well-known values. If one of them applies, then the respective value MUST be used; otherwise, a custom value MAY be used. | Value | Description | Stability | diff --git a/docs/runtime/jvm-metrics.md b/docs/runtime/jvm-metrics.md index 0e5f6619a9..c357e467c5 100644 --- a/docs/runtime/jvm-metrics.md +++ b/docs/runtime/jvm-metrics.md @@ -68,6 +68,8 @@ This metric is obtained from [`MemoryPoolMXBean#getUsage()`](https://docs.oracle **[1]:** Pool names are generally obtained via [MemoryPoolMXBean#getName()](https://docs.oracle.com/en/java/javase/11/docs/api/java.management/java/lang/management/MemoryPoolMXBean.html#getName()). +### `jvm.memory.type` Values + `jvm.memory.type` has the following list of well-known values. If one of them applies, then the respective value MUST be used; otherwise, a custom value MAY be used. | Value | Description | Stability | @@ -103,6 +105,8 @@ This metric is obtained from [`MemoryPoolMXBean#getUsage()`](https://docs.oracle **[1]:** Pool names are generally obtained via [MemoryPoolMXBean#getName()](https://docs.oracle.com/en/java/javase/11/docs/api/java.management/java/lang/management/MemoryPoolMXBean.html#getName()). +### `jvm.memory.type` Values + `jvm.memory.type` has the following list of well-known values. If one of them applies, then the respective value MUST be used; otherwise, a custom value MAY be used. | Value | Description | Stability | @@ -138,6 +142,8 @@ This metric is obtained from [`MemoryPoolMXBean#getUsage()`](https://docs.oracle **[1]:** Pool names are generally obtained via [MemoryPoolMXBean#getName()](https://docs.oracle.com/en/java/javase/11/docs/api/java.management/java/lang/management/MemoryPoolMXBean.html#getName()). +### `jvm.memory.type` Values + `jvm.memory.type` has the following list of well-known values. If one of them applies, then the respective value MUST be used; otherwise, a custom value MAY be used. | Value | Description | Stability | @@ -173,6 +179,8 @@ This metric is obtained from [`MemoryPoolMXBean#getCollectionUsage()`](https://d **[1]:** Pool names are generally obtained via [MemoryPoolMXBean#getName()](https://docs.oracle.com/en/java/javase/11/docs/api/java.management/java/lang/management/MemoryPoolMXBean.html#getName()). +### `jvm.memory.type` Values + `jvm.memory.type` has the following list of well-known values. If one of them applies, then the respective value MUST be used; otherwise, a custom value MAY be used. | Value | Description | Stability | @@ -260,6 +268,8 @@ Note that this is the number of platform threads (as opposed to virtual threads) | [`jvm.thread.daemon`](/docs/attributes-registry/jvm.md) | boolean | Whether the thread is daemon or not. | | `Recommended` | ![Stable](https://img.shields.io/badge/-stable-lightgreen) | | [`jvm.thread.state`](/docs/attributes-registry/jvm.md) | string | State of the thread. | `runnable`; `blocked` | `Recommended` | ![Stable](https://img.shields.io/badge/-stable-lightgreen) | +### `jvm.thread.state` Values + `jvm.thread.state` has the following list of well-known values. If one of them applies, then the respective value MUST be used; otherwise, a custom value MAY be used. | Value | Description | Stability | @@ -450,6 +460,8 @@ This metric is obtained from [`MemoryPoolMXBean#getUsage()`](https://docs.oracle **[1]:** Pool names are generally obtained via [MemoryPoolMXBean#getName()](https://docs.oracle.com/en/java/javase/11/docs/api/java.management/java/lang/management/MemoryPoolMXBean.html#getName()). +### `jvm.memory.type` Values + `jvm.memory.type` has the following list of well-known values. If one of them applies, then the respective value MUST be used; otherwise, a custom value MAY be used. | Value | Description | Stability | diff --git a/docs/runtime/nodejs-metrics.md b/docs/runtime/nodejs-metrics.md index d44fa3a1ea..6c2e50cd3c 100644 --- a/docs/runtime/nodejs-metrics.md +++ b/docs/runtime/nodejs-metrics.md @@ -232,6 +232,8 @@ This metric is [recommended][MetricRecommended]. |---|---|---|---|---|---| | [`nodejs.eventloop.state`](/docs/attributes-registry/nodejs.md) | string | The state of event loop time. | `active`; `idle` | `Required` | ![Experimental](https://img.shields.io/badge/-experimental-blue) | +### `nodejs.eventloop.state` Values + `nodejs.eventloop.state` has the following list of well-known values. If one of them applies, then the respective value MUST be used; otherwise, a custom value MAY be used. | Value | Description | Stability | diff --git a/docs/runtime/v8js-metrics.md b/docs/runtime/v8js-metrics.md index 07a5efc36c..27901a8f0e 100644 --- a/docs/runtime/v8js-metrics.md +++ b/docs/runtime/v8js-metrics.md @@ -52,6 +52,8 @@ of `[ 0.01, 0.1, 1, 10 ]`. |---|---|---|---|---|---| | [`v8js.gc.type`](/docs/attributes-registry/v8js.md) | string | The type of garbage collection. | `major`; `minor`; `incremental` | `Required` | ![Experimental](https://img.shields.io/badge/-experimental-blue) | +### `v8js.gc.type` Values + `v8js.gc.type` has the following list of well-known values. If one of them applies, then the respective value MUST be used; otherwise, a custom value MAY be used. | Value | Description | Stability | @@ -89,6 +91,8 @@ This metric is [recommended][MetricRecommended]. **[1]:** Value can be retrieved from value `space_name` of [`v8.getHeapSpaceStatistics()`](https://nodejs.org/api/v8.html#v8getheapspacestatistics) +### `v8js.heap.space.name` Values + `v8js.heap.space.name` has the following list of well-known values. If one of them applies, then the respective value MUST be used; otherwise, a custom value MAY be used. | Value | Description | Stability | @@ -127,6 +131,8 @@ This metric is [recommended][MetricRecommended]. **[1]:** Value can be retrieved from value `space_name` of [`v8.getHeapSpaceStatistics()`](https://nodejs.org/api/v8.html#v8getheapspacestatistics) +### `v8js.heap.space.name` Values + `v8js.heap.space.name` has the following list of well-known values. If one of them applies, then the respective value MUST be used; otherwise, a custom value MAY be used. | Value | Description | Stability | @@ -165,6 +171,8 @@ This metric is [recommended][MetricRecommended]. **[1]:** Value can be retrieved from value `space_name` of [`v8.getHeapSpaceStatistics()`](https://nodejs.org/api/v8.html#v8getheapspacestatistics) +### `v8js.heap.space.name` Values + `v8js.heap.space.name` has the following list of well-known values. If one of them applies, then the respective value MUST be used; otherwise, a custom value MAY be used. | Value | Description | Stability | @@ -203,6 +211,8 @@ This metric is [recommended][MetricRecommended]. **[1]:** Value can be retrieved from value `space_name` of [`v8.getHeapSpaceStatistics()`](https://nodejs.org/api/v8.html#v8getheapspacestatistics) +### `v8js.heap.space.name` Values + `v8js.heap.space.name` has the following list of well-known values. If one of them applies, then the respective value MUST be used; otherwise, a custom value MAY be used. | Value | Description | Stability | diff --git a/docs/system/container-metrics.md b/docs/system/container-metrics.md index ac2df5e984..c7004a3693 100644 --- a/docs/system/container-metrics.md +++ b/docs/system/container-metrics.md @@ -37,6 +37,8 @@ This metric is [opt-in][MetricOptIn]. **[2]:** Required if mode is available, i.e. metrics coming from the Docker Stats API. +### `cpu.mode` Values + `cpu.mode` has the following list of well-known values. If one of them applies, then the respective value MUST be used; otherwise, a custom value MAY be used. | Value | Description | Stability | @@ -80,6 +82,8 @@ This metric is [opt-in][MetricOptIn]. **[2]:** Required if mode is available, i.e. metrics coming from the Docker Stats API. +### `cpu.mode` Values + `cpu.mode` has the following list of well-known values. If one of them applies, then the respective value MUST be used; otherwise, a custom value MAY be used. | Value | Description | Stability | @@ -142,6 +146,8 @@ This metric is [opt-in][MetricOptIn]. | [`disk.io.direction`](/docs/attributes-registry/disk.md) | string | The disk IO operation direction. | `read` | `Recommended` | ![Experimental](https://img.shields.io/badge/-experimental-blue) | | [`system.device`](/docs/attributes-registry/system.md) | string | The device identifier | `(identifier)` | `Recommended` | ![Experimental](https://img.shields.io/badge/-experimental-blue) | +### `disk.io.direction` Values + `disk.io.direction` has the following list of well-known values. If one of them applies, then the respective value MUST be used; otherwise, a custom value MAY be used. | Value | Description | Stability | @@ -176,6 +182,8 @@ This metric is [opt-in][MetricOptIn]. | [`network.interface.name`](/docs/attributes-registry/network.md) | string | The network interface name. | `lo`; `eth0` | `Recommended` | ![Experimental](https://img.shields.io/badge/-experimental-blue) | | [`network.io.direction`](/docs/attributes-registry/network.md) | string | The network IO operation direction. | `transmit` | `Recommended` | ![Experimental](https://img.shields.io/badge/-experimental-blue) | +### `network.io.direction` Values + `network.io.direction` has the following list of well-known values. If one of them applies, then the respective value MUST be used; otherwise, a custom value MAY be used. | Value | Description | Stability | diff --git a/docs/system/process-metrics.md b/docs/system/process-metrics.md index c08e068e41..f6cd15635d 100644 --- a/docs/system/process-metrics.md +++ b/docs/system/process-metrics.md @@ -67,6 +67,8 @@ This metric is [recommended][MetricRecommended]. **[1]:** Following states SHOULD be used: `user`, `system`, `wait` +### `cpu.mode` Values + `cpu.mode` has the following list of well-known values. If one of them applies, then the respective value MUST be used; otherwise, a custom value MAY be used. | Value | Description | Stability | @@ -106,6 +108,8 @@ This metric is [opt-in][MetricOptIn]. **[1]:** Following states SHOULD be used: `user`, `system`, `wait` +### `cpu.mode` Values + `cpu.mode` has the following list of well-known values. If one of them applies, then the respective value MUST be used; otherwise, a custom value MAY be used. | Value | Description | Stability | @@ -183,6 +187,8 @@ This metric is [recommended][MetricRecommended]. |---|---|---|---|---|---| | [`disk.io.direction`](/docs/attributes-registry/disk.md) | string | The disk IO operation direction. | `read` | `Recommended` | ![Experimental](https://img.shields.io/badge/-experimental-blue) | +### `disk.io.direction` Values + `disk.io.direction` has the following list of well-known values. If one of them applies, then the respective value MUST be used; otherwise, a custom value MAY be used. | Value | Description | Stability | @@ -214,6 +220,8 @@ This metric is [recommended][MetricRecommended]. |---|---|---|---|---|---| | [`network.io.direction`](/docs/attributes-registry/network.md) | string | The network IO operation direction. | `transmit` | `Recommended` | ![Experimental](https://img.shields.io/badge/-experimental-blue) | +### `network.io.direction` Values + `network.io.direction` has the following list of well-known values. If one of them applies, then the respective value MUST be used; otherwise, a custom value MAY be used. | Value | Description | Stability | @@ -285,6 +293,8 @@ This metric is [recommended][MetricRecommended]. |---|---|---|---|---|---| | [`process.context_switch_type`](/docs/attributes-registry/process.md) | string | Specifies whether the context switches for this data point were voluntary or involuntary. | `voluntary`; `involuntary` | `Recommended` | ![Experimental](https://img.shields.io/badge/-experimental-blue) | +### `process.context_switch_type` Values + `process.context_switch_type` has the following list of well-known values. If one of them applies, then the respective value MUST be used; otherwise, a custom value MAY be used. | Value | Description | Stability | @@ -316,6 +326,8 @@ This metric is [recommended][MetricRecommended]. |---|---|---|---|---|---| | [`process.paging.fault_type`](/docs/attributes-registry/process.md) | string | The type of page fault for this data point. Type `major` is for major/hard page faults, and `minor` is for minor/soft page faults. | `major`; `minor` | `Recommended` | ![Experimental](https://img.shields.io/badge/-experimental-blue) | +### `process.paging.fault_type` Values + `process.paging.fault_type` has the following list of well-known values. If one of them applies, then the respective value MUST be used; otherwise, a custom value MAY be used. | Value | Description | Stability | diff --git a/docs/system/system-metrics.md b/docs/system/system-metrics.md index b3f432abae..41ed7a53ad 100644 --- a/docs/system/system-metrics.md +++ b/docs/system/system-metrics.md @@ -126,6 +126,8 @@ This metric is [recommended][MetricRecommended]. **[1]:** Following states SHOULD be used: `user`, `system`, `nice`, `idle`, `iowait`, `interrupt`, `steal` +### `cpu.mode` Values + `cpu.mode` has the following list of well-known values. If one of them applies, then the respective value MUST be used; otherwise, a custom value MAY be used. | Value | Description | Stability | @@ -166,6 +168,8 @@ This metric is [opt-in][MetricOptIn]. **[1]:** Following modes SHOULD be used: `user`, `system`, `nice`, `idle`, `iowait`, `interrupt`, `steal` +### `cpu.mode` Values + `cpu.mode` has the following list of well-known values. If one of them applies, then the respective value MUST be used; otherwise, a custom value MAY be used. | Value | Description | Stability | @@ -275,6 +279,8 @@ available on the system, that is `system.memory.limit`. |---|---|---|---|---|---| | [`system.memory.state`](/docs/attributes-registry/system.md) | string | The memory state | `free`; `cached` | `Recommended` | ![Experimental](https://img.shields.io/badge/-experimental-blue) | +### `system.memory.state` Values + `system.memory.state` has the following list of well-known values. If one of them applies, then the respective value MUST be used; otherwise, a custom value MAY be used. | Value | Description | Stability | @@ -353,6 +359,8 @@ This metric is [recommended][MetricRecommended]. |---|---|---|---|---|---| | [`system.memory.state`](/docs/attributes-registry/system.md) | string | The memory state | `free`; `cached` | `Recommended` | ![Experimental](https://img.shields.io/badge/-experimental-blue) | +### `system.memory.state` Values + `system.memory.state` has the following list of well-known values. If one of them applies, then the respective value MUST be used; otherwise, a custom value MAY be used. | Value | Description | Stability | @@ -391,6 +399,8 @@ This metric is [recommended][MetricRecommended]. | [`system.device`](/docs/attributes-registry/system.md) | string | Unique identifier for the device responsible for managing paging operations. | `/dev/dm-0` | `Recommended` | ![Experimental](https://img.shields.io/badge/-experimental-blue) | | [`system.paging.state`](/docs/attributes-registry/system.md) | string | The memory paging state | `free` | `Recommended` | ![Experimental](https://img.shields.io/badge/-experimental-blue) | +### `system.paging.state` Values + `system.paging.state` has the following list of well-known values. If one of them applies, then the respective value MUST be used; otherwise, a custom value MAY be used. | Value | Description | Stability | @@ -423,6 +433,8 @@ This metric is [recommended][MetricRecommended]. | [`system.device`](/docs/attributes-registry/system.md) | string | Unique identifier for the device responsible for managing paging operations. | `/dev/dm-0` | `Recommended` | ![Experimental](https://img.shields.io/badge/-experimental-blue) | | [`system.paging.state`](/docs/attributes-registry/system.md) | string | The memory paging state | `free` | `Recommended` | ![Experimental](https://img.shields.io/badge/-experimental-blue) | +### `system.paging.state` Values + `system.paging.state` has the following list of well-known values. If one of them applies, then the respective value MUST be used; otherwise, a custom value MAY be used. | Value | Description | Stability | @@ -454,6 +466,8 @@ This metric is [recommended][MetricRecommended]. |---|---|---|---|---|---| | [`system.paging.type`](/docs/attributes-registry/system.md) | string | The memory paging type | `minor` | `Recommended` | ![Experimental](https://img.shields.io/badge/-experimental-blue) | +### `system.paging.type` Values + `system.paging.type` has the following list of well-known values. If one of them applies, then the respective value MUST be used; otherwise, a custom value MAY be used. | Value | Description | Stability | @@ -486,6 +500,8 @@ This metric is [recommended][MetricRecommended]. | [`system.paging.direction`](/docs/attributes-registry/system.md) | string | The paging access direction | `in` | `Recommended` | ![Experimental](https://img.shields.io/badge/-experimental-blue) | | [`system.paging.type`](/docs/attributes-registry/system.md) | string | The memory paging type | `minor` | `Recommended` | ![Experimental](https://img.shields.io/badge/-experimental-blue) | +### `system.paging.direction` Values + `system.paging.direction` has the following list of well-known values. If one of them applies, then the respective value MUST be used; otherwise, a custom value MAY be used. | Value | Description | Stability | @@ -493,6 +509,8 @@ This metric is [recommended][MetricRecommended]. | `in` | in | ![Experimental](https://img.shields.io/badge/-experimental-blue) | | `out` | out | ![Experimental](https://img.shields.io/badge/-experimental-blue) | +### `system.paging.type` Values + `system.paging.type` has the following list of well-known values. If one of them applies, then the respective value MUST be used; otherwise, a custom value MAY be used. | Value | Description | Stability | @@ -529,6 +547,8 @@ This metric is [recommended][MetricRecommended]. | [`disk.io.direction`](/docs/attributes-registry/disk.md) | string | The disk IO operation direction. | `read` | `Recommended` | ![Experimental](https://img.shields.io/badge/-experimental-blue) | | [`system.device`](/docs/attributes-registry/system.md) | string | The device identifier | `(identifier)` | `Recommended` | ![Experimental](https://img.shields.io/badge/-experimental-blue) | +### `disk.io.direction` Values + `disk.io.direction` has the following list of well-known values. If one of them applies, then the respective value MUST be used; otherwise, a custom value MAY be used. | Value | Description | Stability | @@ -561,6 +581,8 @@ This metric is [recommended][MetricRecommended]. | [`disk.io.direction`](/docs/attributes-registry/disk.md) | string | The disk IO operation direction. | `read` | `Recommended` | ![Experimental](https://img.shields.io/badge/-experimental-blue) | | [`system.device`](/docs/attributes-registry/system.md) | string | The device identifier | `(identifier)` | `Recommended` | ![Experimental](https://img.shields.io/badge/-experimental-blue) | +### `disk.io.direction` Values + `disk.io.direction` has the following list of well-known values. If one of them applies, then the respective value MUST be used; otherwise, a custom value MAY be used. | Value | Description | Stability | @@ -629,6 +651,8 @@ This metric is [recommended][MetricRecommended]. | [`disk.io.direction`](/docs/attributes-registry/disk.md) | string | The disk IO operation direction. | `read` | `Recommended` | ![Experimental](https://img.shields.io/badge/-experimental-blue) | | [`system.device`](/docs/attributes-registry/system.md) | string | The device identifier | `(identifier)` | `Recommended` | ![Experimental](https://img.shields.io/badge/-experimental-blue) | +### `disk.io.direction` Values + `disk.io.direction` has the following list of well-known values. If one of them applies, then the respective value MUST be used; otherwise, a custom value MAY be used. | Value | Description | Stability | @@ -661,6 +685,8 @@ This metric is [recommended][MetricRecommended]. | [`disk.io.direction`](/docs/attributes-registry/disk.md) | string | The disk IO operation direction. | `read` | `Recommended` | ![Experimental](https://img.shields.io/badge/-experimental-blue) | | [`system.device`](/docs/attributes-registry/system.md) | string | The device identifier | `(identifier)` | `Recommended` | ![Experimental](https://img.shields.io/badge/-experimental-blue) | +### `disk.io.direction` Values + `disk.io.direction` has the following list of well-known values. If one of them applies, then the respective value MUST be used; otherwise, a custom value MAY be used. | Value | Description | Stability | @@ -727,6 +753,8 @@ SHOULD equal the total storage capacity of the filesystem, that is `system.files | [`system.filesystem.state`](/docs/attributes-registry/system.md) | string | The filesystem state | `used` | `Recommended` | ![Experimental](https://img.shields.io/badge/-experimental-blue) | | [`system.filesystem.type`](/docs/attributes-registry/system.md) | string | The filesystem type | `ext4` | `Recommended` | ![Experimental](https://img.shields.io/badge/-experimental-blue) | +### `system.filesystem.state` Values + `system.filesystem.state` has the following list of well-known values. If one of them applies, then the respective value MUST be used; otherwise, a custom value MAY be used. | Value | Description | Stability | @@ -735,6 +763,8 @@ SHOULD equal the total storage capacity of the filesystem, that is `system.files | `reserved` | reserved | ![Experimental](https://img.shields.io/badge/-experimental-blue) | | `used` | used | ![Experimental](https://img.shields.io/badge/-experimental-blue) | +### `system.filesystem.type` Values + `system.filesystem.type` has the following list of well-known values. If one of them applies, then the respective value MUST be used; otherwise, a custom value MAY be used. | Value | Description | Stability | @@ -774,6 +804,8 @@ This metric is [recommended][MetricRecommended]. | [`system.filesystem.state`](/docs/attributes-registry/system.md) | string | The filesystem state | `used` | `Recommended` | ![Experimental](https://img.shields.io/badge/-experimental-blue) | | [`system.filesystem.type`](/docs/attributes-registry/system.md) | string | The filesystem type | `ext4` | `Recommended` | ![Experimental](https://img.shields.io/badge/-experimental-blue) | +### `system.filesystem.state` Values + `system.filesystem.state` has the following list of well-known values. If one of them applies, then the respective value MUST be used; otherwise, a custom value MAY be used. | Value | Description | Stability | @@ -782,6 +814,8 @@ This metric is [recommended][MetricRecommended]. | `reserved` | reserved | ![Experimental](https://img.shields.io/badge/-experimental-blue) | | `used` | used | ![Experimental](https://img.shields.io/badge/-experimental-blue) | +### `system.filesystem.type` Values + `system.filesystem.type` has the following list of well-known values. If one of them applies, then the respective value MUST be used; otherwise, a custom value MAY be used. | Value | Description | Stability | @@ -820,6 +854,8 @@ This metric is [opt-in][MetricOptIn]. | [`system.filesystem.mountpoint`](/docs/attributes-registry/system.md) | string | The filesystem mount path | `/mnt/data` | `Recommended` | ![Experimental](https://img.shields.io/badge/-experimental-blue) | | [`system.filesystem.type`](/docs/attributes-registry/system.md) | string | The filesystem type | `ext4` | `Recommended` | ![Experimental](https://img.shields.io/badge/-experimental-blue) | +### `system.filesystem.type` Values + `system.filesystem.type` has the following list of well-known values. If one of them applies, then the respective value MUST be used; otherwise, a custom value MAY be used. | Value | Description | Stability | @@ -866,6 +902,8 @@ This metric is [recommended][MetricRecommended]. | [`network.interface.name`](/docs/attributes-registry/network.md) | string | The network interface name. | `lo`; `eth0` | `Recommended` | ![Experimental](https://img.shields.io/badge/-experimental-blue) | | [`network.io.direction`](/docs/attributes-registry/network.md) | string | The network IO operation direction. | `transmit` | `Recommended` | ![Experimental](https://img.shields.io/badge/-experimental-blue) | +### `network.io.direction` Values + `network.io.direction` has the following list of well-known values. If one of them applies, then the respective value MUST be used; otherwise, a custom value MAY be used. | Value | Description | Stability | @@ -898,6 +936,8 @@ This metric is [recommended][MetricRecommended]. | [`network.io.direction`](/docs/attributes-registry/network.md) | string | The network IO operation direction. | `transmit` | `Recommended` | ![Experimental](https://img.shields.io/badge/-experimental-blue) | | [`system.device`](/docs/attributes-registry/system.md) | string | The device identifier | `(identifier)` | `Recommended` | ![Experimental](https://img.shields.io/badge/-experimental-blue) | +### `network.io.direction` Values + `network.io.direction` has the following list of well-known values. If one of them applies, then the respective value MUST be used; otherwise, a custom value MAY be used. | Value | Description | Stability | @@ -936,6 +976,8 @@ This metric is [recommended][MetricRecommended]. | [`network.interface.name`](/docs/attributes-registry/network.md) | string | The network interface name. | `lo`; `eth0` | `Recommended` | ![Experimental](https://img.shields.io/badge/-experimental-blue) | | [`network.io.direction`](/docs/attributes-registry/network.md) | string | The network IO operation direction. | `transmit` | `Recommended` | ![Experimental](https://img.shields.io/badge/-experimental-blue) | +### `network.io.direction` Values + `network.io.direction` has the following list of well-known values. If one of them applies, then the respective value MUST be used; otherwise, a custom value MAY be used. | Value | Description | Stability | @@ -968,6 +1010,8 @@ This metric is [recommended][MetricRecommended]. | [`network.interface.name`](/docs/attributes-registry/network.md) | string | The network interface name. | `lo`; `eth0` | `Recommended` | ![Experimental](https://img.shields.io/badge/-experimental-blue) | | [`network.io.direction`](/docs/attributes-registry/network.md) | string | The network IO operation direction. | `transmit` | `Recommended` | ![Experimental](https://img.shields.io/badge/-experimental-blue) | +### `network.io.direction` Values + `network.io.direction` has the following list of well-known values. If one of them applies, then the respective value MUST be used; otherwise, a custom value MAY be used. | Value | Description | Stability | @@ -1007,6 +1051,8 @@ Consider always setting the transport when setting a port number, since a port number is ambiguous without knowing the transport. For example different processes could be listening on TCP port 12345 and UDP port 12345. +### `network.transport` Values + `network.transport` has the following list of well-known values. If one of them applies, then the respective value MUST be used; otherwise, a custom value MAY be used. | Value | Description | Stability | @@ -1017,6 +1063,8 @@ different processes could be listening on TCP port 12345 and UDP port 12345. | `udp` | UDP | ![Stable](https://img.shields.io/badge/-stable-lightgreen) | | `unix` | Unix domain socket | ![Stable](https://img.shields.io/badge/-stable-lightgreen) | +### `system.network.state` Values + `system.network.state` has the following list of well-known values. If one of them applies, then the respective value MUST be used; otherwise, a custom value MAY be used. | Value | Description | Stability | @@ -1062,6 +1110,8 @@ This metric is [recommended][MetricRecommended]. |---|---|---|---|---|---| | [`system.process.status`](/docs/attributes-registry/system.md) | string | The process state, e.g., [Linux Process State Codes](https://man7.org/linux/man-pages/man1/ps.1.html#PROCESS_STATE_CODES) | `running` | `Recommended` | ![Experimental](https://img.shields.io/badge/-experimental-blue) | +### `system.process.status` Values + `system.process.status` has the following list of well-known values. If one of them applies, then the respective value MUST be used; otherwise, a custom value MAY be used. | Value | Description | Stability | @@ -1175,6 +1225,8 @@ See also the [Slab allocator](https://blogs.oracle.com/linux/post/understanding- |---|---|---|---|---|---| | [`linux.memory.slab.state`](/docs/attributes-registry/linux.md) | string | The Linux Slab memory state | `reclaimable`; `unreclaimable` | `Recommended` | ![Experimental](https://img.shields.io/badge/-experimental-blue) | +### `linux.memory.slab.state` Values + `linux.memory.slab.state` has the following list of well-known values. If one of them applies, then the respective value MUST be used; otherwise, a custom value MAY be used. | Value | Description | Stability | diff --git a/templates/registry/markdown/enum_macros.j2 b/templates/registry/markdown/enum_macros.j2 index 6ad5288a78..7259531b73 100644 --- a/templates/registry/markdown/enum_macros.j2 +++ b/templates/registry/markdown/enum_macros.j2 @@ -1,6 +1,8 @@ {% import 'stability.j2' as stability %} {% macro filter(member) %}{% if snippet_type is not defined or (member.deprecated is none or member.deprecated == "") %}{{ "True" }}{% else %}{{ "False" }}{% endif %}{% endmacro %} {% macro table(enum, notes) %} +### `{{enum.name}}` Values + `{{enum.name}}` has the following list of well-known values. If one of them applies, then the respective value MUST be used; otherwise, a custom value MAY be used. | Value | Description | Stability | From 908b31272fcc53fed523d6348abcac900d1cf8de Mon Sep 17 00:00:00 2001 From: Daniel Dyla Date: Wed, 13 Nov 2024 11:10:32 -0700 Subject: [PATCH 2/2] Generate TOC --- docs/cicd/cicd-metrics.md | 10 +++++++++ docs/database/cosmosdb.md | 5 +++++ docs/database/database-metrics.md | 5 +++++ docs/database/database-spans.md | 2 ++ docs/dns/dns-metrics.md | 1 + docs/dotnet/dotnet-aspnetcore-metrics.md | 5 +++++ docs/dotnet/dotnet-kestrel-metrics.md | 18 ++++++++++++++++ docs/dotnet/dotnet-signalr-metrics.md | 4 ++++ docs/faas/faas-metrics.md | 9 ++++++++ docs/faas/faas-spans.md | 4 ++++ docs/gen-ai/gen-ai-events.md | 1 + docs/gen-ai/gen-ai-metrics.md | 13 ++++++++++++ docs/gen-ai/gen-ai-spans.md | 3 +++ docs/gen-ai/openai.md | 4 ++++ docs/general/attributes.md | 4 ++++ docs/general/logs.md | 1 + docs/general/profiles.md | 1 + docs/general/trace-compatibility.md | 1 + docs/hardware/common.md | 7 +++++++ docs/http/http-metrics.md | 15 ++++++++++++++ docs/http/http-spans.md | 6 ++++++ docs/messaging/kafka.md | 2 ++ docs/messaging/messaging-metrics.md | 9 ++++++++ docs/messaging/messaging-spans.md | 3 +++ docs/resource/README.md | 1 + docs/rpc/rpc-metrics.md | 3 +++ docs/rpc/rpc-spans.md | 7 +++++++ docs/runtime/dotnet-metrics.md | 5 +++++ docs/runtime/go-metrics.md | 1 + docs/runtime/jvm-metrics.md | 6 ++++++ docs/runtime/nodejs-metrics.md | 1 + docs/runtime/v8js-metrics.md | 5 +++++ docs/system/process-metrics.md | 6 ++++++ docs/system/system-metrics.md | 26 ++++++++++++++++++++++++ 34 files changed, 194 insertions(+) diff --git a/docs/cicd/cicd-metrics.md b/docs/cicd/cicd-metrics.md index 029f22d957..41f87eb905 100644 --- a/docs/cicd/cicd-metrics.md +++ b/docs/cicd/cicd-metrics.md @@ -12,13 +12,23 @@ linkTitle: CICD metrics - [VCS Metrics](#vcs-metrics) - [Metric: `vcs.change.count`](#metric-vcschangecount) + - [`vcs.change.state` Values](#vcschangestate-values) - [Metric: `vcs.change.duration`](#metric-vcschangeduration) + - [`vcs.change.state` Values](#vcschangestate-values-1) - [Metric: `vcs.change.time_to_approval`](#metric-vcschangetime_to_approval) - [Metric: `vcs.repository.count`](#metric-vcsrepositorycount) - [Metric: `vcs.ref.count`](#metric-vcsrefcount) + - [`vcs.ref.type` Values](#vcsreftype-values) - [Metric: `vcs.ref.lines_delta`](#metric-vcsreflines_delta) + - [`vcs.line_change.type` Values](#vcsline_changetype-values) + - [`vcs.ref.base.type` Values](#vcsrefbasetype-values) + - [`vcs.ref.head.type` Values](#vcsrefheadtype-values) - [Metric: `vcs.ref.revisions_delta`](#metric-vcsrefrevisions_delta) + - [`vcs.ref.base.type` Values](#vcsrefbasetype-values-1) + - [`vcs.ref.head.type` Values](#vcsrefheadtype-values-1) + - [`vcs.revision_delta.direction` Values](#vcsrevision_deltadirection-values) - [Metric: `vcs.ref.time`](#metric-vcsreftime) + - [`vcs.ref.head.type` Values](#vcsrefheadtype-values-2) - [Metric: `vcs.contributor.count`](#metric-vcscontributorcount) diff --git a/docs/database/cosmosdb.md b/docs/database/cosmosdb.md index a6941891fc..db428af200 100644 --- a/docs/database/cosmosdb.md +++ b/docs/database/cosmosdb.md @@ -8,11 +8,16 @@ linkTitle: Cosmos DB - [Semantic Conventions for Microsoft Azure Cosmos DB](#semantic-conventions-for-microsoft-azure-cosmos-db) - [Attributes](#attributes) + - [`db.cosmosdb.connection_mode` Values](#dbcosmosdbconnection_mode-values) + - [`db.cosmosdb.consistency_level` Values](#dbcosmosdbconsistency_level-values) + - [`error.type` Values](#errortype-values) - [Example](#example) - [Operation Level Metrics](#operation-level-metrics) - [Metric: `db.client.operation.duration`](#metric-dbclientoperationduration) - [Metric: `db.client.response.returned_rows`](#metric-dbclientresponsereturned_rows) - [Metric: `db.client.cosmosdb.operation.request_charge`](#metric-dbclientcosmosdboperationrequest_charge) + - [`db.cosmosdb.consistency_level` Values](#dbcosmosdbconsistency_level-values-1) + - [`error.type` Values](#errortype-values-1) - [Metric: `db.client.cosmosdb.active_instance.count`](#metric-dbclientcosmosdbactive_instancecount) diff --git a/docs/database/database-metrics.md b/docs/database/database-metrics.md index cee0d097c0..2e199aa908 100644 --- a/docs/database/database-metrics.md +++ b/docs/database/database-metrics.md @@ -12,11 +12,16 @@ linkTitle: Metrics - [Database operation](#database-operation) - [Metric: `db.client.operation.duration`](#metric-dbclientoperationduration) + - [`db.system` Values](#dbsystem-values) + - [`error.type` Values](#errortype-values) - [Experimental](#experimental) - [Database Response](#database-response) - [Metric: `db.client.response.returned_rows`](#metric-dbclientresponsereturned_rows) + - [`db.system` Values](#dbsystem-values-1) + - [`error.type` Values](#errortype-values-1) - [Connection pools](#connection-pools) - [Metric: `db.client.connection.count`](#metric-dbclientconnectioncount) + - [`db.client.connection.state` Values](#dbclientconnectionstate-values) - [Metric: `db.client.connection.idle.max`](#metric-dbclientconnectionidlemax) - [Metric: `db.client.connection.idle.min`](#metric-dbclientconnectionidlemin) - [Metric: `db.client.connection.max`](#metric-dbclientconnectionmax) diff --git a/docs/database/database-spans.md b/docs/database/database-spans.md index fca5caccb9..74ce64405f 100644 --- a/docs/database/database-spans.md +++ b/docs/database/database-spans.md @@ -12,6 +12,8 @@ linkTitle: Client Calls - [Name](#name) - [Common attributes](#common-attributes) + - [`db.system` Values](#dbsystem-values) + - [`error.type` Values](#errortype-values) - [Notes and well-known identifiers for `db.system`](#notes-and-well-known-identifiers-for-dbsystem) - [Sanitization of `db.query.text`](#sanitization-of-dbquerytext) - [Generating a summary of the query text](#generating-a-summary-of-the-query-text) diff --git a/docs/dns/dns-metrics.md b/docs/dns/dns-metrics.md index 04fe4cba31..9d033bbb41 100644 --- a/docs/dns/dns-metrics.md +++ b/docs/dns/dns-metrics.md @@ -14,6 +14,7 @@ This document defines semantic conventions to apply when instrumenting DNS queri - [Metrics](#metrics) - [Metric: `dns.lookup.duration`](#metric-dnslookupduration) + - [`error.type` Values](#errortype-values) diff --git a/docs/dotnet/dotnet-aspnetcore-metrics.md b/docs/dotnet/dotnet-aspnetcore-metrics.md index 20d23f455b..fdeda383a1 100644 --- a/docs/dotnet/dotnet-aspnetcore-metrics.md +++ b/docs/dotnet/dotnet-aspnetcore-metrics.md @@ -13,14 +13,19 @@ This article defines semantic conventions for ASP.NET Core metrics. - [Server](#server) - [Routing](#routing) - [Metric: `aspnetcore.routing.match_attempts`](#metric-aspnetcoreroutingmatch_attempts) + - [`aspnetcore.routing.match_status` Values](#aspnetcoreroutingmatch_status-values) - [Exceptions](#exceptions) - [Metric: `aspnetcore.diagnostics.exceptions`](#metric-aspnetcorediagnosticsexceptions) + - [`aspnetcore.diagnostics.exception.result` Values](#aspnetcorediagnosticsexceptionresult-values) + - [`error.type` Values](#errortype-values) - [Rate-limiting](#rate-limiting) - [Metric: `aspnetcore.rate_limiting.active_request_leases`](#metric-aspnetcorerate_limitingactive_request_leases) - [Metric: `aspnetcore.rate_limiting.request_lease.duration`](#metric-aspnetcorerate_limitingrequest_leaseduration) - [Metric: `aspnetcore.rate_limiting.queued_requests`](#metric-aspnetcorerate_limitingqueued_requests) - [Metric: `aspnetcore.rate_limiting.request.time_in_queue`](#metric-aspnetcorerate_limitingrequesttime_in_queue) + - [`aspnetcore.rate_limiting.result` Values](#aspnetcorerate_limitingresult-values) - [Metric: `aspnetcore.rate_limiting.requests`](#metric-aspnetcorerate_limitingrequests) + - [`aspnetcore.rate_limiting.result` Values](#aspnetcorerate_limitingresult-values-1) diff --git a/docs/dotnet/dotnet-kestrel-metrics.md b/docs/dotnet/dotnet-kestrel-metrics.md index 04f0edc983..90631514d7 100644 --- a/docs/dotnet/dotnet-kestrel-metrics.md +++ b/docs/dotnet/dotnet-kestrel-metrics.md @@ -12,13 +12,31 @@ This article defines semantic conventions for Kestrel web server. - [Kestrel endpoint](#kestrel-endpoint) - [Metric: `kestrel.active_connections`](#metric-kestrelactive_connections) + - [`network.transport` Values](#networktransport-values) + - [`network.type` Values](#networktype-values) - [Metric: `kestrel.connection.duration`](#metric-kestrelconnectionduration) + - [`error.type` Values](#errortype-values) + - [`network.transport` Values](#networktransport-values-1) + - [`network.type` Values](#networktype-values-1) - [Metric: `kestrel.rejected_connections`](#metric-kestrelrejected_connections) + - [`network.transport` Values](#networktransport-values-2) + - [`network.type` Values](#networktype-values-2) - [Metric: `kestrel.queued_connections`](#metric-kestrelqueued_connections) + - [`network.transport` Values](#networktransport-values-3) + - [`network.type` Values](#networktype-values-3) - [Metric: `kestrel.queued_requests`](#metric-kestrelqueued_requests) + - [`network.transport` Values](#networktransport-values-4) + - [`network.type` Values](#networktype-values-4) - [Metric: `kestrel.upgraded_connections`](#metric-kestrelupgraded_connections) + - [`network.transport` Values](#networktransport-values-5) + - [`network.type` Values](#networktype-values-5) - [Metric: `kestrel.tls_handshake.duration`](#metric-kestreltls_handshakeduration) + - [`error.type` Values](#errortype-values-1) + - [`network.transport` Values](#networktransport-values-6) + - [`network.type` Values](#networktype-values-6) - [Metric: `kestrel.active_tls_handshakes`](#metric-kestrelactive_tls_handshakes) + - [`network.transport` Values](#networktransport-values-7) + - [`network.type` Values](#networktype-values-7) diff --git a/docs/dotnet/dotnet-signalr-metrics.md b/docs/dotnet/dotnet-signalr-metrics.md index be57027eac..51090c0bd6 100644 --- a/docs/dotnet/dotnet-signalr-metrics.md +++ b/docs/dotnet/dotnet-signalr-metrics.md @@ -11,7 +11,11 @@ This article defines semantic conventions for SignalR metrics emitted by .NET co - [Metric: `signalr.server.connection.duration`](#metric-signalrserverconnectionduration) + - [`signalr.connection.status` Values](#signalrconnectionstatus-values) + - [`signalr.transport` Values](#signalrtransport-values) - [Metric: `signalr.server.active_connections`](#metric-signalrserveractive_connections) + - [`signalr.connection.status` Values](#signalrconnectionstatus-values-1) + - [`signalr.transport` Values](#signalrtransport-values-1) diff --git a/docs/faas/faas-metrics.md b/docs/faas/faas-metrics.md index cbaed087ed..082d96e602 100644 --- a/docs/faas/faas-metrics.md +++ b/docs/faas/faas-metrics.md @@ -20,14 +20,23 @@ operations. By adding FaaS attributes to metric events it allows for finely tune - [Metric Instruments](#metric-instruments) - [FaaS Instance](#faas-instance) - [Metric: `faas.invoke_duration`](#metric-faasinvoke_duration) + - [`faas.trigger` Values](#faastrigger-values) - [Metric: `faas.init_duration`](#metric-faasinit_duration) + - [`faas.trigger` Values](#faastrigger-values-1) - [Metric: `faas.coldstarts`](#metric-faascoldstarts) + - [`faas.trigger` Values](#faastrigger-values-2) - [Metric: `faas.errors`](#metric-faaserrors) + - [`faas.trigger` Values](#faastrigger-values-3) - [Metric: `faas.invocations`](#metric-faasinvocations) + - [`faas.trigger` Values](#faastrigger-values-4) - [Metric: `faas.timeouts`](#metric-faastimeouts) + - [`faas.trigger` Values](#faastrigger-values-5) - [Metric: `faas.mem_usage`](#metric-faasmem_usage) + - [`faas.trigger` Values](#faastrigger-values-6) - [Metric: `faas.cpu_usage`](#metric-faascpu_usage) + - [`faas.trigger` Values](#faastrigger-values-7) - [Metric: `faas.net_io`](#metric-faasnet_io) + - [`faas.trigger` Values](#faastrigger-values-8) - [References](#references) - [Metric References](#metric-references) diff --git a/docs/faas/faas-spans.md b/docs/faas/faas-spans.md index 02a0764ead..2ba8bb3802 100644 --- a/docs/faas/faas-spans.md +++ b/docs/faas/faas-spans.md @@ -16,14 +16,18 @@ See also the [additional instructions for instrumenting AWS Lambda](aws-lambda.m - [General Attributes](#general-attributes) + - [`faas.trigger` Values](#faastrigger-values) - [Function Name](#function-name) - [Difference between invocation and instance](#difference-between-invocation-and-instance) - [Incoming Invocations](#incoming-invocations) - [Incoming FaaS Span attributes](#incoming-faas-span-attributes) + - [`faas.trigger` Values](#faastrigger-values-1) - [Resource attributes as incoming FaaS span attributes](#resource-attributes-as-incoming-faas-span-attributes) - [Outgoing Invocations](#outgoing-invocations) + - [`faas.invoked_provider` Values](#faasinvoked_provider-values) - [Function Trigger Type](#function-trigger-type) - [Datasource](#datasource) + - [`faas.document.operation` Values](#faasdocumentoperation-values) - [HTTP](#http) - [PubSub](#pubsub) - [Timer](#timer) diff --git a/docs/gen-ai/gen-ai-events.md b/docs/gen-ai/gen-ai-events.md index 37dd15f8e5..bedafd818e 100644 --- a/docs/gen-ai/gen-ai-events.md +++ b/docs/gen-ai/gen-ai-events.md @@ -11,6 +11,7 @@ linkTitle: Generative AI events - [Common attributes](#common-attributes) + - [`gen_ai.system` Values](#gen_aisystem-values) - [System event](#system-event) - [User event](#user-event) - [Assistant event](#assistant-event) diff --git a/docs/gen-ai/gen-ai-metrics.md b/docs/gen-ai/gen-ai-metrics.md index 0981a02221..1cc474fee6 100644 --- a/docs/gen-ai/gen-ai-metrics.md +++ b/docs/gen-ai/gen-ai-metrics.md @@ -12,11 +12,24 @@ linkTitle: Generative AI metrics - [Generative AI Client Metrics](#generative-ai-client-metrics) - [Metric: `gen_ai.client.token.usage`](#metric-gen_aiclienttokenusage) + - [`gen_ai.operation.name` Values](#gen_aioperationname-values) + - [`gen_ai.system` Values](#gen_aisystem-values) + - [`gen_ai.token.type` Values](#gen_aitokentype-values) - [Metric: `gen_ai.client.operation.duration`](#metric-gen_aiclientoperationduration) + - [`error.type` Values](#errortype-values) + - [`gen_ai.operation.name` Values](#gen_aioperationname-values-1) + - [`gen_ai.system` Values](#gen_aisystem-values-1) - [Generative AI Model Server Metrics](#generative-ai-model-server-metrics) - [Metric: `gen_ai.server.request.duration`](#metric-gen_aiserverrequestduration) + - [`error.type` Values](#errortype-values-1) + - [`gen_ai.operation.name` Values](#gen_aioperationname-values-2) + - [`gen_ai.system` Values](#gen_aisystem-values-2) - [Metric: `gen_ai.server.time_per_output_token`](#metric-gen_aiservertime_per_output_token) + - [`gen_ai.operation.name` Values](#gen_aioperationname-values-3) + - [`gen_ai.system` Values](#gen_aisystem-values-3) - [Metric: `gen_ai.server.time_to_first_token`](#metric-gen_aiservertime_to_first_token) + - [`gen_ai.operation.name` Values](#gen_aioperationname-values-4) + - [`gen_ai.system` Values](#gen_aisystem-values-4) diff --git a/docs/gen-ai/gen-ai-spans.md b/docs/gen-ai/gen-ai-spans.md index 54e439407d..9d741105ec 100644 --- a/docs/gen-ai/gen-ai-spans.md +++ b/docs/gen-ai/gen-ai-spans.md @@ -12,6 +12,9 @@ linkTitle: Generative AI traces - [Name](#name) - [GenAI attributes](#genai-attributes) + - [`error.type` Values](#errortype-values) + - [`gen_ai.operation.name` Values](#gen_aioperationname-values) + - [`gen_ai.system` Values](#gen_aisystem-values) - [Capturing inputs and outputs](#capturing-inputs-and-outputs) diff --git a/docs/gen-ai/openai.md b/docs/gen-ai/openai.md index 5d74e5970d..716b3e1626 100644 --- a/docs/gen-ai/openai.md +++ b/docs/gen-ai/openai.md @@ -11,6 +11,10 @@ linkTitle: OpenAI traces and metrics - [OpenAI Spans](#openai-spans) + - [`error.type` Values](#errortype-values) + - [`gen_ai.openai.request.response_format` Values](#gen_aiopenairequestresponse_format-values) + - [`gen_ai.openai.request.service_tier` Values](#gen_aiopenairequestservice_tier-values) + - [`gen_ai.operation.name` Values](#gen_aioperationname-values) - [OpenAI Metrics](#openai-metrics) - [Metric: `gen_ai.client.token.usage`](#metric-gen_aiclienttokenusage) - [Metric: `gen_ai.client.operation.duration`](#metric-gen_aiclientoperationduration) diff --git a/docs/general/attributes.md b/docs/general/attributes.md index 2689e463e8..993e0fef69 100644 --- a/docs/general/attributes.md +++ b/docs/general/attributes.md @@ -24,12 +24,16 @@ Particular operations may refer to or require some of these attributes. - [Source](#source) - [Destination](#destination) - [Other network attributes](#other-network-attributes) + - [`network.transport` Values](#networktransport-values) + - [`network.type` Values](#networktype-values) - [`network.peer.*` and `network.local.*` attributes](#networkpeer-and-networklocal-attributes) - [Client/server examples using `network.peer.*`](#clientserver-examples-using-networkpeer) - [Simple client/server example](#simple-clientserver-example) - [Client/server example with reverse proxy](#clientserver-example-with-reverse-proxy) - [Client/server example with forward proxy](#clientserver-example-with-forward-proxy) - [Network connection and carrier attributes](#network-connection-and-carrier-attributes) + - [`network.connection.subtype` Values](#networkconnectionsubtype-values) + - [`network.connection.type` Values](#networkconnectiontype-values) - [General remote service attributes](#general-remote-service-attributes) - [General identity attributes](#general-identity-attributes) - [General thread attributes](#general-thread-attributes) diff --git a/docs/general/logs.md b/docs/general/logs.md index 7a9ca9dc36..55c3e2c8ee 100644 --- a/docs/general/logs.md +++ b/docs/general/logs.md @@ -18,6 +18,7 @@ They may be used in any Log Record they apply to. - [Log Media](#log-media) - [Log File](#log-file) - [I/O Stream](#io-stream) + - [`log.iostream` Values](#logiostream-values) diff --git a/docs/general/profiles.md b/docs/general/profiles.md index 3524eba4e4..afb960fa14 100644 --- a/docs/general/profiles.md +++ b/docs/general/profiles.md @@ -9,6 +9,7 @@ linkTitle: Profiles - [Frame types](#frame-types) + - [`profile.frame.type` Values](#profileframetype-values) diff --git a/docs/general/trace-compatibility.md b/docs/general/trace-compatibility.md index d47ecad523..a75ffd0fa6 100644 --- a/docs/general/trace-compatibility.md +++ b/docs/general/trace-compatibility.md @@ -14,6 +14,7 @@ compatibility components, e.g. OpenTracing Shim layer. - [OpenTracing](#opentracing) + - [`opentracing.ref_type` Values](#opentracingref_type-values) diff --git a/docs/hardware/common.md b/docs/hardware/common.md index 2b8821b2ea..f76074a394 100644 --- a/docs/hardware/common.md +++ b/docs/hardware/common.md @@ -9,10 +9,17 @@ linkTitle: Common Hardware Metrics - [Common hardware metrics](#common-hardware-metrics) + - [`hw.type` Values](#hwtype-values) - [Metric: `hw.energy`](#metric-hwenergy) + - [`hw.type` Values](#hwtype-values-1) - [Metric: `hw.errors`](#metric-hwerrors) + - [`error.type` Values](#errortype-values) + - [`hw.type` Values](#hwtype-values-2) - [Metric: `hw.power`](#metric-hwpower) + - [`hw.type` Values](#hwtype-values-3) - [Metric: `hw.status`](#metric-hwstatus) + - [`hw.state` Values](#hwstate-values) + - [`hw.type` Values](#hwtype-values-4) diff --git a/docs/http/http-metrics.md b/docs/http/http-metrics.md index a008168525..abe3c51333 100644 --- a/docs/http/http-metrics.md +++ b/docs/http/http-metrics.md @@ -16,16 +16,31 @@ operations. By adding HTTP attributes to metric events it allows for finely tune - [HTTP Server](#http-server) - [Metric: `http.server.request.duration`](#metric-httpserverrequestduration) + - [`error.type` Values](#errortype-values) + - [`http.request.method` Values](#httprequestmethod-values) - [Metric: `http.server.active_requests`](#metric-httpserveractive_requests) + - [`http.request.method` Values](#httprequestmethod-values-1) - [Metric: `http.server.request.body.size`](#metric-httpserverrequestbodysize) + - [`error.type` Values](#errortype-values-1) + - [`http.request.method` Values](#httprequestmethod-values-2) - [Metric: `http.server.response.body.size`](#metric-httpserverresponsebodysize) + - [`error.type` Values](#errortype-values-2) + - [`http.request.method` Values](#httprequestmethod-values-3) - [HTTP Client](#http-client) - [Metric: `http.client.request.duration`](#metric-httpclientrequestduration) + - [`error.type` Values](#errortype-values-3) + - [`http.request.method` Values](#httprequestmethod-values-4) - [Metric: `http.client.request.body.size`](#metric-httpclientrequestbodysize) + - [`error.type` Values](#errortype-values-4) + - [`http.request.method` Values](#httprequestmethod-values-5) - [Metric: `http.client.response.body.size`](#metric-httpclientresponsebodysize) + - [`error.type` Values](#errortype-values-5) + - [`http.request.method` Values](#httprequestmethod-values-6) - [Metric: `http.client.open_connections`](#metric-httpclientopen_connections) + - [`http.connection.state` Values](#httpconnectionstate-values) - [Metric: `http.client.connection.duration`](#metric-httpclientconnectionduration) - [Metric: `http.client.active_requests`](#metric-httpclientactive_requests) + - [`http.request.method` Values](#httprequestmethod-values-7) diff --git a/docs/http/http-spans.md b/docs/http/http-spans.md index eb199a0501..a7cf9fe28a 100644 --- a/docs/http/http-spans.md +++ b/docs/http/http-spans.md @@ -17,6 +17,9 @@ and various HTTP versions like 1.1, 2 and SPDY. - [Name](#name) - [Status](#status) - [HTTP client](#http-client) + - [`error.type` Values](#errortype-values) + - [`http.request.method` Values](#httprequestmethod-values) + - [`network.transport` Values](#networktransport-values) - [HTTP client span duration](#http-client-span-duration) - [HTTP request retries and redirects](#http-request-retries-and-redirects) - [HTTP server](#http-server) @@ -25,6 +28,9 @@ and various HTTP versions like 1.1, 2 and SPDY. - [Simple client/server example](#simple-clientserver-example) - [Client/server example with reverse proxy](#clientserver-example-with-reverse-proxy) - [HTTP server semantic conventions](#http-server-semantic-conventions) + - [`error.type` Values](#errortype-values-1) + - [`http.request.method` Values](#httprequestmethod-values-1) + - [`network.transport` Values](#networktransport-values-1) - [Examples](#examples) - [HTTP client-server example](#http-client-server-example) - [HTTP client retries examples](#http-client-retries-examples) diff --git a/docs/messaging/kafka.md b/docs/messaging/kafka.md index 43e65fcd9b..20c8c530fa 100644 --- a/docs/messaging/kafka.md +++ b/docs/messaging/kafka.md @@ -9,6 +9,8 @@ linkTitle: Kafka - [Span attributes](#span-attributes) + - [`error.type` Values](#errortype-values) + - [`messaging.operation.type` Values](#messagingoperationtype-values) - [Examples](#examples) - [Apache Kafka with Quarkus or Spring Boot Example](#apache-kafka-with-quarkus-or-spring-boot-example) diff --git a/docs/messaging/messaging-metrics.md b/docs/messaging/messaging-metrics.md index b5ced69611..54da587469 100644 --- a/docs/messaging/messaging-metrics.md +++ b/docs/messaging/messaging-metrics.md @@ -8,11 +8,20 @@ - [Common metrics](#common-metrics) - [Metric: `messaging.client.operation.duration`](#metric-messagingclientoperationduration) + - [`error.type` Values](#errortype-values) + - [`messaging.operation.type` Values](#messagingoperationtype-values) + - [`messaging.system` Values](#messagingsystem-values) - [Producer metrics](#producer-metrics) - [Metric: `messaging.client.sent.messages`](#metric-messagingclientsentmessages) + - [`error.type` Values](#errortype-values-1) + - [`messaging.system` Values](#messagingsystem-values-1) - [Consumer metrics](#consumer-metrics) - [Metric: `messaging.client.consumed.messages`](#metric-messagingclientconsumedmessages) + - [`error.type` Values](#errortype-values-2) + - [`messaging.system` Values](#messagingsystem-values-2) - [Metric: `messaging.process.duration`](#metric-messagingprocessduration) + - [`error.type` Values](#errortype-values-3) + - [`messaging.system` Values](#messagingsystem-values-3) diff --git a/docs/messaging/messaging-spans.md b/docs/messaging/messaging-spans.md index 64dd9ce500..accbeb3939 100644 --- a/docs/messaging/messaging-spans.md +++ b/docs/messaging/messaging-spans.md @@ -27,6 +27,9 @@ - [Consumer spans](#consumer-spans) - [Message creation context as parent of "Process" span](#message-creation-context-as-parent-of-process-span) - [Messaging attributes](#messaging-attributes) + - [`error.type` Values](#errortype-values) + - [`messaging.operation.type` Values](#messagingoperationtype-values) + - [`messaging.system` Values](#messagingsystem-values) - [Recording per-message attributes on batch operations](#recording-per-message-attributes-on-batch-operations) - [Examples](#examples) - [Topic with multiple consumers](#topic-with-multiple-consumers) diff --git a/docs/resource/README.md b/docs/resource/README.md index a29d46a762..1c02b6f98c 100644 --- a/docs/resource/README.md +++ b/docs/resource/README.md @@ -23,6 +23,7 @@ This document defines standard attributes for resources. These attributes are ty - [Semantic Attributes with SDK-provided Default Value](#semantic-attributes-with-sdk-provided-default-value) - [Service](#service) - [Telemetry SDK](#telemetry-sdk) + - [`telemetry.sdk.language` Values](#telemetrysdklanguage-values) - [Telemetry Distro](#telemetry-distro) - [Compute Unit](#compute-unit) - [Compute Instance](#compute-instance) diff --git a/docs/rpc/rpc-metrics.md b/docs/rpc/rpc-metrics.md index d545a79a1b..ca296f8d39 100644 --- a/docs/rpc/rpc-metrics.md +++ b/docs/rpc/rpc-metrics.md @@ -30,6 +30,9 @@ metrics can be filtered for finer grain analysis. - [Metric: `rpc.client.requests_per_rpc`](#metric-rpcclientrequests_per_rpc) - [Metric: `rpc.client.responses_per_rpc`](#metric-rpcclientresponses_per_rpc) - [Attributes](#attributes) + - [`network.transport` Values](#networktransport-values) + - [`network.type` Values](#networktype-values) + - [`rpc.system` Values](#rpcsystem-values) - [Service name](#service-name) - [Semantic Conventions for specific RPC technologies](#semantic-conventions-for-specific-rpc-technologies) diff --git a/docs/rpc/rpc-spans.md b/docs/rpc/rpc-spans.md index de6d9824dc..1911cf5d89 100644 --- a/docs/rpc/rpc-spans.md +++ b/docs/rpc/rpc-spans.md @@ -17,9 +17,16 @@ This document defines how to describe remote procedure calls - [Span name](#span-name) - [Service name](#service-name) - [Client attributes](#client-attributes) + - [`network.transport` Values](#networktransport-values) + - [`network.type` Values](#networktype-values) + - [`rpc.system` Values](#rpcsystem-values) - [Server attributes](#server-attributes) + - [`network.transport` Values](#networktransport-values-1) + - [`network.type` Values](#networktype-values-1) + - [`rpc.system` Values](#rpcsystem-values-1) - [Events](#events) - [Message event](#message-event) + - [`rpc.message.type` Values](#rpcmessagetype-values) - [Distinction from HTTP spans](#distinction-from-http-spans) - [Semantic Conventions for specific RPC technologies](#semantic-conventions-for-specific-rpc-technologies) diff --git a/docs/runtime/dotnet-metrics.md b/docs/runtime/dotnet-metrics.md index 2704610ea5..c3fa222e08 100644 --- a/docs/runtime/dotnet-metrics.md +++ b/docs/runtime/dotnet-metrics.md @@ -15,13 +15,17 @@ This document describes semantic conventions for .NET CLR runtime metrics in Ope - [.NET CLR Process](#net-clr-process) - [Metric: `dotnet.process.cpu.count`](#metric-dotnetprocesscpucount) - [Metric: `dotnet.process.cpu.time`](#metric-dotnetprocesscputime) + - [`cpu.mode` Values](#cpumode-values) - [Metric: `dotnet.process.memory.working_set`](#metric-dotnetprocessmemoryworking_set) - [.NET CLR Garbage Collection](#net-clr-garbage-collection) - [Metric: `dotnet.gc.collections`](#metric-dotnetgccollections) + - [`dotnet.gc.heap.generation` Values](#dotnetgcheapgeneration-values) - [Metric: `dotnet.gc.heap.total_allocated`](#metric-dotnetgcheaptotal_allocated) - [Metric: `dotnet.gc.last_collection.memory.committed_size`](#metric-dotnetgclast_collectionmemorycommitted_size) - [Metric: `dotnet.gc.last_collection.heap.size`](#metric-dotnetgclast_collectionheapsize) + - [`dotnet.gc.heap.generation` Values](#dotnetgcheapgeneration-values-1) - [Metric: `dotnet.gc.last_collection.heap.fragmentation.size`](#metric-dotnetgclast_collectionheapfragmentationsize) + - [`dotnet.gc.heap.generation` Values](#dotnetgcheapgeneration-values-2) - [Metric: `dotnet.gc.pause.time`](#metric-dotnetgcpausetime) - [.NET CLR Just-In-Time (JIT) Compiler](#net-clr-just-in-time-jit-compiler) - [Metric: `dotnet.jit.compiled_il.size`](#metric-dotnetjitcompiled_ilsize) @@ -36,6 +40,7 @@ This document describes semantic conventions for .NET CLR runtime metrics in Ope - [Metric: `dotnet.timer.count`](#metric-dotnettimercount) - [Metric: `dotnet.assembly.count`](#metric-dotnetassemblycount) - [Metric: `dotnet.exceptions`](#metric-dotnetexceptions) + - [`error.type` Values](#errortype-values) diff --git a/docs/runtime/go-metrics.md b/docs/runtime/go-metrics.md index 460ccaad20..9e1fe1e4e0 100644 --- a/docs/runtime/go-metrics.md +++ b/docs/runtime/go-metrics.md @@ -15,6 +15,7 @@ These metrics are obtained from Go's [`runtime/metrics`][RuntimeMetrics] package - [Go Memory](#go-memory) - [Metric: `go.memory.used`](#metric-gomemoryused) + - [`go.memory.type` Values](#gomemorytype-values) - [Metric: `go.memory.limit`](#metric-gomemorylimit) - [Metric: `go.memory.allocated`](#metric-gomemoryallocated) - [Metric: `go.memory.allocations`](#metric-gomemoryallocations) diff --git a/docs/runtime/jvm-metrics.md b/docs/runtime/jvm-metrics.md index c357e467c5..f00f3d18d3 100644 --- a/docs/runtime/jvm-metrics.md +++ b/docs/runtime/jvm-metrics.md @@ -14,13 +14,18 @@ This document describes semantic conventions for JVM metrics in OpenTelemetry. - [JVM Memory](#jvm-memory) - [Metric: `jvm.memory.used`](#metric-jvmmemoryused) + - [`jvm.memory.type` Values](#jvmmemorytype-values) - [Metric: `jvm.memory.committed`](#metric-jvmmemorycommitted) + - [`jvm.memory.type` Values](#jvmmemorytype-values-1) - [Metric: `jvm.memory.limit`](#metric-jvmmemorylimit) + - [`jvm.memory.type` Values](#jvmmemorytype-values-2) - [Metric: `jvm.memory.used_after_last_gc`](#metric-jvmmemoryused_after_last_gc) + - [`jvm.memory.type` Values](#jvmmemorytype-values-3) - [JVM Garbage Collection](#jvm-garbage-collection) - [Metric: `jvm.gc.duration`](#metric-jvmgcduration) - [JVM Threads](#jvm-threads) - [Metric: `jvm.thread.count`](#metric-jvmthreadcount) + - [`jvm.thread.state` Values](#jvmthreadstate-values) - [JVM Classes](#jvm-classes) - [Metric: `jvm.class.loaded`](#metric-jvmclassloaded) - [Metric: `jvm.class.unloaded`](#metric-jvmclassunloaded) @@ -31,6 +36,7 @@ This document describes semantic conventions for JVM metrics in OpenTelemetry. - [Metric: `jvm.cpu.recent_utilization`](#metric-jvmcpurecent_utilization) - [Experimental](#experimental) - [Metric: `jvm.memory.init`](#metric-jvmmemoryinit) + - [`jvm.memory.type` Values](#jvmmemorytype-values-4) - [Metric: `jvm.system.cpu.utilization`](#metric-jvmsystemcpuutilization) - [Metric: `jvm.system.cpu.load_1m`](#metric-jvmsystemcpuload_1m) - [Metric: `jvm.buffer.memory.used`](#metric-jvmbuffermemoryused) diff --git a/docs/runtime/nodejs-metrics.md b/docs/runtime/nodejs-metrics.md index 6c2e50cd3c..e838fe2d10 100644 --- a/docs/runtime/nodejs-metrics.md +++ b/docs/runtime/nodejs-metrics.md @@ -22,6 +22,7 @@ This document describes semantic conventions for Node.js Runtime metrics in Open - [Metric: `nodejs.eventloop.delay.p99`](#metric-nodejseventloopdelayp99) - [Metric: `nodejs.eventloop.utilization`](#metric-nodejseventlooputilization) - [Metric: `nodejs.eventloop.time`](#metric-nodejseventlooptime) + - [`nodejs.eventloop.state` Values](#nodejseventloopstate-values) diff --git a/docs/runtime/v8js-metrics.md b/docs/runtime/v8js-metrics.md index 27901a8f0e..7b18e2609e 100644 --- a/docs/runtime/v8js-metrics.md +++ b/docs/runtime/v8js-metrics.md @@ -14,10 +14,15 @@ This document describes semantic conventions for V8 JS Engine Runtime metrics in - [Experimental](#experimental) - [Metric: `v8js.gc.duration`](#metric-v8jsgcduration) + - [`v8js.gc.type` Values](#v8jsgctype-values) - [Metric: `v8js.memory.heap.limit`](#metric-v8jsmemoryheaplimit) + - [`v8js.heap.space.name` Values](#v8jsheapspacename-values) - [Metric: `v8js.memory.heap.used`](#metric-v8jsmemoryheapused) + - [`v8js.heap.space.name` Values](#v8jsheapspacename-values-1) - [Metric: `v8js.heap.space.available_size`](#metric-v8jsheapspaceavailable_size) + - [`v8js.heap.space.name` Values](#v8jsheapspacename-values-2) - [Metric: `v8js.heap.space.physical_size`](#metric-v8jsheapspacephysical_size) + - [`v8js.heap.space.name` Values](#v8jsheapspacename-values-3) diff --git a/docs/system/process-metrics.md b/docs/system/process-metrics.md index f6cd15635d..374159c757 100644 --- a/docs/system/process-metrics.md +++ b/docs/system/process-metrics.md @@ -21,15 +21,21 @@ metrics](/docs/runtime/README.md#metrics). - [Process Metrics](#process-metrics) - [Metric: `process.cpu.time`](#metric-processcputime) + - [`cpu.mode` Values](#cpumode-values) - [Metric: `process.cpu.utilization`](#metric-processcpuutilization) + - [`cpu.mode` Values](#cpumode-values-1) - [Metric: `process.memory.usage`](#metric-processmemoryusage) - [Metric: `process.memory.virtual`](#metric-processmemoryvirtual) - [Metric: `process.disk.io`](#metric-processdiskio) + - [`disk.io.direction` Values](#diskiodirection-values) - [Metric: `process.network.io`](#metric-processnetworkio) + - [`network.io.direction` Values](#networkiodirection-values) - [Metric: `process.thread.count`](#metric-processthreadcount) - [Metric: `process.open_file_descriptor.count`](#metric-processopen_file_descriptorcount) - [Metric: `process.context_switches`](#metric-processcontext_switches) + - [`process.context_switch_type` Values](#processcontext_switch_type-values) - [Metric: `process.paging.faults`](#metric-processpagingfaults) + - [`process.paging.fault_type` Values](#processpagingfault_type-values) - [Metric: `process.uptime`](#metric-processuptime) diff --git a/docs/system/system-metrics.md b/docs/system/system-metrics.md index 41ed7a53ad..4a70cec2df 100644 --- a/docs/system/system-metrics.md +++ b/docs/system/system-metrics.md @@ -25,43 +25,69 @@ Resource attributes related to a host, SHOULD be reported under the `host.*` nam - [Metric: `system.uptime`](#metric-systemuptime) - [Processor Metrics](#processor-metrics) - [Metric: `system.cpu.time`](#metric-systemcputime) + - [`cpu.mode` Values](#cpumode-values) - [Metric: `system.cpu.utilization`](#metric-systemcpuutilization) + - [`cpu.mode` Values](#cpumode-values-1) - [Metric: `system.cpu.physical.count`](#metric-systemcpuphysicalcount) - [Metric: `system.cpu.logical.count`](#metric-systemcpulogicalcount) - [Metric: `system.cpu.frequency`](#metric-systemcpufrequency) - [Memory Metrics](#memory-metrics) - [Metric: `system.memory.usage`](#metric-systemmemoryusage) + - [`system.memory.state` Values](#systemmemorystate-values) - [Metric: `system.memory.limit`](#metric-systemmemorylimit) - [Metric: `system.memory.shared`](#metric-systemmemoryshared) - [Metric: `system.memory.utilization`](#metric-systemmemoryutilization) + - [`system.memory.state` Values](#systemmemorystate-values-1) - [Paging/Swap Metrics](#pagingswap-metrics) - [Metric: `system.paging.usage`](#metric-systempagingusage) + - [`system.paging.state` Values](#systempagingstate-values) - [Metric: `system.paging.utilization`](#metric-systempagingutilization) + - [`system.paging.state` Values](#systempagingstate-values-1) - [Metric: `system.paging.faults`](#metric-systempagingfaults) + - [`system.paging.type` Values](#systempagingtype-values) - [Metric: `system.paging.operations`](#metric-systempagingoperations) + - [`system.paging.direction` Values](#systempagingdirection-values) + - [`system.paging.type` Values](#systempagingtype-values-1) - [Disk Controller Metrics](#disk-controller-metrics) - [Metric: `system.disk.io`](#metric-systemdiskio) + - [`disk.io.direction` Values](#diskiodirection-values) - [Metric: `system.disk.operations`](#metric-systemdiskoperations) + - [`disk.io.direction` Values](#diskiodirection-values-1) - [Metric: `system.disk.io_time`](#metric-systemdiskio_time) - [Metric: `system.disk.operation_time`](#metric-systemdiskoperation_time) + - [`disk.io.direction` Values](#diskiodirection-values-2) - [Metric: `system.disk.merged`](#metric-systemdiskmerged) + - [`disk.io.direction` Values](#diskiodirection-values-3) - [Metric: `system.disk.limit`](#metric-systemdisklimit) - [Filesystem Metrics](#filesystem-metrics) - [Metric: `system.filesystem.usage`](#metric-systemfilesystemusage) + - [`system.filesystem.state` Values](#systemfilesystemstate-values) + - [`system.filesystem.type` Values](#systemfilesystemtype-values) - [Metric: `system.filesystem.utilization`](#metric-systemfilesystemutilization) + - [`system.filesystem.state` Values](#systemfilesystemstate-values-1) + - [`system.filesystem.type` Values](#systemfilesystemtype-values-1) - [Metric: `system.filesystem.limit`](#metric-systemfilesystemlimit) + - [`system.filesystem.type` Values](#systemfilesystemtype-values-2) - [Network Metrics](#network-metrics) - [Metric: `system.network.dropped`](#metric-systemnetworkdropped) + - [`network.io.direction` Values](#networkiodirection-values) - [Metric: `system.network.packets`](#metric-systemnetworkpackets) + - [`network.io.direction` Values](#networkiodirection-values-1) - [Metric: `system.network.errors`](#metric-systemnetworkerrors) + - [`network.io.direction` Values](#networkiodirection-values-2) - [Metric: `system.network.io`](#metric-systemnetworkio) + - [`network.io.direction` Values](#networkiodirection-values-3) - [Metric: `system.network.connections`](#metric-systemnetworkconnections) + - [`network.transport` Values](#networktransport-values) + - [`system.network.state` Values](#systemnetworkstate-values) - [Aggregate System Process Metrics](#aggregate-system-process-metrics) - [Metric: `system.process.count`](#metric-systemprocesscount) + - [`system.process.status` Values](#systemprocessstatus-values) - [Metric: `system.process.created`](#metric-systemprocesscreated) - [`system.{os}.` - OS Specific System Metrics](#systemos---os-specific-system-metrics) - [Metric: `system.linux.memory.available`](#metric-systemlinuxmemoryavailable) - [Metric: `system.linux.memory.slab.usage`](#metric-systemlinuxmemoryslabusage) + - [`linux.memory.slab.state` Values](#linuxmemoryslabstate-values)