opentelemetry-semantic_conventions 1.39.0 → 1.40.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (32) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +4 -0
  3. data/lib/opentelemetry/semantic_conventions/version.rb +2 -2
  4. data/lib/opentelemetry/semconv/db/attributes.rb +5 -0
  5. data/lib/opentelemetry/semconv/exception/attributes.rb +2 -0
  6. data/lib/opentelemetry/semconv/http/attributes.rb +9 -2
  7. data/lib/opentelemetry/semconv/incubating/container/attributes.rb +4 -4
  8. data/lib/opentelemetry/semconv/incubating/db/attributes.rb +5 -0
  9. data/lib/opentelemetry/semconv/incubating/error/attributes.rb +1 -0
  10. data/lib/opentelemetry/semconv/incubating/exception/attributes.rb +2 -0
  11. data/lib/opentelemetry/semconv/incubating/feature_flag/attributes.rb +7 -2
  12. data/lib/opentelemetry/semconv/incubating/gcp/attributes.rb +15 -0
  13. data/lib/opentelemetry/semconv/incubating/gen_ai/attributes.rb +45 -0
  14. data/lib/opentelemetry/semconv/incubating/http/attributes.rb +9 -2
  15. data/lib/opentelemetry/semconv/incubating/jvm/metrics.rb +5 -0
  16. data/lib/opentelemetry/semconv/incubating/k8s/attributes.rb +174 -42
  17. data/lib/opentelemetry/semconv/incubating/k8s/metrics.rb +43 -0
  18. data/lib/opentelemetry/semconv/incubating/message/attributes.rb +8 -8
  19. data/lib/opentelemetry/semconv/incubating/openai/attributes.rb +5 -0
  20. data/lib/opentelemetry/semconv/incubating/oracle/attributes.rb +79 -0
  21. data/lib/opentelemetry/semconv/incubating/oracle.rb +21 -0
  22. data/lib/opentelemetry/semconv/incubating/oracle_cloud/attributes.rb +38 -0
  23. data/lib/opentelemetry/semconv/incubating/oracle_cloud.rb +21 -0
  24. data/lib/opentelemetry/semconv/incubating/pprof/attributes.rb +14 -0
  25. data/lib/opentelemetry/semconv/incubating/rpc/attributes.rb +10 -6
  26. data/lib/opentelemetry/semconv/incubating/rpc/metrics.rb +8 -4
  27. data/lib/opentelemetry/semconv/incubating/service/attributes.rb +13 -2
  28. data/lib/opentelemetry/semconv/incubating/system/metrics.rb +10 -4
  29. data/lib/opentelemetry/semconv/incubating/url/attributes.rb +19 -0
  30. data/lib/opentelemetry/semconv/service/attributes.rb +39 -0
  31. data/lib/opentelemetry/semconv/url/attributes.rb +19 -0
  32. metadata +8 -4
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: e49a9dbae06f7fa323d27e16cba48f7df45460602acd8969ac0a3172506b76b3
4
- data.tar.gz: 8134974d85744209fc52e303de680691d4d049b5e54dff4b9a743a8b89afddf3
3
+ metadata.gz: ffb65318e9077b70e39094e8e36a040324a86efc2867623ecca7dafc65a9dfa2
4
+ data.tar.gz: ed3108a7b4bda42719148657e18a5c9eb4d88546901f4bb54c7ed011cb1ec01f
5
5
  SHA512:
6
- metadata.gz: f5c32ee66b18e56efbf598212ab1a0c5365a51ceda54bb6ad17bedae8fb8d75c6b8e82cb4ecd45f6a26cdf5d4d2c3b9830040f5efa9c6422a2fcc223b1db88a3
7
- data.tar.gz: 46073d50823730d0b1c34c70a24982ea0de43692deb627a0da289c7b21ee0ff0067adbd7429fc52565728c30e0fe84886b8a93dd7f1684ce0cf71d196a566d4e
6
+ metadata.gz: 42a11f6d13e431ddf77031dc2feee263fb262992977775b95ec55b6983f9aa620f982fed217d5c53ba34d852e3a8aca96de76ebd22c66e5d37de8a6eec5868e0
7
+ data.tar.gz: 72f1d1a8d50aea38822821325f5c311a9ae1e9f1e92c2f79d7670bf7480534bcd60a8cb3052152331d3d3e3f780eabc536e9d4dc1bd1e484169b9123a7c1c21c
data/CHANGELOG.md CHANGED
@@ -1,5 +1,9 @@
1
1
  # Release History: opentelemetry-semantic_conventions
2
2
 
3
+ ### v1.40.0 / 2026-06-09
4
+
5
+ * ADDED: Update dependency open-telemetry/semantic-conventions to v1.40.0 (#2173)
6
+
3
7
  ### v1.39.0 / 2026-06-03
4
8
 
5
9
  * ADDED: Update dependency open-telemetry/semantic-conventions to v1.39.0 (#2137)
@@ -7,8 +7,8 @@
7
7
  module OpenTelemetry
8
8
  module SemanticConventions
9
9
  # Version of the OpenTelemetry Semantic Conventions from which this library was generated.
10
- SPEC_VERSION = '1.39.0'
10
+ SPEC_VERSION = '1.40.0'
11
11
  # Release version of this gem. May not match SPEC_VERSION until gem is released after a spec update.
12
- VERSION = '1.39.0'
12
+ VERSION = '1.40.0'
13
13
  end
14
14
  end
@@ -86,6 +86,11 @@ module OpenTelemetry
86
86
  # [Generating query summary](/docs/db/database-spans.md#generating-a-summary-of-the-query)
87
87
  # section.
88
88
  #
89
+ # For batch operations, if the individual operations are known to have the same query summary
90
+ # then that query summary SHOULD be used prepended by `BATCH `,
91
+ # otherwise `db.query.summary` SHOULD be `BATCH` or some other database
92
+ # system specific term if more applicable.
93
+ #
89
94
  # @note Stability Level: stable
90
95
  DB_QUERY_SUMMARY = 'db.query.summary'
91
96
 
@@ -31,6 +31,8 @@ module OpenTelemetry
31
31
 
32
32
  # The exception message.
33
33
  #
34
+ # > [!WARNING]> This attribute may contain sensitive information.
35
+ #
34
36
  # @note Stability Level: stable
35
37
  EXCEPTION_MESSAGE = 'exception.message'
36
38
 
@@ -62,8 +62,15 @@ module OpenTelemetry
62
62
  #
63
63
  # If the HTTP instrumentation could end up converting valid HTTP request methods to `_OTHER`, then it MUST provide a way to override
64
64
  # the list of known HTTP methods. If this override is done via environment variable, then the environment variable MUST be named
65
- # OTEL_INSTRUMENTATION_HTTP_KNOWN_METHODS and support a comma-separated list of case-sensitive known HTTP methods
66
- # (this list MUST be a full override of the default known method, it is not a list of known methods in addition to the defaults).
65
+ # OTEL_INSTRUMENTATION_HTTP_KNOWN_METHODS and support a comma-separated list of case-sensitive known HTTP methods.
66
+ #
67
+ #
68
+ # If this override is done via declarative configuration, then the list MUST be configurable via the `known_methods` property
69
+ # (an array of case-sensitive strings with minimum items 0) under `.instrumentation/development.general.http.client` and/or
70
+ # `.instrumentation/development.general.http.server`.
71
+ #
72
+ # In either case, this list MUST be a full override of the default known methods,
73
+ # it is not a list of known methods in addition to the defaults.
67
74
  #
68
75
  # HTTP method names are case-sensitive and `http.request.method` attribute value MUST match a known HTTP method name exactly.
69
76
  # Instrumentations for specific web frameworks that consider HTTP methods to be case insensitive, SHOULD populate a canonical equivalent.
@@ -63,7 +63,7 @@ module OpenTelemetry
63
63
 
64
64
  # Container ID. Usually a UUID, as for example used to [identify Docker containers](https://docs.docker.com/engine/containers/run/#container-identification). The UUID might be abbreviated.
65
65
  #
66
- # @note Stability Level: alpha
66
+ # @note Stability Level: beta
67
67
  CONTAINER_ID = 'container.id'
68
68
 
69
69
  # Runtime specific image identifier. Usually a hash algorithm followed by a UUID.
@@ -77,19 +77,19 @@ module OpenTelemetry
77
77
 
78
78
  # Name of the image the container was built on.
79
79
  #
80
- # @note Stability Level: alpha
80
+ # @note Stability Level: beta
81
81
  CONTAINER_IMAGE_NAME = 'container.image.name'
82
82
 
83
83
  # Repo digests of the container image as provided by the container runtime.
84
84
  #
85
85
  # [Docker](https://docs.docker.com/reference/api/engine/version/v1.52/#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.
86
86
  #
87
- # @note Stability Level: alpha
87
+ # @note Stability Level: beta
88
88
  CONTAINER_IMAGE_REPO_DIGESTS = 'container.image.repo_digests'
89
89
 
90
90
  # Container image tags. An example can be found in [Docker Image Inspect](https://docs.docker.com/reference/api/engine/version/v1.52/#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>`.
91
91
  #
92
- # @note Stability Level: alpha
92
+ # @note Stability Level: beta
93
93
  CONTAINER_IMAGE_TAGS = 'container.image.tags'
94
94
 
95
95
  # Must be called with a key for the full attribute name. See notes below about the expectations
@@ -331,6 +331,11 @@ module OpenTelemetry
331
331
  # [Generating query summary](/docs/db/database-spans.md#generating-a-summary-of-the-query)
332
332
  # section.
333
333
  #
334
+ # For batch operations, if the individual operations are known to have the same query summary
335
+ # then that query summary SHOULD be used prepended by `BATCH `,
336
+ # otherwise `db.query.summary` SHOULD be `BATCH` or some other database
337
+ # system specific term if more applicable.
338
+ #
334
339
  # @note Stability Level: stable
335
340
  #
336
341
  # @deprecated Now available in the stable namespace at {OpenTelemetry::SemConv::DB::DB_QUERY_SUMMARY}.
@@ -33,6 +33,7 @@ module OpenTelemetry
33
33
  # `error.message` is NOT RECOMMENDED for metrics or spans due to its unbounded cardinality and overlap with span status.
34
34
  #
35
35
  # @note Stability Level: development
36
+ # @deprecated Use domain-specific error message attribute. For example, use `feature_flag.error.message` for feature flag errors.
36
37
  ERROR_MESSAGE = 'error.message'
37
38
 
38
39
  # Describes a class of error the operation ended with.
@@ -32,6 +32,8 @@ module OpenTelemetry
32
32
 
33
33
  # The exception message.
34
34
  #
35
+ # > [!WARNING]> This attribute may contain sensitive information.
36
+ #
35
37
  # @note Stability Level: stable
36
38
  #
37
39
  # @deprecated Now available in the stable namespace at {OpenTelemetry::SemConv::EXCEPTION::EXCEPTION_MESSAGE}.
@@ -29,10 +29,15 @@ module OpenTelemetry
29
29
  # @note Stability Level: release_candidate
30
30
  FEATURE_FLAG_CONTEXT_ID = 'feature_flag.context.id'
31
31
 
32
- # Deprecated, use `error.message` instead.
32
+ # A message providing more detail about an error that occurred during feature flag evaluation in human-readable form.
33
+ #
34
+ # @note Stability Level: release_candidate
35
+ FEATURE_FLAG_ERROR_MESSAGE = 'feature_flag.error.message'
36
+
37
+ # Deprecated, use `feature_flag.error.message` instead.
33
38
  #
34
39
  # @note Stability Level: development
35
- # @deprecated Replaced by `error.message`.
40
+ # @deprecated Replaced by `feature_flag.error.message`.
36
41
  FEATURE_FLAG_EVALUATION_ERROR_MESSAGE = 'feature_flag.evaluation.error.message'
37
42
 
38
43
  # Deprecated, use `feature_flag.result.reason` instead.
@@ -149,6 +149,21 @@ module OpenTelemetry
149
149
  # @note Stability Level: development
150
150
  GCP_GCE_INSTANCE_NAME = 'gcp.gce.instance.name'
151
151
 
152
+ # The name of the Instance Group Manager (IGM) that manages this VM, if any.
153
+ #
154
+ # @note Stability Level: development
155
+ GCP_GCE_INSTANCE_GROUP_MANAGER_NAME = 'gcp.gce.instance_group_manager.name'
156
+
157
+ # The region of a **regional** Instance Group Manager (e.g., `us-central1`). Set this **only** when the IGM is regional.
158
+ #
159
+ # @note Stability Level: development
160
+ GCP_GCE_INSTANCE_GROUP_MANAGER_REGION = 'gcp.gce.instance_group_manager.region'
161
+
162
+ # The zone of a **zonal** Instance Group Manager (e.g., `us-central1-a`). Set this **only** when the IGM is zonal.
163
+ #
164
+ # @note Stability Level: development
165
+ GCP_GCE_INSTANCE_GROUP_MANAGER_ZONE = 'gcp.gce.instance_group_manager.zone'
166
+
152
167
  # @!endgroup
153
168
  end
154
169
  end
@@ -39,6 +39,11 @@ module OpenTelemetry
39
39
  # @note Stability Level: development
40
40
  GEN_AI_AGENT_NAME = 'gen_ai.agent.name'
41
41
 
42
+ # The version of the GenAI agent.
43
+ #
44
+ # @note Stability Level: development
45
+ GEN_AI_AGENT_VERSION = 'gen_ai.agent.version'
46
+
42
47
  # Deprecated, use Event API to report completions contents.
43
48
  #
44
49
  # @note Stability Level: development
@@ -282,6 +287,27 @@ module OpenTelemetry
282
287
  # @note Stability Level: development
283
288
  GEN_AI_RESPONSE_MODEL = 'gen_ai.response.model'
284
289
 
290
+ # The documents retrieved.
291
+ #
292
+ # Instrumentations MUST follow [Retrieval documents JSON schema](/docs/gen-ai/gen-ai-retrieval-documents.json).
293
+ # When the attribute is recorded on events, it MUST be recorded in structured
294
+ # form. When recorded on spans, it MAY be recorded as a JSON string if structured
295
+ # format is not supported and SHOULD be recorded in structured form otherwise.
296
+ #
297
+ # Each document object SHOULD contain at least the following properties:
298
+ # `id` (string): A unique identifier for the document, `score` (double): The relevance score of the document
299
+ #
300
+ # @note Stability Level: development
301
+ GEN_AI_RETRIEVAL_DOCUMENTS = 'gen_ai.retrieval.documents'
302
+
303
+ # The query text used for retrieval.
304
+ #
305
+ # > [!Warning]
306
+ # > This attribute may contain sensitive information.
307
+ #
308
+ # @note Stability Level: development
309
+ GEN_AI_RETRIEVAL_QUERY_TEXT = 'gen_ai.retrieval.query.text'
310
+
285
311
  # Deprecated, use `gen_ai.provider.name` instead.
286
312
  #
287
313
  # @note Stability Level: development
@@ -384,6 +410,20 @@ module OpenTelemetry
384
410
  # @note Stability Level: development
385
411
  GEN_AI_TOOL_TYPE = 'gen_ai.tool.type'
386
412
 
413
+ # The number of input tokens written to a provider-managed cache.
414
+ #
415
+ # The value SHOULD be included in `gen_ai.usage.input_tokens`.
416
+ #
417
+ # @note Stability Level: development
418
+ GEN_AI_USAGE_CACHE_CREATION_INPUT_TOKENS = 'gen_ai.usage.cache_creation.input_tokens'
419
+
420
+ # The number of input tokens served from a provider-managed cache.
421
+ #
422
+ # The value SHOULD be included in `gen_ai.usage.input_tokens`.
423
+ #
424
+ # @note Stability Level: development
425
+ GEN_AI_USAGE_CACHE_READ_INPUT_TOKENS = 'gen_ai.usage.cache_read.input_tokens'
426
+
387
427
  # Deprecated, use `gen_ai.usage.output_tokens` instead.
388
428
  #
389
429
  # @note Stability Level: development
@@ -392,6 +432,11 @@ module OpenTelemetry
392
432
 
393
433
  # The number of tokens used in the GenAI input (prompt).
394
434
  #
435
+ # This value SHOULD include all types of input tokens, including cached tokens.
436
+ # Instrumentations SHOULD make a best effort to populate this value, using a total
437
+ # provided by the provider when available or, depending on the provider API,
438
+ # by summing different token types parsed from the provider output.
439
+ #
395
440
  # @note Stability Level: development
396
441
  GEN_AI_USAGE_INPUT_TOKENS = 'gen_ai.usage.input_tokens'
397
442
 
@@ -99,8 +99,15 @@ module OpenTelemetry
99
99
  #
100
100
  # If the HTTP instrumentation could end up converting valid HTTP request methods to `_OTHER`, then it MUST provide a way to override
101
101
  # the list of known HTTP methods. If this override is done via environment variable, then the environment variable MUST be named
102
- # OTEL_INSTRUMENTATION_HTTP_KNOWN_METHODS and support a comma-separated list of case-sensitive known HTTP methods
103
- # (this list MUST be a full override of the default known method, it is not a list of known methods in addition to the defaults).
102
+ # OTEL_INSTRUMENTATION_HTTP_KNOWN_METHODS and support a comma-separated list of case-sensitive known HTTP methods.
103
+ #
104
+ #
105
+ # If this override is done via declarative configuration, then the list MUST be configurable via the `known_methods` property
106
+ # (an array of case-sensitive strings with minimum items 0) under `.instrumentation/development.general.http.client` and/or
107
+ # `.instrumentation/development.general.http.server`.
108
+ #
109
+ # In either case, this list MUST be a full override of the default known methods,
110
+ # it is not a list of known methods in addition to the defaults.
104
111
  #
105
112
  # HTTP method names are case-sensitive and `http.request.method` attribute value MUST match a known HTTP method name exactly.
106
113
  # Instrumentations for specific web frameworks that consider HTTP methods to be case insensitive, SHOULD populate a canonical equivalent.
@@ -94,6 +94,11 @@ module OpenTelemetry
94
94
  # @note Stability Level: development
95
95
  JVM_FILE_DESCRIPTOR_COUNT = 'jvm.file_descriptor.count'
96
96
 
97
+ # Measure of max open file descriptors as reported by the JVM.
98
+ #
99
+ # @note Stability Level: development
100
+ JVM_FILE_DESCRIPTOR_LIMIT = 'jvm.file_descriptor.limit'
101
+
97
102
  # Duration of JVM garbage collection actions.
98
103
  #
99
104
  # @note Stability Level: stable