From 9423bd3a0b3efb6b3664b574f094b54f03e83b31 Mon Sep 17 00:00:00 2001
From: jack-berg <34418638+jack-berg@users.noreply.github.com>
Date: Tue, 2 Jan 2024 12:31:26 -0600
Subject: [PATCH] Reflect service.*, telemetry.sdk.* stability in model (#620)
---
docs/resource/README.md | 10 +++++-----
model/resource/service.yaml | 2 ++
model/resource/telemetry.yaml | 3 +++
3 files changed, 10 insertions(+), 5 deletions(-)
diff --git a/docs/resource/README.md b/docs/resource/README.md
index 5a12b1859..a77cbd2f6 100644
--- a/docs/resource/README.md
+++ b/docs/resource/README.md
@@ -82,8 +82,8 @@ as specified in the [Resource SDK specification](https://github.com/open-telemet
| Attribute | Type | Description | Examples | Requirement Level |
|---|---|---|---|---|
-| `service.name` | string | 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.name` | string | 
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 |
**[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`.
@@ -132,9 +132,9 @@ service.name = Shop.shoppingcart
| Attribute | Type | Description | Examples | Requirement Level |
|---|---|---|---|---|
-| `telemetry.sdk.language` | string | 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.version` | string | The version string of the telemetry SDK. | `1.2.3` | Required |
+| `telemetry.sdk.language` | string | 
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.version` | string | 
The version string of the telemetry SDK. | `1.2.3` | Required |
**[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
diff --git a/model/resource/service.yaml b/model/resource/service.yaml
index e930b6219..05b2e0269 100644
--- a/model/resource/service.yaml
+++ b/model/resource/service.yaml
@@ -7,6 +7,7 @@ groups:
attributes:
- id: name
type: string
+ stability: stable
requirement_level: required
brief: >
Logical name of the service.
@@ -18,6 +19,7 @@ groups:
examples: ["shoppingcart"]
- id: version
type: string
+ stability: stable
brief: >
The version string of the service API or implementation. The format is not defined by these conventions.
examples: ["2.0.0", "a01dbef8a"]
diff --git a/model/resource/telemetry.yaml b/model/resource/telemetry.yaml
index 6966b4a85..9b57a7afd 100644
--- a/model/resource/telemetry.yaml
+++ b/model/resource/telemetry.yaml
@@ -7,6 +7,7 @@ groups:
attributes:
- id: sdk.name
type: string
+ stability: stable
requirement_level: required
brief: >
The name of the telemetry SDK as defined above.
@@ -46,11 +47,13 @@ groups:
value: "swift"
- id: webjs
value: "webjs"
+ stability: stable
requirement_level: required
brief: >
The language of the telemetry SDK.
- id: sdk.version
type: string
+ stability: stable
requirement_level: required
brief: >
The version string of the telemetry SDK.