opentelemetry-semantic_conventions 1.44.0 → 1.45.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 (49) 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/client/attributes.rb +2 -2
  5. data/lib/opentelemetry/semconv/db/attributes.rb +16 -11
  6. data/lib/opentelemetry/semconv/incubating/aws/attributes.rb +1 -1
  7. data/lib/opentelemetry/semconv/incubating/azure/attributes.rb +20 -0
  8. data/lib/opentelemetry/semconv/incubating/client/attributes.rb +72 -2
  9. data/lib/opentelemetry/semconv/incubating/container/metrics.rb +20 -25
  10. data/lib/opentelemetry/semconv/incubating/cpu/attributes.rb +4 -2
  11. data/lib/opentelemetry/semconv/incubating/db/attributes.rb +17 -12
  12. data/lib/opentelemetry/semconv/incubating/db/metrics.rb +8 -2
  13. data/lib/opentelemetry/semconv/incubating/destination/attributes.rb +53 -2
  14. data/lib/opentelemetry/semconv/incubating/enduser/attributes.rb +2 -0
  15. data/lib/opentelemetry/semconv/incubating/faas/attributes.rb +7 -3
  16. data/lib/opentelemetry/semconv/incubating/gcp/attributes.rb +20 -0
  17. data/lib/opentelemetry/semconv/incubating/host/attributes.rb +60 -1
  18. data/lib/opentelemetry/semconv/incubating/http/attributes.rb +59 -0
  19. data/lib/opentelemetry/semconv/incubating/jvm/attributes.rb +24 -0
  20. data/lib/opentelemetry/semconv/incubating/jvm/metrics.rb +45 -2
  21. data/lib/opentelemetry/semconv/incubating/k8s/metrics.rb +268 -66
  22. data/lib/opentelemetry/semconv/incubating/kafka/attributes.rb +55 -0
  23. data/lib/opentelemetry/semconv/incubating/kafka.rb +21 -0
  24. data/lib/opentelemetry/semconv/incubating/log/attributes.rb +5 -5
  25. data/lib/opentelemetry/semconv/incubating/messaging/attributes.rb +68 -26
  26. data/lib/opentelemetry/semconv/incubating/network/attributes.rb +103 -1
  27. data/lib/opentelemetry/semconv/incubating/opentracing/attributes.rb +1 -0
  28. data/lib/opentelemetry/semconv/incubating/otel/metrics.rb +7 -1
  29. data/lib/opentelemetry/semconv/incubating/peer/attributes.rb +1 -1
  30. data/lib/opentelemetry/semconv/incubating/rabbitmq/attributes.rb +41 -0
  31. data/lib/opentelemetry/semconv/incubating/rabbitmq.rb +21 -0
  32. data/lib/opentelemetry/semconv/incubating/rocketmq/attributes.rb +71 -0
  33. data/lib/opentelemetry/semconv/incubating/rocketmq.rb +21 -0
  34. data/lib/opentelemetry/semconv/incubating/rpc/attributes.rb +110 -33
  35. data/lib/opentelemetry/semconv/incubating/rpc/metrics.rb +6 -2
  36. data/lib/opentelemetry/semconv/incubating/server/attributes.rb +70 -0
  37. data/lib/opentelemetry/semconv/incubating/service/attributes.rb +16 -0
  38. data/lib/opentelemetry/semconv/incubating/source/attributes.rb +53 -2
  39. data/lib/opentelemetry/semconv/incubating/system/attributes.rb +15 -9
  40. data/lib/opentelemetry/semconv/incubating/system/metrics.rb +7 -3
  41. data/lib/opentelemetry/semconv/incubating/url/attributes.rb +12 -0
  42. data/lib/opentelemetry/semconv/incubating/v8js/attributes.rb +2 -1
  43. data/lib/opentelemetry/semconv/incubating/zos/attributes.rb +4 -2
  44. data/lib/opentelemetry/semconv/rpc/attributes.rb +77 -0
  45. data/lib/opentelemetry/semconv/rpc/metrics.rb +45 -0
  46. data/lib/opentelemetry/semconv/rpc.rb +22 -0
  47. data/lib/opentelemetry/semconv/url/attributes.rb +12 -0
  48. data/lib/opentelemetry/semconv.rb +4 -0
  49. metadata +14 -5
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 83a4fe1eefc8216b24d3c38fc0a6705987c5829681456ae0d84457f0f0d20e63
4
- data.tar.gz: '0398ac350966985307a2987f9a5de63542b132afb7409ca013c2faf36a14f4d8'
3
+ metadata.gz: 12dd7eccacccfd4e29594f1dc62862b8e1a6b00f1e10a3f6e9c75dedae5d5469
4
+ data.tar.gz: 0d07d4c6b3fcaa329db5e15e5b0fed98a035a74e142022466566957ae2c1a176
5
5
  SHA512:
6
- metadata.gz: 97fcd773f881a7489754145cebb68531a0ad94443e532127d0332d1ea08adea0a820ed3bd9965917734c9eedb1e5587f4ee2a3421214754aca2b6539838b5592
7
- data.tar.gz: a9b7ef0a6a9bee697f0b13cd5658d8970742f26052dab4326e47d10a48785c51e7953a3cd01526b7f9d4966a7712a8ab01ba97425680558cdebda5242f7fc511
6
+ metadata.gz: 1817794bbc3c0cbd0121b3ff1205f60b570f9f106c3380a8c1dbd95ca7480dd942e4c9921d65cafc802d18a8de324a1ff031ddb9e809694e81b4464ceaf139f5
7
+ data.tar.gz: a2b398bb0ec666f56f48398eba989671aa624cdcbe46124044229d2d7b67ef8baa720ff8a0fd8905e32b2f33789568d1aa61d91266aa4f549acf595175ce478e
data/CHANGELOG.md CHANGED
@@ -1,5 +1,9 @@
1
1
  # Release History: opentelemetry-semantic_conventions
2
2
 
3
+ ### v1.45.0 / 2026-11-17
4
+
5
+ * ADDED: Update dependency open-telemetry/semantic-conventions to v1.45.0 (#2484)
6
+
3
7
  ### v1.44.0 / 2026-08-07
4
8
 
5
9
  * ADDED: Update dependency open-telemetry/semantic-conventions to v1.44.0 (#2279)
@@ -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.44.0'
10
+ SPEC_VERSION = '1.45.0'
11
11
  # Release version of this gem. May not match SPEC_VERSION until gem is released after a spec update.
12
- VERSION = '1.44.0'
12
+ VERSION = '1.45.0'
13
13
  end
14
14
  end
@@ -25,14 +25,14 @@ module OpenTelemetry
25
25
 
26
26
  # Client address - domain name if available without reverse DNS lookup; otherwise, IP address or UNIX domain socket name.
27
27
  #
28
- # When observed from the server side, and when communicating through an intermediary, `client.address` SHOULD represent the client address behind any intermediaries, for example proxies, if it's available.
28
+ # When observed from the server side, and when communicating through an intermediary, `client.address` SHOULD represent the client address behind any intermediaries, for example proxies, if it's available.
29
29
  #
30
30
  # @note Stability Level: stable
31
31
  CLIENT_ADDRESS = 'client.address'
32
32
 
33
33
  # Client port number.
34
34
  #
35
- # When observed from the server side, and when communicating through an intermediary, `client.port` SHOULD represent the client port behind any intermediaries, for example proxies, if it's available.
35
+ # When observed from the server side, and when communicating through an intermediary, `client.port` SHOULD represent the client port behind any intermediaries, for example proxies, if it's available.
36
36
  #
37
37
  # @note Stability Level: stable
38
38
  CLIENT_PORT = 'client.port'
@@ -32,8 +32,9 @@ module OpenTelemetry
32
32
  # when the database system supports query text with multiple collections
33
33
  # in non-batch operations.
34
34
  #
35
- # For batch operations, if the individual operations are known to have the same
36
- # collection name then that collection name SHOULD be used.
35
+ # For batch operations, if the individual operations would all have the same
36
+ # `db.collection.name` when executed as non-batch operations,
37
+ # then that collection name SHOULD be used.
37
38
  #
38
39
  # @note Stability Level: stable
39
40
  DB_COLLECTION_NAME = 'db.collection.name'
@@ -87,9 +88,10 @@ module OpenTelemetry
87
88
  # If spaces can occur in the operation name, multiple consecutive spaces
88
89
  # SHOULD be normalized to a single space.
89
90
  #
90
- # For batch operations, if the individual operations are known to have the same operation name
91
- # then that operation name SHOULD be used prepended by `BATCH `,
92
- # otherwise `db.operation.name` SHOULD be `BATCH` or some other database
91
+ # For batch operations, if the individual operations would all have the same
92
+ # `db.operation.name` when executed as non-batch operations,
93
+ # then that operation name SHOULD be used prepended by `BATCH `.
94
+ # Otherwise, `db.operation.name` SHOULD be `BATCH` or some other database
93
95
  # system specific term if more applicable.
94
96
  #
95
97
  # @note Stability Level: stable
@@ -107,9 +109,10 @@ module OpenTelemetry
107
109
  # [Generating query summary](/docs/db/database-spans.md#generating-a-summary-of-the-query)
108
110
  # section.
109
111
  #
110
- # For batch operations, if the individual operations are known to have the same query summary
111
- # then that query summary SHOULD be used prepended by `BATCH `,
112
- # otherwise `db.query.summary` SHOULD be `BATCH` or some other database
112
+ # For batch operations, if the individual operations would all have the same
113
+ # `db.query.summary` when executed as non-batch operations,
114
+ # then that query summary SHOULD be used prepended by `BATCH `.
115
+ # Otherwise, `db.query.summary` SHOULD be `BATCH` or some other database
113
116
  # system specific term if more applicable.
114
117
  #
115
118
  # @note Stability Level: stable
@@ -118,7 +121,7 @@ module OpenTelemetry
118
121
  # The database query being executed.
119
122
  #
120
123
  # For sanitization see [Sanitization of `db.query.text`](/docs/db/database-spans.md#sanitization-of-dbquerytext).
121
- # For batch operations, if the individual operations are known to have the same query text then that query text SHOULD be used, otherwise all of the individual query texts SHOULD be concatenated with separator `; ` or some other database system specific separator if more applicable.
124
+ # For batch operations, if the individual operations would all have the same `db.query.text` when executed as non-batch operations, then that query text SHOULD be used. Otherwise, all of the individual query texts SHOULD be concatenated with separator `; ` or some other database system specific separator if more applicable.
122
125
  # Parameterized query text SHOULD NOT be sanitized. Even though parameterized query text can potentially have sensitive data, by using a parameterized query the user is giving a strong signal that any sensitive data will be passed as parameter values, and the benefit to observability of capturing the static part of the query text by default outweighs the risk.
123
126
  #
124
127
  # @note Stability Level: stable
@@ -127,6 +130,7 @@ module OpenTelemetry
127
130
  # Database response status code.
128
131
  #
129
132
  # The status code returned by the database. Usually it represents an error code, but may also represent partial success, warning, or differentiate between various types of successful outcomes.
133
+ # The value MAY use a standardized string representation of a numeric status code, if one exists, instead of the numeric code. The value MAY be a synthetic status provided by the client library rather than returned by the remote service.
130
134
  # Semantic conventions for individual database systems SHOULD document what `db.response.status_code` means in the context of that system.
131
135
  #
132
136
  # @note Stability Level: stable
@@ -137,8 +141,9 @@ module OpenTelemetry
137
141
  # It is RECOMMENDED to capture the value as provided by the application
138
142
  # without attempting to do any case normalization.
139
143
  #
140
- # For batch operations, if the individual operations are known to have the same
141
- # stored procedure name then that stored procedure name SHOULD be used.
144
+ # For batch operations, if the individual operations would all have the same
145
+ # `db.stored_procedure.name` when executed as non-batch operations,
146
+ # then that stored procedure name SHOULD be used.
142
147
  #
143
148
  # @note Stability Level: stable
144
149
  DB_STORED_PROCEDURE_NAME = 'db.stored_procedure.name'
@@ -149,7 +149,7 @@ module OpenTelemetry
149
149
  # @note Stability Level: development
150
150
  AWS_ECS_CLUSTER_ARN = 'aws.ecs.cluster.arn'
151
151
 
152
- # The Amazon Resource Name (ARN) of an [ECS container instance](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ECS_instances.html).
152
+ # The Amazon Resource Name (ARN) of an [ECS container](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-metadata-endpoint-v4-response.html).
153
153
  #
154
154
  # @note Stability Level: development
155
155
  AWS_ECS_CONTAINER_ARN = 'aws.ecs.container.arn'
@@ -61,6 +61,11 @@ module OpenTelemetry
61
61
  # @note Stability Level: development
62
62
  AZURE_COSMOSDB_RESPONSE_SUB_STATUS_CODE = 'azure.cosmosdb.response.sub_status_code'
63
63
 
64
+ # The UTC epoch seconds at which the message has been accepted and stored in the entity.
65
+ #
66
+ # @note Stability Level: development
67
+ AZURE_EVENTHUBS_MESSAGE_ENQUEUED_TIME = 'azure.eventhubs.message.enqueued_time'
68
+
64
69
  # The name of the Azure [resource group](https://learn.microsoft.com/azure/azure-resource-manager/management/manage-resource-groups-portal) the resource belongs to.
65
70
  #
66
71
  # @note Stability Level: development
@@ -76,6 +81,21 @@ module OpenTelemetry
76
81
  # @note Stability Level: development
77
82
  AZURE_SERVICE_REQUEST_ID = 'azure.service.request.id'
78
83
 
84
+ # Describes the [settlement type](https://learn.microsoft.com/azure/service-bus-messaging/message-transfers-locks-settlement#peeklock).
85
+ #
86
+ # @note Stability Level: development
87
+ AZURE_SERVICEBUS_DISPOSITION_STATUS = 'azure.servicebus.disposition_status'
88
+
89
+ # Number of deliveries that have been attempted for this message.
90
+ #
91
+ # @note Stability Level: development
92
+ AZURE_SERVICEBUS_MESSAGE_DELIVERY_COUNT = 'azure.servicebus.message.delivery_count'
93
+
94
+ # The UTC epoch seconds at which the message has been accepted and stored in the entity.
95
+ #
96
+ # @note Stability Level: development
97
+ AZURE_SERVICEBUS_MESSAGE_ENQUEUED_TIME = 'azure.servicebus.message.enqueued_time'
98
+
79
99
  # @!endgroup
80
100
  end
81
101
  end
@@ -26,22 +26,92 @@ module OpenTelemetry
26
26
 
27
27
  # Client address - domain name if available without reverse DNS lookup; otherwise, IP address or UNIX domain socket name.
28
28
  #
29
- # When observed from the server side, and when communicating through an intermediary, `client.address` SHOULD represent the client address behind any intermediaries, for example proxies, if it's available.
29
+ # When observed from the server side, and when communicating through an intermediary, `client.address` SHOULD represent the client address behind any intermediaries, for example proxies, if it's available.
30
30
  #
31
31
  # @note Stability Level: stable
32
32
  #
33
33
  # @deprecated Now available in the stable namespace at {OpenTelemetry::SemConv::CLIENT::CLIENT_ADDRESS}.
34
34
  CLIENT_ADDRESS = 'client.address'
35
35
 
36
+ # The [Autonomous System Number (ASN)](https://www.iana.org/assignments/as-numbers/as-numbers.xhtml) associated with the client IP address.
37
+ #
38
+ # This attribute SHOULD only be set when the client address is an IP address and the ASN is available from routing, enrichment, or lookup data. The value SHOULD be represented as an integer without the `AS` prefix.
39
+ #
40
+ # @note Stability Level: development
41
+ CLIENT_AS_NUMBER = 'client.as.number'
42
+
43
+ # The name of the organization associated with the autonomous system of the client IP address.
44
+ #
45
+ # This attribute SHOULD only be set when `client.as.number` is set and the organization name is available. The value SHOULD be the organization name as provided by the lookup or enrichment source, not the AS name or short code.
46
+ #
47
+ # @note Stability Level: development
48
+ CLIENT_AS_ORGANIZATION = 'client.as.organization'
49
+
50
+ # Client Media Access Control (MAC) address.
51
+ #
52
+ # This attribute MUST identify a MAC address associated with the logical client
53
+ # endpoint, including when that endpoint is behind intermediaries. If the client's
54
+ # MAC address is unknown, this attribute MUST NOT be set. The MAC address of a
55
+ # proxy, gateway, or next-hop router MUST NOT be used as a substitute.
56
+ #
57
+ # MAC addresses MUST be represented in [IEEE RA hexadecimal form](https://standards.ieee.org/wp-content/uploads/import/documents/tutorials/eui.pdf):
58
+ # as hyphen-separated octets in uppercase hexadecimal form from most to least significant.
59
+ #
60
+ # > [!WARNING]> This attribute may contain sensitive (PII) information.
61
+ #
62
+ # @note Stability Level: development
63
+ CLIENT_MAC_ADDRESS = 'client.mac.address'
64
+
36
65
  # Client port number.
37
66
  #
38
- # When observed from the server side, and when communicating through an intermediary, `client.port` SHOULD represent the client port behind any intermediaries, for example proxies, if it's available.
67
+ # When observed from the server side, and when communicating through an intermediary, `client.port` SHOULD represent the client port behind any intermediaries, for example proxies, if it's available.
39
68
  #
40
69
  # @note Stability Level: stable
41
70
  #
42
71
  # @deprecated Now available in the stable namespace at {OpenTelemetry::SemConv::CLIENT::CLIENT_PORT}.
43
72
  CLIENT_PORT = 'client.port'
44
73
 
74
+ # The IP prefix associated with the client IP address, in CIDR notation.
75
+ #
76
+ # > [!WARNING]> This attribute may contain sensitive (PII) information. A `/32`> IPv4 prefix
77
+ # > or `/128`> IPv6 prefix preserves the complete endpoint IP address.
78
+ # > Using CIDR notation does not guarantee that the data is anonymous.
79
+ #
80
+ # The value MUST be an IPv4 or IPv6 network prefix in CIDR notation, as defined in
81
+ # [RFC 4632](https://www.rfc-editor.org/rfc/rfc4632.html) for IPv4 and
82
+ # [RFC 4291](https://www.rfc-editor.org/rfc/rfc4291.html#section-2.3) for IPv6.
83
+ # IPv4 prefixes MUST use a dotted-decimal address followed by `/` and a decimal
84
+ # prefix length from 0 to 32. IPv6 prefixes MUST use the canonical address text
85
+ # representation defined in [RFC 5952](https://www.rfc-editor.org/rfc/rfc5952.html),
86
+ # followed by `/` and a decimal prefix length from 0 to 128. All host bits in
87
+ # the address MUST be set to zero. The value MUST NOT contain a domain name,
88
+ # UNIX domain socket name, or IPv6 zone identifier.
89
+ #
90
+ # Instrumentation or Collector receivers that populate this attribute MUST
91
+ # convert native representations, such as an address and subnet mask or an
92
+ # address and prefix length, to equivalent CIDR notation before emitting it.
93
+ #
94
+ # This attribute MUST NOT be set unless `client.address` is set to an IPv4 or
95
+ # IPv6 address. The address MUST use the same IP version as this prefix and
96
+ # be contained in it.
97
+ #
98
+ # @note Stability Level: development
99
+ CLIENT_PREFIX = 'client.prefix'
100
+
101
+ # Logical name of the service acting as the client in a connection-based network interaction.
102
+ #
103
+ # SHOULD be equal to the actual [`service.name`](/docs/resource/README.md#service) resource attribute of the logical client, if any. This identifies the client service whether the telemetry is recorded by the client, the server, or another observer.
104
+ #
105
+ # @note Stability Level: development
106
+ CLIENT_SERVICE_NAME = 'client.service.name'
107
+
108
+ # Logical namespace of the service acting as the client in a connection-based network interaction.
109
+ #
110
+ # SHOULD be equal to the actual [`service.namespace`](/docs/resource/README.md#service) resource attribute of the logical client, if any. This identifies the client service's namespace whether the telemetry is recorded by the client, the server, or another observer. Together with `client.service.name`, this identifies the client service. An empty namespace is equivalent to an unspecified namespace.
111
+ #
112
+ # @note Stability Level: development
113
+ CLIENT_SERVICE_NAMESPACE = 'client.service.namespace'
114
+
45
115
  # @!endgroup
46
116
  end
47
117
  end
@@ -35,7 +35,7 @@ module OpenTelemetry
35
35
  #
36
36
  # CPU usage of the specific container on all available CPU cores. It is calculated as the change in cumulative CPU time (container.cpu.time) over a measurement interval, divided by the elapsed time: usageCores = (cpuTimeEnd - cpuTimeStart) / elapsedSeconds
37
37
  #
38
- # @note Stability Level: development
38
+ # @note Stability Level: release_candidate
39
39
  CONTAINER_CPU_USAGE = 'container.cpu.usage'
40
40
 
41
41
  # Disk bytes for the container.
@@ -47,34 +47,29 @@ module OpenTelemetry
47
47
 
48
48
  # Container filesystem available bytes.
49
49
  #
50
- # In K8s, this metric is derived from the
51
- # [FsStats.AvailableBytes](https://pkg.go.dev/k8s.io/kubelet@v0.33.0/pkg/apis/stats/v1alpha1#FsStats) field
52
- # of the [ContainerStats.Rootfs](https://pkg.go.dev/k8s.io/kubelet@v0.33.0/pkg/apis/stats/v1alpha1#ContainerStats)
53
- # of the Kubelet's stats API.
50
+ # Available filesystem space for the container's `rootfs`.
51
+ # In K8s, this metric is derived from the [FsStats.AvailableBytes](https://pkg.go.dev/k8s.io/kubelet@v0.34.0/pkg/apis/stats/v1alpha1#FsStats) field of the [ContainerStats.Rootfs](https://pkg.go.dev/k8s.io/kubelet@v0.34.0/pkg/apis/stats/v1alpha1#ContainerStats) of the Kubelet's stats API.
54
52
  #
55
- # @note Stability Level: development
53
+ # @note Stability Level: release_candidate
56
54
  CONTAINER_FILESYSTEM_AVAILABLE = 'container.filesystem.available'
57
55
 
58
56
  # Container filesystem capacity.
59
57
  #
60
- # In K8s, this metric is derived from the
61
- # [FsStats.CapacityBytes](https://pkg.go.dev/k8s.io/kubelet@v0.33.0/pkg/apis/stats/v1alpha1#FsStats) field
62
- # of the [ContainerStats.Rootfs](https://pkg.go.dev/k8s.io/kubelet@v0.33.0/pkg/apis/stats/v1alpha1#ContainerStats)
63
- # of the Kubelet's stats API.
58
+ # Total filesystem capacity for the container's `rootfs`.
59
+ # In general, this metric can be derived from [cadvisor](https://github.com/google/cadvisor/blob/v0.53.0/docs/storage/prometheus.md#prometheus-container-metrics) and specifically the `container_fs_limit_bytes` metric for the container's `rootfs` device.
60
+ # In K8s, this metric is derived from the [FsStats.CapacityBytes](https://pkg.go.dev/k8s.io/kubelet@v0.34.0/pkg/apis/stats/v1alpha1#FsStats) field of the [ContainerStats.Rootfs](https://pkg.go.dev/k8s.io/kubelet@v0.34.0/pkg/apis/stats/v1alpha1#ContainerStats) of the Kubelet's stats API.
64
61
  #
65
- # @note Stability Level: development
62
+ # @note Stability Level: release_candidate
66
63
  CONTAINER_FILESYSTEM_CAPACITY = 'container.filesystem.capacity'
67
64
 
68
65
  # Container filesystem usage.
69
66
  #
70
- # This may not equal capacity - available.
71
- #
72
- # In K8s, this metric is derived from the
73
- # [FsStats.UsedBytes](https://pkg.go.dev/k8s.io/kubelet@v0.33.0/pkg/apis/stats/v1alpha1#FsStats) field
74
- # of the [ContainerStats.Rootfs](https://pkg.go.dev/k8s.io/kubelet@v0.33.0/pkg/apis/stats/v1alpha1#ContainerStats)
75
- # of the Kubelet's stats API.
67
+ # Filesystem space used by the container's `rootfs`.
68
+ # In general, this metric can be derived from [cadvisor](https://github.com/google/cadvisor/blob/v0.53.0/docs/storage/prometheus.md#prometheus-container-metrics) and specifically the `container_fs_usage_bytes` metric for the container's `rootfs` device.
69
+ # In K8s, this metric is derived from the [FsStats.UsedBytes](https://pkg.go.dev/k8s.io/kubelet@v0.34.0/pkg/apis/stats/v1alpha1#FsStats) field of the [ContainerStats.Rootfs](https://pkg.go.dev/k8s.io/kubelet@v0.34.0/pkg/apis/stats/v1alpha1#ContainerStats) of the Kubelet's stats API.
70
+ # Capacity and available are reported for the backing filesystem, which may be shared with other workloads; therefore, usage may not equal `capacity - available`.
76
71
  #
77
- # @note Stability Level: development
72
+ # @note Stability Level: release_candidate
78
73
  CONTAINER_FILESYSTEM_USAGE = 'container.filesystem.usage'
79
74
 
80
75
  # Container memory available.
@@ -114,7 +109,7 @@ module OpenTelemetry
114
109
 
115
110
  # Container memory working set.
116
111
  #
117
- # In general, this metric can be derived from [cadvisor](https://github.com/google/cadvisor/blob/v0.53.0/docs/storage/prometheus.md#prometheus-container-metrics) and specifically the `container_memory_working_set_bytes` metric.
112
+ # In general, this metric can be derived from [cadvisor](https://github.com/google/cadvisor/blob/v0.53.0/docs/storage/prometheus.md#prometheus-container-metrics) and specifically the `container_memory_working_set_bytes` metric. When derived from cAdvisor on Linux, the working set is calculated by excluding inactive file-backed memory from memory usage (`inactive_file` on cgroup v2, `total_inactive_file` on cgroup v1), so active file-backed memory remains included.
118
113
  # In K8s, this metric is derived from the [MemoryStats.WorkingSetBytes](https://pkg.go.dev/k8s.io/kubelet@v0.34.0/pkg/apis/stats/v1alpha1#MemoryStats) field of the [ContainerStats.Memory](https://pkg.go.dev/k8s.io/kubelet@v0.34.0/pkg/apis/stats/v1alpha1#ContainerStats) of the Kubelet's stats API.
119
114
  #
120
115
  # @note Stability Level: release_candidate
@@ -129,18 +124,18 @@ module OpenTelemetry
129
124
 
130
125
  # Container memory paging faults.
131
126
  #
132
- # In general, this metric can be derived from [cadvisor](https://github.com/google/cadvisor/blob/v0.53.0/docs/storage/prometheus.md#prometheus-container-metrics) and specifically the `container_memory_failures_total{failure_type=pgfault, scope=container}` and `container_memory_failures_total{failure_type=pgmajfault, scope=container}`metric.
133
- # In K8s, this metric is derived from the [MemoryStats.PageFaults](https://pkg.go.dev/k8s.io/kubelet@v0.34.0/pkg/apis/stats/v1alpha1#MemoryStats) and [MemoryStats.MajorPageFaults](https://pkg.go.dev/k8s.io/kubelet@v0.34.0/pkg/apis/stats/v1alpha1#MemoryStats) field of the [ContainerStats.Memory](https://pkg.go.dev/k8s.io/kubelet@v0.34.0/pkg/apis/stats/v1alpha1#ContainerStats) of the Kubelet's stats API.
127
+ # In general, this metric can be derived from [cadvisor](https://github.com/google/cadvisor/blob/v0.53.0/docs/storage/prometheus.md#prometheus-container-metrics). The `container_memory_failures_total{failure_type=pgfault, scope=container}` counter reports the total page faults (minor + major), while `container_memory_failures_total{failure_type=pgmajfault, scope=container}` reports only major faults. The minor page faults MUST be derived as the difference between the two.
128
+ # In K8s, this metric is derived from the [MemoryStats.PageFaults](https://pkg.go.dev/k8s.io/kubelet@v0.34.0/pkg/apis/stats/v1alpha1#MemoryStats) and [MemoryStats.MajorPageFaults](https://pkg.go.dev/k8s.io/kubelet@v0.34.0/pkg/apis/stats/v1alpha1#MemoryStats) fields of the [ContainerStats.Memory](https://pkg.go.dev/k8s.io/kubelet@v0.34.0/pkg/apis/stats/v1alpha1#ContainerStats) of the Kubelet's stats API. `MemoryStats.PageFaults` reports the total number of page faults (equivalent to `pgfault` in the cgroup `memory.stat`), with minor and major combined. The minor page faults MUST therefore be derived as `MemoryStats.PageFaults - MemoryStats.MajorPageFaults`, so that summing the metric over `system.paging.fault.type` yields the total number of page faults.
134
129
  #
135
- # @note Stability Level: development
130
+ # @note Stability Level: release_candidate
136
131
  CONTAINER_PAGING_FAULTS = 'container.paging.faults'
137
132
 
138
133
  # The time the container has been running.
139
134
  #
140
- # Instrumentations SHOULD use a gauge with type `double` and measure uptime in seconds as a floating point number with the highest precision available.
141
- # The actual accuracy would depend on the instrumentation and operating system.
135
+ # Instrumentations SHOULD use a gauge with type `double` and measure uptime in seconds as a floating point number with the highest precision available. The actual accuracy would depend on the instrumentation and operating system.
136
+ # In K8s environments, this metric can be derived from Kubelet's stats API and specifically from the [ContainerStats.StartTime](https://github.com/kubernetes/kubelet/blob/v0.35.2/pkg/apis/stats/v1alpha1/types.go#L161) field, where `StartTime` represents the container creation time as [noted in the Kubelet source](https://github.com/kubernetes/kubernetes/blob/v1.36.3/pkg/kubelet/stats/cri_stats_provider.go#L776). This value resets on every container restart and aligns with [ContainerStateRunning.startedAt](https://kubernetes.io/docs/reference/kubernetes-api/workload-resources/pod-v1/#ContainerStateRunning) from the K8s API.
142
137
  #
143
- # @note Stability Level: development
138
+ # @note Stability Level: release_candidate
144
139
  CONTAINER_UPTIME = 'container.uptime'
145
140
 
146
141
  # @!endgroup
@@ -24,9 +24,11 @@ module OpenTelemetry
24
24
  module CPU
25
25
  # @!group Attribute Names
26
26
 
27
- # The logical CPU number [0..n-1]
27
+ # The identifier of a logical execution target (CPU) as seen by the operating system, in the range [0..n-1].
28
28
  #
29
- # @note Stability Level: development
29
+ # On systems with simultaneous multithreading (SMT) enabled — such as Intel Hyper-Threading or AMD SMT — this value will usually differ from the physical core number, because each core presents multiple logical CPUs for the system to use.
30
+ #
31
+ # @note Stability Level: release_candidate
30
32
  CPU_LOGICAL_NUMBER = 'cpu.logical_number'
31
33
 
32
34
  # The mode of the CPU
@@ -66,7 +66,7 @@ module OpenTelemetry
66
66
  # @deprecated Replaced by `db.collection.name`.
67
67
  DB_CASSANDRA_TABLE = 'db.cassandra.table'
68
68
 
69
- # The name of the connection pool; unique within the instrumented application. In case the connection pool implementation doesn't provide a name, instrumentation SHOULD use a combination of parameters that would make the name unique, for example, combining attributes `server.address`, `server.port`, and `db.namespace`, formatted as `server.address:server.port/db.namespace`. Instrumentations that generate connection pool name following different patterns SHOULD document it.
69
+ # The name of the connection pool. If the connection pool does not have a name, instrumentation SHOULD use `db.namespace`; otherwise `server.address`, with `server.port` appended using `:` if set. When appending a port to an IPv6 address, instrumentation MUST enclose the address in square brackets. If `server.address` is not available, instrumentation SHOULD use `db.system.name`; otherwise the connection pool library name.
70
70
  #
71
71
  # @note Stability Level: development
72
72
  DB_CLIENT_CONNECTION_POOL_NAME = 'db.client.connection.pool.name'
@@ -97,8 +97,9 @@ module OpenTelemetry
97
97
  # when the database system supports query text with multiple collections
98
98
  # in non-batch operations.
99
99
  #
100
- # For batch operations, if the individual operations are known to have the same
101
- # collection name then that collection name SHOULD be used.
100
+ # For batch operations, if the individual operations would all have the same
101
+ # `db.collection.name` when executed as non-batch operations,
102
+ # then that collection name SHOULD be used.
102
103
  #
103
104
  # @note Stability Level: stable
104
105
  #
@@ -284,9 +285,10 @@ module OpenTelemetry
284
285
  # If spaces can occur in the operation name, multiple consecutive spaces
285
286
  # SHOULD be normalized to a single space.
286
287
  #
287
- # For batch operations, if the individual operations are known to have the same operation name
288
- # then that operation name SHOULD be used prepended by `BATCH `,
289
- # otherwise `db.operation.name` SHOULD be `BATCH` or some other database
288
+ # For batch operations, if the individual operations would all have the same
289
+ # `db.operation.name` when executed as non-batch operations,
290
+ # then that operation name SHOULD be used prepended by `BATCH `.
291
+ # Otherwise, `db.operation.name` SHOULD be `BATCH` or some other database
290
292
  # system specific term if more applicable.
291
293
  #
292
294
  # @note Stability Level: stable
@@ -357,9 +359,10 @@ module OpenTelemetry
357
359
  # [Generating query summary](/docs/db/database-spans.md#generating-a-summary-of-the-query)
358
360
  # section.
359
361
  #
360
- # For batch operations, if the individual operations are known to have the same query summary
361
- # then that query summary SHOULD be used prepended by `BATCH `,
362
- # otherwise `db.query.summary` SHOULD be `BATCH` or some other database
362
+ # For batch operations, if the individual operations would all have the same
363
+ # `db.query.summary` when executed as non-batch operations,
364
+ # then that query summary SHOULD be used prepended by `BATCH `.
365
+ # Otherwise, `db.query.summary` SHOULD be `BATCH` or some other database
363
366
  # system specific term if more applicable.
364
367
  #
365
368
  # @note Stability Level: stable
@@ -370,7 +373,7 @@ module OpenTelemetry
370
373
  # The database query being executed.
371
374
  #
372
375
  # For sanitization see [Sanitization of `db.query.text`](/docs/db/database-spans.md#sanitization-of-dbquerytext).
373
- # For batch operations, if the individual operations are known to have the same query text then that query text SHOULD be used, otherwise all of the individual query texts SHOULD be concatenated with separator `; ` or some other database system specific separator if more applicable.
376
+ # For batch operations, if the individual operations would all have the same `db.query.text` when executed as non-batch operations, then that query text SHOULD be used. Otherwise, all of the individual query texts SHOULD be concatenated with separator `; ` or some other database system specific separator if more applicable.
374
377
  # Parameterized query text SHOULD NOT be sanitized. Even though parameterized query text can potentially have sensitive data, by using a parameterized query the user is giving a strong signal that any sensitive data will be passed as parameter values, and the benefit to observability of capturing the static part of the query text by default outweighs the risk.
375
378
  #
376
379
  # @note Stability Level: stable
@@ -392,6 +395,7 @@ module OpenTelemetry
392
395
  # Database response status code.
393
396
  #
394
397
  # The status code returned by the database. Usually it represents an error code, but may also represent partial success, warning, or differentiate between various types of successful outcomes.
398
+ # The value MAY use a standardized string representation of a numeric status code, if one exists, instead of the numeric code. The value MAY be a synthetic status provided by the client library rather than returned by the remote service.
395
399
  # Semantic conventions for individual database systems SHOULD document what `db.response.status_code` means in the context of that system.
396
400
  #
397
401
  # @note Stability Level: stable
@@ -416,8 +420,9 @@ module OpenTelemetry
416
420
  # It is RECOMMENDED to capture the value as provided by the application
417
421
  # without attempting to do any case normalization.
418
422
  #
419
- # For batch operations, if the individual operations are known to have the same
420
- # stored procedure name then that stored procedure name SHOULD be used.
423
+ # For batch operations, if the individual operations would all have the same
424
+ # `db.stored_procedure.name` when executed as non-batch operations,
425
+ # then that stored procedure name SHOULD be used.
421
426
  #
422
427
  # @note Stability Level: stable
423
428
  #
@@ -47,6 +47,12 @@ module OpenTelemetry
47
47
  # The maximum number of open connections allowed.
48
48
  #
49
49
  # @note Stability Level: development
50
+ DB_CLIENT_CONNECTION_LIMIT = 'db.client.connection.limit'
51
+
52
+ # Deprecated, use `db.client.connection.limit` instead.
53
+ #
54
+ # @note Stability Level: development
55
+ # @deprecated Replaced by `db.client.connection.limit`.
50
56
  DB_CLIENT_CONNECTION_MAX = 'db.client.connection.max'
51
57
 
52
58
  # The number of current pending requests for an open connection.
@@ -87,10 +93,10 @@ module OpenTelemetry
87
93
  # @deprecated Replaced by `db.client.connection.idle.min`.
88
94
  DB_CLIENT_CONNECTIONS_IDLE_MIN = 'db.client.connections.idle.min'
89
95
 
90
- # Deprecated, use `db.client.connection.max` instead.
96
+ # Deprecated, use `db.client.connection.limit` instead.
91
97
  #
92
98
  # @note Stability Level: development
93
- # @deprecated Replaced by `db.client.connection.max`.
99
+ # @deprecated Replaced by `db.client.connection.limit`.
94
100
  DB_CLIENT_CONNECTIONS_MAX = 'db.client.connections.max'
95
101
 
96
102
  # Deprecated, use `db.client.connection.pending_requests` instead.
@@ -24,18 +24,69 @@ module OpenTelemetry
24
24
  module DESTINATION
25
25
  # @!group Attribute Names
26
26
 
27
- # Destination address - domain name if available without reverse DNS lookup; otherwise, IP address or UNIX domain socket name.
27
+ # Destination address as observed at the point of instrumentation - typically an IP address, or a UNIX domain socket name; a domain name only when the receiver was addressed by name (for example a peer-to-peer node dialed by hostname), never obtained via reverse DNS lookup.
28
28
  #
29
- # When observed from the source side, and when communicating through an intermediary, `destination.address` SHOULD represent the destination address behind any intermediaries, for example proxies, if it's available.
29
+ # `destination.address` SHOULD be the receiver address as observed at the point of instrumentation, for example the destination of the packet, flow, or exchange seen on the wire or socket. Instrumentation SHOULD capture the available address and SHOULD NOT try to resolve the address behind intermediaries such as proxies or load balancers, or perform a reverse DNS lookup to obtain a domain name.
30
30
  #
31
31
  # @note Stability Level: development
32
32
  DESTINATION_ADDRESS = 'destination.address'
33
33
 
34
+ # The [Autonomous System Number (ASN)](https://www.iana.org/assignments/as-numbers/as-numbers.xhtml) associated with the destination IP address.
35
+ #
36
+ # This attribute SHOULD only be set when the destination address is an IP address and the ASN is available from routing, enrichment, or lookup data. The value SHOULD be represented as an integer without the `AS` prefix.
37
+ #
38
+ # @note Stability Level: development
39
+ DESTINATION_AS_NUMBER = 'destination.as.number'
40
+
41
+ # The name of the organization associated with the autonomous system of the destination IP address.
42
+ #
43
+ # This attribute SHOULD only be set when `destination.as.number` is set and the organization name is available. The value SHOULD be the organization name as provided by the lookup or enrichment source, not the AS name or short code.
44
+ #
45
+ # @note Stability Level: development
46
+ DESTINATION_AS_ORGANIZATION = 'destination.as.organization'
47
+
48
+ # Destination Media Access Control (MAC) address.
49
+ #
50
+ # MAC addresses MUST be represented in [IEEE RA hexadecimal form](https://standards.ieee.org/wp-content/uploads/import/documents/tutorials/eui.pdf):
51
+ # as hyphen-separated octets in uppercase hexadecimal form from most to least significant.
52
+ #
53
+ # > [!WARNING]> This attribute may contain sensitive (PII) information.
54
+ #
55
+ # @note Stability Level: development
56
+ DESTINATION_MAC_ADDRESS = 'destination.mac.address'
57
+
34
58
  # Destination port number
35
59
  #
36
60
  # @note Stability Level: development
37
61
  DESTINATION_PORT = 'destination.port'
38
62
 
63
+ # The IP prefix associated with the destination IP address, in CIDR notation.
64
+ #
65
+ # > [!WARNING]> This attribute may contain sensitive (PII) information. A `/32`> IPv4 prefix
66
+ # > or `/128`> IPv6 prefix preserves the complete endpoint IP address.
67
+ # > Using CIDR notation does not guarantee that the data is anonymous.
68
+ #
69
+ # The value MUST be an IPv4 or IPv6 network prefix in CIDR notation, as defined in
70
+ # [RFC 4632](https://www.rfc-editor.org/rfc/rfc4632.html) for IPv4 and
71
+ # [RFC 4291](https://www.rfc-editor.org/rfc/rfc4291.html#section-2.3) for IPv6.
72
+ # IPv4 prefixes MUST use a dotted-decimal address followed by `/` and a decimal
73
+ # prefix length from 0 to 32. IPv6 prefixes MUST use the canonical address text
74
+ # representation defined in [RFC 5952](https://www.rfc-editor.org/rfc/rfc5952.html),
75
+ # followed by `/` and a decimal prefix length from 0 to 128. All host bits in
76
+ # the address MUST be set to zero. The value MUST NOT contain a domain name,
77
+ # UNIX domain socket name, or IPv6 zone identifier.
78
+ #
79
+ # Instrumentation or Collector receivers that populate this attribute MUST
80
+ # convert native representations, such as an address and subnet mask or an
81
+ # address and prefix length, to equivalent CIDR notation before emitting it.
82
+ #
83
+ # This attribute MAY be set whether or not `destination.address` is set. If
84
+ # `destination.address` is also set to an IP address, it MUST use the same IP version
85
+ # and be contained in this prefix.
86
+ #
87
+ # @note Stability Level: development
88
+ DESTINATION_PREFIX = 'destination.prefix'
89
+
39
90
  # @!endgroup
40
91
  end
41
92
  end
@@ -32,6 +32,7 @@ module OpenTelemetry
32
32
  # > This field contains sensitive (PII) information.
33
33
  #
34
34
  # @note Stability Level: development
35
+ # @deprecated Moved to the [OpenTelemetry Client-Side semantic conventions repository](https://github.com/open-telemetry/semantic-conventions-client-side).
35
36
  ENDUSER_ID = 'enduser.id'
36
37
 
37
38
  # Pseudonymous identifier of an end user. This identifier should be a random value that is not directly linked or associated with the end user's actual identity.
@@ -42,6 +43,7 @@ module OpenTelemetry
42
43
  # > This field contains sensitive (linkable PII) information.
43
44
  #
44
45
  # @note Stability Level: development
46
+ # @deprecated Moved to the [OpenTelemetry Client-Side semantic conventions repository](https://github.com/open-telemetry/semantic-conventions-client-side).
45
47
  ENDUSER_PSEUDO_ID = 'enduser.pseudo.id'
46
48
 
47
49
  # Deprecated, use `user.roles` instead.
@@ -64,7 +64,12 @@ module OpenTelemetry
64
64
  # The invocation ID of the current function invocation.
65
65
  #
66
66
  # @note Stability Level: development
67
- FAAS_INVOCATION_ID = 'faas.invocation_id'
67
+ FAAS_INVOCATION_ID = 'faas.invocation.id'
68
+
69
+ # A string containing the function invocation time in the [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format expressed in [UTC](https://www.w3.org/TR/NOTE-datetime).
70
+ #
71
+ # @note Stability Level: development
72
+ FAAS_INVOCATION_START_TIME = 'faas.invocation.start_time'
68
73
 
69
74
  # The name of the invoked function.
70
75
  #
@@ -117,8 +122,7 @@ module OpenTelemetry
117
122
  FAAS_NAME = 'faas.name'
118
123
 
119
124
  # A string containing the function invocation time in the [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format expressed in [UTC](https://www.w3.org/TR/NOTE-datetime).
120
- #
121
- # @note Stability Level: development
125
+ # @deprecated Replaced by `faas.invocation.start_time`.
122
126
  FAAS_TIME = 'faas.time'
123
127
 
124
128
  # Type of the trigger which caused this function invocation.
@@ -177,6 +177,26 @@ module OpenTelemetry
177
177
  # @note Stability Level: development
178
178
  GCP_GCE_INSTANCE_GROUP_MANAGER_ZONE = 'gcp.gce.instance_group_manager.zone'
179
179
 
180
+ # The ack deadline in seconds set for the modify ack deadline request.
181
+ #
182
+ # @note Stability Level: development
183
+ GCP_PUBSUB_MESSAGE_ACK_DEADLINE = 'gcp.pubsub.message.ack_deadline'
184
+
185
+ # The ack ID for a given message.
186
+ #
187
+ # @note Stability Level: development
188
+ GCP_PUBSUB_MESSAGE_ACK_ID = 'gcp.pubsub.message.ack_id'
189
+
190
+ # The delivery attempt for a given message.
191
+ #
192
+ # @note Stability Level: development
193
+ GCP_PUBSUB_MESSAGE_DELIVERY_ATTEMPT = 'gcp.pubsub.message.delivery_attempt'
194
+
195
+ # The ordering key for a given message. If the attribute is not present, the message does not have an ordering key.
196
+ #
197
+ # @note Stability Level: development
198
+ GCP_PUBSUB_MESSAGE_ORDERING_KEY = 'gcp.pubsub.message.ordering_key'
199
+
180
200
  # @!endgroup
181
201
  end
182
202
  end