opentelemetry-semantic_conventions 1.41.0 → 1.42.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 (37) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +5 -0
  3. data/README.md +11 -4
  4. data/lib/opentelemetry/semantic_conventions/version.rb +2 -2
  5. data/lib/opentelemetry/semconv/container/attributes.rb +51 -0
  6. data/lib/opentelemetry/semconv/container.rb +21 -0
  7. data/lib/opentelemetry/semconv/incubating/android/attributes.rb +1 -1
  8. data/lib/opentelemetry/semconv/incubating/app/attributes.rb +10 -0
  9. data/lib/opentelemetry/semconv/incubating/browser/attributes.rb +5 -0
  10. data/lib/opentelemetry/semconv/incubating/cicd/attributes.rb +4 -4
  11. data/lib/opentelemetry/semconv/incubating/cicd/metrics.rb +2 -2
  12. data/lib/opentelemetry/semconv/incubating/container/attributes.rb +12 -4
  13. data/lib/opentelemetry/semconv/incubating/container/metrics.rb +3 -3
  14. data/lib/opentelemetry/semconv/incubating/cpu/attributes.rb +1 -1
  15. data/lib/opentelemetry/semconv/incubating/file/attributes.rb +15 -0
  16. data/lib/opentelemetry/semconv/incubating/gcp/attributes.rb +13 -0
  17. data/lib/opentelemetry/semconv/incubating/gen_ai/attributes.rb +66 -16
  18. data/lib/opentelemetry/semconv/incubating/gen_ai/metrics.rb +7 -0
  19. data/lib/opentelemetry/semconv/incubating/k8s/attributes.rb +140 -49
  20. data/lib/opentelemetry/semconv/incubating/k8s/metrics.rb +83 -76
  21. data/lib/opentelemetry/semconv/incubating/mcp/attributes.rb +4 -0
  22. data/lib/opentelemetry/semconv/incubating/mcp/metrics.rb +4 -0
  23. data/lib/opentelemetry/semconv/incubating/nodejs/metrics.rb +7 -7
  24. data/lib/opentelemetry/semconv/incubating/openai/attributes.rb +4 -0
  25. data/lib/opentelemetry/semconv/incubating/openshift/metrics.rb +20 -20
  26. data/lib/opentelemetry/semconv/incubating/otel/metrics.rb +22 -3
  27. data/lib/opentelemetry/semconv/incubating/process/attributes.rb +34 -34
  28. data/lib/opentelemetry/semconv/incubating/service/attributes.rb +1 -1
  29. data/lib/opentelemetry/semconv/incubating/system/metrics.rb +5 -0
  30. data/lib/opentelemetry/semconv/incubating/url/attributes.rb +6 -4
  31. data/lib/opentelemetry/semconv/incubating/v8js/metrics.rb +9 -3
  32. data/lib/opentelemetry/semconv/k8s/attributes.rb +517 -0
  33. data/lib/opentelemetry/semconv/k8s.rb +21 -0
  34. data/lib/opentelemetry/semconv/url/attributes.rb +6 -4
  35. data/lib/opentelemetry/semconv.rb +141 -0
  36. data/lib/opentelemetry-semantic_conventions.rb +1 -0
  37. metadata +9 -4
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 4c0338c46c79107495c86964d690d5f0db7b3cb222ed683ea4c81dd97040032b
4
- data.tar.gz: a213a8550ea2b4aab219df00677c06f1f9f98f39a67c09ff82dab070a5013c09
3
+ metadata.gz: dc7a3272858c8f6b81b0bf6fe79daaf2dbe86ea9998cdf8d9de9931ae39f8a78
4
+ data.tar.gz: 55c64947141573ee3c72b2e563c98aab71d84bf86a50076513da34ab552cf299
5
5
  SHA512:
6
- metadata.gz: 7ef135235380d18753a8fe2e12bd3967a85ad7502e7704644efe573e5966ca1399d91f5f157b0fa7811d06a11fe19551b5d52d55cfd0460c9dad624bc062b836
7
- data.tar.gz: 96bf1f471baa38882224599fe57fcb61b5a1d9acac4af2458050ca6c92f855cf90e84dffd606ed4855825543bd7ed8d34308c548c6a39d832e1236b4b8a42f06
6
+ metadata.gz: 581dc30386c954d919f3cb0ea205b2230f11e78035b92e68b6e79ebea143aa791aeab0f8c16f15730f92140f4f17e45b6189620839c0813f6022ae9c1d14eabc
7
+ data.tar.gz: ad1f871f3bfae12f3ab40f86ba999c8e759d1e16304c68353c52ab8da6abca50c58f9c46ecfb38189fc8128210309651a45133124906e65a0e32f1466717823a
data/CHANGELOG.md CHANGED
@@ -1,5 +1,10 @@
1
1
  # Release History: opentelemetry-semantic_conventions
2
2
 
3
+ ### v1.42.0 / 2026-07-07
4
+
5
+ * ADDED: Autoload namespaces so a single require exposes all constants (#2204)
6
+ * ADDED: Update dependency open-telemetry/semantic-conventions to v1.42.0 (#2195)
7
+
3
8
  ### v1.41.0 / 2026-06-10
4
9
 
5
10
  * ADDED: Update dependency open-telemetry/semantic-conventions to v1.41.1 (#2184)
data/README.md CHANGED
@@ -55,12 +55,19 @@ These constants will be preserved to avoid breaking changes for users who rely
55
55
  on the old constants. These constants do not differentiate between stable and
56
56
  unstable constants. New constants will not be added to this namespace.
57
57
 
58
- We recommend you require only the files that contain the constants you are going
59
- to use. For example, if you were creating instrumentation for an HTTP Client
60
- that emits only stable conventions, you would likely require:
58
+ Require the gem once and reference any constant directly. Each namespace is
59
+ registered with Ruby's `autoload`, so the file backing a namespace is only loaded
60
+ the first time you reference one of its constants — you don't pay to load
61
+ conventions you never use.
61
62
 
62
63
  ```rb
63
- require 'opentelemetry/semconv/http'
64
+ require 'opentelemetry-semantic_conventions'
65
+
66
+ # Stable
67
+ OpenTelemetry::SemConv::HTTP::HTTP_REQUEST_METHOD # => 'http.request.method'
68
+
69
+ # Incubating (experimental/deprecated)
70
+ OpenTelemetry::SemConv::Incubating::GEN_AI::GEN_AI_SYSTEM
64
71
  ```
65
72
 
66
73
  If you want to require all of the 1.11.0 constants, you can use:
@@ -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.41.1'
10
+ SPEC_VERSION = '1.42.0'
11
11
  # Release version of this gem. May not match SPEC_VERSION until gem is released after a spec update.
12
- VERSION = '1.41.0'
12
+ VERSION = '1.42.0'
13
13
  end
14
14
  end
@@ -0,0 +1,51 @@
1
+ # frozen_string_literal: true
2
+
3
+ # Copyright The OpenTelemetry Authors
4
+ #
5
+ # Licensed under the Apache License, Version 2.0 (the "License");
6
+ # you may not use this file except in compliance with the License.
7
+ # You may obtain a copy of the License at
8
+ #
9
+ # http://www.apache.org/licenses/LICENSE-2.0
10
+ #
11
+ # Unless required by applicable law or agreed to in writing, software
12
+ # distributed under the License is distributed on an "AS IS" BASIS,
13
+ # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14
+ # See the License for the specific language governing permissions and
15
+ # limitations under the License.
16
+ #
17
+ # SPDX-License-Identifier: Apache-2.0
18
+ #
19
+ # This file was autogenerated. Do not edit it by hand.
20
+
21
+ module OpenTelemetry
22
+ module SemConv
23
+ module CONTAINER
24
+ # @!group Attribute Names
25
+
26
+ # 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.
27
+ #
28
+ # @note Stability Level: stable
29
+ CONTAINER_ID = 'container.id'
30
+
31
+ # Name of the image the container was built on.
32
+ #
33
+ # @note Stability Level: stable
34
+ CONTAINER_IMAGE_NAME = 'container.image.name'
35
+
36
+ # Repo digests of the container image as provided by the container runtime.
37
+ #
38
+ # [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.
39
+ #
40
+ # @note Stability Level: stable
41
+ CONTAINER_IMAGE_REPO_DIGESTS = 'container.image.repo_digests'
42
+
43
+ # 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>`.
44
+ #
45
+ # @note Stability Level: stable
46
+ CONTAINER_IMAGE_TAGS = 'container.image.tags'
47
+
48
+ # @!endgroup
49
+ end
50
+ end
51
+ end
@@ -0,0 +1,21 @@
1
+ # frozen_string_literal: true
2
+
3
+ # Copyright The OpenTelemetry Authors
4
+ #
5
+ # Licensed under the Apache License, Version 2.0 (the "License");
6
+ # you may not use this file except in compliance with the License.
7
+ # You may obtain a copy of the License at
8
+ #
9
+ # http://www.apache.org/licenses/LICENSE-2.0
10
+ #
11
+ # Unless required by applicable law or agreed to in writing, software
12
+ # distributed under the License is distributed on an "AS IS" BASIS,
13
+ # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14
+ # See the License for the specific language governing permissions and
15
+ # limitations under the License.
16
+ #
17
+ # SPDX-License-Identifier: Apache-2.0
18
+
19
+ # This file was autogenerated. Do not edit it by hand.
20
+
21
+ require_relative 'container/attributes'
@@ -26,7 +26,7 @@ module OpenTelemetry
26
26
 
27
27
  # This attribute represents the state of the application.
28
28
  #
29
- # The Android lifecycle states are defined in [Activity lifecycle callbacks](https://developer.android.com/guide/components/activities/activity-lifecycle#lc), and from which the `OS identifiers` are derived.
29
+ # The Android lifecycle states are defined in [Activity lifecycle callbacks](https://developer.android.com/guide/components/activities/activity-lifecycle#lifecycle-callbacks), and from which the `OS identifiers` are derived.
30
30
  #
31
31
  # @note Stability Level: development
32
32
  ANDROID_APP_STATE = 'android.app.state'
@@ -29,6 +29,16 @@ module OpenTelemetry
29
29
  # @note Stability Level: development
30
30
  APP_BUILD_ID = 'app.build_id'
31
31
 
32
+ # A unique identifier representing an instance of an end-user facing app crash.
33
+ #
34
+ # Its value MAY be meaningful and be used as a reference for telemetry and metadata recorded by
35
+ # the same instrumentation (e.g. it is an ID generated by an external source that captured the crash).
36
+ # It MAY come from a source external to the instrumentation such that it can be used to look up additional
37
+ # data from other sources as well as facilitate deduplication.
38
+ #
39
+ # @note Stability Level: development
40
+ APP_CRASH_ID = 'app.crash.id'
41
+
32
42
  # A unique identifier representing the installation of an application on a specific device
33
43
  #
34
44
  # Its value SHOULD persist across launches of the same application installation, including through application upgrades.
@@ -31,6 +31,11 @@ module OpenTelemetry
31
31
  # @note Stability Level: development
32
32
  BROWSER_BRANDS = 'browser.brands'
33
33
 
34
+ # Absolute URL of the current browser document according to [RFC3986](https://www.rfc-editor.org/rfc/rfc3986).
35
+ #
36
+ # @note Stability Level: development
37
+ BROWSER_DOCUMENT_URL_FULL = 'browser.document.url.full'
38
+
34
39
  # Preferred language of the user using the browser
35
40
  #
36
41
  # This value is intended to be taken from the Navigator API `navigator.language`.
@@ -81,22 +81,22 @@ module OpenTelemetry
81
81
  # @note Stability Level: development
82
82
  CICD_PIPELINE_TASK_TYPE = 'cicd.pipeline.task.type'
83
83
 
84
- # The name of a component of the CICD system.
84
+ # The name of a component of the CI/CD system.
85
85
  #
86
86
  # @note Stability Level: development
87
87
  CICD_SYSTEM_COMPONENT = 'cicd.system.component'
88
88
 
89
- # The unique identifier of a worker within a CICD system.
89
+ # The unique identifier of a worker within a CI/CD system.
90
90
  #
91
91
  # @note Stability Level: development
92
92
  CICD_WORKER_ID = 'cicd.worker.id'
93
93
 
94
- # The name of a worker within a CICD system.
94
+ # The name of a worker within a CI/CD system.
95
95
  #
96
96
  # @note Stability Level: development
97
97
  CICD_WORKER_NAME = 'cicd.worker.name'
98
98
 
99
- # The state of a CICD worker / agent.
99
+ # The state of a CI/CD worker / agent.
100
100
  #
101
101
  # @note Stability Level: development
102
102
  CICD_WORKER_STATE = 'cicd.worker.state'
@@ -42,14 +42,14 @@ module OpenTelemetry
42
42
  # @note Stability Level: development
43
43
  CICD_PIPELINE_RUN_ERRORS = 'cicd.pipeline.run.errors'
44
44
 
45
- # The number of errors in a component of the CICD system (eg. controller, scheduler, agent).
45
+ # The number of errors in a component of the CI/CD system (eg. controller, scheduler, agent).
46
46
  #
47
47
  # Errors in pipeline run execution are explicitly excluded. Ie a test failure is not counted in this metric.
48
48
  #
49
49
  # @note Stability Level: development
50
50
  CICD_SYSTEM_ERRORS = 'cicd.system.errors'
51
51
 
52
- # The number of workers on the CICD system by state.
52
+ # The number of workers on the CI/CD system by state.
53
53
  #
54
54
  # @note Stability Level: development
55
55
  CICD_WORKER_COUNT = 'cicd.worker.count'
@@ -63,7 +63,9 @@ 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: release_candidate
66
+ # @note Stability Level: stable
67
+ #
68
+ # @deprecated Now available in the stable namespace at {OpenTelemetry::SemConv::CONTAINER::CONTAINER_ID}.
67
69
  CONTAINER_ID = 'container.id'
68
70
 
69
71
  # Runtime specific image identifier. Usually a hash algorithm followed by a UUID.
@@ -77,19 +79,25 @@ module OpenTelemetry
77
79
 
78
80
  # Name of the image the container was built on.
79
81
  #
80
- # @note Stability Level: release_candidate
82
+ # @note Stability Level: stable
83
+ #
84
+ # @deprecated Now available in the stable namespace at {OpenTelemetry::SemConv::CONTAINER::CONTAINER_IMAGE_NAME}.
81
85
  CONTAINER_IMAGE_NAME = 'container.image.name'
82
86
 
83
87
  # Repo digests of the container image as provided by the container runtime.
84
88
  #
85
89
  # [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
90
  #
87
- # @note Stability Level: release_candidate
91
+ # @note Stability Level: stable
92
+ #
93
+ # @deprecated Now available in the stable namespace at {OpenTelemetry::SemConv::CONTAINER::CONTAINER_IMAGE_REPO_DIGESTS}.
88
94
  CONTAINER_IMAGE_REPO_DIGESTS = 'container.image.repo_digests'
89
95
 
90
96
  # 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
97
  #
92
- # @note Stability Level: release_candidate
98
+ # @note Stability Level: stable
99
+ #
100
+ # @deprecated Now available in the stable namespace at {OpenTelemetry::SemConv::CONTAINER::CONTAINER_IMAGE_TAGS}.
93
101
  CONTAINER_IMAGE_TAGS = 'container.image.tags'
94
102
 
95
103
  # Must be called with a key for the full attribute name. See notes below about the expectations
@@ -24,11 +24,11 @@ module OpenTelemetry
24
24
  module CONTAINER
25
25
  # @!group Metrics Names
26
26
 
27
- # Total CPU time consumed.
27
+ # CPU time consumed.
28
28
  #
29
- # Total CPU time consumed by the specific container on all available CPU cores
29
+ # CPU time consumed by the specific container on all available CPU cores
30
30
  #
31
- # @note Stability Level: development
31
+ # @note Stability Level: release_candidate
32
32
  CONTAINER_CPU_TIME = 'container.cpu.time'
33
33
 
34
34
  # Container's CPU usage, measured in cpus. Range from 0 to the number of allocatable CPUs.
@@ -31,7 +31,7 @@ module OpenTelemetry
31
31
 
32
32
  # The mode of the CPU
33
33
  #
34
- # @note Stability Level: development
34
+ # @note Stability Level: release_candidate
35
35
  CPU_MODE = 'cpu.mode'
36
36
 
37
37
  # @!endgroup
@@ -87,6 +87,21 @@ module OpenTelemetry
87
87
  # @note Stability Level: development
88
88
  FILE_INODE = 'file.inode'
89
89
 
90
+ # The lock mechanism such as noted by [POSIX](https://pubs.opengroup.org/onlinepubs/9699919799/functions/fcntl.html)
91
+ #
92
+ # @note Stability Level: development
93
+ FILE_LOCK_MECHANISM = 'file.lock.mechanism'
94
+
95
+ # Mode of lock or operation such as documented by [POSIX](https://pubs.opengroup.org/onlinepubs/9699919799/functions/fcntl.html)
96
+ #
97
+ # @note Stability Level: development
98
+ FILE_LOCK_MODE = 'file.lock.mode'
99
+
100
+ # The lock type as represented by i.e. [POSIX](https://pubs.opengroup.org/onlinepubs/9699919799/functions/fcntl.html)'s l_type.
101
+ #
102
+ # @note Stability Level: development
103
+ FILE_LOCK_TYPE = 'file.lock.type'
104
+
90
105
  # Mode of the file in octal representation.
91
106
  #
92
107
  # @note Stability Level: development
@@ -144,6 +144,19 @@ module OpenTelemetry
144
144
  # @note Stability Level: development
145
145
  GCP_GCE_INSTANCE_HOSTNAME = 'gcp.gce.instance.hostname'
146
146
 
147
+ # Must be called with a key for the full attribute name. See notes below about the expectations
148
+ # for the state of the key.
149
+ #
150
+ # @example Usage
151
+ # GCP_GCE_INSTANCE_LABELS_LAMBDA.call('some-cool-key') #=> 'gcp.gce.instance.labels.some-cool-key'
152
+ #
153
+ # GCE instance labels, `<key>` being the label name and the value being the label value.
154
+ #
155
+ # For example, a GCE instance label `team` with value `observability` SHOULD be recorded as the `gcp.gce.instance.labels.team` attribute with value `"observability"`. The `<key>` MUST be the exact GCE instance label key.
156
+ #
157
+ # @note Stability Level: development
158
+ GCP_GCE_INSTANCE_LABELS_LAMBDA = ->(key) { "gcp.gce.instance.labels.#{key}" }
159
+
147
160
  # The instance name of a GCE instance. This is the value provided by `host.name`, the visible name of the instance in the Cloud Console UI, and the prefix for the default hostname of the instance as defined by the [default internal DNS name](https://cloud.google.com/compute/docs/internal-dns#instance-fully-qualified-domain-names).
148
161
  #
149
162
  # @note Stability Level: development