From 6a57f094004ededd1f8ec7b9df8e8dfe3983d383 Mon Sep 17 00:00:00 2001 From: Josh Suereth Date: Thu, 11 May 2023 07:59:41 -0400 Subject: [PATCH] Put hiatus on semantic conventions until they are in the new repository. (#3489) As per OTEP: https://github.com/open-telemetry/oteps/blob/main/text/0227-separate-semantic-conventions.md --- .../logs/semantic_conventions/README.md | 5 ++ .../logs/semantic_conventions/events.md | 5 ++ .../logs/semantic_conventions/exceptions.md | 5 ++ .../semantic_conventions/feature-flags.md | 5 ++ .../logs/semantic_conventions/general.md | 5 ++ .../logs/semantic_conventions/media.md | 5 ++ .../metrics/semantic_conventions/README.md | 5 ++ .../semantic_conventions/database-metrics.md | 5 ++ .../semantic_conventions/faas-metrics.md | 5 ++ .../semantic_conventions/hardware-metrics.md | 5 ++ .../semantic_conventions/http-metrics.md | 5 ++ .../instrumentation/README.md | 5 ++ .../instrumentation/kafka.md | 5 ++ .../semantic_conventions/process-metrics.md | 5 ++ .../semantic_conventions/rpc-metrics.md | 5 ++ .../runtime-environment-metrics.md | 5 ++ .../semantic_conventions/system-metrics.md | 5 ++ specification/overview.md | 5 ++ .../resource/semantic_conventions/README.md | 5 ++ .../resource/semantic_conventions/browser.md | 5 ++ .../resource/semantic_conventions/cloud.md | 5 ++ .../cloud_provider/aws/README.md | 5 ++ .../cloud_provider/aws/ecs.md | 5 ++ .../cloud_provider/aws/eks.md | 5 ++ .../cloud_provider/aws/logs.md | 5 ++ .../cloud_provider/gcp/README.md | 5 ++ .../cloud_provider/gcp/cloud_run.md | 5 ++ .../cloud_provider/heroku.md | 5 ++ .../semantic_conventions/container.md | 5 ++ .../deployment_environment.md | 5 ++ .../resource/semantic_conventions/device.md | 5 ++ .../resource/semantic_conventions/faas.md | 5 ++ .../resource/semantic_conventions/host.md | 5 ++ .../resource/semantic_conventions/k8s.md | 5 ++ .../resource/semantic_conventions/os.md | 5 ++ .../resource/semantic_conventions/process.md | 5 ++ .../semantic_conventions/webengine.md | 7 +++ specification/semantic-conventions.md | 38 ++++++++++++++ specification/trace/api.md | 2 +- specification/trace/exceptions.md | 50 +++++++++++++++++++ .../trace/semantic_conventions/README.md | 5 ++ .../trace/semantic_conventions/cloudevents.md | 5 ++ .../semantic_conventions/compatibility.md | 5 ++ .../trace/semantic_conventions/database.md | 5 ++ .../trace/semantic_conventions/exceptions.md | 5 ++ .../trace/semantic_conventions/faas.md | 5 ++ .../semantic_conventions/feature-flags.md | 5 ++ .../trace/semantic_conventions/http.md | 5 ++ .../instrumentation/aws-lambda.md | 5 ++ .../instrumentation/aws-sdk.md | 5 ++ .../instrumentation/graphql.md | 5 ++ .../trace/semantic_conventions/messaging.md | 5 ++ .../trace/semantic_conventions/rpc.md | 5 ++ .../semantic_conventions/span-general.md | 5 ++ 54 files changed, 346 insertions(+), 1 deletion(-) create mode 100644 specification/semantic-conventions.md create mode 100644 specification/trace/exceptions.md diff --git a/specification/logs/semantic_conventions/README.md b/specification/logs/semantic_conventions/README.md index 4df36b93317..c0fba6e39c6 100644 --- a/specification/logs/semantic_conventions/README.md +++ b/specification/logs/semantic_conventions/README.md @@ -1,5 +1,10 @@ # Log Attribute Semantic Conventions +**NOTICE** Semantic Conventions are moving to a +[new location](http://github.com/open-telemetry/semantic-conventions). + +No changes to this document are allowed. + **Status**: [Experimental](../../document-status.md) The following semantic conventions for logs are defined: diff --git a/specification/logs/semantic_conventions/events.md b/specification/logs/semantic_conventions/events.md index 8f9997c25dd..a59f29936d0 100644 --- a/specification/logs/semantic_conventions/events.md +++ b/specification/logs/semantic_conventions/events.md @@ -1,5 +1,10 @@ # Semantic Convention for event attributes +**NOTICE** Semantic Conventions are moving to a +[new location](http://github.com/open-telemetry/semantic-conventions). + +No changes to this document are allowed. + **Status**: [Experimental](../../document-status.md) This document describes the attributes of standalone Events that are represented diff --git a/specification/logs/semantic_conventions/exceptions.md b/specification/logs/semantic_conventions/exceptions.md index f40d44cb89d..50c0a916ef6 100644 --- a/specification/logs/semantic_conventions/exceptions.md +++ b/specification/logs/semantic_conventions/exceptions.md @@ -1,5 +1,10 @@ # Semantic Conventions for Exceptions +**NOTICE** Semantic Conventions are moving to a +[new location](http://github.com/open-telemetry/semantic-conventions). + +No changes to this document are allowed. + **Status**: [Experimental](../../document-status.md) This document defines semantic conventions for recording exceptions on diff --git a/specification/logs/semantic_conventions/feature-flags.md b/specification/logs/semantic_conventions/feature-flags.md index 25c62b58e9c..8ea7c4a1523 100644 --- a/specification/logs/semantic_conventions/feature-flags.md +++ b/specification/logs/semantic_conventions/feature-flags.md @@ -1,5 +1,10 @@ # Semantic Conventions for Feature Flag Evaluations +**NOTICE** Semantic Conventions are moving to a +[new location](http://github.com/open-telemetry/semantic-conventions). + +No changes to this document are allowed. + **Status**: [Experimental](../../document-status.md) This document defines semantic conventions for recording feature flag evaluations as diff --git a/specification/logs/semantic_conventions/general.md b/specification/logs/semantic_conventions/general.md index 80b679a0bc0..0c125586087 100644 --- a/specification/logs/semantic_conventions/general.md +++ b/specification/logs/semantic_conventions/general.md @@ -1,5 +1,10 @@ # General attributes +**NOTICE** Semantic Conventions are moving to a +[new location](http://github.com/open-telemetry/semantic-conventions). + +No changes to this document are allowed. + **Status**: [Experimental](../../document-status.md) The attributes described in this section are rather generic. diff --git a/specification/logs/semantic_conventions/media.md b/specification/logs/semantic_conventions/media.md index f8e02542f7b..031c77a702c 100644 --- a/specification/logs/semantic_conventions/media.md +++ b/specification/logs/semantic_conventions/media.md @@ -1,5 +1,10 @@ # Semantic Conventions for Log Media +**NOTICE** Semantic Conventions are moving to a +[new location](http://github.com/open-telemetry/semantic-conventions). + +No changes to this document are allowed. + **Status**: [Experimental](../../document-status.md) This document describes attributes for log media in OpenTelemetry. Log media are mechanisms by which logs are transmitted. Types of media include files, streams, network protocols, and os-specific logging services such as journald and Windows Event Log. diff --git a/specification/metrics/semantic_conventions/README.md b/specification/metrics/semantic_conventions/README.md index 718d894fa2f..1bd0f041437 100644 --- a/specification/metrics/semantic_conventions/README.md +++ b/specification/metrics/semantic_conventions/README.md @@ -5,6 +5,11 @@ linkTitle: Semantic Conventions # Metrics Semantic Conventions +**NOTICE** Semantic Conventions are moving to a +[new location](http://github.com/open-telemetry/semantic-conventions). + +No changes to this document are allowed. + **Status**: [Mixed](../../document-status.md) diff --git a/specification/metrics/semantic_conventions/database-metrics.md b/specification/metrics/semantic_conventions/database-metrics.md index a319a5974a5..8ab20830575 100644 --- a/specification/metrics/semantic_conventions/database-metrics.md +++ b/specification/metrics/semantic_conventions/database-metrics.md @@ -4,6 +4,11 @@ linkTitle: Database # Semantic Conventions for Database Metrics +**NOTICE** Semantic Conventions are moving to a +[new location](http://github.com/open-telemetry/semantic-conventions). + +No changes to this document are allowed. + **Status**: [Experimental](../../document-status.md) The conventions described in this section are specific to SQL and NoSQL clients. diff --git a/specification/metrics/semantic_conventions/faas-metrics.md b/specification/metrics/semantic_conventions/faas-metrics.md index 2cdff199d25..99a94b3002f 100644 --- a/specification/metrics/semantic_conventions/faas-metrics.md +++ b/specification/metrics/semantic_conventions/faas-metrics.md @@ -4,6 +4,11 @@ linkTitle: FaaS # Semantic Conventions for FaaS Metrics +**NOTICE** Semantic Conventions are moving to a +[new location](http://github.com/open-telemetry/semantic-conventions). + +No changes to this document are allowed. + **Status**: [Experimental](../../document-status.md) This document defines how to describe an instance of a function that runs without provisioning diff --git a/specification/metrics/semantic_conventions/hardware-metrics.md b/specification/metrics/semantic_conventions/hardware-metrics.md index 9037d4d3558..709347558fc 100644 --- a/specification/metrics/semantic_conventions/hardware-metrics.md +++ b/specification/metrics/semantic_conventions/hardware-metrics.md @@ -4,6 +4,11 @@ linkTitle: Hardware # Semantic Conventions for Hardware Metrics +**NOTICE** Semantic Conventions are moving to a +[new location](http://github.com/open-telemetry/semantic-conventions). + +No changes to this document are allowed. + **Status**: [Experimental](../../document-status.md) This document describes instruments and attributes for common hardware level diff --git a/specification/metrics/semantic_conventions/http-metrics.md b/specification/metrics/semantic_conventions/http-metrics.md index 8535d5dc0a6..49de8803372 100644 --- a/specification/metrics/semantic_conventions/http-metrics.md +++ b/specification/metrics/semantic_conventions/http-metrics.md @@ -4,6 +4,11 @@ linkTitle: HTTP # Semantic Conventions for HTTP Metrics +**NOTICE** Semantic Conventions are moving to a +[new location](http://github.com/open-telemetry/semantic-conventions). + +No changes to this document are allowed. + **Status**: [Experimental](../../document-status.md) The conventions described in this section are HTTP specific. When HTTP operations occur, diff --git a/specification/metrics/semantic_conventions/instrumentation/README.md b/specification/metrics/semantic_conventions/instrumentation/README.md index ab7111ba62c..2b46ff92c3e 100644 --- a/specification/metrics/semantic_conventions/instrumentation/README.md +++ b/specification/metrics/semantic_conventions/instrumentation/README.md @@ -1 +1,6 @@ # Instrumentation + +**NOTICE** Semantic Conventions are moving to a +[new location](http://github.com/open-telemetry/semantic-conventions). + +No changes to this document are allowed. diff --git a/specification/metrics/semantic_conventions/instrumentation/kafka.md b/specification/metrics/semantic_conventions/instrumentation/kafka.md index db4b21ac322..c9e24f94c78 100644 --- a/specification/metrics/semantic_conventions/instrumentation/kafka.md +++ b/specification/metrics/semantic_conventions/instrumentation/kafka.md @@ -4,6 +4,11 @@ linkTitle: Kafka # Instrumenting Kafka +**NOTICE** Semantic Conventions are moving to a +[new location](http://github.com/open-telemetry/semantic-conventions). + +No changes to this document are allowed. + **Status**: [Experimental](../../../document-status.md) This document defines how to apply semantic conventions when instrumenting Kafka. diff --git a/specification/metrics/semantic_conventions/process-metrics.md b/specification/metrics/semantic_conventions/process-metrics.md index 529fdca299a..a53f0e9f1ee 100644 --- a/specification/metrics/semantic_conventions/process-metrics.md +++ b/specification/metrics/semantic_conventions/process-metrics.md @@ -4,6 +4,11 @@ linkTitle: Process # Semantic Conventions for OS Process Metrics +**NOTICE** Semantic Conventions are moving to a +[new location](http://github.com/open-telemetry/semantic-conventions). + +No changes to this document are allowed. + **Status**: [Experimental](../../document-status.md) This document describes instruments and attributes for common OS process level diff --git a/specification/metrics/semantic_conventions/rpc-metrics.md b/specification/metrics/semantic_conventions/rpc-metrics.md index e47aa28fc99..007fea85aff 100644 --- a/specification/metrics/semantic_conventions/rpc-metrics.md +++ b/specification/metrics/semantic_conventions/rpc-metrics.md @@ -4,6 +4,11 @@ linkTitle: RPC # General RPC conventions +**NOTICE** Semantic Conventions are moving to a +[new location](http://github.com/open-telemetry/semantic-conventions). + +No changes to this document are allowed. + **Status**: [Experimental](../../document-status.md) The conventions described in this section are RPC specific. When RPC operations diff --git a/specification/metrics/semantic_conventions/runtime-environment-metrics.md b/specification/metrics/semantic_conventions/runtime-environment-metrics.md index 160bf582fd1..7548c25fb6c 100644 --- a/specification/metrics/semantic_conventions/runtime-environment-metrics.md +++ b/specification/metrics/semantic_conventions/runtime-environment-metrics.md @@ -4,6 +4,11 @@ linkTitle: Runtime Environment # Semantic Conventions for Runtime Environment Metrics +**NOTICE** Semantic Conventions are moving to a +[new location](http://github.com/open-telemetry/semantic-conventions). + +No changes to this document are allowed. + **Status**: [Experimental](../../document-status.md) This document includes semantic conventions for runtime environment level diff --git a/specification/metrics/semantic_conventions/system-metrics.md b/specification/metrics/semantic_conventions/system-metrics.md index 44b5059bbeb..fb257eeff15 100644 --- a/specification/metrics/semantic_conventions/system-metrics.md +++ b/specification/metrics/semantic_conventions/system-metrics.md @@ -4,6 +4,11 @@ linkTitle: System # Semantic Conventions for System Metrics +**NOTICE** Semantic Conventions are moving to a +[new location](http://github.com/open-telemetry/semantic-conventions). + +No changes to this document are allowed. + **Status**: [Experimental](../../document-status.md) This document describes instruments and attributes for common system level diff --git a/specification/overview.md b/specification/overview.md index 8242daad5aa..3b77204d9c5 100644 --- a/specification/overview.md +++ b/specification/overview.md @@ -72,6 +72,8 @@ Application owners use the SDK constructors; [plugin authors](glossary.md#plugin The **Semantic Conventions** define the keys and values which describe commonly observed concepts, protocols, and operations used by applications. +**Note: Semantic conventions will be moving to a new repository.** + * [Resource Conventions](resource/semantic_conventions/README.md) * [Span Conventions](trace/semantic_conventions/README.md) * [Metrics Conventions](metrics/semantic_conventions/README.md) @@ -85,6 +87,9 @@ source of truth for generation. Each language implementation SHOULD provide language-specific support to the [code generator](https://github.com/open-telemetry/build-tools/tree/main/semantic-conventions#code-generator). +Additionally, attributes required by the specification will be listed +[here](semantic-conventions.md) + ### Contrib Packages The OpenTelemetry project maintains integrations with popular OSS projects which have been identified as important for observing modern web services. diff --git a/specification/resource/semantic_conventions/README.md b/specification/resource/semantic_conventions/README.md index e6aeba57e92..b8e62e84f0f 100644 --- a/specification/resource/semantic_conventions/README.md +++ b/specification/resource/semantic_conventions/README.md @@ -1,5 +1,10 @@ # Resource Semantic Conventions +**NOTICE** Semantic Conventions are moving to a +[new location](http://github.com/open-telemetry/semantic-conventions). + +No changes to this document are allowed. + **Status**: [Mixed](../../document-status.md) This document defines standard attributes for resources. These attributes are typically used in the [Resource](../sdk.md) and are also recommended to be used anywhere else where there is a need to describe a resource in a consistent manner. The majority of these attributes are inherited from diff --git a/specification/resource/semantic_conventions/browser.md b/specification/resource/semantic_conventions/browser.md index cc3acd247a0..0c1b762ba1e 100644 --- a/specification/resource/semantic_conventions/browser.md +++ b/specification/resource/semantic_conventions/browser.md @@ -2,6 +2,11 @@ **Status**: [Experimental](../../document-status.md) +**NOTICE** Semantic Conventions are moving to a +[new location](http://github.com/open-telemetry/semantic-conventions). + +No changes to this document are allowed. + **type:** `browser` **Description**: The web browser in which the application represented by the resource is running. The `browser.*` attributes MUST be used only for resources that represent applications running in a web browser (regardless of whether running on a mobile or desktop device). diff --git a/specification/resource/semantic_conventions/cloud.md b/specification/resource/semantic_conventions/cloud.md index b8bb6e49329..a5cca57c723 100644 --- a/specification/resource/semantic_conventions/cloud.md +++ b/specification/resource/semantic_conventions/cloud.md @@ -2,6 +2,11 @@ **Status**: [Experimental](../../document-status.md) +**NOTICE** Semantic Conventions are moving to a +[new location](http://github.com/open-telemetry/semantic-conventions). + +No changes to this document are allowed. + **type:** `cloud` **Description:** A cloud infrastructure (e.g. GCP, Azure, AWS). diff --git a/specification/resource/semantic_conventions/cloud_provider/aws/README.md b/specification/resource/semantic_conventions/cloud_provider/aws/README.md index 25ef5cc35d2..da14c6a472d 100644 --- a/specification/resource/semantic_conventions/cloud_provider/aws/README.md +++ b/specification/resource/semantic_conventions/cloud_provider/aws/README.md @@ -1,5 +1,10 @@ # AWS Semantic Conventions +**NOTICE** Semantic Conventions are moving to a +[new location](http://github.com/open-telemetry/semantic-conventions). + +No changes to this document are allowed. + **Status**: [Experimental](../../../../document-status.md) This directory defines standards for resource attributes that only apply to Amazon diff --git a/specification/resource/semantic_conventions/cloud_provider/aws/ecs.md b/specification/resource/semantic_conventions/cloud_provider/aws/ecs.md index e9b56cc8b17..19d24731431 100644 --- a/specification/resource/semantic_conventions/cloud_provider/aws/ecs.md +++ b/specification/resource/semantic_conventions/cloud_provider/aws/ecs.md @@ -1,5 +1,10 @@ # AWS ECS +**NOTICE** Semantic Conventions are moving to a +[new location](http://github.com/open-telemetry/semantic-conventions). + +No changes to this document are allowed. + **Status**: [Experimental](../../../../document-status.md) **type:** `aws.ecs` diff --git a/specification/resource/semantic_conventions/cloud_provider/aws/eks.md b/specification/resource/semantic_conventions/cloud_provider/aws/eks.md index 9514c8d56e6..85ba84e97e0 100644 --- a/specification/resource/semantic_conventions/cloud_provider/aws/eks.md +++ b/specification/resource/semantic_conventions/cloud_provider/aws/eks.md @@ -1,5 +1,10 @@ # AWS EKS +**NOTICE** Semantic Conventions are moving to a +[new location](http://github.com/open-telemetry/semantic-conventions). + +No changes to this document are allowed. + **Status**: [Experimental](../../../../document-status.md) **type:** `aws.eks` diff --git a/specification/resource/semantic_conventions/cloud_provider/aws/logs.md b/specification/resource/semantic_conventions/cloud_provider/aws/logs.md index 7acec435a0d..bcc36f5cb6b 100644 --- a/specification/resource/semantic_conventions/cloud_provider/aws/logs.md +++ b/specification/resource/semantic_conventions/cloud_provider/aws/logs.md @@ -1,5 +1,10 @@ # AWS Logs +**NOTICE** Semantic Conventions are moving to a +[new location](http://github.com/open-telemetry/semantic-conventions). + +No changes to this document are allowed. + **Status**: [Experimental](../../../../document-status.md) **Type:** `aws.log` diff --git a/specification/resource/semantic_conventions/cloud_provider/gcp/README.md b/specification/resource/semantic_conventions/cloud_provider/gcp/README.md index b1d0d7ef538..720cb6445d4 100644 --- a/specification/resource/semantic_conventions/cloud_provider/gcp/README.md +++ b/specification/resource/semantic_conventions/cloud_provider/gcp/README.md @@ -1,5 +1,10 @@ # GCP Semantic Conventions +**NOTICE** Semantic Conventions are moving to a +[new location](http://github.com/open-telemetry/semantic-conventions). + +No changes to this document are allowed. + This directory defines standards for resource attributes that only apply to Google Cloud Platform (GCP). If an attribute could apply to resources from more than one cloud provider (like account ID, operating system, etc), it belongs in the parent diff --git a/specification/resource/semantic_conventions/cloud_provider/gcp/cloud_run.md b/specification/resource/semantic_conventions/cloud_provider/gcp/cloud_run.md index 1888720a525..f110d7d72e6 100644 --- a/specification/resource/semantic_conventions/cloud_provider/gcp/cloud_run.md +++ b/specification/resource/semantic_conventions/cloud_provider/gcp/cloud_run.md @@ -1,5 +1,10 @@ # Google Cloud Run +**NOTICE** Semantic Conventions are moving to a +[new location](http://github.com/open-telemetry/semantic-conventions). + +No changes to this document are allowed. + These conventions are recommended for resources running on Cloud Run. **Type:** `gcp.cloud_run` diff --git a/specification/resource/semantic_conventions/cloud_provider/heroku.md b/specification/resource/semantic_conventions/cloud_provider/heroku.md index 9030d2f93ea..5f8761d9a18 100644 --- a/specification/resource/semantic_conventions/cloud_provider/heroku.md +++ b/specification/resource/semantic_conventions/cloud_provider/heroku.md @@ -2,6 +2,11 @@ **Status**: [Experimental](../../../document-status.md) +**NOTICE** Semantic Conventions are moving to a +[new location](http://github.com/open-telemetry/semantic-conventions). + +No changes to this document are allowed. + **type:** `heroku` **Description:** [Heroku dyno metadata] diff --git a/specification/resource/semantic_conventions/container.md b/specification/resource/semantic_conventions/container.md index 64948141d06..1746e63dbb5 100644 --- a/specification/resource/semantic_conventions/container.md +++ b/specification/resource/semantic_conventions/container.md @@ -2,6 +2,11 @@ **Status**: [Experimental](../../document-status.md) +**NOTICE** Semantic Conventions are moving to a +[new location](http://github.com/open-telemetry/semantic-conventions). + +No changes to this document are allowed. + **type:** `container` **Description:** A container instance. diff --git a/specification/resource/semantic_conventions/deployment_environment.md b/specification/resource/semantic_conventions/deployment_environment.md index 35cff71aa97..b7284161f06 100644 --- a/specification/resource/semantic_conventions/deployment_environment.md +++ b/specification/resource/semantic_conventions/deployment_environment.md @@ -2,6 +2,11 @@ **Status**: [Experimental](../../document-status.md) +**NOTICE** Semantic Conventions are moving to a +[new location](http://github.com/open-telemetry/semantic-conventions). + +No changes to this document are allowed. + **type:** `deployment` **Description:** The software deployment. diff --git a/specification/resource/semantic_conventions/device.md b/specification/resource/semantic_conventions/device.md index 6f746e76385..c6421fe0684 100644 --- a/specification/resource/semantic_conventions/device.md +++ b/specification/resource/semantic_conventions/device.md @@ -2,6 +2,11 @@ **Status**: [Experimental](../../document-status.md) +**NOTICE** Semantic Conventions are moving to a +[new location](http://github.com/open-telemetry/semantic-conventions). + +No changes to this document are allowed. + **type:** `device` **Description**: The device on which the process represented by this resource is running. diff --git a/specification/resource/semantic_conventions/faas.md b/specification/resource/semantic_conventions/faas.md index d2728663263..90a245074db 100644 --- a/specification/resource/semantic_conventions/faas.md +++ b/specification/resource/semantic_conventions/faas.md @@ -2,6 +2,11 @@ **Status**: [Experimental](../../document-status.md) +**NOTICE** Semantic Conventions are moving to a +[new location](http://github.com/open-telemetry/semantic-conventions). + +No changes to this document are allowed. + **type:** `faas` **Description:** A "function as a service" aka "serverless function" instance. diff --git a/specification/resource/semantic_conventions/host.md b/specification/resource/semantic_conventions/host.md index 7fe24db93aa..0bbc2622f04 100644 --- a/specification/resource/semantic_conventions/host.md +++ b/specification/resource/semantic_conventions/host.md @@ -2,6 +2,11 @@ **Status**: [Experimental](../../document-status.md) +**NOTICE** Semantic Conventions are moving to a +[new location](http://github.com/open-telemetry/semantic-conventions). + +No changes to this document are allowed. + **type:** `host` **Description:** A host is defined as a computing instance. For example, physical servers, virtual machines, switches or disk array. diff --git a/specification/resource/semantic_conventions/k8s.md b/specification/resource/semantic_conventions/k8s.md index 25dfe2e3781..67c346a2f25 100644 --- a/specification/resource/semantic_conventions/k8s.md +++ b/specification/resource/semantic_conventions/k8s.md @@ -2,6 +2,11 @@ **Status**: [Experimental](../../document-status.md) +**NOTICE** Semantic Conventions are moving to a +[new location](http://github.com/open-telemetry/semantic-conventions). + +No changes to this document are allowed. + Useful resources to understand Kubernetes objects and metadata: * [Namespace](https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/) diff --git a/specification/resource/semantic_conventions/os.md b/specification/resource/semantic_conventions/os.md index c3db6708909..4ca67cf1dce 100644 --- a/specification/resource/semantic_conventions/os.md +++ b/specification/resource/semantic_conventions/os.md @@ -1,5 +1,10 @@ # Operating System +**NOTICE** Semantic Conventions are moving to a +[new location](http://github.com/open-telemetry/semantic-conventions). + +No changes to this document are allowed. + **Status**: [Experimental](../../document-status.md) **type:** `os` diff --git a/specification/resource/semantic_conventions/process.md b/specification/resource/semantic_conventions/process.md index b741128b5ed..21e90bc8f93 100644 --- a/specification/resource/semantic_conventions/process.md +++ b/specification/resource/semantic_conventions/process.md @@ -1,5 +1,10 @@ # Process and process runtime resources +**NOTICE** Semantic Conventions are moving to a +[new location](http://github.com/open-telemetry/semantic-conventions). + +No changes to this document are allowed. + **Status**: [Experimental](../../document-status.md) diff --git a/specification/resource/semantic_conventions/webengine.md b/specification/resource/semantic_conventions/webengine.md index 2869d00d388..82d2e87dff2 100644 --- a/specification/resource/semantic_conventions/webengine.md +++ b/specification/resource/semantic_conventions/webengine.md @@ -1,5 +1,12 @@ # Webengine +**NOTICE** Semantic Conventions are moving to a +[new location](http://github.com/open-telemetry/semantic-conventions). + +No changes to this document are allowed. + +**Status**: [Experimental](../../document-status.md) + **type:** `webengine` **Description:** Resource describing the packaged software running the application code. Web engines are typically executed using process.runtime. diff --git a/specification/semantic-conventions.md b/specification/semantic-conventions.md new file mode 100644 index 00000000000..7ef8d4efed7 --- /dev/null +++ b/specification/semantic-conventions.md @@ -0,0 +1,38 @@ +# Semantic Conventions + +**Status**: [Experimental](document-status.md) + +The **Semantic Conventions** define the keys and values which describe commonly observed concepts, protocols, and operations used by applications. + +OpenTelemetry defines its semantic conventions in a separate repository: +[https://github.com/open-telemetry/semantic-conventions](https://github.com/open-telemetry/semantic-conventions). + +## Reserved Attributes + +Semantic conventions MUST provide the following attributes: + +- Resource + - `service.name` + - `telemetry.sdk.language` + - `telemetry.sdk.name` + - `telemetry.sdk.version` +- Event + - `exception.escaped` + - `exception.message` + - `exception.stacktrace` + - `exception.type` + +## Experimental Reserved Attributes + +Semantic conventions MUST provide the following attributes: + +- Resource + - `server.address` + - `server.port` + - `service.instance.id` + - `url.scheme` + +## Reserved Namespace + +The `otel.*` namespace is reserved for defining compatibility with +non-opentelemetry technologies. diff --git a/specification/trace/api.md b/specification/trace/api.md index 59a4b390a97..31a80a30bfc 100644 --- a/specification/trace/api.md +++ b/specification/trace/api.md @@ -681,7 +681,7 @@ so for anything not specified here, the same requirements as for `AddEvent` appl The signature of the method is to be determined by each language and can be overloaded as appropriate. The method MUST record an exception as an `Event` with the conventions outlined in -the [exception semantic conventions](semantic_conventions/exceptions.md) document. +the [exceptions](exceptions.md) document. The minimum required argument SHOULD be no more than only an exception object. If `RecordException` is provided, the method MUST accept an optional parameter diff --git a/specification/trace/exceptions.md b/specification/trace/exceptions.md new file mode 100644 index 00000000000..e0d7f2ad890 --- /dev/null +++ b/specification/trace/exceptions.md @@ -0,0 +1,50 @@ +# Exceptions + +**Status**: [Experimental](../document-status.md) + +This document defines how to record exceptions and +their required attributes. + + + +- [Recording an Exception](#recording-an-exception) +- [Attributes](#attributes) + + + +## Recording an Exception + +An exception SHOULD be recorded as an `Event` on the span during which it occurred. +The name of the event MUST be `"exception"`. + +A typical template for an auto-instrumentation implementing this semantic convention +using an [API-provided `recordException` method](api.md#record-exception) +could look like this (pseudo-Java): + +```java +Span span = myTracer.startSpan(/*...*/); +try { + // Code that does the actual work which the Span represents +} catch (Throwable e) { + span.recordException(e, Attributes.of("exception.escaped", true)); + throw e; +} finally { + span.end(); +} +``` + +## Attributes + +An event representing an exception MUST have an +event name `exception`. + +Additionally, the following attributes SHOULD be +filled out: + +- `exception.escaped` +- `exception.message` +- `exception.stacktrace` +- `exception.type` + +The format and semantics of these attributes are +defined in [semantic conventions](semantic_conventions/exceptions.md). diff --git a/specification/trace/semantic_conventions/README.md b/specification/trace/semantic_conventions/README.md index 78656e96710..3167a518e2c 100644 --- a/specification/trace/semantic_conventions/README.md +++ b/specification/trace/semantic_conventions/README.md @@ -1,5 +1,10 @@ # Trace Semantic Conventions +**NOTICE** Semantic Conventions are moving to a +[new location](http://github.com/open-telemetry/semantic-conventions). + +No changes to this document are allowed. + **Status**: [Experimental](../../document-status.md) In OpenTelemetry spans can be created freely and it’s up to the implementor to diff --git a/specification/trace/semantic_conventions/cloudevents.md b/specification/trace/semantic_conventions/cloudevents.md index 1a7538561b2..37d563afadb 100644 --- a/specification/trace/semantic_conventions/cloudevents.md +++ b/specification/trace/semantic_conventions/cloudevents.md @@ -1,5 +1,10 @@ # CloudEvents +**NOTICE** Semantic Conventions are moving to a +[new location](http://github.com/open-telemetry/semantic-conventions). + +No changes to this document are allowed. + **Status**: [Experimental](../../document-status.md) diff --git a/specification/trace/semantic_conventions/compatibility.md b/specification/trace/semantic_conventions/compatibility.md index b5a4f2d0740..fb2c1b2b89d 100644 --- a/specification/trace/semantic_conventions/compatibility.md +++ b/specification/trace/semantic_conventions/compatibility.md @@ -1,5 +1,10 @@ # Semantic conventions for Compatibility components +**NOTICE** Semantic Conventions are moving to a +[new location](http://github.com/open-telemetry/semantic-conventions). + +No changes to this document are allowed. + **Status**: [Experimental](../../document-status.md) This document defines trace semantic conventions used by the diff --git a/specification/trace/semantic_conventions/database.md b/specification/trace/semantic_conventions/database.md index 70e49f987ff..5dc4e593bdb 100644 --- a/specification/trace/semantic_conventions/database.md +++ b/specification/trace/semantic_conventions/database.md @@ -1,5 +1,10 @@ # Semantic conventions for database client calls +**NOTICE** Semantic Conventions are moving to a +[new location](http://github.com/open-telemetry/semantic-conventions). + +No changes to this document are allowed. + **Status**: [Experimental](../../document-status.md) diff --git a/specification/trace/semantic_conventions/exceptions.md b/specification/trace/semantic_conventions/exceptions.md index 234eb710fed..b6dd674e357 100644 --- a/specification/trace/semantic_conventions/exceptions.md +++ b/specification/trace/semantic_conventions/exceptions.md @@ -1,5 +1,10 @@ # Semantic Conventions for Exceptions +**NOTICE** Semantic Conventions are moving to a +[new location](http://github.com/open-telemetry/semantic-conventions). + +No changes to this document are allowed. + **Status**: [Experimental](../../document-status.md) This document defines semantic conventions for recording application diff --git a/specification/trace/semantic_conventions/faas.md b/specification/trace/semantic_conventions/faas.md index cfa486030a3..719733802e1 100644 --- a/specification/trace/semantic_conventions/faas.md +++ b/specification/trace/semantic_conventions/faas.md @@ -1,5 +1,10 @@ # Semantic conventions for FaaS spans +**NOTICE** Semantic Conventions are moving to a +[new location](http://github.com/open-telemetry/semantic-conventions). + +No changes to this document are allowed. + **Status**: [Experimental](../../document-status.md) This document defines how to describe an instance of a function that runs without provisioning diff --git a/specification/trace/semantic_conventions/feature-flags.md b/specification/trace/semantic_conventions/feature-flags.md index 1b7b5862b1e..b11e6fde55c 100644 --- a/specification/trace/semantic_conventions/feature-flags.md +++ b/specification/trace/semantic_conventions/feature-flags.md @@ -1,5 +1,10 @@ # Semantic conventions for Feature Flags +**NOTICE** Semantic Conventions are moving to a +[new location](http://github.com/open-telemetry/semantic-conventions). + +No changes to this document are allowed. + **Status**: [Experimental](../../document-status.md) This document defines semantic conventions for recording dynamic feature flag diff --git a/specification/trace/semantic_conventions/http.md b/specification/trace/semantic_conventions/http.md index eea84660c21..65a4b95befc 100644 --- a/specification/trace/semantic_conventions/http.md +++ b/specification/trace/semantic_conventions/http.md @@ -1,5 +1,10 @@ # Semantic conventions for HTTP spans +**NOTICE** Semantic Conventions are moving to a +[new location](http://github.com/open-telemetry/semantic-conventions). + +No changes to this document are allowed. + **Status**: [Experimental](../../document-status.md) This document defines semantic conventions for HTTP client and server Spans. diff --git a/specification/trace/semantic_conventions/instrumentation/aws-lambda.md b/specification/trace/semantic_conventions/instrumentation/aws-lambda.md index aab4165acbf..fbe60b27c9f 100644 --- a/specification/trace/semantic_conventions/instrumentation/aws-lambda.md +++ b/specification/trace/semantic_conventions/instrumentation/aws-lambda.md @@ -1,5 +1,10 @@ # Instrumenting AWS Lambda +**NOTICE** Semantic Conventions are moving to a +[new location](http://github.com/open-telemetry/semantic-conventions). + +No changes to this document are allowed. + **Status**: [Experimental](../../../document-status.md) This document defines how to apply semantic conventions when instrumenting an AWS Lambda request handler. AWS diff --git a/specification/trace/semantic_conventions/instrumentation/aws-sdk.md b/specification/trace/semantic_conventions/instrumentation/aws-sdk.md index ba179651fbe..a5cd1665a35 100644 --- a/specification/trace/semantic_conventions/instrumentation/aws-sdk.md +++ b/specification/trace/semantic_conventions/instrumentation/aws-sdk.md @@ -1,5 +1,10 @@ # Semantic conventions for AWS SDK +**NOTICE** Semantic Conventions are moving to a +[new location](http://github.com/open-telemetry/semantic-conventions). + +No changes to this document are allowed. + **Status**: [Experimental](../../../document-status.md) This document defines semantic conventions to apply when instrumenting the AWS SDK. They map request or response diff --git a/specification/trace/semantic_conventions/instrumentation/graphql.md b/specification/trace/semantic_conventions/instrumentation/graphql.md index 2a7e6107601..8b9c9beb963 100644 --- a/specification/trace/semantic_conventions/instrumentation/graphql.md +++ b/specification/trace/semantic_conventions/instrumentation/graphql.md @@ -1,5 +1,10 @@ # Semantic conventions for GraphQL Server +**NOTICE** Semantic Conventions are moving to a +[new location](http://github.com/open-telemetry/semantic-conventions). + +No changes to this document are allowed. + **Status**: [Experimental](../../../document-status.md) This document defines semantic conventions to apply when instrumenting the GraphQL implementation. They map GraphQL diff --git a/specification/trace/semantic_conventions/messaging.md b/specification/trace/semantic_conventions/messaging.md index 1b97e3d594f..e80b4c9893e 100644 --- a/specification/trace/semantic_conventions/messaging.md +++ b/specification/trace/semantic_conventions/messaging.md @@ -1,5 +1,10 @@ # Messaging systems +**NOTICE** Semantic Conventions are moving to a +[new location](http://github.com/open-telemetry/semantic-conventions). + +No changes to this document are allowed. + **Status**: [Experimental](../../document-status.md) diff --git a/specification/trace/semantic_conventions/rpc.md b/specification/trace/semantic_conventions/rpc.md index e8ce49a5c9b..683c7acfc63 100644 --- a/specification/trace/semantic_conventions/rpc.md +++ b/specification/trace/semantic_conventions/rpc.md @@ -1,5 +1,10 @@ # Semantic conventions for RPC spans +**NOTICE** Semantic Conventions are moving to a +[new location](http://github.com/open-telemetry/semantic-conventions). + +No changes to this document are allowed. + **Status**: [Experimental](../../document-status.md) This document defines how to describe remote procedure calls diff --git a/specification/trace/semantic_conventions/span-general.md b/specification/trace/semantic_conventions/span-general.md index ec73c9db351..a812800297e 100644 --- a/specification/trace/semantic_conventions/span-general.md +++ b/specification/trace/semantic_conventions/span-general.md @@ -1,5 +1,10 @@ # General attributes +**NOTICE** Semantic Conventions are moving to a +[new location](http://github.com/open-telemetry/semantic-conventions). + +No changes to this document are allowed. + **Status**: [Experimental](../../document-status.md) The attributes described in this section are not specific to a particular operation but rather generic.