opentelemetry-semantic_conventions 1.43.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 (67) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +8 -0
  3. data/lib/opentelemetry/semantic_conventions/version.rb +2 -2
  4. data/lib/opentelemetry/semconv/client/attributes.rb +3 -3
  5. data/lib/opentelemetry/semconv/code/attributes.rb +1 -1
  6. data/lib/opentelemetry/semconv/container/attributes.rb +1 -1
  7. data/lib/opentelemetry/semconv/db/attributes.rb +16 -11
  8. data/lib/opentelemetry/semconv/incubating/android/attributes.rb +1 -1
  9. data/lib/opentelemetry/semconv/incubating/app/attributes.rb +1 -1
  10. data/lib/opentelemetry/semconv/incubating/artifact/attributes.rb +3 -3
  11. data/lib/opentelemetry/semconv/incubating/aws/attributes.rb +1 -1
  12. data/lib/opentelemetry/semconv/incubating/azure/attributes.rb +20 -0
  13. data/lib/opentelemetry/semconv/incubating/browser/attributes.rb +30 -0
  14. data/lib/opentelemetry/semconv/incubating/client/attributes.rb +73 -3
  15. data/lib/opentelemetry/semconv/incubating/cloudfoundry/attributes.rb +1 -1
  16. data/lib/opentelemetry/semconv/incubating/code/attributes.rb +1 -1
  17. data/lib/opentelemetry/semconv/incubating/container/attributes.rb +3 -3
  18. data/lib/opentelemetry/semconv/incubating/container/metrics.rb +40 -34
  19. data/lib/opentelemetry/semconv/incubating/cpu/attributes.rb +4 -2
  20. data/lib/opentelemetry/semconv/incubating/db/attributes.rb +24 -14
  21. data/lib/opentelemetry/semconv/incubating/db/metrics.rb +8 -2
  22. data/lib/opentelemetry/semconv/incubating/deployment/attributes.rb +1 -1
  23. data/lib/opentelemetry/semconv/incubating/destination/attributes.rb +53 -2
  24. data/lib/opentelemetry/semconv/incubating/enduser/attributes.rb +2 -0
  25. data/lib/opentelemetry/semconv/incubating/faas/attributes.rb +7 -3
  26. data/lib/opentelemetry/semconv/incubating/file/attributes.rb +3 -3
  27. data/lib/opentelemetry/semconv/incubating/gcp/attributes.rb +20 -0
  28. data/lib/opentelemetry/semconv/incubating/host/attributes.rb +61 -2
  29. data/lib/opentelemetry/semconv/incubating/http/attributes.rb +59 -0
  30. data/lib/opentelemetry/semconv/incubating/jvm/attributes.rb +24 -0
  31. data/lib/opentelemetry/semconv/incubating/jvm/metrics.rb +45 -2
  32. data/lib/opentelemetry/semconv/incubating/k8s/metrics.rb +315 -73
  33. data/lib/opentelemetry/semconv/incubating/kafka/attributes.rb +55 -0
  34. data/lib/opentelemetry/semconv/incubating/kafka.rb +21 -0
  35. data/lib/opentelemetry/semconv/incubating/log/attributes.rb +7 -7
  36. data/lib/opentelemetry/semconv/incubating/mcp/attributes.rb +1 -1
  37. data/lib/opentelemetry/semconv/incubating/messaging/attributes.rb +78 -29
  38. data/lib/opentelemetry/semconv/incubating/network/attributes.rb +107 -5
  39. data/lib/opentelemetry/semconv/incubating/opentracing/attributes.rb +1 -0
  40. data/lib/opentelemetry/semconv/incubating/oracle/attributes.rb +1 -1
  41. data/lib/opentelemetry/semconv/incubating/otel/metrics.rb +25 -8
  42. data/lib/opentelemetry/semconv/incubating/peer/attributes.rb +1 -1
  43. data/lib/opentelemetry/semconv/incubating/pprof/attributes.rb +2 -2
  44. data/lib/opentelemetry/semconv/incubating/process/metrics.rb +16 -1
  45. data/lib/opentelemetry/semconv/incubating/rabbitmq/attributes.rb +41 -0
  46. data/lib/opentelemetry/semconv/incubating/rabbitmq.rb +21 -0
  47. data/lib/opentelemetry/semconv/incubating/rocketmq/attributes.rb +71 -0
  48. data/lib/opentelemetry/semconv/incubating/rocketmq.rb +21 -0
  49. data/lib/opentelemetry/semconv/incubating/rpc/attributes.rb +111 -36
  50. data/lib/opentelemetry/semconv/incubating/rpc/metrics.rb +6 -2
  51. data/lib/opentelemetry/semconv/incubating/server/attributes.rb +71 -1
  52. data/lib/opentelemetry/semconv/incubating/service/attributes.rb +16 -0
  53. data/lib/opentelemetry/semconv/incubating/session/attributes.rb +1 -1
  54. data/lib/opentelemetry/semconv/incubating/source/attributes.rb +53 -2
  55. data/lib/opentelemetry/semconv/incubating/system/attributes.rb +15 -9
  56. data/lib/opentelemetry/semconv/incubating/system/metrics.rb +18 -5
  57. data/lib/opentelemetry/semconv/incubating/url/attributes.rb +15 -3
  58. data/lib/opentelemetry/semconv/incubating/v8js/attributes.rb +2 -1
  59. data/lib/opentelemetry/semconv/incubating/zos/attributes.rb +4 -2
  60. data/lib/opentelemetry/semconv/network/attributes.rb +2 -2
  61. data/lib/opentelemetry/semconv/rpc/attributes.rb +77 -0
  62. data/lib/opentelemetry/semconv/rpc/metrics.rb +45 -0
  63. data/lib/opentelemetry/semconv/rpc.rb +22 -0
  64. data/lib/opentelemetry/semconv/server/attributes.rb +1 -1
  65. data/lib/opentelemetry/semconv/url/attributes.rb +12 -0
  66. data/lib/opentelemetry/semconv.rb +4 -0
  67. metadata +14 -5
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: c87619f45a9752cbd827768b88976c4636aba6abb0376efc480113bc4664ef73
4
- data.tar.gz: b62d6d3745214c370d0316b2c95b0a0b35510dd53cb375d4ce15dcc07b7c5f6a
3
+ metadata.gz: 12dd7eccacccfd4e29594f1dc62862b8e1a6b00f1e10a3f6e9c75dedae5d5469
4
+ data.tar.gz: 0d07d4c6b3fcaa329db5e15e5b0fed98a035a74e142022466566957ae2c1a176
5
5
  SHA512:
6
- metadata.gz: 3a2e44a598a565d9cedac1a31cfec2d5d8c5e9ba6c43b22e8cf34c7c94472ac516cee0f5bd56a58bd94cc8529d5c41ab5d73d3da3b8c36d01c7ba5da73dee6a9
7
- data.tar.gz: 9b537d4df0f26facf57fa5e411660287f6e81c8627fd9d046fd7a6edb66055d6c3f8ce512ed21d872c630b01c264949bfd50d336853483cebb349e3e095ace82
6
+ metadata.gz: 1817794bbc3c0cbd0121b3ff1205f60b570f9f106c3380a8c1dbd95ca7480dd942e4c9921d65cafc802d18a8de324a1ff031ddb9e809694e81b4464ceaf139f5
7
+ data.tar.gz: a2b398bb0ec666f56f48398eba989671aa624cdcbe46124044229d2d7b67ef8baa720ff8a0fd8905e32b2f33789568d1aa61d91266aa4f549acf595175ce478e
data/CHANGELOG.md CHANGED
@@ -1,5 +1,13 @@
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
+
7
+ ### v1.44.0 / 2026-08-07
8
+
9
+ * ADDED: Update dependency open-telemetry/semantic-conventions to v1.44.0 (#2279)
10
+
3
11
  ### v1.43.0 / 2026-07-08
4
12
 
5
13
  * ADDED: Update dependency open-telemetry/semantic-conventions to v1.43.0 (#2218)
@@ -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.43.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.43.0'
12
+ VERSION = '1.45.0'
13
13
  end
14
14
  end
@@ -23,16 +23,16 @@ module OpenTelemetry
23
23
  module CLIENT
24
24
  # @!group Attribute Names
25
25
 
26
- # Client address - domain name if available without reverse DNS lookup; otherwise, IP address or Unix domain socket name.
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'
@@ -28,7 +28,7 @@ module OpenTelemetry
28
28
  # @note Stability Level: stable
29
29
  CODE_COLUMN_NUMBER = 'code.column.number'
30
30
 
31
- # The source code file name that identifies the code unit as uniquely as possible (preferably an absolute file path). This attribute MUST NOT be used on the Profile signal since the data is already captured in 'message Function'. This constraint is imposed to prevent redundancy and maintain data integrity.
31
+ # The source code filename that identifies the code unit as uniquely as possible (preferably an absolute file path). This attribute MUST NOT be used on the Profile signal since the data is already captured in 'message Function'. This constraint is imposed to prevent redundancy and maintain data integrity.
32
32
  #
33
33
  # @note Stability Level: stable
34
34
  CODE_FILE_PATH = 'code.file.path'
@@ -33,7 +33,7 @@ module OpenTelemetry
33
33
  # @note Stability Level: stable
34
34
  CONTAINER_IMAGE_NAME = 'container.image.name'
35
35
 
36
- # Repo digests of the container image as provided by the container runtime.
36
+ # Repository digests of the container image as provided by the container runtime.
37
37
  #
38
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
39
  #
@@ -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'
@@ -31,7 +31,7 @@ module OpenTelemetry
31
31
  # @note Stability Level: development
32
32
  ANDROID_APP_STATE = 'android.app.state'
33
33
 
34
- # Uniquely identifies the framework API revision offered by a version (`os.version`) of the android operating system. More information can be found in the [Android API levels documentation](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels).
34
+ # Uniquely identifies the framework API revision offered by a version (`os.version`) of the Android operating system. More information can be found in the [Android API levels documentation](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels).
35
35
  #
36
36
  # @note Stability Level: development
37
37
  ANDROID_OS_API_LEVEL = 'android.os.api_level'
@@ -29,7 +29,7 @@ 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.
32
+ # A unique identifier representing an instance of an end user facing app crash.
33
33
  #
34
34
  # Its value MAY be meaningful and be used as a reference for telemetry and metadata recorded by
35
35
  # the same instrumentation (e.g. it is an ID generated by an external source that captured the crash).
@@ -34,14 +34,14 @@ module OpenTelemetry
34
34
  # @note Stability Level: development
35
35
  ARTIFACT_ATTESTATION_HASH = 'artifact.attestation.hash'
36
36
 
37
- # The id of the build [software attestation](https://slsa.dev/attestation-model).
37
+ # The ID of the build [software attestation](https://slsa.dev/attestation-model).
38
38
  #
39
39
  # @note Stability Level: development
40
40
  ARTIFACT_ATTESTATION_ID = 'artifact.attestation.id'
41
41
 
42
- # The human readable file name of the artifact, typically generated during build and release processes. Often includes the package name and version in the file name.
42
+ # The human readable filename of the artifact, typically generated during build and release processes. Often includes the package name and version in the filename.
43
43
  #
44
- # This file name can also act as the [Package Name](https://slsa.dev/spec/v1.0/terminology#package-model)
44
+ # This filename can also act as the [Package Name](https://slsa.dev/spec/v1.0/terminology#package-model)
45
45
  # in cases where the package ecosystem maps accordingly.
46
46
  # Additionally, the artifact [can be published](https://slsa.dev/spec/v1.0/terminology#software-supply-chain)
47
47
  # for others, but that is not a guarantee.
@@ -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
@@ -58,6 +58,36 @@ module OpenTelemetry
58
58
  # @note Stability Level: development
59
59
  BROWSER_PLATFORM = 'browser.platform'
60
60
 
61
+ # The delta between the current value and the last-reported value. See [delta](https://github.com/GoogleChrome/web-vitals?tab=readme-ov-file#report-only-the-delta-of-changes).
62
+ #
63
+ # @note Stability Level: development
64
+ BROWSER_WEB_VITAL_DELTA = 'browser.web_vital.delta'
65
+
66
+ # A unique ID representing this particular metric instance.
67
+ #
68
+ # @note Stability Level: development
69
+ BROWSER_WEB_VITAL_ID = 'browser.web_vital.id'
70
+
71
+ # Name of the web vital.
72
+ #
73
+ # @note Stability Level: development
74
+ BROWSER_WEB_VITAL_NAME = 'browser.web_vital.name'
75
+
76
+ # The type of navigation, as reported by the [Navigation Timing API](https://developer.mozilla.org/docs/Web/API/PerformanceNavigationTiming/type), with additional values reported by the web-vitals library.
77
+ #
78
+ # @note Stability Level: development
79
+ BROWSER_WEB_VITAL_NAVIGATION_TYPE = 'browser.web_vital.navigation_type'
80
+
81
+ # The rating of the web vital value against the "good", "needs improvement", and "poor" thresholds defined for the metric.
82
+ #
83
+ # @note Stability Level: development
84
+ BROWSER_WEB_VITAL_RATING = 'browser.web_vital.rating'
85
+
86
+ # Value of the web vital.
87
+ #
88
+ # @note Stability Level: development
89
+ BROWSER_WEB_VITAL_VALUE = 'browser.web_vital.value'
90
+
61
91
  # @!endgroup
62
92
  end
63
93
  end
@@ -24,24 +24,94 @@ module OpenTelemetry
24
24
  module CLIENT
25
25
  # @!group Attribute Names
26
26
 
27
- # Client address - domain name if available without reverse DNS lookup; otherwise, IP address or Unix domain socket name.
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
@@ -129,7 +129,7 @@ module OpenTelemetry
129
129
  #
130
130
  # CloudFoundry defines the `instance_id` in the [Loggregator v2 envelope](https://github.com/cloudfoundry/loggregator-api#v2-envelope).
131
131
  # It is used for logs and metrics emitted by CloudFoundry. It is
132
- # supposed to contain the vm id for CloudFoundry components.
132
+ # supposed to contain the vm ID for CloudFoundry components.
133
133
  #
134
134
  # When system components are instrumented, values from the
135
135
  # [Bosh spec](https://bosh.io/docs/jobs/#properties-spec)
@@ -37,7 +37,7 @@ module OpenTelemetry
37
37
  # @deprecated Now available in the stable namespace at {OpenTelemetry::SemConv::CODE::CODE_COLUMN_NUMBER}.
38
38
  CODE_COLUMN_NUMBER = 'code.column.number'
39
39
 
40
- # The source code file name that identifies the code unit as uniquely as possible (preferably an absolute file path). This attribute MUST NOT be used on the Profile signal since the data is already captured in 'message Function'. This constraint is imposed to prevent redundancy and maintain data integrity.
40
+ # The source code filename that identifies the code unit as uniquely as possible (preferably an absolute file path). This attribute MUST NOT be used on the Profile signal since the data is already captured in 'message Function'. This constraint is imposed to prevent redundancy and maintain data integrity.
41
41
  #
42
42
  # @note Stability Level: stable
43
43
  #
@@ -70,7 +70,7 @@ module OpenTelemetry
70
70
 
71
71
  # Runtime specific image identifier. Usually a hash algorithm followed by a UUID.
72
72
  #
73
- # 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.52/#tag/Container/operation/ContainerInspect) endpoint.
73
+ # 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.52/#tag/Container/operation/ContainerInspect) endpoint.
74
74
  # K8s defines a link to the container registry repository with digest `"imageID": "registry.azurecr.io /namespace/service/dockerfile@sha256:bdeabd40c3a8a492eaf9e8e44d0ebbb84bac7ee25ac0cf8a7159d25f62555625"`.
75
75
  # 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.
76
76
  #
@@ -84,7 +84,7 @@ module OpenTelemetry
84
84
  # @deprecated Now available in the stable namespace at {OpenTelemetry::SemConv::CONTAINER::CONTAINER_IMAGE_NAME}.
85
85
  CONTAINER_IMAGE_NAME = 'container.image.name'
86
86
 
87
- # Repo digests of the container image as provided by the container runtime.
87
+ # Repository digests of the container image as provided by the container runtime.
88
88
  #
89
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.
90
90
  #
@@ -108,7 +108,7 @@ module OpenTelemetry
108
108
  #
109
109
  # Container labels, `<key>` being the label name, the value being the label value.
110
110
  #
111
- # For example, a docker container label `app` with value `nginx` SHOULD be recorded as the `container.label.app` attribute with value `"nginx"`.
111
+ # For example, a Docker container label `app` with value `nginx` SHOULD be recorded as the `container.label.app` attribute with value `"nginx"`.
112
112
  #
113
113
  # @note Stability Level: development
114
114
  CONTAINER_LABEL_LAMBDA = ->(key) { "container.label.#{key}" }
@@ -24,18 +24,18 @@ module OpenTelemetry
24
24
  module CONTAINER
25
25
  # @!group Metrics Names
26
26
 
27
- # CPU time consumed.
27
+ # Total CPU time consumed.
28
28
  #
29
29
  # CPU time consumed by the specific container on all available CPU cores
30
30
  #
31
31
  # @note Stability Level: release_candidate
32
32
  CONTAINER_CPU_TIME = 'container.cpu.time'
33
33
 
34
- # Container's CPU usage, measured in cpus. Range from 0 to the number of allocatable CPUs.
34
+ # Container's CPU usage, measured in CPUs. Range from 0 to the number of allocatable CPUs.
35
35
  #
36
- # CPU usage of the specific container on all available CPU cores, averaged over the sample window
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,74 +47,72 @@ 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.
81
76
  #
82
77
  # Available memory for use. This is defined as the memory limit - workingSetBytes. If memory limit is undefined, the available bytes is omitted.
83
78
  # 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 by subtracting the `container_memory_working_set_bytes` metric from the `container_spec_memory_limit_bytes` metric.
84
- # In K8s, this metric is derived from the [MemoryStats.AvailableBytes](https://pkg.go.dev/k8s.io/kubelet@v0.34.0/pkg/apis/stats/v1alpha1#MemoryStats) field of the [PodStats.Memory](https://pkg.go.dev/k8s.io/kubelet@v0.34.0/pkg/apis/stats/v1alpha1#PodStats) of the Kubelet's stats API.
79
+ # In K8s, this metric is derived from the [MemoryStats.AvailableBytes](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.
85
80
  #
86
- # @note Stability Level: development
81
+ # @note Stability Level: release_candidate
87
82
  CONTAINER_MEMORY_AVAILABLE = 'container.memory.available'
88
83
 
89
- # Container memory paging faults.
84
+ # Deprecated, use `container.paging.faults` instead.
90
85
  #
91
86
  # 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.
92
87
  # 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 [PodStats.Memory](https://pkg.go.dev/k8s.io/kubelet@v0.34.0/pkg/apis/stats/v1alpha1#PodStats) of the Kubelet's stats API.
93
88
  #
94
89
  # @note Stability Level: development
90
+ # @deprecated Replaced by `container.paging.faults`.
95
91
  CONTAINER_MEMORY_PAGING_FAULTS = 'container.memory.paging.faults'
96
92
 
97
93
  # Container memory RSS.
98
94
  #
99
95
  # 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_rss` metric.
100
- # In K8s, this metric is derived from the [MemoryStats.RSSBytes](https://pkg.go.dev/k8s.io/kubelet@v0.34.0/pkg/apis/stats/v1alpha1#MemoryStats) field of the [PodStats.Memory](https://pkg.go.dev/k8s.io/kubelet@v0.34.0/pkg/apis/stats/v1alpha1#PodStats) of the Kubelet's stats API.
96
+ # In K8s, this metric is derived from the [MemoryStats.RSSBytes](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.
101
97
  #
102
- # @note Stability Level: development
98
+ # @note Stability Level: release_candidate
103
99
  CONTAINER_MEMORY_RSS = 'container.memory.rss'
104
100
 
105
101
  # Memory usage of the container.
106
102
  #
107
- # Memory usage of the container.
103
+ # Current memory usage, including all memory regardless of when it was accessed.
104
+ # 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_usage_bytes` metric.
105
+ # In K8s, this metric is derived from the [MemoryStats.UsageBytes](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.
108
106
  #
109
- # @note Stability Level: development
107
+ # @note Stability Level: release_candidate
110
108
  CONTAINER_MEMORY_USAGE = 'container.memory.usage'
111
109
 
112
110
  # Container memory working set.
113
111
  #
114
- # 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.
115
- # 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 [PodStats.Memory](https://pkg.go.dev/k8s.io/kubelet@v0.34.0/pkg/apis/stats/v1alpha1#PodStats) of the Kubelet's stats API.
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.
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.
116
114
  #
117
- # @note Stability Level: development
115
+ # @note Stability Level: release_candidate
118
116
  CONTAINER_MEMORY_WORKING_SET = 'container.memory.working_set'
119
117
 
120
118
  # Network bytes for the container.
@@ -124,12 +122,20 @@ module OpenTelemetry
124
122
  # @note Stability Level: development
125
123
  CONTAINER_NETWORK_IO = 'container.network.io'
126
124
 
125
+ # Container memory paging faults.
126
+ #
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.
129
+ #
130
+ # @note Stability Level: release_candidate
131
+ CONTAINER_PAGING_FAULTS = 'container.paging.faults'
132
+
127
133
  # The time the container has been running.
128
134
  #
129
- # Instrumentations SHOULD use a gauge with type `double` and measure uptime in seconds as a floating point number with the highest precision available.
130
- # 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.
131
137
  #
132
- # @note Stability Level: development
138
+ # @note Stability Level: release_candidate
133
139
  CONTAINER_UPTIME = 'container.uptime'
134
140
 
135
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