opentelemetry-semantic_conventions 1.11.0 → 1.36.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/.yardopts +2 -2
- data/CHANGELOG.md +4 -0
- data/lib/opentelemetry/semantic_conventions/resource.rb +258 -4
- data/lib/opentelemetry/semantic_conventions/trace.rb +432 -5
- data/lib/opentelemetry/semantic_conventions/version.rb +1 -1
- data/lib/opentelemetry/semantic_conventions.rb +13 -1
- data/lib/opentelemetry/semconv/aspnetcore/attributes.rb +97 -0
- data/lib/opentelemetry/semconv/aspnetcore/metrics.rb +83 -0
- data/lib/opentelemetry/semconv/aspnetcore.rb +22 -0
- data/lib/opentelemetry/semconv/client/attributes.rb +53 -0
- data/lib/opentelemetry/semconv/client.rb +21 -0
- data/lib/opentelemetry/semconv/code/attributes.rb +92 -0
- data/lib/opentelemetry/semconv/code.rb +21 -0
- data/lib/opentelemetry/semconv/db/attributes.rb +174 -0
- data/lib/opentelemetry/semconv/db/metrics.rb +36 -0
- data/lib/opentelemetry/semconv/db.rb +22 -0
- data/lib/opentelemetry/semconv/dotnet/attributes.rb +40 -0
- data/lib/opentelemetry/semconv/dotnet/metrics.rb +181 -0
- data/lib/opentelemetry/semconv/dotnet.rb +22 -0
- data/lib/opentelemetry/semconv/error/attributes.rb +61 -0
- data/lib/opentelemetry/semconv/error.rb +21 -0
- data/lib/opentelemetry/semconv/exception/attributes.rb +64 -0
- data/lib/opentelemetry/semconv/exception.rb +21 -0
- data/lib/opentelemetry/semconv/http/attributes.rb +164 -0
- data/lib/opentelemetry/semconv/http/metrics.rb +39 -0
- data/lib/opentelemetry/semconv/http.rb +22 -0
- data/lib/opentelemetry/semconv/incubating/android/attributes.rb +58 -0
- data/lib/opentelemetry/semconv/incubating/android.rb +21 -0
- data/lib/opentelemetry/semconv/incubating/app/attributes.rb +103 -0
- data/lib/opentelemetry/semconv/incubating/app.rb +21 -0
- data/lib/opentelemetry/semconv/incubating/artifact/attributes.rb +117 -0
- data/lib/opentelemetry/semconv/incubating/artifact.rb +21 -0
- data/lib/opentelemetry/semconv/incubating/aspnetcore/attributes.rb +113 -0
- data/lib/opentelemetry/semconv/incubating/aspnetcore/metrics.rb +99 -0
- data/lib/opentelemetry/semconv/incubating/aspnetcore.rb +22 -0
- data/lib/opentelemetry/semconv/incubating/aws/attributes.rb +551 -0
- data/lib/opentelemetry/semconv/incubating/aws.rb +21 -0
- data/lib/opentelemetry/semconv/incubating/az/attributes.rb +53 -0
- data/lib/opentelemetry/semconv/incubating/az.rb +21 -0
- data/lib/opentelemetry/semconv/incubating/azure/attributes.rb +115 -0
- data/lib/opentelemetry/semconv/incubating/azure/metrics.rb +41 -0
- data/lib/opentelemetry/semconv/incubating/azure.rb +22 -0
- data/lib/opentelemetry/semconv/incubating/browser/attributes.rb +77 -0
- data/lib/opentelemetry/semconv/incubating/browser.rb +21 -0
- data/lib/opentelemetry/semconv/incubating/cassandra/attributes.rb +78 -0
- data/lib/opentelemetry/semconv/incubating/cassandra.rb +21 -0
- data/lib/opentelemetry/semconv/incubating/cicd/attributes.rb +201 -0
- data/lib/opentelemetry/semconv/incubating/cicd/metrics.rb +61 -0
- data/lib/opentelemetry/semconv/incubating/cicd.rb +22 -0
- data/lib/opentelemetry/semconv/incubating/client/attributes.rb +59 -0
- data/lib/opentelemetry/semconv/incubating/client.rb +21 -0
- data/lib/opentelemetry/semconv/incubating/cloud/attributes.rb +105 -0
- data/lib/opentelemetry/semconv/incubating/cloud.rb +21 -0
- data/lib/opentelemetry/semconv/incubating/cloudevents/attributes.rb +80 -0
- data/lib/opentelemetry/semconv/incubating/cloudevents.rb +21 -0
- data/lib/opentelemetry/semconv/incubating/cloudfoundry/attributes.rb +190 -0
- data/lib/opentelemetry/semconv/incubating/cloudfoundry.rb +21 -0
- data/lib/opentelemetry/semconv/incubating/code/attributes.rb +155 -0
- data/lib/opentelemetry/semconv/incubating/code.rb +21 -0
- data/lib/opentelemetry/semconv/incubating/container/attributes.rb +197 -0
- data/lib/opentelemetry/semconv/incubating/container/metrics.rb +74 -0
- data/lib/opentelemetry/semconv/incubating/container.rb +22 -0
- data/lib/opentelemetry/semconv/incubating/cpu/attributes.rb +50 -0
- data/lib/opentelemetry/semconv/incubating/cpu/metrics.rb +49 -0
- data/lib/opentelemetry/semconv/incubating/cpu.rb +22 -0
- data/lib/opentelemetry/semconv/incubating/cpython/attributes.rb +42 -0
- data/lib/opentelemetry/semconv/incubating/cpython/metrics.rb +52 -0
- data/lib/opentelemetry/semconv/incubating/cpython.rb +22 -0
- data/lib/opentelemetry/semconv/incubating/db/attributes.rb +615 -0
- data/lib/opentelemetry/semconv/incubating/db/metrics.rb +156 -0
- data/lib/opentelemetry/semconv/incubating/db.rb +22 -0
- data/lib/opentelemetry/semconv/incubating/deployment/attributes.rb +84 -0
- data/lib/opentelemetry/semconv/incubating/deployment.rb +21 -0
- data/lib/opentelemetry/semconv/incubating/destination/attributes.rb +54 -0
- data/lib/opentelemetry/semconv/incubating/destination.rb +21 -0
- data/lib/opentelemetry/semconv/incubating/device/attributes.rb +88 -0
- data/lib/opentelemetry/semconv/incubating/device.rb +21 -0
- data/lib/opentelemetry/semconv/incubating/disk/attributes.rb +40 -0
- data/lib/opentelemetry/semconv/incubating/disk.rb +21 -0
- data/lib/opentelemetry/semconv/incubating/dns/attributes.rb +52 -0
- data/lib/opentelemetry/semconv/incubating/dns/metrics.rb +36 -0
- data/lib/opentelemetry/semconv/incubating/dns.rb +22 -0
- data/lib/opentelemetry/semconv/incubating/dotnet/attributes.rb +44 -0
- data/lib/opentelemetry/semconv/incubating/dotnet/metrics.rb +221 -0
- data/lib/opentelemetry/semconv/incubating/dotnet.rb +22 -0
- data/lib/opentelemetry/semconv/incubating/elasticsearch/attributes.rb +40 -0
- data/lib/opentelemetry/semconv/incubating/elasticsearch.rb +21 -0
- data/lib/opentelemetry/semconv/incubating/enduser/attributes.rb +79 -0
- data/lib/opentelemetry/semconv/incubating/enduser.rb +21 -0
- data/lib/opentelemetry/semconv/incubating/error/attributes.rb +81 -0
- data/lib/opentelemetry/semconv/incubating/error.rb +21 -0
- data/lib/opentelemetry/semconv/incubating/event/attributes.rb +42 -0
- data/lib/opentelemetry/semconv/incubating/event.rb +21 -0
- data/lib/opentelemetry/semconv/incubating/exception/attributes.rb +73 -0
- data/lib/opentelemetry/semconv/incubating/exception.rb +21 -0
- data/lib/opentelemetry/semconv/incubating/faas/attributes.rb +200 -0
- data/lib/opentelemetry/semconv/incubating/faas/metrics.rb +76 -0
- data/lib/opentelemetry/semconv/incubating/faas.rb +22 -0
- data/lib/opentelemetry/semconv/incubating/feature_flag/attributes.rb +159 -0
- data/lib/opentelemetry/semconv/incubating/feature_flag.rb +21 -0
- data/lib/opentelemetry/semconv/incubating/file/attributes.rb +207 -0
- data/lib/opentelemetry/semconv/incubating/file.rb +21 -0
- data/lib/opentelemetry/semconv/incubating/gcp/attributes.rb +159 -0
- data/lib/opentelemetry/semconv/incubating/gcp.rb +21 -0
- data/lib/opentelemetry/semconv/incubating/gen_ai/attributes.rb +404 -0
- data/lib/opentelemetry/semconv/incubating/gen_ai/metrics.rb +56 -0
- data/lib/opentelemetry/semconv/incubating/gen_ai.rb +22 -0
- data/lib/opentelemetry/semconv/incubating/geo/attributes.rb +91 -0
- data/lib/opentelemetry/semconv/incubating/geo.rb +21 -0
- data/lib/opentelemetry/semconv/incubating/go/attributes.rb +41 -0
- data/lib/opentelemetry/semconv/incubating/go/metrics.rb +94 -0
- data/lib/opentelemetry/semconv/incubating/go.rb +22 -0
- data/lib/opentelemetry/semconv/incubating/graphql/attributes.rb +62 -0
- data/lib/opentelemetry/semconv/incubating/graphql.rb +21 -0
- data/lib/opentelemetry/semconv/incubating/heroku/attributes.rb +58 -0
- data/lib/opentelemetry/semconv/incubating/heroku.rb +21 -0
- data/lib/opentelemetry/semconv/incubating/host/attributes.rb +172 -0
- data/lib/opentelemetry/semconv/incubating/host.rb +21 -0
- data/lib/opentelemetry/semconv/incubating/http/attributes.rb +366 -0
- data/lib/opentelemetry/semconv/incubating/http/metrics.rb +93 -0
- data/lib/opentelemetry/semconv/incubating/http.rb +22 -0
- data/lib/opentelemetry/semconv/incubating/hw/attributes.rb +70 -0
- data/lib/opentelemetry/semconv/incubating/hw/metrics.rb +79 -0
- data/lib/opentelemetry/semconv/incubating/hw.rb +22 -0
- data/lib/opentelemetry/semconv/incubating/ios/attributes.rb +44 -0
- data/lib/opentelemetry/semconv/incubating/ios.rb +21 -0
- data/lib/opentelemetry/semconv/incubating/jvm/attributes.rb +129 -0
- data/lib/opentelemetry/semconv/incubating/jvm/metrics.rb +162 -0
- data/lib/opentelemetry/semconv/incubating/jvm.rb +22 -0
- data/lib/opentelemetry/semconv/incubating/k8s/attributes.rb +910 -0
- data/lib/opentelemetry/semconv/incubating/k8s/metrics.rb +658 -0
- data/lib/opentelemetry/semconv/incubating/k8s.rb +22 -0
- data/lib/opentelemetry/semconv/incubating/kestrel/metrics.rb +106 -0
- data/lib/opentelemetry/semconv/incubating/kestrel.rb +21 -0
- data/lib/opentelemetry/semconv/incubating/linux/attributes.rb +41 -0
- data/lib/opentelemetry/semconv/incubating/linux.rb +21 -0
- data/lib/opentelemetry/semconv/incubating/log/attributes.rb +96 -0
- data/lib/opentelemetry/semconv/incubating/log.rb +21 -0
- data/lib/opentelemetry/semconv/incubating/mainframe/attributes.rb +40 -0
- data/lib/opentelemetry/semconv/incubating/mainframe.rb +21 -0
- data/lib/opentelemetry/semconv/incubating/message/attributes.rb +55 -0
- data/lib/opentelemetry/semconv/incubating/message.rb +21 -0
- data/lib/opentelemetry/semconv/incubating/messaging/attributes.rb +451 -0
- data/lib/opentelemetry/semconv/incubating/messaging/metrics.rb +96 -0
- data/lib/opentelemetry/semconv/incubating/messaging.rb +22 -0
- data/lib/opentelemetry/semconv/incubating/net/attributes.rb +175 -0
- data/lib/opentelemetry/semconv/incubating/net.rb +21 -0
- data/lib/opentelemetry/semconv/incubating/network/attributes.rb +222 -0
- data/lib/opentelemetry/semconv/incubating/network.rb +21 -0
- data/lib/opentelemetry/semconv/incubating/nodejs/attributes.rb +36 -0
- data/lib/opentelemetry/semconv/incubating/nodejs/metrics.rb +94 -0
- data/lib/opentelemetry/semconv/incubating/nodejs.rb +22 -0
- data/lib/opentelemetry/semconv/incubating/oci/attributes.rb +43 -0
- data/lib/opentelemetry/semconv/incubating/oci.rb +21 -0
- data/lib/opentelemetry/semconv/incubating/opentracing/attributes.rb +38 -0
- data/lib/opentelemetry/semconv/incubating/opentracing.rb +21 -0
- data/lib/opentelemetry/semconv/incubating/os/attributes.rb +78 -0
- data/lib/opentelemetry/semconv/incubating/os.rb +21 -0
- data/lib/opentelemetry/semconv/incubating/otel/attributes.rb +138 -0
- data/lib/opentelemetry/semconv/incubating/otel/metrics.rb +194 -0
- data/lib/opentelemetry/semconv/incubating/otel.rb +22 -0
- data/lib/opentelemetry/semconv/incubating/other/attributes.rb +41 -0
- data/lib/opentelemetry/semconv/incubating/other.rb +21 -0
- data/lib/opentelemetry/semconv/incubating/peer/attributes.rb +40 -0
- data/lib/opentelemetry/semconv/incubating/peer.rb +21 -0
- data/lib/opentelemetry/semconv/incubating/pool/attributes.rb +41 -0
- data/lib/opentelemetry/semconv/incubating/pool.rb +21 -0
- data/lib/opentelemetry/semconv/incubating/process/attributes.rb +367 -0
- data/lib/opentelemetry/semconv/incubating/process/metrics.rb +89 -0
- data/lib/opentelemetry/semconv/incubating/process.rb +22 -0
- data/lib/opentelemetry/semconv/incubating/profile/attributes.rb +40 -0
- data/lib/opentelemetry/semconv/incubating/profile.rb +21 -0
- data/lib/opentelemetry/semconv/incubating/rpc/attributes.rb +215 -0
- data/lib/opentelemetry/semconv/incubating/rpc/metrics.rb +115 -0
- data/lib/opentelemetry/semconv/incubating/rpc.rb +22 -0
- data/lib/opentelemetry/semconv/incubating/security_rule/attributes.rb +106 -0
- data/lib/opentelemetry/semconv/incubating/security_rule.rb +21 -0
- data/lib/opentelemetry/semconv/incubating/server/attributes.rb +61 -0
- data/lib/opentelemetry/semconv/incubating/server.rb +21 -0
- data/lib/opentelemetry/semconv/incubating/service/attributes.rb +103 -0
- data/lib/opentelemetry/semconv/incubating/service.rb +21 -0
- data/lib/opentelemetry/semconv/incubating/session/attributes.rb +49 -0
- data/lib/opentelemetry/semconv/incubating/session.rb +21 -0
- data/lib/opentelemetry/semconv/incubating/signalr/attributes.rb +55 -0
- data/lib/opentelemetry/semconv/incubating/signalr/metrics.rb +49 -0
- data/lib/opentelemetry/semconv/incubating/signalr.rb +22 -0
- data/lib/opentelemetry/semconv/incubating/source/attributes.rb +54 -0
- data/lib/opentelemetry/semconv/incubating/source.rb +21 -0
- data/lib/opentelemetry/semconv/incubating/system/attributes.rb +162 -0
- data/lib/opentelemetry/semconv/incubating/system/metrics.rb +227 -0
- data/lib/opentelemetry/semconv/incubating/system.rb +22 -0
- data/lib/opentelemetry/semconv/incubating/telemetry/attributes.rb +88 -0
- data/lib/opentelemetry/semconv/incubating/telemetry.rb +21 -0
- data/lib/opentelemetry/semconv/incubating/test/attributes.rb +75 -0
- data/lib/opentelemetry/semconv/incubating/test.rb +21 -0
- data/lib/opentelemetry/semconv/incubating/thread/attributes.rb +49 -0
- data/lib/opentelemetry/semconv/incubating/thread.rb +21 -0
- data/lib/opentelemetry/semconv/incubating/tls/attributes.rb +293 -0
- data/lib/opentelemetry/semconv/incubating/tls.rb +21 -0
- data/lib/opentelemetry/semconv/incubating/url/attributes.rb +225 -0
- data/lib/opentelemetry/semconv/incubating/url.rb +21 -0
- data/lib/opentelemetry/semconv/incubating/user/attributes.rb +87 -0
- data/lib/opentelemetry/semconv/incubating/user.rb +21 -0
- data/lib/opentelemetry/semconv/incubating/user_agent/attributes.rb +100 -0
- data/lib/opentelemetry/semconv/incubating/user_agent.rb +21 -0
- data/lib/opentelemetry/semconv/incubating/v8js/attributes.rb +43 -0
- data/lib/opentelemetry/semconv/incubating/v8js/metrics.rb +66 -0
- data/lib/opentelemetry/semconv/incubating/v8js.rb +22 -0
- data/lib/opentelemetry/semconv/incubating/vcs/attributes.rb +303 -0
- data/lib/opentelemetry/semconv/incubating/vcs/metrics.rb +88 -0
- data/lib/opentelemetry/semconv/incubating/vcs.rb +22 -0
- data/lib/opentelemetry/semconv/incubating/webengine/attributes.rb +58 -0
- data/lib/opentelemetry/semconv/incubating/webengine.rb +21 -0
- data/lib/opentelemetry/semconv/incubating/zos/attributes.rb +49 -0
- data/lib/opentelemetry/semconv/incubating/zos.rb +21 -0
- data/lib/opentelemetry/semconv/jvm/attributes.rb +91 -0
- data/lib/opentelemetry/semconv/jvm/metrics.rb +91 -0
- data/lib/opentelemetry/semconv/jvm.rb +22 -0
- data/lib/opentelemetry/semconv/kestrel/metrics.rb +88 -0
- data/lib/opentelemetry/semconv/kestrel.rb +21 -0
- data/lib/opentelemetry/semconv/network/attributes.rb +120 -0
- data/lib/opentelemetry/semconv/network.rb +21 -0
- data/lib/opentelemetry/semconv/otel/attributes.rb +61 -0
- data/lib/opentelemetry/semconv/otel.rb +21 -0
- data/lib/opentelemetry/semconv/server/attributes.rb +55 -0
- data/lib/opentelemetry/semconv/server.rb +21 -0
- data/lib/opentelemetry/semconv/service/attributes.rb +50 -0
- data/lib/opentelemetry/semconv/service.rb +21 -0
- data/lib/opentelemetry/semconv/signalr/attributes.rb +49 -0
- data/lib/opentelemetry/semconv/signalr/metrics.rb +43 -0
- data/lib/opentelemetry/semconv/signalr.rb +22 -0
- data/lib/opentelemetry/semconv/telemetry/attributes.rb +59 -0
- data/lib/opentelemetry/semconv/telemetry.rb +21 -0
- data/lib/opentelemetry/semconv/url/attributes.rb +118 -0
- data/lib/opentelemetry/semconv/url.rb +21 -0
- data/lib/opentelemetry/semconv/user_agent/attributes.rb +40 -0
- data/lib/opentelemetry/semconv/user_agent.rb +21 -0
- metadata +249 -4
@@ -0,0 +1,215 @@
|
|
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 RPC
|
25
|
+
# @!group Attribute Names
|
26
|
+
|
27
|
+
# The [error codes](https://connectrpc.com//docs/protocol/#error-codes) of the Connect request. Error codes are always string values.
|
28
|
+
#
|
29
|
+
# @note Stability Level: development
|
30
|
+
RPC_CONNECT_RPC_ERROR_CODE = 'rpc.connect_rpc.error_code'
|
31
|
+
|
32
|
+
# Must be called with a key for the full attribute name. See notes below about the expectations
|
33
|
+
# for the state of the key.
|
34
|
+
#
|
35
|
+
# @example Usage
|
36
|
+
# RPC_CONNECT_RPC_REQUEST_METADATA_LAMBDA.call('some-cool-key') #=> 'rpc.connect_rpc.request.metadata.some-cool-key'
|
37
|
+
#
|
38
|
+
# Connect request metadata, `<key>` being the normalized Connect Metadata key (lowercase), the value being the metadata values.
|
39
|
+
#
|
40
|
+
# Instrumentations SHOULD require an explicit configuration of which metadata values are to be captured.
|
41
|
+
# Including all request metadata values can be a security risk - explicit configuration helps avoid leaking sensitive information.
|
42
|
+
#
|
43
|
+
# For example, a property `my-custom-key` with value `["1.2.3.4", "1.2.3.5"]` SHOULD be recorded as
|
44
|
+
# the `rpc.connect_rpc.request.metadata.my-custom-key` attribute with value `["1.2.3.4", "1.2.3.5"]`
|
45
|
+
#
|
46
|
+
# @note Stability Level: development
|
47
|
+
#
|
48
|
+
# @example Sample Values
|
49
|
+
# ["1.2.3.4", "1.2.3.5"]
|
50
|
+
#
|
51
|
+
RPC_CONNECT_RPC_REQUEST_METADATA_LAMBDA = ->(key) { "rpc.connect_rpc.request.metadata.#{key}" }
|
52
|
+
|
53
|
+
# Must be called with a key for the full attribute name. See notes below about the expectations
|
54
|
+
# for the state of the key.
|
55
|
+
#
|
56
|
+
# @example Usage
|
57
|
+
# RPC_CONNECT_RPC_RESPONSE_METADATA_LAMBDA.call('some-cool-key') #=> 'rpc.connect_rpc.response.metadata.some-cool-key'
|
58
|
+
#
|
59
|
+
# Connect response metadata, `<key>` being the normalized Connect Metadata key (lowercase), the value being the metadata values.
|
60
|
+
#
|
61
|
+
# Instrumentations SHOULD require an explicit configuration of which metadata values are to be captured.
|
62
|
+
# Including all response metadata values can be a security risk - explicit configuration helps avoid leaking sensitive information.
|
63
|
+
#
|
64
|
+
# For example, a property `my-custom-key` with value `"attribute_value"` SHOULD be recorded as
|
65
|
+
# the `rpc.connect_rpc.response.metadata.my-custom-key` attribute with value `["attribute_value"]`
|
66
|
+
#
|
67
|
+
# @note Stability Level: development
|
68
|
+
#
|
69
|
+
# @example Sample Values
|
70
|
+
# ["attribute_value"]
|
71
|
+
#
|
72
|
+
RPC_CONNECT_RPC_RESPONSE_METADATA_LAMBDA = ->(key) { "rpc.connect_rpc.response.metadata.#{key}" }
|
73
|
+
|
74
|
+
# Must be called with a key for the full attribute name. See notes below about the expectations
|
75
|
+
# for the state of the key.
|
76
|
+
#
|
77
|
+
# @example Usage
|
78
|
+
# RPC_GRPC_REQUEST_METADATA_LAMBDA.call('some-cool-key') #=> 'rpc.grpc.request.metadata.some-cool-key'
|
79
|
+
#
|
80
|
+
# gRPC request metadata, `<key>` being the normalized gRPC Metadata key (lowercase), the value being the metadata values.
|
81
|
+
#
|
82
|
+
# Instrumentations SHOULD require an explicit configuration of which metadata values are to be captured.
|
83
|
+
# Including all request metadata values can be a security risk - explicit configuration helps avoid leaking sensitive information.
|
84
|
+
#
|
85
|
+
# For example, a property `my-custom-key` with value `["1.2.3.4", "1.2.3.5"]` SHOULD be recorded as
|
86
|
+
# `rpc.grpc.request.metadata.my-custom-key` attribute with value `["1.2.3.4", "1.2.3.5"]`
|
87
|
+
#
|
88
|
+
# @note Stability Level: development
|
89
|
+
#
|
90
|
+
# @example Sample Values
|
91
|
+
# ["1.2.3.4", "1.2.3.5"]
|
92
|
+
#
|
93
|
+
RPC_GRPC_REQUEST_METADATA_LAMBDA = ->(key) { "rpc.grpc.request.metadata.#{key}" }
|
94
|
+
|
95
|
+
# Must be called with a key for the full attribute name. See notes below about the expectations
|
96
|
+
# for the state of the key.
|
97
|
+
#
|
98
|
+
# @example Usage
|
99
|
+
# RPC_GRPC_RESPONSE_METADATA_LAMBDA.call('some-cool-key') #=> 'rpc.grpc.response.metadata.some-cool-key'
|
100
|
+
#
|
101
|
+
# gRPC response metadata, `<key>` being the normalized gRPC Metadata key (lowercase), the value being the metadata values.
|
102
|
+
#
|
103
|
+
# Instrumentations SHOULD require an explicit configuration of which metadata values are to be captured.
|
104
|
+
# Including all response metadata values can be a security risk - explicit configuration helps avoid leaking sensitive information.
|
105
|
+
#
|
106
|
+
# For example, a property `my-custom-key` with value `["attribute_value"]` SHOULD be recorded as
|
107
|
+
# the `rpc.grpc.response.metadata.my-custom-key` attribute with value `["attribute_value"]`
|
108
|
+
#
|
109
|
+
# @note Stability Level: development
|
110
|
+
#
|
111
|
+
# @example Sample Values
|
112
|
+
# ["attribute_value"]
|
113
|
+
#
|
114
|
+
RPC_GRPC_RESPONSE_METADATA_LAMBDA = ->(key) { "rpc.grpc.response.metadata.#{key}" }
|
115
|
+
|
116
|
+
# The [numeric status code](https://github.com/grpc/grpc/blob/v1.33.2/doc/statuscodes.md) of the gRPC request.
|
117
|
+
#
|
118
|
+
# @note Stability Level: development
|
119
|
+
RPC_GRPC_STATUS_CODE = 'rpc.grpc.status_code'
|
120
|
+
|
121
|
+
# `error.code` property of response if it is an error response.
|
122
|
+
#
|
123
|
+
# @note Stability Level: development
|
124
|
+
#
|
125
|
+
# @example Sample Values
|
126
|
+
# -32700
|
127
|
+
# 100
|
128
|
+
#
|
129
|
+
RPC_JSONRPC_ERROR_CODE = 'rpc.jsonrpc.error_code'
|
130
|
+
|
131
|
+
# `error.message` property of response if it is an error response.
|
132
|
+
#
|
133
|
+
# @note Stability Level: development
|
134
|
+
#
|
135
|
+
# @example Sample Values
|
136
|
+
# Parse error
|
137
|
+
# User already exists
|
138
|
+
#
|
139
|
+
RPC_JSONRPC_ERROR_MESSAGE = 'rpc.jsonrpc.error_message'
|
140
|
+
|
141
|
+
# `id` property of request or response. Since protocol allows id to be int, string, `null` or missing (for notifications), value is expected to be cast to string for simplicity. Use empty string in case of `null` value. Omit entirely if this is a notification.
|
142
|
+
#
|
143
|
+
# @note Stability Level: development
|
144
|
+
#
|
145
|
+
# @example Sample Values
|
146
|
+
# 10
|
147
|
+
# request-7
|
148
|
+
#
|
149
|
+
#
|
150
|
+
RPC_JSONRPC_REQUEST_ID = 'rpc.jsonrpc.request_id'
|
151
|
+
|
152
|
+
# Protocol version as in `jsonrpc` property of request/response. Since JSON-RPC 1.0 doesn't specify this, the value can be omitted.
|
153
|
+
#
|
154
|
+
# @note Stability Level: development
|
155
|
+
#
|
156
|
+
# @example Sample Values
|
157
|
+
# 2.0
|
158
|
+
# 1.0
|
159
|
+
#
|
160
|
+
RPC_JSONRPC_VERSION = 'rpc.jsonrpc.version'
|
161
|
+
|
162
|
+
# Compressed size of the message in bytes.
|
163
|
+
#
|
164
|
+
# @note Stability Level: development
|
165
|
+
RPC_MESSAGE_COMPRESSED_SIZE = 'rpc.message.compressed_size'
|
166
|
+
|
167
|
+
# MUST be calculated as two different counters starting from `1` one for sent messages and one for received message.
|
168
|
+
#
|
169
|
+
# This way we guarantee that the values will be consistent between different implementations.
|
170
|
+
#
|
171
|
+
# @note Stability Level: development
|
172
|
+
RPC_MESSAGE_ID = 'rpc.message.id'
|
173
|
+
|
174
|
+
# Whether this is a received or sent message.
|
175
|
+
#
|
176
|
+
# @note Stability Level: development
|
177
|
+
RPC_MESSAGE_TYPE = 'rpc.message.type'
|
178
|
+
|
179
|
+
# Uncompressed size of the message in bytes.
|
180
|
+
#
|
181
|
+
# @note Stability Level: development
|
182
|
+
RPC_MESSAGE_UNCOMPRESSED_SIZE = 'rpc.message.uncompressed_size'
|
183
|
+
|
184
|
+
# The name of the (logical) method being called, must be equal to the $method part in the span name.
|
185
|
+
#
|
186
|
+
# This is the logical name of the method from the RPC interface perspective, which can be different from the name of any implementing method/function. The `code.function.name` attribute may be used to store the latter (e.g., method actually executing the call on the server side, RPC client stub method on the client side).
|
187
|
+
#
|
188
|
+
# @note Stability Level: development
|
189
|
+
#
|
190
|
+
# @example Sample Values
|
191
|
+
# exampleMethod
|
192
|
+
#
|
193
|
+
RPC_METHOD = 'rpc.method'
|
194
|
+
|
195
|
+
# The full (logical) name of the service being called, including its package name, if applicable.
|
196
|
+
#
|
197
|
+
# This is the logical name of the service from the RPC interface perspective, which can be different from the name of any implementing class. The `code.namespace` attribute may be used to store the latter (despite the attribute name, it may include a class name; e.g., class with method actually executing the call on the server side, RPC client stub class on the client side).
|
198
|
+
#
|
199
|
+
# @note Stability Level: development
|
200
|
+
#
|
201
|
+
# @example Sample Values
|
202
|
+
# myservice.EchoService
|
203
|
+
#
|
204
|
+
RPC_SERVICE = 'rpc.service'
|
205
|
+
|
206
|
+
# A string identifying the remoting system. See below for a list of well-known identifiers.
|
207
|
+
#
|
208
|
+
# @note Stability Level: development
|
209
|
+
RPC_SYSTEM = 'rpc.system'
|
210
|
+
|
211
|
+
# @!endgroup
|
212
|
+
end
|
213
|
+
end
|
214
|
+
end
|
215
|
+
end
|
@@ -0,0 +1,115 @@
|
|
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 RPC
|
25
|
+
# @!group Metrics Names
|
26
|
+
|
27
|
+
# Measures the duration of outbound RPC.
|
28
|
+
#
|
29
|
+
# While streaming RPCs may record this metric as start-of-batch
|
30
|
+
# to end-of-batch, it's hard to interpret in practice.
|
31
|
+
#
|
32
|
+
# **Streaming**: N/A.
|
33
|
+
#
|
34
|
+
# @note Stability Level: development
|
35
|
+
RPC_CLIENT_DURATION = 'rpc.client.duration'
|
36
|
+
|
37
|
+
# Measures the size of RPC request messages (uncompressed).
|
38
|
+
#
|
39
|
+
# **Streaming**: Recorded per message in a streaming batch
|
40
|
+
#
|
41
|
+
# @note Stability Level: development
|
42
|
+
RPC_CLIENT_REQUEST_SIZE = 'rpc.client.request.size'
|
43
|
+
|
44
|
+
# Measures the number of messages received per RPC.
|
45
|
+
#
|
46
|
+
# Should be 1 for all non-streaming RPCs.
|
47
|
+
#
|
48
|
+
# **Streaming**: This metric is required for server and client streaming RPCs
|
49
|
+
#
|
50
|
+
# @note Stability Level: development
|
51
|
+
RPC_CLIENT_REQUESTS_PER_RPC = 'rpc.client.requests_per_rpc'
|
52
|
+
|
53
|
+
# Measures the size of RPC response messages (uncompressed).
|
54
|
+
#
|
55
|
+
# **Streaming**: Recorded per response in a streaming batch
|
56
|
+
#
|
57
|
+
# @note Stability Level: development
|
58
|
+
RPC_CLIENT_RESPONSE_SIZE = 'rpc.client.response.size'
|
59
|
+
|
60
|
+
# Measures the number of messages sent per RPC.
|
61
|
+
#
|
62
|
+
# Should be 1 for all non-streaming RPCs.
|
63
|
+
#
|
64
|
+
# **Streaming**: This metric is required for server and client streaming RPCs
|
65
|
+
#
|
66
|
+
# @note Stability Level: development
|
67
|
+
RPC_CLIENT_RESPONSES_PER_RPC = 'rpc.client.responses_per_rpc'
|
68
|
+
|
69
|
+
# Measures the duration of inbound RPC.
|
70
|
+
#
|
71
|
+
# While streaming RPCs may record this metric as start-of-batch
|
72
|
+
# to end-of-batch, it's hard to interpret in practice.
|
73
|
+
#
|
74
|
+
# **Streaming**: N/A.
|
75
|
+
#
|
76
|
+
# @note Stability Level: development
|
77
|
+
RPC_SERVER_DURATION = 'rpc.server.duration'
|
78
|
+
|
79
|
+
# Measures the size of RPC request messages (uncompressed).
|
80
|
+
#
|
81
|
+
# **Streaming**: Recorded per message in a streaming batch
|
82
|
+
#
|
83
|
+
# @note Stability Level: development
|
84
|
+
RPC_SERVER_REQUEST_SIZE = 'rpc.server.request.size'
|
85
|
+
|
86
|
+
# Measures the number of messages received per RPC.
|
87
|
+
#
|
88
|
+
# Should be 1 for all non-streaming RPCs.
|
89
|
+
#
|
90
|
+
# **Streaming** : This metric is required for server and client streaming RPCs
|
91
|
+
#
|
92
|
+
# @note Stability Level: development
|
93
|
+
RPC_SERVER_REQUESTS_PER_RPC = 'rpc.server.requests_per_rpc'
|
94
|
+
|
95
|
+
# Measures the size of RPC response messages (uncompressed).
|
96
|
+
#
|
97
|
+
# **Streaming**: Recorded per response in a streaming batch
|
98
|
+
#
|
99
|
+
# @note Stability Level: development
|
100
|
+
RPC_SERVER_RESPONSE_SIZE = 'rpc.server.response.size'
|
101
|
+
|
102
|
+
# Measures the number of messages sent per RPC.
|
103
|
+
#
|
104
|
+
# Should be 1 for all non-streaming RPCs.
|
105
|
+
#
|
106
|
+
# **Streaming**: This metric is required for server and client streaming RPCs
|
107
|
+
#
|
108
|
+
# @note Stability Level: development
|
109
|
+
RPC_SERVER_RESPONSES_PER_RPC = 'rpc.server.responses_per_rpc'
|
110
|
+
|
111
|
+
# @!endgroup
|
112
|
+
end
|
113
|
+
end
|
114
|
+
end
|
115
|
+
end
|
@@ -0,0 +1,22 @@
|
|
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 'rpc/attributes'
|
22
|
+
require_relative 'rpc/metrics'
|
@@ -0,0 +1,106 @@
|
|
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 SECURITY_RULE
|
25
|
+
# @!group Attribute Names
|
26
|
+
|
27
|
+
# A categorization value keyword used by the entity using the rule for detection of this event
|
28
|
+
#
|
29
|
+
# @note Stability Level: development
|
30
|
+
#
|
31
|
+
# @example Sample Values
|
32
|
+
# Attempted Information Leak
|
33
|
+
#
|
34
|
+
SECURITY_RULE_CATEGORY = 'security_rule.category'
|
35
|
+
|
36
|
+
# The description of the rule generating the event.
|
37
|
+
#
|
38
|
+
# @note Stability Level: development
|
39
|
+
#
|
40
|
+
# @example Sample Values
|
41
|
+
# Block requests to public DNS over HTTPS / TLS protocols
|
42
|
+
#
|
43
|
+
SECURITY_RULE_DESCRIPTION = 'security_rule.description'
|
44
|
+
|
45
|
+
# Name of the license under which the rule used to generate this event is made available.
|
46
|
+
#
|
47
|
+
# @note Stability Level: development
|
48
|
+
#
|
49
|
+
# @example Sample Values
|
50
|
+
# Apache 2.0
|
51
|
+
#
|
52
|
+
SECURITY_RULE_LICENSE = 'security_rule.license'
|
53
|
+
|
54
|
+
# The name of the rule or signature generating the event.
|
55
|
+
#
|
56
|
+
# @note Stability Level: development
|
57
|
+
#
|
58
|
+
# @example Sample Values
|
59
|
+
# BLOCK_DNS_over_TLS
|
60
|
+
#
|
61
|
+
SECURITY_RULE_NAME = 'security_rule.name'
|
62
|
+
|
63
|
+
# Reference URL to additional information about the rule used to generate this event.
|
64
|
+
#
|
65
|
+
# The URL can point to the vendor’s documentation about the rule. If that’s not available, it can also be a link to a more general page describing this type of alert.
|
66
|
+
#
|
67
|
+
# @note Stability Level: development
|
68
|
+
#
|
69
|
+
# @example Sample Values
|
70
|
+
# https://en.wikipedia.org/wiki/DNS_over_TLS
|
71
|
+
#
|
72
|
+
SECURITY_RULE_REFERENCE = 'security_rule.reference'
|
73
|
+
|
74
|
+
# Name of the ruleset, policy, group, or parent category in which the rule used to generate this event is a member.
|
75
|
+
#
|
76
|
+
# @note Stability Level: development
|
77
|
+
#
|
78
|
+
# @example Sample Values
|
79
|
+
# Standard_Protocol_Filters
|
80
|
+
#
|
81
|
+
SECURITY_RULE_RULESET_NAME = 'security_rule.ruleset.name'
|
82
|
+
|
83
|
+
# A rule ID that is unique within the scope of a set or group of agents, observers, or other entities using the rule for detection of this event.
|
84
|
+
#
|
85
|
+
# @note Stability Level: development
|
86
|
+
#
|
87
|
+
# @example Sample Values
|
88
|
+
# 550e8400-e29b-41d4-a716-446655440000
|
89
|
+
# 1100110011
|
90
|
+
#
|
91
|
+
SECURITY_RULE_UUID = 'security_rule.uuid'
|
92
|
+
|
93
|
+
# The version / revision of the rule being used for analysis.
|
94
|
+
#
|
95
|
+
# @note Stability Level: development
|
96
|
+
#
|
97
|
+
# @example Sample Values
|
98
|
+
# 1.0.0
|
99
|
+
#
|
100
|
+
SECURITY_RULE_VERSION = 'security_rule.version'
|
101
|
+
|
102
|
+
# @!endgroup
|
103
|
+
end
|
104
|
+
end
|
105
|
+
end
|
106
|
+
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 'security_rule/attributes'
|
@@ -0,0 +1,61 @@
|
|
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 SERVER
|
25
|
+
# @!group Attribute Names
|
26
|
+
|
27
|
+
# Server domain name if available without reverse DNS lookup; otherwise, IP address or Unix domain socket name.
|
28
|
+
#
|
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
|
+
#
|
31
|
+
# @note Stability Level: stable
|
32
|
+
#
|
33
|
+
# @example Sample Values
|
34
|
+
# example.com
|
35
|
+
# 10.1.2.80
|
36
|
+
# /tmp/my.sock
|
37
|
+
#
|
38
|
+
#
|
39
|
+
# @deprecated Now available in the stable namespace at {OpenTelemetry::SemConv::SERVER::SERVER_ADDRESS}.
|
40
|
+
SERVER_ADDRESS = 'server.address'
|
41
|
+
|
42
|
+
# Server port number.
|
43
|
+
#
|
44
|
+
# 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.
|
45
|
+
#
|
46
|
+
# @note Stability Level: stable
|
47
|
+
#
|
48
|
+
# @example Sample Values
|
49
|
+
# 80
|
50
|
+
# 8080
|
51
|
+
# 443
|
52
|
+
#
|
53
|
+
#
|
54
|
+
# @deprecated Now available in the stable namespace at {OpenTelemetry::SemConv::SERVER::SERVER_PORT}.
|
55
|
+
SERVER_PORT = 'server.port'
|
56
|
+
|
57
|
+
# @!endgroup
|
58
|
+
end
|
59
|
+
end
|
60
|
+
end
|
61
|
+
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 'server/attributes'
|
@@ -0,0 +1,103 @@
|
|
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 SERVICE
|
25
|
+
# @!group Attribute Names
|
26
|
+
|
27
|
+
# The string ID of the service instance.
|
28
|
+
#
|
29
|
+
# MUST be unique for each instance of the same `service.namespace,service.name` pair (in other words
|
30
|
+
# `service.namespace,service.name,service.instance.id` triplet MUST be globally unique). The ID helps to
|
31
|
+
# distinguish instances of the same service that exist at the same time (e.g. instances of a horizontally scaled
|
32
|
+
# service).
|
33
|
+
#
|
34
|
+
# Implementations, such as SDKs, are recommended to generate a random Version 1 or Version 4 [RFC
|
35
|
+
# 4122](https://www.ietf.org/rfc/rfc4122.txt) UUID, but are free to use an inherent unique ID as the source of
|
36
|
+
# this value if stability is desirable. In that case, the ID SHOULD be used as source of a UUID Version 5 and
|
37
|
+
# SHOULD use the following UUID as the namespace: `4d63009a-8d0f-11ee-aad7-4c796ed8e320`.
|
38
|
+
#
|
39
|
+
# UUIDs are typically recommended, as only an opaque value for the purposes of identifying a service instance is
|
40
|
+
# needed. Similar to what can be seen in the man page for the
|
41
|
+
# [`/etc/machine-id`](https://www.freedesktop.org/software/systemd/man/latest/machine-id.html) file, the underlying
|
42
|
+
# data, such as pod name and namespace should be treated as confidential, being the user's choice to expose it
|
43
|
+
# or not via another resource attribute.
|
44
|
+
#
|
45
|
+
# For applications running behind an application server (like unicorn), we do not recommend using one identifier
|
46
|
+
# for all processes participating in the application. Instead, it's recommended each division (e.g. a worker
|
47
|
+
# thread in unicorn) to have its own instance.id.
|
48
|
+
#
|
49
|
+
# It's not recommended for a Collector to set `service.instance.id` if it can't unambiguously determine the
|
50
|
+
# service instance that is generating that telemetry. For instance, creating an UUID based on `pod.name` will
|
51
|
+
# likely be wrong, as the Collector might not know from which container within that pod the telemetry originated.
|
52
|
+
# However, Collectors can set the `service.instance.id` if they can unambiguously determine the service instance
|
53
|
+
# for that telemetry. This is typically the case for scraping receivers, as they know the target address and
|
54
|
+
# port.
|
55
|
+
#
|
56
|
+
# @note Stability Level: development
|
57
|
+
#
|
58
|
+
# @example Sample Values
|
59
|
+
# 627cc493-f310-47de-96bd-71410b7dec09
|
60
|
+
#
|
61
|
+
SERVICE_INSTANCE_ID = 'service.instance.id'
|
62
|
+
|
63
|
+
# Logical name of the service.
|
64
|
+
#
|
65
|
+
# MUST be the same for all instances of horizontally scaled services. If the value was not specified, SDKs MUST fallback to `unknown_service:` concatenated with [`process.executable.name`](process.md), e.g. `unknown_service:bash`. If `process.executable.name` is not available, the value MUST be set to `unknown_service`.
|
66
|
+
#
|
67
|
+
# @note Stability Level: stable
|
68
|
+
#
|
69
|
+
# @example Sample Values
|
70
|
+
# shoppingcart
|
71
|
+
#
|
72
|
+
#
|
73
|
+
# @deprecated Now available in the stable namespace at {OpenTelemetry::SemConv::SERVICE::SERVICE_NAME}.
|
74
|
+
SERVICE_NAME = 'service.name'
|
75
|
+
|
76
|
+
# A namespace for `service.name`.
|
77
|
+
#
|
78
|
+
# A string value having a meaning that helps to distinguish a group of services, for example the team name that owns a group of services. `service.name` is expected to be unique within the same namespace. If `service.namespace` is not specified in the Resource then `service.name` is expected to be unique for all services that have no explicit namespace defined (so the empty/unspecified namespace is simply one more valid namespace). Zero-length namespace string is assumed equal to unspecified namespace.
|
79
|
+
#
|
80
|
+
# @note Stability Level: development
|
81
|
+
#
|
82
|
+
# @example Sample Values
|
83
|
+
# Shop
|
84
|
+
#
|
85
|
+
SERVICE_NAMESPACE = 'service.namespace'
|
86
|
+
|
87
|
+
# The version string of the service API or implementation. The format is not defined by these conventions.
|
88
|
+
#
|
89
|
+
# @note Stability Level: stable
|
90
|
+
#
|
91
|
+
# @example Sample Values
|
92
|
+
# 2.0.0
|
93
|
+
# a01dbef8a
|
94
|
+
#
|
95
|
+
#
|
96
|
+
# @deprecated Now available in the stable namespace at {OpenTelemetry::SemConv::SERVICE::SERVICE_VERSION}.
|
97
|
+
SERVICE_VERSION = 'service.version'
|
98
|
+
|
99
|
+
# @!endgroup
|
100
|
+
end
|
101
|
+
end
|
102
|
+
end
|
103
|
+
end
|