From 6b06fd4a569045263043279f6c20149d04608252 Mon Sep 17 00:00:00 2001 From: Josh Suereth Date: Fri, 10 Feb 2023 12:20:30 -0500 Subject: [PATCH 1/9] Update semantic convention specification to mark important/required resource attributes as stable. --- semantic_conventions/resource/service.yaml | 2 +- .../resource/semantic_conventions/README.md | 23 +++++++++++++++++-- specification/versioning-and-stability.md | 4 ++++ 3 files changed, 26 insertions(+), 3 deletions(-) diff --git a/semantic_conventions/resource/service.yaml b/semantic_conventions/resource/service.yaml index 9c60099f463..5a647c5c680 100644 --- a/semantic_conventions/resource/service.yaml +++ b/semantic_conventions/resource/service.yaml @@ -45,7 +45,7 @@ groups: it is recommended to generate a random Version 1 or Version 4 RFC 4122 UUID (services aiming for reproducible UUIDs may also use Version 5, see RFC 4122 for more recommendations). - examples: ["627cc493-f310-47de-96bd-71410b7dec09"] + examples: ["my-k8s-pod-deployment-1", "627cc493-f310-47de-96bd-71410b7dec09"] - id: version type: string brief: > diff --git a/specification/resource/semantic_conventions/README.md b/specification/resource/semantic_conventions/README.md index 31f29611091..c492edeb90a 100644 --- a/specification/resource/semantic_conventions/README.md +++ b/specification/resource/semantic_conventions/README.md @@ -1,6 +1,6 @@ # Resource Semantic Conventions -**Status**: [Experimental](../../document-status.md) +**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 [OpenCensus Resource standard](https://github.com/census-instrumentation/opencensus-specs/blob/master/resource/StandardResources.md). @@ -34,12 +34,16 @@ This document defines standard attributes for resources. These attributes are ty ## Document Conventions +**Status**: [Stable](../../document-status.md) + Attributes are grouped logically by the type of the concept that they described. Attributes in the same group have a common prefix that ends with a dot. For example all attributes that describe Kubernetes properties start with "k8s." Certain attribute groups in this document have a **Required** column. For these groups if any attribute from the particular group is present in the Resource then all attributes that are marked as Required MUST be also present in the Resource. However it is also valid if the entire attribute group is omitted (i.e. none of the attributes from the particular group are present even though some of them are marked as Required in this document). ## Attributes with Special Handling +**Status**: [Stable](../../document-status.md) + Given their significance some resource attributes are treated specifically as described below. ### Semantic Attributes with Dedicated Environment Variable @@ -55,9 +59,12 @@ These are the attributes which MUST be provided by the SDK as specified in the [Resource SDK specification](../sdk.md#sdk-provided-resource-attributes): - [`service.name`](#service) +- [`telemetry.sdk` group](#telemetry-sdk) ## Service +**Status**: [Stable](../../document-status.md) + **type:** `service` **Description:** A service instance. @@ -67,7 +74,7 @@ as specified in the [Resource SDK specification](../sdk.md#sdk-provided-resource |---|---|---|---|---| | `service.name` | string | Logical name of the service. [1] | `shoppingcart` | Required | | `service.namespace` | string | A namespace for `service.name`. [2] | `Shop` | Recommended | -| `service.instance.id` | string | The string ID of the service instance. [3] | `627cc493-f310-47de-96bd-71410b7dec09` | Recommended | +| `service.instance.id` | string | The string ID of the service instance. [3] | `my-k8s-pod-deployment-1`; `627cc493-f310-47de-96bd-71410b7dec09` | Recommended | | `service.version` | string | The version string of the service API or implementation. | `2.0.0` | Recommended | **[1]:** MUST be the same for all instances of horizontally scaled services. If the value was not specified, SDKs MUST fallback to `unknown_service:` concatenated with [`process.executable.name`](process.md#process), e.g. `unknown_service:bash`. If `process.executable.name` is not available, the value MUST be set to `unknown_service`. @@ -93,6 +100,8 @@ service.name = Shop.shoppingcart ## Telemetry SDK +**Status**: [Stable](../../document-status.md) + **type:** `telemetry.sdk` **Description:** The telemetry SDK used to capture data recorded by the instrumentation libraries. @@ -133,6 +142,8 @@ The identifier SHOULD be stable across different versions of an implementation. ## Compute Unit +**Status**: [Experimental](../../document-status.md) + Attributes defining a compute unit (e.g. Container, Process, Function as a Service): - [Container](./container.md) @@ -142,12 +153,16 @@ Attributes defining a compute unit (e.g. Container, Process, Function as a Servi ## Compute Instance +**Status**: [Experimental](../../document-status.md) + Attributes defining a computing instance (e.g. host): - [Host](./host.md) ## Environment +**Status**: [Experimental](../../document-status.md) + Attributes defining a running environment (e.g. Operating System, Cloud, Data Center, Deployment Service): - [Operating System](./os.md) @@ -160,12 +175,16 @@ Attributes defining a running environment (e.g. Operating System, Cloud, Data Ce ## Version attributes +**Status**: [Stable](../../document-status.md) + Version attributes, such as `service.version`, are values of type `string`. They are the exact version used to identify an artifact. This may be a semantic version, e.g., `1.2.3`, git hash, e.g., `8ae73a`, or an arbitrary version string, e.g., `0.1.2.20210101`, whatever was used when building the artifact. ## Cloud-Provider-Specific Attributes +**Status**: [Experimental](../../document-status.md) + Attributes that are only applicable to resources from a specific cloud provider. Currently, these resources can only be defined for providers listed as a valid `cloud.provider` in [Cloud](./cloud.md) and below. Provider-specific attributes all reside in the `cloud_provider` directory. diff --git a/specification/versioning-and-stability.md b/specification/versioning-and-stability.md index 15115529750..233e075bdfe 100644 --- a/specification/versioning-and-stability.md +++ b/specification/versioning-and-stability.md @@ -176,6 +176,10 @@ For details see [how OpenTelemetry Schemas are published](schemas/README.md#open See the [Telemetry Stability](telemetry-stability.md) document for details on how instrumentations can use schemas to change the instrumentation they produce. +**Exception:** Some resource attributes are embedded in various locations of the +Specification, e.g. the `service.*` attributes which are required by SDKs to be +produced and have corresponding [environment variables defined in general SDK configuration](sdk-environment-variables.md#general-sdk-configuration). + In addition to the 3 types of changes described above there are certain types that are always allowed. Such changes do not need to be described (and are not described) by schema files. Here is the list of such changes: From 1e3c6dd505f4e46c955cae52817ddb151e144b86 Mon Sep 17 00:00:00 2001 From: Josh Suereth Date: Tue, 21 Feb 2023 13:07:25 -0500 Subject: [PATCH 2/9] Split contentious attributes into experimental portions so we can mark important attributes stable. --- semantic_conventions/resource/service.yaml | 36 +--------------- .../resource/service_experimental.yaml | 42 +++++++++++++++++++ semantic_conventions/resource/telemetry.yaml | 6 +-- .../resource/telemetry_experimental.yaml | 12 ++++++ .../resource/semantic_conventions/README.md | 38 ++++++++++++++--- 5 files changed, 88 insertions(+), 46 deletions(-) create mode 100644 semantic_conventions/resource/service_experimental.yaml create mode 100644 semantic_conventions/resource/telemetry_experimental.yaml diff --git a/semantic_conventions/resource/service.yaml b/semantic_conventions/resource/service.yaml index 5a647c5c680..af96580ca14 100644 --- a/semantic_conventions/resource/service.yaml +++ b/semantic_conventions/resource/service.yaml @@ -16,38 +16,4 @@ groups: with [`process.executable.name`](process.md#process), e.g. `unknown_service:bash`. If `process.executable.name` is not available, the value MUST be set to `unknown_service`. examples: ["shoppingcart"] - - id: namespace - type: string - brief: > - A namespace for `service.name`. - note: > - A string value having a meaning that helps to distinguish a group of services, - for example the team name that owns a group of services. - `service.name` is expected to be unique within the same namespace. - If `service.namespace` is not specified in the Resource then `service.name` - is expected to be unique for all services that have no explicit namespace defined - (so the empty/unspecified namespace is simply one more valid namespace). - Zero-length namespace string is assumed equal to unspecified namespace. - examples: ["Shop"] - - id: instance.id - type: string - brief: > - The string ID of the service instance. - note: > - MUST be unique for each instance of the same `service.namespace,service.name` pair - (in other words `service.namespace,service.name,service.instance.id` triplet MUST be globally unique). - The ID helps to distinguish instances of the same service that exist at the same time - (e.g. instances of a horizontally scaled service). It is preferable for the ID to be persistent - and stay the same for the lifetime of the service instance, however it is acceptable that - the ID is ephemeral and changes during important lifetime events for the service - (e.g. service restarts). - If the service has no inherent unique ID that can be used as the value of this attribute - it is recommended to generate a random Version 1 or Version 4 RFC 4122 UUID - (services aiming for reproducible UUIDs may also use Version 5, see RFC 4122 - for more recommendations). - examples: ["my-k8s-pod-deployment-1", "627cc493-f310-47de-96bd-71410b7dec09"] - - id: version - type: string - brief: > - The version string of the service API or implementation. - examples: ["2.0.0"] + diff --git a/semantic_conventions/resource/service_experimental.yaml b/semantic_conventions/resource/service_experimental.yaml new file mode 100644 index 00000000000..4ad790d16ab --- /dev/null +++ b/semantic_conventions/resource/service_experimental.yaml @@ -0,0 +1,42 @@ +groups: + - id: service_experimental + prefix: service + type: resource + brief: > + A service instance. + attributes: + - id: namespace + type: string + brief: > + A namespace for `service.name`. + note: > + A string value having a meaning that helps to distinguish a group of services, + for example the team name that owns a group of services. + `service.name` is expected to be unique within the same namespace. + If `service.namespace` is not specified in the Resource then `service.name` + is expected to be unique for all services that have no explicit namespace defined + (so the empty/unspecified namespace is simply one more valid namespace). + Zero-length namespace string is assumed equal to unspecified namespace. + examples: ["Shop"] + - id: instance.id + type: string + brief: > + The string ID of the service instance. + note: > + MUST be unique for each instance of the same `service.namespace,service.name` pair + (in other words `service.namespace,service.name,service.instance.id` triplet MUST be globally unique). + The ID helps to distinguish instances of the same service that exist at the same time + (e.g. instances of a horizontally scaled service). It is preferable for the ID to be persistent + and stay the same for the lifetime of the service instance, however it is acceptable that + the ID is ephemeral and changes during important lifetime events for the service + (e.g. service restarts). + If the service has no inherent unique ID that can be used as the value of this attribute + it is recommended to generate a random Version 1 or Version 4 RFC 4122 UUID + (services aiming for reproducible UUIDs may also use Version 5, see RFC 4122 + for more recommendations). + examples: ["my-k8s-pod-deployment-1", "627cc493-f310-47de-96bd-71410b7dec09"] + - id: version + type: string + brief: > + The version string of the service API or implementation. + examples: ["2.0.0"] diff --git a/semantic_conventions/resource/telemetry.yaml b/semantic_conventions/resource/telemetry.yaml index fc80b853895..d0c16c9f632 100644 --- a/semantic_conventions/resource/telemetry.yaml +++ b/semantic_conventions/resource/telemetry.yaml @@ -43,8 +43,4 @@ groups: brief: > The version string of the telemetry SDK. examples: ["1.2.3"] - - id: auto.version - type: string - brief: > - The version string of the auto instrumentation agent, if used. - examples: ["1.2.3"] + diff --git a/semantic_conventions/resource/telemetry_experimental.yaml b/semantic_conventions/resource/telemetry_experimental.yaml new file mode 100644 index 00000000000..63137055173 --- /dev/null +++ b/semantic_conventions/resource/telemetry_experimental.yaml @@ -0,0 +1,12 @@ +groups: + - id: telemetry_experimental + prefix: telemetry + type: resource + brief: > + The telemetry SDK used to capture data recorded by the instrumentation libraries. + attributes: + - id: auto.version + type: string + brief: > + The version string of the auto instrumentation agent, if used. + examples: ["1.2.3"] diff --git a/specification/resource/semantic_conventions/README.md b/specification/resource/semantic_conventions/README.md index f8034537ad5..de33250032f 100644 --- a/specification/resource/semantic_conventions/README.md +++ b/specification/resource/semantic_conventions/README.md @@ -73,15 +73,28 @@ as specified in the [Resource SDK specification](../sdk.md#sdk-provided-resource | Attribute | Type | Description | Examples | Requirement Level | |---|---|---|---|---| | `service.name` | string | Logical name of the service. [1] | `shoppingcart` | Required | -| `service.namespace` | string | A namespace for `service.name`. [2] | `Shop` | Recommended | -| `service.instance.id` | string | The string ID of the service instance. [3] | `my-k8s-pod-deployment-1`; `627cc493-f310-47de-96bd-71410b7dec09` | Recommended | -| `service.version` | string | The version string of the service API or implementation. | `2.0.0` | Recommended | **[1]:** MUST be the same for all instances of horizontally scaled services. If the value was not specified, SDKs MUST fallback to `unknown_service:` concatenated with [`process.executable.name`](process.md#process), e.g. `unknown_service:bash`. If `process.executable.name` is not available, the value MUST be set to `unknown_service`. + + +## Service (Experimental) + +**Status**: [Experimental](../../document-status.md) + +**type:** `service` + +**Description:** Additions to service instance. + + +| Attribute | Type | Description | Examples | Requirement Level | +|---|---|---|---|---| +| `service.namespace` | string | A namespace for `service.name`. [1] | `Shop` | Recommended | +| `service.instance.id` | string | The string ID of the service instance. [2] | `my-k8s-pod-deployment-1`; `627cc493-f310-47de-96bd-71410b7dec09` | Recommended | +| `service.version` | string | The version string of the service API or implementation. | `2.0.0` | Recommended | -**[2]:** A string value having a meaning that helps to distinguish a group of services, for example the team name that owns a group of services. `service.name` is expected to be unique within the same namespace. If `service.namespace` is not specified in the Resource then `service.name` is expected to be unique for all services that have no explicit namespace defined (so the empty/unspecified namespace is simply one more valid namespace). Zero-length namespace string is assumed equal to unspecified namespace. +**[1]:** A string value having a meaning that helps to distinguish a group of services, for example the team name that owns a group of services. `service.name` is expected to be unique within the same namespace. If `service.namespace` is not specified in the Resource then `service.name` is expected to be unique for all services that have no explicit namespace defined (so the empty/unspecified namespace is simply one more valid namespace). Zero-length namespace string is assumed equal to unspecified namespace. -**[3]:** MUST be unique for each instance of the same `service.namespace,service.name` pair (in other words `service.namespace,service.name,service.instance.id` triplet MUST be globally unique). The ID helps to distinguish instances of the same service that exist at the same time (e.g. instances of a horizontally scaled service). It is preferable for the ID to be persistent and stay the same for the lifetime of the service instance, however it is acceptable that the ID is ephemeral and changes during important lifetime events for the service (e.g. service restarts). If the service has no inherent unique ID that can be used as the value of this attribute it is recommended to generate a random Version 1 or Version 4 RFC 4122 UUID (services aiming for reproducible UUIDs may also use Version 5, see RFC 4122 for more recommendations). +**[2]:** MUST be unique for each instance of the same `service.namespace,service.name` pair (in other words `service.namespace,service.name,service.instance.id` triplet MUST be globally unique). The ID helps to distinguish instances of the same service that exist at the same time (e.g. instances of a horizontally scaled service). It is preferable for the ID to be persistent and stay the same for the lifetime of the service instance, however it is acceptable that the ID is ephemeral and changes during important lifetime events for the service (e.g. service restarts). If the service has no inherent unique ID that can be used as the value of this attribute it is recommended to generate a random Version 1 or Version 4 RFC 4122 UUID (services aiming for reproducible UUIDs may also use Version 5, see RFC 4122 for more recommendations). Note: `service.namespace` and `service.name` are not intended to be concatenated for the purpose of forming a single globally unique name for the service. For example the following 2 sets of attributes actually describe 2 different services (despite the fact that the concatenation would result in the same string): @@ -121,7 +134,6 @@ The identifier SHOULD be stable across different versions of an implementation. | `telemetry.sdk.name` | string | The name of the telemetry SDK as defined above. | `opentelemetry` | Recommended | | `telemetry.sdk.language` | string | The language of the telemetry SDK. | `cpp` | Recommended | | `telemetry.sdk.version` | string | The version string of the telemetry SDK. | `1.2.3` | Recommended | -| `telemetry.auto.version` | string | The version string of the auto instrumentation agent, if used. | `1.2.3` | Recommended | `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. @@ -140,6 +152,20 @@ The identifier SHOULD be stable across different versions of an implementation. | `swift` | swift | +## Telemetry SDK (Experimental) + +**Status**: [Experimental](../../document-status.md) + +**type:** `telemetry.sdk` + +**Description:** Additions to the telemetry SDK. + + +| Attribute | Type | Description | Examples | Requirement Level | +|---|---|---|---|---| +| `telemetry.auto.version` | string | The version string of the auto instrumentation agent, if used. | `1.2.3` | Recommended | + + ## Compute Unit **Status**: [Experimental](../../document-status.md) From ed5a184e5f7bb5d1a96bafea6b8e5ac622ec4a2c Mon Sep 17 00:00:00 2001 From: Josh Suereth Date: Wed, 22 Feb 2023 13:54:44 -0500 Subject: [PATCH 3/9] Mark attributes that were listed as required for SDKs as required to avoid conflicting statements. --- semantic_conventions/resource/telemetry.yaml | 3 +++ specification/resource/semantic_conventions/README.md | 6 +++--- 2 files changed, 6 insertions(+), 3 deletions(-) diff --git a/semantic_conventions/resource/telemetry.yaml b/semantic_conventions/resource/telemetry.yaml index d0c16c9f632..2e88664352d 100644 --- a/semantic_conventions/resource/telemetry.yaml +++ b/semantic_conventions/resource/telemetry.yaml @@ -7,6 +7,7 @@ groups: attributes: - id: sdk.name type: string + requirement_level: required brief: > The name of the telemetry SDK as defined above. examples: ["opentelemetry"] @@ -36,10 +37,12 @@ groups: value: "webjs" - id: swift value: "swift" + requirement_level: required brief: > The language of the telemetry SDK. - id: sdk.version type: string + requirement_level: required brief: > The version string of the telemetry SDK. examples: ["1.2.3"] diff --git a/specification/resource/semantic_conventions/README.md b/specification/resource/semantic_conventions/README.md index de33250032f..db9a49fc8b7 100644 --- a/specification/resource/semantic_conventions/README.md +++ b/specification/resource/semantic_conventions/README.md @@ -131,9 +131,9 @@ The identifier SHOULD be stable across different versions of an implementation. | Attribute | Type | Description | Examples | Requirement Level | |---|---|---|---|---| -| `telemetry.sdk.name` | string | The name of the telemetry SDK as defined above. | `opentelemetry` | Recommended | -| `telemetry.sdk.language` | string | The language of the telemetry SDK. | `cpp` | Recommended | -| `telemetry.sdk.version` | string | The version string of the telemetry SDK. | `1.2.3` | Recommended | +| `telemetry.sdk.name` | string | The name of the telemetry SDK as defined above. | `opentelemetry` | Required | +| `telemetry.sdk.language` | string | The language of the telemetry SDK. | `cpp` | Required | +| `telemetry.sdk.version` | string | The version string of the telemetry SDK. | `1.2.3` | Required | `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. From 3334481d41ef6c6561d66fbbc5e6df4cf58596fe Mon Sep 17 00:00:00 2001 From: Josh Suereth Date: Wed, 22 Feb 2023 14:49:32 -0500 Subject: [PATCH 4/9] Fix toc. --- specification/resource/semantic_conventions/README.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/specification/resource/semantic_conventions/README.md b/specification/resource/semantic_conventions/README.md index db9a49fc8b7..3a9dc34e11b 100644 --- a/specification/resource/semantic_conventions/README.md +++ b/specification/resource/semantic_conventions/README.md @@ -15,7 +15,9 @@ This document defines standard attributes for resources. These attributes are ty * [Semantic Attributes with Dedicated Environment Variable](#semantic-attributes-with-dedicated-environment-variable) - [Semantic Attributes with SDK-provided Default Value](#semantic-attributes-with-sdk-provided-default-value) - [Service](#service) +- [Service (Experimental)](#service-experimental) - [Telemetry SDK](#telemetry-sdk) +- [Telemetry SDK (Experimental)](#telemetry-sdk-experimental) - [Compute Unit](#compute-unit) - [Compute Instance](#compute-instance) - [Environment](#environment) From 69cf8852b46634a5039a2ed3ef4c05b3b41c7355 Mon Sep 17 00:00:00 2001 From: Josh Suereth Date: Wed, 22 Feb 2023 14:52:38 -0500 Subject: [PATCH 5/9] Fix yamllint errors. --- semantic_conventions/resource/service.yaml | 1 - semantic_conventions/resource/telemetry.yaml | 1 - 2 files changed, 2 deletions(-) diff --git a/semantic_conventions/resource/service.yaml b/semantic_conventions/resource/service.yaml index af96580ca14..3765345bac1 100644 --- a/semantic_conventions/resource/service.yaml +++ b/semantic_conventions/resource/service.yaml @@ -16,4 +16,3 @@ groups: with [`process.executable.name`](process.md#process), e.g. `unknown_service:bash`. If `process.executable.name` is not available, the value MUST be set to `unknown_service`. examples: ["shoppingcart"] - diff --git a/semantic_conventions/resource/telemetry.yaml b/semantic_conventions/resource/telemetry.yaml index 2e88664352d..979566f8414 100644 --- a/semantic_conventions/resource/telemetry.yaml +++ b/semantic_conventions/resource/telemetry.yaml @@ -46,4 +46,3 @@ groups: brief: > The version string of the telemetry SDK. examples: ["1.2.3"] - From 8aa57e0cb9994c0e688e612bf9cf24d0dcef3a8f Mon Sep 17 00:00:00 2001 From: Josh Suereth Date: Mon, 3 Apr 2023 12:15:56 -0400 Subject: [PATCH 6/9] Remove unecessary paragraph for attribute requirement level link. --- specification/resource/semantic_conventions/README.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/specification/resource/semantic_conventions/README.md b/specification/resource/semantic_conventions/README.md index 35f8444f6e0..4deb41d7b61 100644 --- a/specification/resource/semantic_conventions/README.md +++ b/specification/resource/semantic_conventions/README.md @@ -40,7 +40,8 @@ This document defines standard attributes for resources. These attributes are ty Attributes are grouped logically by the type of the concept that they described. Attributes in the same group have a common prefix that ends with a dot. For example all attributes that describe Kubernetes properties start with "k8s." -Certain attribute groups in this document have a **Required** column. For these groups if any attribute from the particular group is present in the Resource then all attributes that are marked as Required MUST be also present in the Resource. However it is also valid if the entire attribute group is omitted (i.e. none of the attributes from the particular group are present even though some of them are marked as Required in this document). +See [Attribute Requirement Levels](../../common/attribute-requirement-level.md) for details on when attributes +should be included. ## Attributes with Special Handling From dfc5fcc40185f0a8502c7e6ce5768035d3658bde Mon Sep 17 00:00:00 2001 From: Josh Suereth Date: Mon, 3 Apr 2023 12:27:05 -0400 Subject: [PATCH 7/9] Add changelog. --- CHANGELOG.md | 3 +++ 1 file changed, 3 insertions(+) diff --git a/CHANGELOG.md b/CHANGELOG.md index d245b19650c..061064bf0d7 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -54,6 +54,9 @@ release. [#3348](https://github.com/open-telemetry/opentelemetry-specification/pull/3348)) - Define attributes collected for `cosmosdb` by Cosmos DB SDK ([#3097](https://github.com/open-telemetry/opentelemetry-specification/pull/3097)) +- Stabilize key components of `service.*` and `telemetry.sdk.*` resource + semantic conventions. + ([#3202](https://github.com/open-telemetry/opentelemetry-specification/pull/3202)) ### Compatibility From 48f659d140419081eb6f4531ac8dc549b30d8aac Mon Sep 17 00:00:00 2001 From: Josh Suereth Date: Mon, 3 Apr 2023 12:32:35 -0400 Subject: [PATCH 8/9] Update to handle Tigran's comments. --- specification/versioning-and-stability.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/specification/versioning-and-stability.md b/specification/versioning-and-stability.md index 233e075bdfe..b12d1218077 100644 --- a/specification/versioning-and-stability.md +++ b/specification/versioning-and-stability.md @@ -178,7 +178,9 @@ instrumentations can use schemas to change the instrumentation they produce. **Exception:** Some resource attributes are embedded in various locations of the Specification, e.g. the `service.*` attributes which are required by SDKs to be -produced and have corresponding [environment variables defined in general SDK configuration](sdk-environment-variables.md#general-sdk-configuration). +produced and have corresponding [environment variables defined in general SDK configuration](sdk-environment-variables.md#general-sdk-configuration). These resource +attributes MUST NOT be ever changed. They are considered a hard-coded part of +this specification. In addition to the 3 types of changes described above there are certain types that are always allowed. Such changes do not need to be described (and are not From 7b3242f27a445f004b5741b26ee5eb0d743baae9 Mon Sep 17 00:00:00 2001 From: Josh Suereth Date: Mon, 3 Apr 2023 12:36:12 -0400 Subject: [PATCH 9/9] Clarify that custom identifiers should remain stable across their own versions. --- specification/resource/semantic_conventions/README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/specification/resource/semantic_conventions/README.md b/specification/resource/semantic_conventions/README.md index 4deb41d7b61..ee9eacc597a 100644 --- a/specification/resource/semantic_conventions/README.md +++ b/specification/resource/semantic_conventions/README.md @@ -129,7 +129,7 @@ If another SDK, like a fork or a vendor-provided implementation, is used, this S `telemetry.sdk.name` to the fully-qualified class or module name of this SDK's main entry point or another suitable identifier depending on the language. The identifier `opentelemetry` is reserved and MUST NOT be used in this case. -The identifier SHOULD be stable across different versions of an implementation. +All custom identifiers SHOULD be stable across different versions of an implementation. | Attribute | Type | Description | Examples | Requirement Level |