open-telemetry
/
semantic-conventions
mirror of https://github.com/open-telemetry/semantic-conventions.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Reflect service.*, telemetry.sdk.* stability in model (#620)

This commit is contained in:
jack-berg 2024-01-02 12:31:26 -06:00 committed by GitHub
parent 7051551400
commit 9423bd3a0b
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
3 changed files with 10 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
docs/resource/README.md
View File

@ -82,8 +82,8 @@ as specified in the [Resource SDK specification](https://github.com/open-telemet
<!-- semconv service --> <!-- semconv service -->
| Attribute | Type | Description | Examples | Requirement Level | | Attribute | Type | Description | Examples | Requirement Level |
|---|---|---|---|---| |---|---|---|---|---|
| `service.name` | string | Logical name of the service. [1] | `shoppingcart` | Required | | `service.name` | string | ![Stable](https://img.shields.io/badge/-stable-lightgreen)<br>Logical name of the service. [1] | `shoppingcart` | Required |
| `service.version` | string | The version string of the service API or implementation. The format is not defined by these conventions. | `2.0.0`; `a01dbef8a` | Recommended | | `service.version` | string | ![Stable](https://img.shields.io/badge/-stable-lightgreen)<br>The version string of the service API or implementation. The format is not defined by these conventions. | `2.0.0`; `a01dbef8a` | 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`. **[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`.
<!-- endsemconv --> <!-- endsemconv -->
@ -132,9 +132,9 @@ service.name = Shop.shoppingcart
<!-- semconv telemetry --> <!-- semconv telemetry -->
| Attribute | Type | Description | Examples | Requirement Level | | Attribute | Type | Description | Examples | Requirement Level |
|---|---|---|---|---| |---|---|---|---|---|
| `telemetry.sdk.language` | string | The language of the telemetry SDK. | `cpp` | Required | | `telemetry.sdk.language` | string | ![Stable](https://img.shields.io/badge/-stable-lightgreen)<br>The language of the telemetry SDK. | `cpp` | Required |
| `telemetry.sdk.name` | string | The name of the telemetry SDK as defined above. [1] | `opentelemetry` | Required | | `telemetry.sdk.name` | string | ![Stable](https://img.shields.io/badge/-stable-lightgreen)<br>The name of the telemetry SDK as defined above. [1] | `opentelemetry` | Required |
| `telemetry.sdk.version` | string | The version string of the telemetry SDK. | `1.2.3` | Required | | `telemetry.sdk.version` | string | ![Stable](https://img.shields.io/badge/-stable-lightgreen)<br>The version string of the telemetry SDK. | `1.2.3` | Required |
**[1]:** The OpenTelemetry SDK MUST set the `telemetry.sdk.name` attribute to `opentelemetry`. **[1]:** The OpenTelemetry SDK MUST set the `telemetry.sdk.name` attribute to `opentelemetry`.
If another SDK, like a fork or a vendor-provided implementation, is used, this SDK MUST set the If another SDK, like a fork or a vendor-provided implementation, is used, this SDK MUST set the

2
model/resource/service.yaml
View File

@ -7,6 +7,7 @@ groups:
attributes: attributes:
- id: name - id: name
type: string type: string
stability: stable
requirement_level: required requirement_level: required
brief: > brief: >
Logical name of the service. Logical name of the service.
@ -18,6 +19,7 @@ groups:
examples: ["shoppingcart"] examples: ["shoppingcart"]
- id: version - id: version
type: string type: string
stability: stable
brief: > brief: >
The version string of the service API or implementation. The format is not defined by these conventions. The version string of the service API or implementation. The format is not defined by these conventions.
examples: ["2.0.0", "a01dbef8a"] examples: ["2.0.0", "a01dbef8a"]

3
model/resource/telemetry.yaml
View File

@ -7,6 +7,7 @@ groups:
attributes: attributes:
- id: sdk.name - id: sdk.name
type: string type: string
stability: stable
requirement_level: required requirement_level: required
brief: > brief: >
The name of the telemetry SDK as defined above. The name of the telemetry SDK as defined above.
@ -46,11 +47,13 @@ groups:
value: "swift" value: "swift"
- id: webjs - id: webjs
value: "webjs" value: "webjs"
stability: stable
requirement_level: required requirement_level: required
brief: > brief: >
The language of the telemetry SDK. The language of the telemetry SDK.
- id: sdk.version - id: sdk.version
type: string type: string
stability: stable
requirement_level: required requirement_level: required
brief: > brief: >
The version string of the telemetry SDK. The version string of the telemetry SDK.