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.
- checksums.yaml +4 -4
- data/CHANGELOG.md +4 -0
- data/lib/opentelemetry/semantic_conventions/version.rb +2 -2
- data/lib/opentelemetry/semconv/client/attributes.rb +2 -2
- data/lib/opentelemetry/semconv/db/attributes.rb +16 -11
- data/lib/opentelemetry/semconv/incubating/aws/attributes.rb +1 -1
- data/lib/opentelemetry/semconv/incubating/azure/attributes.rb +20 -0
- data/lib/opentelemetry/semconv/incubating/client/attributes.rb +72 -2
- data/lib/opentelemetry/semconv/incubating/container/metrics.rb +20 -25
- data/lib/opentelemetry/semconv/incubating/cpu/attributes.rb +4 -2
- data/lib/opentelemetry/semconv/incubating/db/attributes.rb +17 -12
- data/lib/opentelemetry/semconv/incubating/db/metrics.rb +8 -2
- data/lib/opentelemetry/semconv/incubating/destination/attributes.rb +53 -2
- data/lib/opentelemetry/semconv/incubating/enduser/attributes.rb +2 -0
- data/lib/opentelemetry/semconv/incubating/faas/attributes.rb +7 -3
- data/lib/opentelemetry/semconv/incubating/gcp/attributes.rb +20 -0
- data/lib/opentelemetry/semconv/incubating/host/attributes.rb +60 -1
- data/lib/opentelemetry/semconv/incubating/http/attributes.rb +59 -0
- data/lib/opentelemetry/semconv/incubating/jvm/attributes.rb +24 -0
- data/lib/opentelemetry/semconv/incubating/jvm/metrics.rb +45 -2
- data/lib/opentelemetry/semconv/incubating/k8s/metrics.rb +268 -66
- data/lib/opentelemetry/semconv/incubating/kafka/attributes.rb +55 -0
- data/lib/opentelemetry/semconv/incubating/kafka.rb +21 -0
- data/lib/opentelemetry/semconv/incubating/log/attributes.rb +5 -5
- data/lib/opentelemetry/semconv/incubating/messaging/attributes.rb +68 -26
- data/lib/opentelemetry/semconv/incubating/network/attributes.rb +103 -1
- data/lib/opentelemetry/semconv/incubating/opentracing/attributes.rb +1 -0
- data/lib/opentelemetry/semconv/incubating/otel/metrics.rb +7 -1
- data/lib/opentelemetry/semconv/incubating/peer/attributes.rb +1 -1
- data/lib/opentelemetry/semconv/incubating/rabbitmq/attributes.rb +41 -0
- data/lib/opentelemetry/semconv/incubating/rabbitmq.rb +21 -0
- data/lib/opentelemetry/semconv/incubating/rocketmq/attributes.rb +71 -0
- data/lib/opentelemetry/semconv/incubating/rocketmq.rb +21 -0
- data/lib/opentelemetry/semconv/incubating/rpc/attributes.rb +110 -33
- data/lib/opentelemetry/semconv/incubating/rpc/metrics.rb +6 -2
- data/lib/opentelemetry/semconv/incubating/server/attributes.rb +70 -0
- data/lib/opentelemetry/semconv/incubating/service/attributes.rb +16 -0
- data/lib/opentelemetry/semconv/incubating/source/attributes.rb +53 -2
- data/lib/opentelemetry/semconv/incubating/system/attributes.rb +15 -9
- data/lib/opentelemetry/semconv/incubating/system/metrics.rb +7 -3
- data/lib/opentelemetry/semconv/incubating/url/attributes.rb +12 -0
- data/lib/opentelemetry/semconv/incubating/v8js/attributes.rb +2 -1
- data/lib/opentelemetry/semconv/incubating/zos/attributes.rb +4 -2
- data/lib/opentelemetry/semconv/rpc/attributes.rb +77 -0
- data/lib/opentelemetry/semconv/rpc/metrics.rb +45 -0
- data/lib/opentelemetry/semconv/rpc.rb +22 -0
- data/lib/opentelemetry/semconv/url/attributes.rb +12 -0
- data/lib/opentelemetry/semconv.rb +4 -0
- metadata +14 -5
|
@@ -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.
|
|
27
|
+
# Deprecated, use `rpc.status_code` attribute instead.
|
|
28
28
|
#
|
|
29
29
|
# @note Stability Level: development
|
|
30
|
-
# @deprecated Replaced by `rpc.
|
|
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.
|
|
39
|
+
# Deprecated, use `rpc.request.header` instead.
|
|
40
40
|
#
|
|
41
41
|
# @note Stability Level: development
|
|
42
|
-
# @deprecated Replaced by `rpc.request.
|
|
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.
|
|
51
|
+
# Deprecated, use `rpc.response.header` and `rpc.response.trailer`.
|
|
52
52
|
#
|
|
53
53
|
# @note Stability Level: development
|
|
54
|
-
# @deprecated
|
|
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.
|
|
63
|
+
# Deprecated, use `rpc.request.header` instead.
|
|
64
64
|
#
|
|
65
65
|
# @note Stability Level: development
|
|
66
|
-
# @deprecated Replaced by `rpc.request.
|
|
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.
|
|
75
|
+
# Deprecated, use `rpc.response.header` and `rpc.response.trailer`.
|
|
76
76
|
#
|
|
77
77
|
# @note Stability Level: development
|
|
78
|
-
# @deprecated
|
|
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.
|
|
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.
|
|
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.
|
|
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.
|
|
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.
|
|
@@ -158,62 +158,137 @@ module OpenTelemetry
|
|
|
158
158
|
# method actually executing the call on the server side, or the
|
|
159
159
|
# RPC client stub method on the client side.
|
|
160
160
|
#
|
|
161
|
-
# @note Stability Level:
|
|
161
|
+
# @note Stability Level: stable
|
|
162
|
+
#
|
|
163
|
+
# @deprecated Now available in the stable namespace at {OpenTelemetry::SemConv::RPC::RPC_METHOD}.
|
|
162
164
|
RPC_METHOD = 'rpc.method'
|
|
163
165
|
|
|
164
166
|
# The original name of the method used by the client.
|
|
165
167
|
#
|
|
166
|
-
# @note Stability Level:
|
|
168
|
+
# @note Stability Level: stable
|
|
169
|
+
#
|
|
170
|
+
# @deprecated Now available in the stable namespace at {OpenTelemetry::SemConv::RPC::RPC_METHOD_ORIGINAL}.
|
|
167
171
|
RPC_METHOD_ORIGINAL = 'rpc.method_original'
|
|
168
172
|
|
|
169
173
|
# Must be called with a key for the full attribute name. See notes below about the expectations
|
|
170
174
|
# for the state of the key.
|
|
171
175
|
#
|
|
172
176
|
# @example Usage
|
|
173
|
-
#
|
|
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.
|
|
174
183
|
#
|
|
175
|
-
#
|
|
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.
|
|
176
199
|
#
|
|
177
|
-
#
|
|
178
|
-
#
|
|
200
|
+
# @example Usage
|
|
201
|
+
# RPC_REQUEST_METADATA_LAMBDA.call('some-cool-key') #=> 'rpc.request.metadata.some-cool-key'
|
|
179
202
|
#
|
|
180
|
-
#
|
|
181
|
-
# `rpc.request.metadata.my-custom-key` attribute with value `["1.2.3.4", "1.2.3.5"]`
|
|
203
|
+
# Deprecated, use `rpc.request.header` instead.
|
|
182
204
|
#
|
|
183
205
|
# @note Stability Level: development
|
|
206
|
+
# @deprecated Replaced by `rpc.request.header`.
|
|
184
207
|
RPC_REQUEST_METADATA_LAMBDA = ->(key) { "rpc.request.metadata.#{key}" }
|
|
185
208
|
|
|
186
209
|
# Must be called with a key for the full attribute name. See notes below about the expectations
|
|
187
210
|
# for the state of the key.
|
|
188
211
|
#
|
|
189
212
|
# @example Usage
|
|
190
|
-
#
|
|
213
|
+
# RPC_RESPONSE_HEADER_LAMBDA.call('some-cool-key') #=> 'rpc.response.header.some-cool-key'
|
|
191
214
|
#
|
|
192
|
-
# RPC response metadata, `<key>` being the normalized
|
|
215
|
+
# RPC response headers or metadata sent before the response payload, `<key>` being the normalized header name (lowercase), the value being the header values.
|
|
193
216
|
#
|
|
194
|
-
# Instrumentations SHOULD require an explicit configuration of which
|
|
195
|
-
# Including all response
|
|
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.
|
|
196
219
|
#
|
|
197
|
-
# For example, a
|
|
198
|
-
# the `rpc.response.
|
|
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`.
|
|
199
240
|
#
|
|
200
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.
|
|
201
243
|
RPC_RESPONSE_METADATA_LAMBDA = ->(key) { "rpc.response.metadata.#{key}" }
|
|
202
244
|
|
|
203
|
-
#
|
|
204
|
-
#
|
|
205
|
-
# Usually it represents an error code, but may also represent partial success, warning, or differentiate between various types of successful outcomes.
|
|
206
|
-
# 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.
|
|
207
246
|
#
|
|
208
247
|
# @note Stability Level: release_candidate
|
|
248
|
+
# @deprecated Replaced by `rpc.status_code`.
|
|
209
249
|
RPC_RESPONSE_STATUS_CODE = 'rpc.response.status_code'
|
|
210
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
|
+
|
|
211
275
|
# Deprecated, use fully-qualified `rpc.method` instead.
|
|
212
276
|
#
|
|
213
277
|
# @note Stability Level: development
|
|
214
278
|
# @deprecated Value should be included in `rpc.method` which is expected to be a fully-qualified name.
|
|
215
279
|
RPC_SERVICE = 'rpc.service'
|
|
216
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
|
+
|
|
217
292
|
# Deprecated, use `rpc.system.name` attribute instead.
|
|
218
293
|
#
|
|
219
294
|
# @note Stability Level: development
|
|
@@ -224,7 +299,9 @@ module OpenTelemetry
|
|
|
224
299
|
#
|
|
225
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.
|
|
226
301
|
#
|
|
227
|
-
# @note Stability Level:
|
|
302
|
+
# @note Stability Level: stable
|
|
303
|
+
#
|
|
304
|
+
# @deprecated Now available in the stable namespace at {OpenTelemetry::SemConv::RPC::RPC_SYSTEM_NAME}.
|
|
228
305
|
RPC_SYSTEM_NAME = 'rpc.system.name'
|
|
229
306
|
|
|
230
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:
|
|
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:
|
|
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`.
|
|
@@ -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,18 +24,69 @@ module OpenTelemetry
|
|
|
24
24
|
module SOURCE
|
|
25
25
|
# @!group Attribute Names
|
|
26
26
|
|
|
27
|
-
# Source address
|
|
27
|
+
# Source address as observed at the point of instrumentation - typically an IP address, or a UNIX domain socket name; a domain name only when the sender was addressed by name (for example a peer-to-peer node dialed by hostname), never obtained via reverse DNS lookup.
|
|
28
28
|
#
|
|
29
|
-
#
|
|
29
|
+
# `source.address` SHOULD be the sender address as observed at the point of instrumentation, for example the source 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
|
SOURCE_ADDRESS = 'source.address'
|
|
33
33
|
|
|
34
|
+
# The [Autonomous System Number (ASN)](https://www.iana.org/assignments/as-numbers/as-numbers.xhtml) associated with the source IP address.
|
|
35
|
+
#
|
|
36
|
+
# This attribute SHOULD only be set when the source 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
|
+
SOURCE_AS_NUMBER = 'source.as.number'
|
|
40
|
+
|
|
41
|
+
# The name of the organization associated with the autonomous system of the source IP address.
|
|
42
|
+
#
|
|
43
|
+
# This attribute SHOULD only be set when `source.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
|
+
SOURCE_AS_ORGANIZATION = 'source.as.organization'
|
|
47
|
+
|
|
48
|
+
# Source 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
|
+
SOURCE_MAC_ADDRESS = 'source.mac.address'
|
|
57
|
+
|
|
34
58
|
# Source port number
|
|
35
59
|
#
|
|
36
60
|
# @note Stability Level: development
|
|
37
61
|
SOURCE_PORT = 'source.port'
|
|
38
62
|
|
|
63
|
+
# The IP prefix associated with the source 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 `source.address` is set. If
|
|
84
|
+
# `source.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
|
+
SOURCE_PREFIX = 'source.prefix'
|
|
89
|
+
|
|
39
90
|
# @!endgroup
|
|
40
91
|
end
|
|
41
92
|
end
|
|
@@ -36,39 +36,45 @@ module OpenTelemetry
|
|
|
36
36
|
# @deprecated Replaced by `cpu.mode`.
|
|
37
37
|
SYSTEM_CPU_STATE = 'system.cpu.state'
|
|
38
38
|
|
|
39
|
-
#
|
|
39
|
+
# Deprecated, use `system.device.name` instead.
|
|
40
40
|
#
|
|
41
41
|
# @note Stability Level: development
|
|
42
|
+
# @deprecated Replaced by `system.device.name`.
|
|
42
43
|
SYSTEM_DEVICE = 'system.device'
|
|
43
44
|
|
|
45
|
+
# The OS level identifier for a device, such as disk, partition or network interface.
|
|
46
|
+
#
|
|
47
|
+
# @note Stability Level: release_candidate
|
|
48
|
+
SYSTEM_DEVICE_NAME = 'system.device.name'
|
|
49
|
+
|
|
44
50
|
# The filesystem mode
|
|
45
51
|
#
|
|
46
|
-
# @note Stability Level:
|
|
52
|
+
# @note Stability Level: release_candidate
|
|
47
53
|
SYSTEM_FILESYSTEM_MODE = 'system.filesystem.mode'
|
|
48
54
|
|
|
49
55
|
# The filesystem mount path
|
|
50
56
|
#
|
|
51
|
-
# @note Stability Level:
|
|
57
|
+
# @note Stability Level: release_candidate
|
|
52
58
|
SYSTEM_FILESYSTEM_MOUNTPOINT = 'system.filesystem.mountpoint'
|
|
53
59
|
|
|
54
60
|
# The filesystem state
|
|
55
61
|
#
|
|
56
|
-
# @note Stability Level:
|
|
62
|
+
# @note Stability Level: release_candidate
|
|
57
63
|
SYSTEM_FILESYSTEM_STATE = 'system.filesystem.state'
|
|
58
64
|
|
|
59
65
|
# The filesystem type
|
|
60
66
|
#
|
|
61
|
-
# @note Stability Level:
|
|
67
|
+
# @note Stability Level: release_candidate
|
|
62
68
|
SYSTEM_FILESYSTEM_TYPE = 'system.filesystem.type'
|
|
63
69
|
|
|
64
70
|
# The Linux HugePages memory state
|
|
65
71
|
#
|
|
66
|
-
# @note Stability Level:
|
|
72
|
+
# @note Stability Level: release_candidate
|
|
67
73
|
SYSTEM_MEMORY_LINUX_HUGEPAGES_STATE = 'system.memory.linux.hugepages.state'
|
|
68
74
|
|
|
69
75
|
# The Linux Slab memory state
|
|
70
76
|
#
|
|
71
|
-
# @note Stability Level:
|
|
77
|
+
# @note Stability Level: release_candidate
|
|
72
78
|
SYSTEM_MEMORY_LINUX_SLAB_STATE = 'system.memory.linux.slab.state'
|
|
73
79
|
|
|
74
80
|
# The memory state
|
|
@@ -84,7 +90,7 @@ module OpenTelemetry
|
|
|
84
90
|
|
|
85
91
|
# The paging access direction
|
|
86
92
|
#
|
|
87
|
-
# @note Stability Level:
|
|
93
|
+
# @note Stability Level: release_candidate
|
|
88
94
|
SYSTEM_PAGING_DIRECTION = 'system.paging.direction'
|
|
89
95
|
|
|
90
96
|
# The paging fault type
|
|
@@ -94,7 +100,7 @@ module OpenTelemetry
|
|
|
94
100
|
|
|
95
101
|
# The memory paging state
|
|
96
102
|
#
|
|
97
|
-
# @note Stability Level:
|
|
103
|
+
# @note Stability Level: release_candidate
|
|
98
104
|
SYSTEM_PAGING_STATE = 'system.paging.state'
|
|
99
105
|
|
|
100
106
|
# Deprecated, use `system.paging.fault.type` instead.
|
|
@@ -137,7 +137,7 @@ module OpenTelemetry
|
|
|
137
137
|
|
|
138
138
|
# An estimate of how much memory is available for starting new applications, without causing swapping.
|
|
139
139
|
#
|
|
140
|
-
# This is
|
|
140
|
+
# This is equivalent to the `system.memory.usage` metric with `state=available`.
|
|
141
141
|
# Linux starting from 3.14 exports "available" memory. It takes "free" memory as a baseline, and then factors in kernel-specific values.
|
|
142
142
|
# This is supposed to be more accurate than just "free" memory.
|
|
143
143
|
# For reference, see the calculations [here](https://superuser.com/a/980821).
|
|
@@ -207,12 +207,16 @@ module OpenTelemetry
|
|
|
207
207
|
# @deprecated Replaced by `system.memory.linux.shared`.
|
|
208
208
|
SYSTEM_MEMORY_SHARED = 'system.memory.shared'
|
|
209
209
|
|
|
210
|
-
# Reports memory
|
|
210
|
+
# Reports memory by state.
|
|
211
|
+
#
|
|
212
|
+
# The sum of the `used` and `available` state values SHOULD be equal to `system.memory.limit`.
|
|
211
213
|
#
|
|
212
214
|
# @note Stability Level: development
|
|
213
215
|
SYSTEM_MEMORY_USAGE = 'system.memory.usage'
|
|
214
216
|
|
|
215
|
-
#
|
|
217
|
+
# Fraction of memory bytes by state.
|
|
218
|
+
#
|
|
219
|
+
# The sum of the `used` and `available` state values SHOULD be equal to 1.
|
|
216
220
|
#
|
|
217
221
|
# @note Stability Level: development
|
|
218
222
|
SYSTEM_MEMORY_UTILIZATION = 'system.memory.utilization'
|
|
@@ -64,9 +64,15 @@ module OpenTelemetry
|
|
|
64
64
|
# - [`X-Amz-Signature`](https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_sigv-authentication-methods.html)
|
|
65
65
|
# - [`X-Amz-Credential`](https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_sigv-authentication-methods.html)
|
|
66
66
|
# - [`X-Amz-Security-Token`](https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_sigv-authentication-methods.html)
|
|
67
|
+
# - [`AWSAccessKeyId`](https://docs.aws.amazon.com/AmazonS3/latest/developerguide/RESTAuthentication.html#RESTAuthenticationQueryStringAuth)
|
|
68
|
+
# - [`Signature`](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/private-content-creating-signed-url-canned-policy.html)
|
|
67
69
|
# - [`sig`](https://learn.microsoft.com/azure/storage/common/storage-sas-overview#sas-token)
|
|
68
70
|
# - [`X-Goog-Signature`](https://cloud.google.com/storage/docs/access-control/signed-urls)
|
|
69
71
|
#
|
|
72
|
+
# Several of these keys are used by more than one service or signing scheme. Each link
|
|
73
|
+
# points to one representative usage rather than an exhaustive list, and does not narrow
|
|
74
|
+
# the scope of the key to the linked service or signing scheme.
|
|
75
|
+
#
|
|
70
76
|
# This list is subject to change over time.
|
|
71
77
|
#
|
|
72
78
|
# Matching of query parameter keys against the sensitive list SHOULD be case-sensitive.
|
|
@@ -119,9 +125,15 @@ module OpenTelemetry
|
|
|
119
125
|
# - [`X-Amz-Signature`](https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_sigv-authentication-methods.html)
|
|
120
126
|
# - [`X-Amz-Credential`](https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_sigv-authentication-methods.html)
|
|
121
127
|
# - [`X-Amz-Security-Token`](https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_sigv-authentication-methods.html)
|
|
128
|
+
# - [`AWSAccessKeyId`](https://docs.aws.amazon.com/AmazonS3/latest/developerguide/RESTAuthentication.html#RESTAuthenticationQueryStringAuth)
|
|
129
|
+
# - [`Signature`](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/private-content-creating-signed-url-canned-policy.html)
|
|
122
130
|
# - [`sig`](https://learn.microsoft.com/azure/storage/common/storage-sas-overview#sas-token)
|
|
123
131
|
# - [`X-Goog-Signature`](https://cloud.google.com/storage/docs/access-control/signed-urls)
|
|
124
132
|
#
|
|
133
|
+
# Several of these keys are used by more than one service or signing scheme. Each link
|
|
134
|
+
# points to one representative usage rather than an exhaustive list, and does not narrow
|
|
135
|
+
# the scope of the key to the linked service or signing scheme.
|
|
136
|
+
#
|
|
125
137
|
# This list is subject to change over time.
|
|
126
138
|
#
|
|
127
139
|
# Matching of query parameter keys against the sensitive list SHOULD be case-sensitive.
|
|
@@ -31,7 +31,8 @@ module OpenTelemetry
|
|
|
31
31
|
|
|
32
32
|
# The name of the space type of heap memory.
|
|
33
33
|
#
|
|
34
|
-
# Value can be retrieved from value `space_name` of [`v8.getHeapSpaceStatistics()`](https://nodejs.org/api/v8.html#v8getheapspacestatistics)
|
|
34
|
+
# Value can be retrieved from value `space_name` of [`v8.getHeapSpaceStatistics()`](https://nodejs.org/api/v8.html#v8getheapspacestatistics).
|
|
35
|
+
# The set of reported spaces depends on the V8 version the runtime embeds.
|
|
35
36
|
#
|
|
36
37
|
# @note Stability Level: development
|
|
37
38
|
V8JS_HEAP_SPACE_NAME = 'v8js.heap.space.name'
|