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
|
@@ -61,7 +61,66 @@ module OpenTelemetry
|
|
|
61
61
|
# @note Stability Level: development
|
|
62
62
|
HOST_CPU_VENDOR_ID = 'host.cpu.vendor.id'
|
|
63
63
|
|
|
64
|
-
# Unique host ID
|
|
64
|
+
# Unique host ID, determined by the first matching source in the priority order.
|
|
65
|
+
#
|
|
66
|
+
# SHOULD be determined using the first available source from the following priority tiers:
|
|
67
|
+
#
|
|
68
|
+
# 1. Known cloud vendors - cloud instance ID
|
|
69
|
+
# 2. Known VM vendors - provider VM ID
|
|
70
|
+
# 3. OS-dependent machine ID
|
|
71
|
+
# 4. User-provided value
|
|
72
|
+
#
|
|
73
|
+
# The value SHOULD conform to the following properties:
|
|
74
|
+
#
|
|
75
|
+
# - **Unique** within a given context;
|
|
76
|
+
# - **[Repeatable](https://opentelemetry.io/docs/specs/otel/entities/data-model/#repeatable-identity)** - multiple observers on the same host come up with the same value;
|
|
77
|
+
# - **Persistent** - survives host restarts and software updates.
|
|
78
|
+
#
|
|
79
|
+
# **Collecting `host.id` From Known Environments:** When `host.id` is derived from a
|
|
80
|
+
# cloud vendor instance ID, the resource SHOULD also carry the corresponding
|
|
81
|
+
# `cloud.provider` and `cloud.platform` attributes so that the source of the `host.id`
|
|
82
|
+
# value can be unambiguously determined.
|
|
83
|
+
#
|
|
84
|
+
# The following cloud environments are currently recognized:
|
|
85
|
+
#
|
|
86
|
+
# | Environment | `host.id` source | `cloud.provider` | `cloud.platform` |
|
|
87
|
+
# | --- | --- | --- | --- |
|
|
88
|
+
# | AWS EC2 | EC2 instance ID | `aws` | `aws_ec2` |
|
|
89
|
+
# | AWS EKS (node) | EC2 instance ID | `aws` | `aws_eks` |
|
|
90
|
+
# | Azure VM | `vmId` | `azure` | `azure.vm` |
|
|
91
|
+
# | GCP Compute Engine | GCE instance ID | `gcp` | `gcp_compute_engine` |
|
|
92
|
+
# | GCP GKE (node) | GCE instance ID | `gcp` | `gcp_kubernetes_engine` |
|
|
93
|
+
#
|
|
94
|
+
# The listed `cloud.provider`/`cloud.platform` values are for example only. Refer to the
|
|
95
|
+
# [`cloud`](/docs/registry/attributes/cloud.md) attribute definitions for the relevant set of values.
|
|
96
|
+
#
|
|
97
|
+
# **Non-privileged Machine ID Lookup:** When collecting `host.id` for non-containerized
|
|
98
|
+
# systems, non-privileged lookups of the machine ID are preferred. SDK detector
|
|
99
|
+
# implementations MUST use the sources listed below to obtain the machine ID.
|
|
100
|
+
#
|
|
101
|
+
# | OS | Primary | Fallback |
|
|
102
|
+
# | --- | --- | --- |
|
|
103
|
+
# | Linux | contents of `/etc/machine-id` | contents of `/var/lib/dbus/machine-id` |
|
|
104
|
+
# | BSD | contents of `/etc/hostid` | output of `/bin/kenv -q smbios.system.uuid` |
|
|
105
|
+
# | macOS | `IOPlatformUUID` line from the output of `/usr/sbin/ioreg -rd1 -c "IOPlatformExpertDevice"` | - |
|
|
106
|
+
# | Windows | `MachineGuid` from registry `HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\Cryptography` | - |
|
|
107
|
+
#
|
|
108
|
+
# **Privileged Machine ID Lookup:** The `host.id` can be looked up using privileged
|
|
109
|
+
# sources. For example, Linux systems can use the output of `dmidecode -t system`,
|
|
110
|
+
# `dmidecode -t baseboard`,
|
|
111
|
+
# `dmidecode -t chassis`, or read the corresponding data from the filesystem
|
|
112
|
+
# (e.g. `cat /sys/devices/virtual/dmi/id/product_id`,
|
|
113
|
+
# `cat /sys/devices/virtual/dmi/id/product_uuid`, etc), however, SDK resource
|
|
114
|
+
# detector implementations MUST NOT collect `host.id` from privileged sources. If
|
|
115
|
+
# privileged lookup of `host.id` is required, the value SHOULD be injected via the
|
|
116
|
+
# `OTEL_RESOURCE_ATTRIBUTES` environment variable.
|
|
117
|
+
#
|
|
118
|
+
# **Collecting `host.id` From User Configuration:** If none of the above sources yields
|
|
119
|
+
# a non-empty value, the implementation MAY be unable to determine `host.id`
|
|
120
|
+
# automatically and SHOULD omit the attribute.
|
|
121
|
+
# In that case, the `host.id` can only be provided through user configuration
|
|
122
|
+
# or other available manual options. Users SHOULD ensure that the `host.id` value
|
|
123
|
+
# conforms to the properties stated above.
|
|
65
124
|
#
|
|
66
125
|
# @note Stability Level: development
|
|
67
126
|
HOST_ID = 'host.id'
|
|
@@ -53,6 +53,34 @@ module OpenTelemetry
|
|
|
53
53
|
# @deprecated Replaced by `http.request.method`.
|
|
54
54
|
HTTP_METHOD = 'http.method'
|
|
55
55
|
|
|
56
|
+
# The content of the HTTP request body, with any content coding indicated by [Content-Encoding](https://www.rfc-editor.org/rfc/rfc9110.html#field.content-encoding) removed, captured as a string when the request content is textual or as byte array otherwise.
|
|
57
|
+
#
|
|
58
|
+
# Captured value MAY be limited in size and thus value is expected to be truncated in many cases.
|
|
59
|
+
# When an instrumentation applies a byte-based limit while capturing the body as a string, it SHOULD truncate on a character
|
|
60
|
+
# boundary so that the recorded value remains valid text.
|
|
61
|
+
#
|
|
62
|
+
# Instrumentations MUST NOT capture this attribute by default and MAY provide an option to enable it.
|
|
63
|
+
#
|
|
64
|
+
# > [!WARNING]
|
|
65
|
+
# > This attribute may contain sensitive information.
|
|
66
|
+
#
|
|
67
|
+
# When instrumentations record body, they SHOULD capture the body as string whenever possible as it makes it easier to use in human-readable form,
|
|
68
|
+
# also it allows to implement sanitization if needed.
|
|
69
|
+
#
|
|
70
|
+
# Textual content is typically detected based on the [Content-Type](https://www.rfc-editor.org/rfc/rfc9110.html#field.content-type) header using heuristics
|
|
71
|
+
# such as checking if the type/subtype (compared case-insensitively, ignoring any parameters) starts with `text/`, ends with `/json`, `+json`, `/xml`, `+xml`, `/yaml` or `+yaml`,
|
|
72
|
+
# is `application/x-www-form-urlencoded`, or if the header declares a `charset` parameter.
|
|
73
|
+
#
|
|
74
|
+
# Instrumentations that implement request body recording MUST NOT intentionally introduce side effects such as changing stream position or closing body stream independently from the
|
|
75
|
+
# application.
|
|
76
|
+
#
|
|
77
|
+
# When body is recorded, the instrumentation SHOULD record part of the body that was sent or received at the time HTTP call has ended.
|
|
78
|
+
# The value MUST be either a string or a byte array. Instrumentations MUST NOT record a parsed or otherwise structured representation of the body,
|
|
79
|
+
# and MUST NOT base64-encode binary content into a string value.
|
|
80
|
+
#
|
|
81
|
+
# @note Stability Level: development
|
|
82
|
+
HTTP_REQUEST_BODY_CONTENT = 'http.request.body.content'
|
|
83
|
+
|
|
56
84
|
# The size of the request payload body in bytes. This is the number of bytes transferred excluding headers and is often, but not always, present as the [Content-Length](https://www.rfc-editor.org/rfc/rfc9110.html#field.content-length) header. For requests using transport encoding, this should be the compressed size.
|
|
57
85
|
#
|
|
58
86
|
# @note Stability Level: development
|
|
@@ -151,6 +179,37 @@ module OpenTelemetry
|
|
|
151
179
|
# @deprecated Replaced by `http.request.body.size`.
|
|
152
180
|
HTTP_REQUEST_CONTENT_LENGTH_UNCOMPRESSED = 'http.request_content_length_uncompressed'
|
|
153
181
|
|
|
182
|
+
# The content of the HTTP response body, with any content coding indicated by [Content-Encoding](https://www.rfc-editor.org/rfc/rfc9110.html#field.content-encoding) removed, captured as a string when the response content is textual or as byte array otherwise.
|
|
183
|
+
#
|
|
184
|
+
# Captured value MAY be limited in size and thus value is expected to be truncated in many cases.
|
|
185
|
+
# When an instrumentation applies a byte-based limit while capturing the body as a string, it SHOULD truncate on a character
|
|
186
|
+
# boundary so that the recorded value remains valid text.
|
|
187
|
+
#
|
|
188
|
+
# Instrumentations MUST NOT capture this attribute by default and MAY provide an option to enable it.
|
|
189
|
+
#
|
|
190
|
+
# > [!WARNING]
|
|
191
|
+
# > This attribute may contain sensitive information.
|
|
192
|
+
#
|
|
193
|
+
# When instrumentations record body, they SHOULD capture the body as string whenever possible as it makes it easier to use in human-readable form,
|
|
194
|
+
# also it allows to implement sanitization if needed.
|
|
195
|
+
#
|
|
196
|
+
# Textual content is typically detected based on the [Content-Type](https://www.rfc-editor.org/rfc/rfc9110.html#field.content-type) header using heuristics
|
|
197
|
+
# such as checking if the type/subtype (compared case-insensitively, ignoring any parameters) starts with `text/`, ends with `/json`, `+json`, `/xml`, `+xml`, `/yaml` or `+yaml`,
|
|
198
|
+
# is `application/x-www-form-urlencoded`, or if the header declares a `charset` parameter.
|
|
199
|
+
#
|
|
200
|
+
# Instrumentations that implement response body recording MUST NOT intentionally introduce side effects such as changing stream position or closing body stream independently from the
|
|
201
|
+
# application.
|
|
202
|
+
#
|
|
203
|
+
# When body is recorded, the instrumentation SHOULD record part of the body that was sent or received at the time HTTP call has ended.
|
|
204
|
+
# Note that HTTP client spans [SHOULD end sometime after the response headers are fully read](/docs/http/http-spans.md#http-client-span-duration),
|
|
205
|
+
# which may or may not include reading the response body, so on client spans this attribute is often absent or holds only part of the body.
|
|
206
|
+
#
|
|
207
|
+
# The value MUST be either a string or a byte array. Instrumentations MUST NOT record a parsed or otherwise structured representation of the body,
|
|
208
|
+
# and MUST NOT base64-encode binary content into a string value.
|
|
209
|
+
#
|
|
210
|
+
# @note Stability Level: development
|
|
211
|
+
HTTP_RESPONSE_BODY_CONTENT = 'http.response.body.content'
|
|
212
|
+
|
|
154
213
|
# The size of the response payload body in bytes. This is the number of bytes transferred excluding headers and is often, but not always, present as the [Content-Length](https://www.rfc-editor.org/rfc/rfc9110.html#field.content-length) header. For requests using transport encoding, this should be the compressed size.
|
|
155
214
|
#
|
|
156
215
|
# @note Stability Level: development
|
|
@@ -31,6 +31,30 @@ module OpenTelemetry
|
|
|
31
31
|
# @note Stability Level: development
|
|
32
32
|
JVM_BUFFER_POOL_NAME = 'jvm.buffer.pool.name'
|
|
33
33
|
|
|
34
|
+
# Name of the executor.
|
|
35
|
+
#
|
|
36
|
+
# The executor name SHOULD be low-cardinality. If `jvm.executor.owner.name` is present, the combination of `jvm.executor.owner.name` and `jvm.executor.name` SHOULD be unique within the instrumented application; otherwise, `jvm.executor.name` SHOULD be unique when an executor-specific name is available. If the executor implementation does not provide an explicit name, instrumentation SHOULD derive a name from available implementation-specific metadata, such as a normalized worker thread name. If no executor-specific name or metadata is available, instrumentation MAY use `unknown`. The `unknown` value does not identify an executor, and metrics from multiple executors using this value MAY be aggregated. Users requiring per-executor metric series SHOULD configure a distinct name through the executor's `ThreadFactory`. Instrumentations SHOULD document how the name is derived and how users can configure it. Once metric series registration for an executor has started, `jvm.executor.name` and `jvm.executor.owner.name` MUST remain stable for the lifetime of that registration. Instrumentations SHOULD determine these attributes before the first worker is registered. Instrumentations MUST NOT re-register cumulative metrics under a new attribute set or replay prior cumulative values under new attributes.
|
|
37
|
+
#
|
|
38
|
+
# @note Stability Level: development
|
|
39
|
+
JVM_EXECUTOR_NAME = 'jvm.executor.name'
|
|
40
|
+
|
|
41
|
+
# Name of the logical component that owns the executor.
|
|
42
|
+
#
|
|
43
|
+
# The executor owner name SHOULD be a low-cardinality identifier for the component that creates and configures the executor. It is neither the executor implementation type nor an OpenTelemetry instrumentation scope.
|
|
44
|
+
#
|
|
45
|
+
# @note Stability Level: development
|
|
46
|
+
JVM_EXECUTOR_OWNER_NAME = 'jvm.executor.owner.name'
|
|
47
|
+
|
|
48
|
+
# State of an executor thread.
|
|
49
|
+
#
|
|
50
|
+
# @note Stability Level: development
|
|
51
|
+
JVM_EXECUTOR_THREAD_STATE = 'jvm.executor.thread.state'
|
|
52
|
+
|
|
53
|
+
# The fully qualified class name of the executor implementation.
|
|
54
|
+
#
|
|
55
|
+
# @note Stability Level: development
|
|
56
|
+
JVM_EXECUTOR_TYPE = 'jvm.executor.type'
|
|
57
|
+
|
|
34
58
|
# Name of the garbage collector action.
|
|
35
59
|
#
|
|
36
60
|
# Garbage collector action is generally obtained via [GarbageCollectionNotificationInfo#getGcAction()](https://docs.oracle.com/en/java/javase/11/docs/api/jdk.management/com/sun/management/GarbageCollectionNotificationInfo.html#getGcAction()).
|
|
@@ -89,14 +89,57 @@ module OpenTelemetry
|
|
|
89
89
|
# @deprecated Now available in the stable namespace at {OpenTelemetry::SemConv::JVM::JVM_CPU_TIME}.
|
|
90
90
|
JVM_CPU_TIME = 'jvm.cpu.time'
|
|
91
91
|
|
|
92
|
-
#
|
|
92
|
+
# The maximum number of tasks the executor queue can hold.
|
|
93
|
+
#
|
|
94
|
+
# Instrumentations SHOULD emit this metric only when the queue has a finite capacity that represents a meaningful operational limit. This metric SHOULD NOT be emitted for unbounded or effectively unbounded queues.
|
|
95
|
+
#
|
|
96
|
+
# @note Stability Level: development
|
|
97
|
+
JVM_EXECUTOR_QUEUE_CAPACITY = 'jvm.executor.queue.capacity'
|
|
98
|
+
|
|
99
|
+
# The number of tasks currently queued for execution.
|
|
100
|
+
#
|
|
101
|
+
# @note Stability Level: development
|
|
102
|
+
JVM_EXECUTOR_QUEUE_SIZE = 'jvm.executor.queue.size'
|
|
103
|
+
|
|
104
|
+
# The number of tasks completed by the executor.
|
|
105
|
+
#
|
|
106
|
+
# A task SHOULD be counted as completed when the executor has finished processing it, regardless of whether it returns normally, terminates with an exception, or is canceled. Cancellation during processing does not complete the task until processing ends. A task that never begins processing on the executor SHOULD NOT be counted. A task initially rejected but subsequently resubmitted to and processed by the executor SHOULD be counted when processing ends.
|
|
93
107
|
#
|
|
94
108
|
# @note Stability Level: development
|
|
109
|
+
JVM_EXECUTOR_TASK_COMPLETED = 'jvm.executor.task.completed'
|
|
110
|
+
|
|
111
|
+
# The number of task submissions rejected by the executor.
|
|
112
|
+
#
|
|
113
|
+
# A task submission SHOULD be counted as rejected when the executor invokes its rejection handler, regardless of whether the handler subsequently executes the task in the caller (for example, `CallerRunsPolicy`) or discards or replaces a queued task (for example, `DiscardOldestPolicy`). This metric counts rejected submissions, not tasks ultimately discarded from the queue.
|
|
114
|
+
#
|
|
115
|
+
# @note Stability Level: development
|
|
116
|
+
JVM_EXECUTOR_TASK_REJECTED = 'jvm.executor.task.rejected'
|
|
117
|
+
|
|
118
|
+
# The number of core threads configured for the executor.
|
|
119
|
+
#
|
|
120
|
+
# @note Stability Level: development
|
|
121
|
+
JVM_EXECUTOR_THREAD_CORE = 'jvm.executor.thread.core'
|
|
122
|
+
|
|
123
|
+
# The number of executor threads that are currently in the state described by the `jvm.executor.thread.state` attribute.
|
|
124
|
+
#
|
|
125
|
+
# @note Stability Level: development
|
|
126
|
+
JVM_EXECUTOR_THREAD_COUNT = 'jvm.executor.thread.count'
|
|
127
|
+
|
|
128
|
+
# The maximum number of threads allowed for the executor.
|
|
129
|
+
#
|
|
130
|
+
# Instrumentations SHOULD emit this metric only when the maximum thread count is finite and represents a meaningful operational limit. This metric SHOULD NOT be emitted for unbounded or effectively unbounded executors. For example, an executor with a maximum thread count of `Integer.MAX_VALUE` is effectively unbounded.
|
|
131
|
+
#
|
|
132
|
+
# @note Stability Level: development
|
|
133
|
+
JVM_EXECUTOR_THREAD_LIMIT = 'jvm.executor.thread.limit'
|
|
134
|
+
|
|
135
|
+
# Number of open file descriptors as reported by the JVM.
|
|
136
|
+
#
|
|
137
|
+
# @note Stability Level: release_candidate
|
|
95
138
|
JVM_FILE_DESCRIPTOR_COUNT = 'jvm.file_descriptor.count'
|
|
96
139
|
|
|
97
140
|
# Measure of max open file descriptors as reported by the JVM.
|
|
98
141
|
#
|
|
99
|
-
# @note Stability Level:
|
|
142
|
+
# @note Stability Level: release_candidate
|
|
100
143
|
JVM_FILE_DESCRIPTOR_LIMIT = 'jvm.file_descriptor.limit'
|
|
101
144
|
|
|
102
145
|
# Duration of JVM garbage collection actions.
|