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
@@ -61,12 +61,12 @@ module OpenTelemetry
61
61
  # @note Stability Level: development
62
62
  PPROF_PROFILE_DOC_URL = 'pprof.profile.doc_url'
63
63
 
64
- # Frames with Function.function_name fully matching the regexp will be dropped from the samples, along with their successors.
64
+ # Frames with Function.function_name fully matching the regular expression will be dropped from the samples, along with their successors.
65
65
  #
66
66
  # @note Stability Level: development
67
67
  PPROF_PROFILE_DROP_FRAMES = 'pprof.profile.drop_frames'
68
68
 
69
- # Frames with Function.function_name fully matching the regexp will be kept, even if it matches drop_frames.
69
+ # Frames with Function.function_name fully matching the regular expression will be kept, even if it matches drop_frames.
70
70
  #
71
71
  # @note Stability Level: development
72
72
  PPROF_PROFILE_KEEP_FRAMES = 'pprof.profile.keep_frames'
@@ -44,11 +44,21 @@ module OpenTelemetry
44
44
  # @note Stability Level: release_candidate
45
45
  PROCESS_DISK_IO = 'process.disk.io'
46
46
 
47
+ # Number of disk operations performed by the process.
48
+ #
49
+ # @note Stability Level: development
50
+ PROCESS_DISK_OPERATIONS = 'process.disk.operations'
51
+
47
52
  # The amount of physical memory in use.
48
53
  #
49
54
  # @note Stability Level: release_candidate
50
55
  PROCESS_MEMORY_USAGE = 'process.memory.usage'
51
56
 
57
+ # Percentage of total physical memory that is used by the process.
58
+ #
59
+ # @note Stability Level: development
60
+ PROCESS_MEMORY_UTILIZATION = 'process.memory.utilization'
61
+
52
62
  # The amount of committed virtual memory.
53
63
  #
54
64
  # @note Stability Level: release_candidate
@@ -70,12 +80,17 @@ module OpenTelemetry
70
80
  # @note Stability Level: release_candidate
71
81
  PROCESS_PAGING_FAULTS = 'process.paging.faults'
72
82
 
83
+ # Number of pending signals for the process.
84
+ #
85
+ # @note Stability Level: development
86
+ PROCESS_SIGNALS_PENDING = 'process.signals_pending'
87
+
73
88
  # Process threads count.
74
89
  #
75
90
  # @note Stability Level: release_candidate
76
91
  PROCESS_THREAD_COUNT = 'process.thread.count'
77
92
 
78
- # Number of unix file descriptors in use by the process.
93
+ # Number of UNIX file descriptors in use by the process.
79
94
  #
80
95
  # @note Stability Level: release_candidate
81
96
  PROCESS_UNIX_FILE_DESCRIPTOR_COUNT = 'process.unix.file_descriptor.count'
@@ -0,0 +1,41 @@
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 Incubating
24
+ module RABBITMQ
25
+ # @!group Attribute Names
26
+
27
+ # RabbitMQ message routing key.
28
+ #
29
+ # @note Stability Level: development
30
+ RABBITMQ_DESTINATION_ROUTING_KEY = 'rabbitmq.destination.routing_key'
31
+
32
+ # RabbitMQ message delivery tag
33
+ #
34
+ # @note Stability Level: development
35
+ RABBITMQ_MESSAGE_DELIVERY_TAG = 'rabbitmq.message.delivery_tag'
36
+
37
+ # @!endgroup
38
+ end
39
+ end
40
+ end
41
+ 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 'rabbitmq/attributes'
@@ -0,0 +1,71 @@
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 Incubating
24
+ module ROCKETMQ
25
+ # @!group Attribute Names
26
+
27
+ # Model of message consumption. This only applies to consumer spans.
28
+ #
29
+ # @note Stability Level: development
30
+ ROCKETMQ_CONSUMPTION_MODEL = 'rocketmq.consumption_model'
31
+
32
+ # The delay time level for delay message, which determines the message delay time.
33
+ #
34
+ # @note Stability Level: development
35
+ ROCKETMQ_MESSAGE_DELAY_TIME_LEVEL = 'rocketmq.message.delay_time_level'
36
+
37
+ # The timestamp in milliseconds that the delay message is expected to be delivered to consumer.
38
+ #
39
+ # @note Stability Level: development
40
+ ROCKETMQ_MESSAGE_DELIVERY_TIMESTAMP = 'rocketmq.message.delivery_timestamp'
41
+
42
+ # It is essential for FIFO message. Messages that belong to the same message group are always processed one by one within the same consumer group.
43
+ #
44
+ # @note Stability Level: development
45
+ ROCKETMQ_MESSAGE_GROUP = 'rocketmq.message.group'
46
+
47
+ # Key(s) of message, another way to mark message besides message ID.
48
+ #
49
+ # @note Stability Level: development
50
+ ROCKETMQ_MESSAGE_KEYS = 'rocketmq.message.keys'
51
+
52
+ # The secondary classifier of message besides topic.
53
+ #
54
+ # @note Stability Level: development
55
+ ROCKETMQ_MESSAGE_TAG = 'rocketmq.message.tag'
56
+
57
+ # Type of message.
58
+ #
59
+ # @note Stability Level: development
60
+ ROCKETMQ_MESSAGE_TYPE = 'rocketmq.message.type'
61
+
62
+ # Namespace of RocketMQ resources, resources in different namespaces are individual.
63
+ #
64
+ # @note Stability Level: development
65
+ ROCKETMQ_NAMESPACE = 'rocketmq.namespace'
66
+
67
+ # @!endgroup
68
+ end
69
+ end
70
+ end
71
+ 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 'rocketmq/attributes'
@@ -24,10 +24,10 @@ module OpenTelemetry
24
24
  module RPC
25
25
  # @!group Attribute Names
26
26
 
27
- # Deprecated, use `rpc.response.status_code` attribute instead.
27
+ # Deprecated, use `rpc.status_code` attribute instead.
28
28
  #
29
29
  # @note Stability Level: development
30
- # @deprecated Replaced by `rpc.response.status_code`.
30
+ # @deprecated Replaced by `rpc.status_code`.
31
31
  RPC_CONNECT_RPC_ERROR_CODE = 'rpc.connect_rpc.error_code'
32
32
 
33
33
  # Must be called with a key for the full attribute name. See notes below about the expectations
@@ -36,10 +36,10 @@ module OpenTelemetry
36
36
  # @example Usage
37
37
  # RPC_CONNECT_RPC_REQUEST_METADATA_LAMBDA.call('some-cool-key') #=> 'rpc.connect_rpc.request.metadata.some-cool-key'
38
38
  #
39
- # Deprecated, use `rpc.request.metadata` instead.
39
+ # Deprecated, use `rpc.request.header` instead.
40
40
  #
41
41
  # @note Stability Level: development
42
- # @deprecated Replaced by `rpc.request.metadata`.
42
+ # @deprecated Replaced by `rpc.request.header`.
43
43
  RPC_CONNECT_RPC_REQUEST_METADATA_LAMBDA = ->(key) { "rpc.connect_rpc.request.metadata.#{key}" }
44
44
 
45
45
  # Must be called with a key for the full attribute name. See notes below about the expectations
@@ -48,10 +48,10 @@ module OpenTelemetry
48
48
  # @example Usage
49
49
  # RPC_CONNECT_RPC_RESPONSE_METADATA_LAMBDA.call('some-cool-key') #=> 'rpc.connect_rpc.response.metadata.some-cool-key'
50
50
  #
51
- # Deprecated, use `rpc.response.metadata` instead.
51
+ # Deprecated, use `rpc.response.header` and `rpc.response.trailer`.
52
52
  #
53
53
  # @note Stability Level: development
54
- # @deprecated Replaced by `rpc.response.metadata`.
54
+ # @deprecated Split to `rpc.response.header` for metadata sent before the response payload and `rpc.response.trailer` for metadata sent after it.
55
55
  RPC_CONNECT_RPC_RESPONSE_METADATA_LAMBDA = ->(key) { "rpc.connect_rpc.response.metadata.#{key}" }
56
56
 
57
57
  # Must be called with a key for the full attribute name. See notes below about the expectations
@@ -60,10 +60,10 @@ module OpenTelemetry
60
60
  # @example Usage
61
61
  # RPC_GRPC_REQUEST_METADATA_LAMBDA.call('some-cool-key') #=> 'rpc.grpc.request.metadata.some-cool-key'
62
62
  #
63
- # Deprecated, use `rpc.request.metadata` instead.
63
+ # Deprecated, use `rpc.request.header` instead.
64
64
  #
65
65
  # @note Stability Level: development
66
- # @deprecated Replaced by `rpc.request.metadata`.
66
+ # @deprecated Replaced by `rpc.request.header`.
67
67
  RPC_GRPC_REQUEST_METADATA_LAMBDA = ->(key) { "rpc.grpc.request.metadata.#{key}" }
68
68
 
69
69
  # Must be called with a key for the full attribute name. See notes below about the expectations
@@ -72,22 +72,22 @@ module OpenTelemetry
72
72
  # @example Usage
73
73
  # RPC_GRPC_RESPONSE_METADATA_LAMBDA.call('some-cool-key') #=> 'rpc.grpc.response.metadata.some-cool-key'
74
74
  #
75
- # Deprecated, use `rpc.response.metadata` instead.
75
+ # Deprecated, use `rpc.response.header` and `rpc.response.trailer`.
76
76
  #
77
77
  # @note Stability Level: development
78
- # @deprecated Replaced by `rpc.response.metadata`.
78
+ # @deprecated Split to `rpc.response.header` for metadata sent before the response payload and `rpc.response.trailer` for metadata sent after it.
79
79
  RPC_GRPC_RESPONSE_METADATA_LAMBDA = ->(key) { "rpc.grpc.response.metadata.#{key}" }
80
80
 
81
- # Deprecated, use string representation on the `rpc.response.status_code` attribute instead.
81
+ # Deprecated, use string representation on the `rpc.status_code` attribute instead.
82
82
  #
83
83
  # @note Stability Level: development
84
- # @deprecated Use string representation of the gRPC status code on the `rpc.response.status_code` attribute.
84
+ # @deprecated Use string representation of the gRPC status code on the `rpc.status_code` attribute.
85
85
  RPC_GRPC_STATUS_CODE = 'rpc.grpc.status_code'
86
86
 
87
- # Deprecated, use string representation on the `rpc.response.status_code` attribute instead.
87
+ # Deprecated, use string representation on the `rpc.status_code` attribute instead.
88
88
  #
89
89
  # @note Stability Level: development
90
- # @deprecated Use string representation of the error code on the `rpc.response.status_code` attribute.
90
+ # @deprecated Use string representation of the error code on the `rpc.status_code` attribute.
91
91
  RPC_JSONRPC_ERROR_CODE = 'rpc.jsonrpc.error_code'
92
92
 
93
93
  # Deprecated, use the span status description when reporting JSON-RPC spans.
@@ -146,9 +146,7 @@ module OpenTelemetry
146
146
  # When the method is not recognized, for example, when the server receives
147
147
  # a request for a method that is not predefined on the server, or when
148
148
  # instrumentation is not able to reliably detect if the method is predefined,
149
- # the attribute MUST be set to `_OTHER`. In such cases, tracing
150
- # instrumentations MUST also set `rpc.method_original` attribute to
151
- # the original method value.
149
+ # the attribute MUST be set to `_OTHER`.
152
150
  #
153
151
  # If the RPC instrumentation could end up converting valid RPC methods to
154
152
  # `_OTHER`, then it SHOULD provide a way to configure the list of recognized
@@ -160,62 +158,137 @@ module OpenTelemetry
160
158
  # method actually executing the call on the server side, or the
161
159
  # RPC client stub method on the client side.
162
160
  #
163
- # @note Stability Level: release_candidate
161
+ # @note Stability Level: stable
162
+ #
163
+ # @deprecated Now available in the stable namespace at {OpenTelemetry::SemConv::RPC::RPC_METHOD}.
164
164
  RPC_METHOD = 'rpc.method'
165
165
 
166
166
  # The original name of the method used by the client.
167
167
  #
168
- # @note Stability Level: release_candidate
168
+ # @note Stability Level: stable
169
+ #
170
+ # @deprecated Now available in the stable namespace at {OpenTelemetry::SemConv::RPC::RPC_METHOD_ORIGINAL}.
169
171
  RPC_METHOD_ORIGINAL = 'rpc.method_original'
170
172
 
171
173
  # Must be called with a key for the full attribute name. See notes below about the expectations
172
174
  # for the state of the key.
173
175
  #
174
176
  # @example Usage
175
- # RPC_REQUEST_METADATA_LAMBDA.call('some-cool-key') #=> 'rpc.request.metadata.some-cool-key'
177
+ # RPC_REQUEST_HEADER_LAMBDA.call('some-cool-key') #=> 'rpc.request.header.some-cool-key'
178
+ #
179
+ # RPC request headers or metadata, `<key>` being the normalized header name (lowercase), the value being the header values.
180
+ #
181
+ # Instrumentations SHOULD require an explicit configuration of which headers are to be captured.
182
+ # Including all request headers can be a security risk - explicit configuration helps avoid leaking sensitive information.
176
183
  #
177
- # RPC request metadata, `<key>` being the normalized RPC metadata key (lowercase), the value being the metadata values.
184
+ # For example, a header `my-custom-key` with value `["1.2.3.4", "1.2.3.5"]` SHOULD be recorded as
185
+ # the `rpc.request.header.my-custom-key` attribute with value `["1.2.3.4", "1.2.3.5"]`
186
+ #
187
+ # The attribute value MUST consist of either multiple header values as an array of
188
+ # strings or a single-item array containing a possibly comma-concatenated string,
189
+ # depending on the way the RPC library provides access to headers.
190
+ #
191
+ # Values that the RPC system exposes as binary data, or that are otherwise not valid
192
+ # UTF-8 strings, SHOULD be base64-encoded when recorded.
193
+ #
194
+ # @note Stability Level: release_candidate
195
+ RPC_REQUEST_HEADER_LAMBDA = ->(key) { "rpc.request.header.#{key}" }
196
+
197
+ # Must be called with a key for the full attribute name. See notes below about the expectations
198
+ # for the state of the key.
178
199
  #
179
- # Instrumentations SHOULD require an explicit configuration of which metadata values are to be captured.
180
- # Including all request metadata values can be a security risk - explicit configuration helps avoid leaking sensitive information.
200
+ # @example Usage
201
+ # RPC_REQUEST_METADATA_LAMBDA.call('some-cool-key') #=> 'rpc.request.metadata.some-cool-key'
181
202
  #
182
- # For example, a property `my-custom-key` with value `["1.2.3.4", "1.2.3.5"]` SHOULD be recorded as
183
- # `rpc.request.metadata.my-custom-key` attribute with value `["1.2.3.4", "1.2.3.5"]`
203
+ # Deprecated, use `rpc.request.header` instead.
184
204
  #
185
205
  # @note Stability Level: development
206
+ # @deprecated Replaced by `rpc.request.header`.
186
207
  RPC_REQUEST_METADATA_LAMBDA = ->(key) { "rpc.request.metadata.#{key}" }
187
208
 
188
209
  # Must be called with a key for the full attribute name. See notes below about the expectations
189
210
  # for the state of the key.
190
211
  #
191
212
  # @example Usage
192
- # RPC_RESPONSE_METADATA_LAMBDA.call('some-cool-key') #=> 'rpc.response.metadata.some-cool-key'
213
+ # RPC_RESPONSE_HEADER_LAMBDA.call('some-cool-key') #=> 'rpc.response.header.some-cool-key'
193
214
  #
194
- # RPC response metadata, `<key>` being the normalized RPC metadata key (lowercase), the value being the metadata values.
215
+ # RPC response headers or metadata sent before the response payload, `<key>` being the normalized header name (lowercase), the value being the header values.
195
216
  #
196
- # Instrumentations SHOULD require an explicit configuration of which metadata values are to be captured.
197
- # Including all response metadata values can be a security risk - explicit configuration helps avoid leaking sensitive information.
217
+ # Instrumentations SHOULD require an explicit configuration of which headers are to be captured.
218
+ # Including all response headers can be a security risk - explicit configuration helps avoid leaking sensitive information.
198
219
  #
199
- # For example, a property `my-custom-key` with value `["attribute_value"]` SHOULD be recorded as
200
- # the `rpc.response.metadata.my-custom-key` attribute with value `["attribute_value"]`
220
+ # For example, a header `my-custom-key` with value `["attribute_value"]` SHOULD be recorded as
221
+ # the `rpc.response.header.my-custom-key` attribute with value `["attribute_value"]`
222
+ #
223
+ # The attribute value MUST consist of either multiple header values as an array of
224
+ # strings or a single-item array containing a possibly comma-concatenated string,
225
+ # depending on the way the RPC library provides access to headers.
226
+ #
227
+ # Values that the RPC system exposes as binary data, or that are otherwise not valid
228
+ # UTF-8 strings, SHOULD be base64-encoded when recorded.
229
+ #
230
+ # @note Stability Level: release_candidate
231
+ RPC_RESPONSE_HEADER_LAMBDA = ->(key) { "rpc.response.header.#{key}" }
232
+
233
+ # Must be called with a key for the full attribute name. See notes below about the expectations
234
+ # for the state of the key.
235
+ #
236
+ # @example Usage
237
+ # RPC_RESPONSE_METADATA_LAMBDA.call('some-cool-key') #=> 'rpc.response.metadata.some-cool-key'
238
+ #
239
+ # Deprecated, use `rpc.response.header` and `rpc.response.trailer`.
201
240
  #
202
241
  # @note Stability Level: development
242
+ # @deprecated Split to `rpc.response.header` for metadata sent before the response payload and `rpc.response.trailer` for metadata sent after it.
203
243
  RPC_RESPONSE_METADATA_LAMBDA = ->(key) { "rpc.response.metadata.#{key}" }
204
244
 
205
- # Status code of the RPC returned by the RPC server or generated by the client
206
- #
207
- # Usually it represents an error code, but may also represent partial success, warning, or differentiate between various types of successful outcomes.
208
- # Semantic conventions for individual RPC frameworks SHOULD document what `rpc.response.status_code` means in the context of that system and which values are considered to represent errors.
245
+ # Deprecated, use `rpc.status_code` instead.
209
246
  #
210
247
  # @note Stability Level: release_candidate
248
+ # @deprecated Replaced by `rpc.status_code`.
211
249
  RPC_RESPONSE_STATUS_CODE = 'rpc.response.status_code'
212
250
 
251
+ # Must be called with a key for the full attribute name. See notes below about the expectations
252
+ # for the state of the key.
253
+ #
254
+ # @example Usage
255
+ # RPC_RESPONSE_TRAILER_LAMBDA.call('some-cool-key') #=> 'rpc.response.trailer.some-cool-key'
256
+ #
257
+ # RPC response trailers or metadata sent after the response payload, `<key>` being the normalized trailer name (lowercase), the value being the trailer values.
258
+ #
259
+ # Instrumentations SHOULD require an explicit configuration of which trailers are to be captured.
260
+ # Including all response trailers can be a security risk - explicit configuration helps avoid leaking sensitive information.
261
+ #
262
+ # For example, a trailer `my-custom-key` with value `["attribute_value"]` SHOULD be recorded as
263
+ # the `rpc.response.trailer.my-custom-key` attribute with value `["attribute_value"]`
264
+ #
265
+ # The attribute value MUST consist of either multiple trailer values as an array of
266
+ # strings or a single-item array containing a possibly comma-concatenated string,
267
+ # depending on the way the RPC library provides access to trailers.
268
+ #
269
+ # Values that the RPC system exposes as binary data, or that are otherwise not valid
270
+ # UTF-8 strings, SHOULD be base64-encoded when recorded.
271
+ #
272
+ # @note Stability Level: release_candidate
273
+ RPC_RESPONSE_TRAILER_LAMBDA = ->(key) { "rpc.response.trailer.#{key}" }
274
+
213
275
  # Deprecated, use fully-qualified `rpc.method` instead.
214
276
  #
215
277
  # @note Stability Level: development
216
278
  # @deprecated Value should be included in `rpc.method` which is expected to be a fully-qualified name.
217
279
  RPC_SERVICE = 'rpc.service'
218
280
 
281
+ # Status code of the RPC returned by the RPC server or generated by the client
282
+ #
283
+ # Usually it represents an error code, but may also represent partial success, warning, or differentiate between various types of successful outcomes.
284
+ # 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.
285
+ # Semantic conventions for individual RPC frameworks SHOULD document what `rpc.status_code` means in the context of that system and which values are considered to represent errors.
286
+ #
287
+ # @note Stability Level: stable
288
+ #
289
+ # @deprecated Now available in the stable namespace at {OpenTelemetry::SemConv::RPC::RPC_STATUS_CODE}.
290
+ RPC_STATUS_CODE = 'rpc.status_code'
291
+
219
292
  # Deprecated, use `rpc.system.name` attribute instead.
220
293
  #
221
294
  # @note Stability Level: development
@@ -226,7 +299,9 @@ module OpenTelemetry
226
299
  #
227
300
  # The client and server RPC systems may differ for the same RPC interaction. For example, a client may use Apache Dubbo or Connect RPC to communicate with a server that uses gRPC since both protocols provide compatibility with gRPC.
228
301
  #
229
- # @note Stability Level: release_candidate
302
+ # @note Stability Level: stable
303
+ #
304
+ # @deprecated Now available in the stable namespace at {OpenTelemetry::SemConv::RPC::RPC_SYSTEM_NAME}.
230
305
  RPC_SYSTEM_NAME = 'rpc.system.name'
231
306
 
232
307
  # @!endgroup
@@ -29,7 +29,9 @@ module OpenTelemetry
29
29
  # When this metric is reported alongside an RPC client span, the metric value
30
30
  # SHOULD be the same as the RPC client span duration.
31
31
  #
32
- # @note Stability Level: release_candidate
32
+ # @note Stability Level: stable
33
+ #
34
+ # @deprecated Now available in the stable namespace at {OpenTelemetry::SemConv::RPC::RPC_CLIENT_CALL_DURATION}.
33
35
  RPC_CLIENT_CALL_DURATION = 'rpc.client.call.duration'
34
36
 
35
37
  # Deprecated, use `rpc.client.call.duration` instead. Note: the unit also changed from `ms` to `s`.
@@ -84,7 +86,9 @@ module OpenTelemetry
84
86
  # When this metric is reported alongside an RPC server span, the metric value
85
87
  # SHOULD be the same as the RPC server span duration.
86
88
  #
87
- # @note Stability Level: release_candidate
89
+ # @note Stability Level: stable
90
+ #
91
+ # @deprecated Now available in the stable namespace at {OpenTelemetry::SemConv::RPC::RPC_SERVER_CALL_DURATION}.
88
92
  RPC_SERVER_CALL_DURATION = 'rpc.server.call.duration'
89
93
 
90
94
  # Deprecated, use `rpc.server.call.duration` instead. Note: the unit also changed from `ms` to `s`.
@@ -24,7 +24,7 @@ module OpenTelemetry
24
24
  module SERVER
25
25
  # @!group Attribute Names
26
26
 
27
- # Server domain name if available without reverse DNS lookup; otherwise, IP address or Unix domain socket name.
27
+ # Server domain name if available without reverse DNS lookup; otherwise, IP address or UNIX domain socket name.
28
28
  #
29
29
  # When observed from the client side, and when communicating through an intermediary, `server.address` SHOULD represent the server address behind any intermediaries, for example proxies, if it's available.
30
30
  #
@@ -33,6 +33,35 @@ module OpenTelemetry
33
33
  # @deprecated Now available in the stable namespace at {OpenTelemetry::SemConv::SERVER::SERVER_ADDRESS}.
34
34
  SERVER_ADDRESS = 'server.address'
35
35
 
36
+ # The [Autonomous System Number (ASN)](https://www.iana.org/assignments/as-numbers/as-numbers.xhtml) associated with the server IP address.
37
+ #
38
+ # This attribute SHOULD only be set when the server 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
+ SERVER_AS_NUMBER = 'server.as.number'
42
+
43
+ # The name of the organization associated with the autonomous system of the server IP address.
44
+ #
45
+ # This attribute SHOULD only be set when `server.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
+ SERVER_AS_ORGANIZATION = 'server.as.organization'
49
+
50
+ # Server Media Access Control (MAC) address.
51
+ #
52
+ # This attribute MUST identify a MAC address associated with the logical server
53
+ # endpoint, including when that endpoint is behind intermediaries. If the server'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
+ SERVER_MAC_ADDRESS = 'server.mac.address'
64
+
36
65
  # Server port number.
37
66
  #
38
67
  # When observed from the client side, and when communicating through an intermediary, `server.port` SHOULD represent the server port behind any intermediaries, for example proxies, if it's available.
@@ -42,6 +71,47 @@ module OpenTelemetry
42
71
  # @deprecated Now available in the stable namespace at {OpenTelemetry::SemConv::SERVER::SERVER_PORT}.
43
72
  SERVER_PORT = 'server.port'
44
73
 
74
+ # The IP prefix associated with the server 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 `server.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
+ SERVER_PREFIX = 'server.prefix'
100
+
101
+ # Logical name of the service acting as the server 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 server, if any. This identifies the server service whether the telemetry is recorded by the client, the server, or another observer.
104
+ #
105
+ # @note Stability Level: development
106
+ SERVER_SERVICE_NAME = 'server.service.name'
107
+
108
+ # Logical namespace of the service acting as the server 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 server, if any. This identifies the server service's namespace whether the telemetry is recorded by the client, the server, or another observer. Together with `server.service.name`, this identifies the server service. An empty namespace is equivalent to an unspecified namespace.
111
+ #
112
+ # @note Stability Level: development
113
+ SERVER_SERVICE_NAMESPACE = 'server.service.namespace'
114
+
45
115
  # @!endgroup
46
116
  end
47
117
  end
@@ -31,6 +31,20 @@ module OpenTelemetry
31
31
  # @note Stability Level: alpha
32
32
  SERVICE_CRITICALITY = 'service.criticality'
33
33
 
34
+ # Identifier of the cost center associated with the service instance.
35
+ #
36
+ # The cost center identifier enables tracking and attribution of service resource costs to organizational units, billing accounts, or teams. It is typically a string identifier such as a billing account ID, cost allocation code, or internal accounting ID.
37
+ #
38
+ # @note Stability Level: development
39
+ SERVICE_INSTANCE_COST_CENTER_ID = 'service.instance.cost_center.id'
40
+
41
+ # Name of the cost center associated with the service instance.
42
+ #
43
+ # A human-readable name of the cost center, department, or organizational unit responsible for the service instance costs.
44
+ #
45
+ # @note Stability Level: development
46
+ SERVICE_INSTANCE_COST_CENTER_NAME = 'service.instance.cost_center.name'
47
+
34
48
  # The string ID of the service instance.
35
49
  #
36
50
  # MUST be unique for each instance of the same `service.namespace,service.name` pair (in other words
@@ -87,11 +101,13 @@ module OpenTelemetry
87
101
  # Logical name of the service on the other side of the connection. SHOULD be equal to the actual [`service.name`](/docs/resource/README.md#service) resource attribute of the remote service if any.
88
102
  #
89
103
  # @note Stability Level: development
104
+ # @deprecated Use `server.service.name` on the client side or `client.service.name` on the server side.
90
105
  SERVICE_PEER_NAME = 'service.peer.name'
91
106
 
92
107
  # Logical namespace of the service on the other side of the connection. SHOULD be equal to the actual [`service.namespace`](/docs/resource/README.md#service) resource attribute of the remote service if any.
93
108
  #
94
109
  # @note Stability Level: development
110
+ # @deprecated Use `server.service.namespace` on the client side or `client.service.namespace` on the server side.
95
111
  SERVICE_PEER_NAMESPACE = 'service.peer.namespace'
96
112
 
97
113
  # The version string of the service component. The format is not defined by these conventions.
@@ -24,7 +24,7 @@ module OpenTelemetry
24
24
  module SESSION
25
25
  # @!group Attribute Names
26
26
 
27
- # A unique id to identify a session.
27
+ # A unique ID to identify a session.
28
28
  #
29
29
  # @note Stability Level: development
30
30
  SESSION_ID = 'session.id'