Skip to content

Commit 1a03f79

Browse files
authored
Update semconv to 1.38.0 (open-telemetry#4791)
* update semconv to 1.38.0 * up * changelog
1 parent 75c8d67 commit 1a03f79

33 files changed

+2220
-200
lines changed

CHANGELOG.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
1616
([#4734](https://github.com/open-telemetry/opentelemetry-python/pull/4734))
1717
- build: bump ruff to 0.14.1
1818
([#4782](https://github.com/open-telemetry/opentelemetry-python/pull/4782))
19+
- semantic-conventions: Bump to 1.38.0
20+
([#4791](https://github.com/open-telemetry/opentelemetry-python/pull/4791))
1921

2022
## Version 1.38.0/0.59b0 (2025-10-16)
2123

opentelemetry-semantic-conventions/src/opentelemetry/semconv/_incubating/attributes/app_attributes.py

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -67,6 +67,18 @@
6767
The y (vertical) component of a screen coordinate, in screen pixels.
6868
"""
6969

70+
APP_SCREEN_ID: Final = "app.screen.id"
71+
"""
72+
An identifier that uniquely differentiates this screen from other screens in the same application.
73+
Note: A screen represents only the part of the device display drawn by the app. It typically contains multiple widgets or UI components and is larger in scope than individual widgets. Multiple screens can coexist on the same display simultaneously (e.g., split view on tablets).
74+
"""
75+
76+
APP_SCREEN_NAME: Final = "app.screen.name"
77+
"""
78+
The name of an application screen.
79+
Note: A screen represents only the part of the device display drawn by the app. It typically contains multiple widgets or UI components and is larger in scope than individual widgets. Multiple screens can coexist on the same display simultaneously (e.g., split view on tablets).
80+
"""
81+
7082
APP_WIDGET_ID: Final = "app.widget.id"
7183
"""
7284
An identifier that uniquely differentiates this widget from other widgets in the same application.

opentelemetry-semantic-conventions/src/opentelemetry/semconv/_incubating/attributes/azure_attributes.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@
3535
)
3636
"""
3737
List of regions contacted during operation in the order that they were contacted. If there is more than one region listed, it indicates that the operation was performed on multiple regions i.e. cross-regional call.
38-
Note: Region name matches the format of `displayName` in [Azure Location API](https://learn.microsoft.com/rest/api/subscription/subscriptions/list-locations?view=rest-subscription-2021-10-01&tabs=HTTP#location).
38+
Note: Region name matches the format of `displayName` in [Azure Location API](https://learn.microsoft.com/rest/api/resources/subscriptions/list-locations).
3939
"""
4040

4141
AZURE_COSMOSDB_OPERATION_REQUEST_CHARGE: Final = (

opentelemetry-semantic-conventions/src/opentelemetry/semconv/_incubating/attributes/container_attributes.py

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -58,7 +58,7 @@
5858
CONTAINER_IMAGE_ID: Final = "container.image.id"
5959
"""
6060
Runtime specific image identifier. Usually a hash algorithm followed by a UUID.
61-
Note: Docker defines a sha256 of the image id; `container.image.id` corresponds to the `Image` field from the Docker container inspect [API](https://docs.docker.com/engine/api/v1.43/#tag/Container/operation/ContainerInspect) endpoint.
61+
Note: Docker defines a sha256 of the image id; `container.image.id` corresponds to the `Image` field from the Docker container inspect [API](https://docs.docker.com/reference/api/engine/version/v1.43/#tag/Container/operation/ContainerInspect) endpoint.
6262
K8s defines a link to the container registry repository with digest `"imageID": "registry.azurecr.io /namespace/service/dockerfile@sha256:bdeabd40c3a8a492eaf9e8e44d0ebbb84bac7ee25ac0cf8a7159d25f62555625"`.
6363
The ID is assigned by the container runtime and can vary in different environments. Consider using `oci.manifest.digest` if it is important to identify the same image in different environments/runtimes.
6464
"""
@@ -71,12 +71,12 @@
7171
CONTAINER_IMAGE_REPO_DIGESTS: Final = "container.image.repo_digests"
7272
"""
7373
Repo digests of the container image as provided by the container runtime.
74-
Note: [Docker](https://docs.docker.com/engine/api/v1.43/#tag/Image/operation/ImageInspect) and [CRI](https://github.com/kubernetes/cri-api/blob/c75ef5b473bbe2d0a4fc92f82235efd665ea8e9f/pkg/apis/runtime/v1/api.proto#L1237-L1238) report those under the `RepoDigests` field.
74+
Note: [Docker](https://docs.docker.com/reference/api/engine/version/v1.43/#tag/Image/operation/ImageInspect) and [CRI](https://github.com/kubernetes/cri-api/blob/c75ef5b473bbe2d0a4fc92f82235efd665ea8e9f/pkg/apis/runtime/v1/api.proto#L1237-L1238) report those under the `RepoDigests` field.
7575
"""
7676

7777
CONTAINER_IMAGE_TAGS: Final = "container.image.tags"
7878
"""
79-
Container image tags. An example can be found in [Docker Image Inspect](https://docs.docker.com/engine/api/v1.43/#tag/Image/operation/ImageInspect). Should be only the `<tag>` section of the full name for example from `registry.example.com/my-org/my-image:<tag>`.
79+
Container image tags. An example can be found in [Docker Image Inspect](https://docs.docker.com/reference/api/engine/version/v1.43/#tag/Image/operation/ImageInspect). Should be only the `<tag>` section of the full name for example from `registry.example.com/my-org/my-image:<tag>`.
8080
"""
8181

8282
CONTAINER_LABEL_TEMPLATE: Final = "container.label"

opentelemetry-semantic-conventions/src/opentelemetry/semconv/_incubating/attributes/db_attributes.py

Lines changed: 7 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -128,7 +128,7 @@
128128

129129
DB_COSMOSDB_STATUS_CODE: Final = "db.cosmosdb.status_code"
130130
"""
131-
Deprecated: Replaced by `db.response.status_code`.
131+
Deprecated: Use `db.response.status_code` instead.
132132
"""
133133

134134
DB_COSMOSDB_SUB_STATUS_CODE: Final = "db.cosmosdb.sub_status_code"
@@ -215,15 +215,18 @@
215215
`db.query.parameter.<key>` SHOULD match
216216
up with the parameterized placeholders present in `db.query.text`.
217217
218+
It is RECOMMENDED to capture the value as provided by the application
219+
without attempting to do any case normalization.
220+
218221
`db.query.parameter.<key>` SHOULD NOT be captured on batch operations.
219222
220223
Examples:
221224
222225
- For a query `SELECT * FROM users where username = %s` with the parameter `"jdoe"`,
223226
the attribute `db.query.parameter.0` SHOULD be set to `"jdoe"`.
224227
225-
- For a query `"SELECT * FROM users WHERE username = %(username)s;` with parameter
226-
`username = "jdoe"`, the attribute `db.query.parameter.username` SHOULD be set to `"jdoe"`.
228+
- For a query `"SELECT * FROM users WHERE username = %(userName)s;` with parameter
229+
`userName = "jdoe"`, the attribute `db.query.parameter.userName` SHOULD be set to `"jdoe"`.
227230
"""
228231

229232
DB_QUERY_SUMMARY: Final = "db.query.summary"
@@ -238,7 +241,7 @@
238241

239242
DB_REDIS_DATABASE_INDEX: Final = "db.redis.database_index"
240243
"""
241-
Deprecated: Replaced by `db.namespace`.
244+
Deprecated: Uncategorized.
242245
"""
243246

244247
DB_RESPONSE_RETURNED_ROWS: Final = "db.response.returned_rows"

opentelemetry-semantic-conventions/src/opentelemetry/semconv/_incubating/attributes/dns_attributes.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,5 +22,5 @@
2222
DNS_QUESTION_NAME: Final = "dns.question.name"
2323
"""
2424
The name being queried.
25-
Note: If the name field contains non-printable characters (below 32 or above 126), those characters should be represented as escaped base 10 integers (\\DDD). Back slashes and quotes should be escaped. Tabs, carriage returns, and line feeds should be converted to \\t, \\r, and \\n respectively.
25+
Note: The name represents the queried domain name as it appears in the DNS query without any additional normalization.
2626
"""

opentelemetry-semantic-conventions/src/opentelemetry/semconv/_incubating/attributes/enduser_attributes.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,7 @@
3434

3535
ENDUSER_ROLE: Final = "enduser.role"
3636
"""
37-
Deprecated: Replaced by `user.roles`.
37+
Deprecated: Use `user.roles` instead.
3838
"""
3939

4040
ENDUSER_SCOPE: Final = "enduser.scope"

opentelemetry-semantic-conventions/src/opentelemetry/semconv/_incubating/attributes/event_attributes.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,5 +16,5 @@
1616

1717
EVENT_NAME: Final = "event.name"
1818
"""
19-
Deprecated: Replaced by EventName top-level field on the LogRecord.
19+
Deprecated: The value of this attribute MUST now be set as the value of the EventName field on the LogRecord to indicate that the LogRecord represents an Event.
2020
"""

opentelemetry-semantic-conventions/src/opentelemetry/semconv/_incubating/attributes/faas_attributes.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -121,7 +121,7 @@
121121
- **Google Cloud Run (Services):** The [revision](https://cloud.google.com/run/docs/managing/revisions)
122122
(i.e., the function name plus the revision suffix).
123123
- **Google Cloud Functions:** The value of the
124-
[`K_REVISION` environment variable](https://cloud.google.com/functions/docs/env-var#runtime_environment_variables_set_automatically).
124+
[`K_REVISION` environment variable](https://cloud.google.com/run/docs/container-contract#services-env-vars).
125125
- **Azure Functions:** Not applicable. Do not set this attribute.
126126
"""
127127

opentelemetry-semantic-conventions/src/opentelemetry/semconv/_incubating/attributes/gcp_attributes.py

Lines changed: 105 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -72,6 +72,67 @@
7272
The name of the workload as configured in AppHub.
7373
"""
7474

75+
GCP_APPHUB_DESTINATION_APPLICATION_CONTAINER: Final = (
76+
"gcp.apphub_destination.application.container"
77+
)
78+
"""
79+
The container within GCP where the AppHub destination application is defined.
80+
"""
81+
82+
GCP_APPHUB_DESTINATION_APPLICATION_ID: Final = (
83+
"gcp.apphub_destination.application.id"
84+
)
85+
"""
86+
The name of the destination application as configured in AppHub.
87+
"""
88+
89+
GCP_APPHUB_DESTINATION_APPLICATION_LOCATION: Final = (
90+
"gcp.apphub_destination.application.location"
91+
)
92+
"""
93+
The GCP zone or region where the destination application is defined.
94+
"""
95+
96+
GCP_APPHUB_DESTINATION_SERVICE_CRITICALITY_TYPE: Final = (
97+
"gcp.apphub_destination.service.criticality_type"
98+
)
99+
"""
100+
Criticality of a destination workload indicates its importance to the business as specified in [AppHub type enum](https://cloud.google.com/app-hub/docs/reference/rest/v1/Attributes#type).
101+
"""
102+
103+
GCP_APPHUB_DESTINATION_SERVICE_ENVIRONMENT_TYPE: Final = (
104+
"gcp.apphub_destination.service.environment_type"
105+
)
106+
"""
107+
Software lifecycle stage of a destination service as defined [AppHub environment type](https://cloud.google.com/app-hub/docs/reference/rest/v1/Attributes#type_1).
108+
"""
109+
110+
GCP_APPHUB_DESTINATION_SERVICE_ID: Final = "gcp.apphub_destination.service.id"
111+
"""
112+
The name of the destination service as configured in AppHub.
113+
"""
114+
115+
GCP_APPHUB_DESTINATION_WORKLOAD_CRITICALITY_TYPE: Final = (
116+
"gcp.apphub_destination.workload.criticality_type"
117+
)
118+
"""
119+
Criticality of a destination workload indicates its importance to the business as specified in [AppHub type enum](https://cloud.google.com/app-hub/docs/reference/rest/v1/Attributes#type).
120+
"""
121+
122+
GCP_APPHUB_DESTINATION_WORKLOAD_ENVIRONMENT_TYPE: Final = (
123+
"gcp.apphub_destination.workload.environment_type"
124+
)
125+
"""
126+
Environment of a destination workload is the stage of a software lifecycle as provided in the [AppHub environment type](https://cloud.google.com/app-hub/docs/reference/rest/v1/Attributes#type_1).
127+
"""
128+
129+
GCP_APPHUB_DESTINATION_WORKLOAD_ID: Final = (
130+
"gcp.apphub_destination.workload.id"
131+
)
132+
"""
133+
The name of the destination workload as configured in AppHub.
134+
"""
135+
75136
GCP_CLIENT_SERVICE: Final = "gcp.client.service"
76137
"""
77138
Identifies the Google Cloud service for which the official client library is intended.
@@ -141,3 +202,47 @@ class GcpApphubWorkloadEnvironmentTypeValues(Enum):
141202
"""Test environment."""
142203
DEVELOPMENT = "DEVELOPMENT"
143204
"""Development environment."""
205+
206+
207+
class GcpApphubDestinationServiceCriticalityTypeValues(Enum):
208+
MISSION_CRITICAL = "MISSION_CRITICAL"
209+
"""Mission critical service."""
210+
HIGH = "HIGH"
211+
"""High impact."""
212+
MEDIUM = "MEDIUM"
213+
"""Medium impact."""
214+
LOW = "LOW"
215+
"""Low impact."""
216+
217+
218+
class GcpApphubDestinationServiceEnvironmentTypeValues(Enum):
219+
PRODUCTION = "PRODUCTION"
220+
"""Production environment."""
221+
STAGING = "STAGING"
222+
"""Staging environment."""
223+
TEST = "TEST"
224+
"""Test environment."""
225+
DEVELOPMENT = "DEVELOPMENT"
226+
"""Development environment."""
227+
228+
229+
class GcpApphubDestinationWorkloadCriticalityTypeValues(Enum):
230+
MISSION_CRITICAL = "MISSION_CRITICAL"
231+
"""Mission critical service."""
232+
HIGH = "HIGH"
233+
"""High impact."""
234+
MEDIUM = "MEDIUM"
235+
"""Medium impact."""
236+
LOW = "LOW"
237+
"""Low impact."""
238+
239+
240+
class GcpApphubDestinationWorkloadEnvironmentTypeValues(Enum):
241+
PRODUCTION = "PRODUCTION"
242+
"""Production environment."""
243+
STAGING = "STAGING"
244+
"""Staging environment."""
245+
TEST = "TEST"
246+
"""Test environment."""
247+
DEVELOPMENT = "DEVELOPMENT"
248+
"""Development environment."""

0 commit comments

Comments
 (0)