opentelemetry-semantic_conventions 1.4.0

Sign up to get free protection for your applications and to get access to all the features.
checksums.yaml ADDED
@@ -0,0 +1,7 @@
1
+ ---
2
+ SHA256:
3
+ metadata.gz: 7261c53b0d437137673f0fb895979531cd58fa578ed5e15724589529846f7666
4
+ data.tar.gz: 4a05344287b655f8a234b26b7ab3f82eee281dc87ea4691e029c5c9d89d08474
5
+ SHA512:
6
+ metadata.gz: 6319b1f937665aa42a70eb3b9ea737eb18d66576ae4c2e865b1cbcd8210742fa2be965bfb2a51c703a928d0807332749d5e66d77eb8deada62cb8cb4a68b752d
7
+ data.tar.gz: e3612d95c3a7a4614fdf994c6aaf5a50d4f6f233def10570b3b23ca2acf27e95acad595a4560adb21f3c8f80d48d2b2be50527a69dafeec3d9974788360e36ce
data/.yardopts ADDED
@@ -0,0 +1,9 @@
1
+ --no-private
2
+ --title=OpenTelemetry Semantic Conventions
3
+ --markup=markdown
4
+ --main=README.md
5
+ ./lib/opentelemetry/semantic_conventions/**/*.rb
6
+ ./lib/opentelemetry/semantic_conventions.rb
7
+ -
8
+ README.md
9
+ CHANGELOG.md
data/CHANGELOG.md ADDED
@@ -0,0 +1,5 @@
1
+ # Release History: opentelemetry-semantic_conventions
2
+
3
+ ### v1.4.0 / 2021-07-07
4
+
5
+ * Initial release.
data/LICENSE ADDED
@@ -0,0 +1,201 @@
1
+ Apache License
2
+ Version 2.0, January 2004
3
+ http://www.apache.org/licenses/
4
+
5
+ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
6
+
7
+ 1. Definitions.
8
+
9
+ "License" shall mean the terms and conditions for use, reproduction,
10
+ and distribution as defined by Sections 1 through 9 of this document.
11
+
12
+ "Licensor" shall mean the copyright owner or entity authorized by
13
+ the copyright owner that is granting the License.
14
+
15
+ "Legal Entity" shall mean the union of the acting entity and all
16
+ other entities that control, are controlled by, or are under common
17
+ control with that entity. For the purposes of this definition,
18
+ "control" means (i) the power, direct or indirect, to cause the
19
+ direction or management of such entity, whether by contract or
20
+ otherwise, or (ii) ownership of fifty percent (50%) or more of the
21
+ outstanding shares, or (iii) beneficial ownership of such entity.
22
+
23
+ "You" (or "Your") shall mean an individual or Legal Entity
24
+ exercising permissions granted by this License.
25
+
26
+ "Source" form shall mean the preferred form for making modifications,
27
+ including but not limited to software source code, documentation
28
+ source, and configuration files.
29
+
30
+ "Object" form shall mean any form resulting from mechanical
31
+ transformation or translation of a Source form, including but
32
+ not limited to compiled object code, generated documentation,
33
+ and conversions to other media types.
34
+
35
+ "Work" shall mean the work of authorship, whether in Source or
36
+ Object form, made available under the License, as indicated by a
37
+ copyright notice that is included in or attached to the work
38
+ (an example is provided in the Appendix below).
39
+
40
+ "Derivative Works" shall mean any work, whether in Source or Object
41
+ form, that is based on (or derived from) the Work and for which the
42
+ editorial revisions, annotations, elaborations, or other modifications
43
+ represent, as a whole, an original work of authorship. For the purposes
44
+ of this License, Derivative Works shall not include works that remain
45
+ separable from, or merely link (or bind by name) to the interfaces of,
46
+ the Work and Derivative Works thereof.
47
+
48
+ "Contribution" shall mean any work of authorship, including
49
+ the original version of the Work and any modifications or additions
50
+ to that Work or Derivative Works thereof, that is intentionally
51
+ submitted to Licensor for inclusion in the Work by the copyright owner
52
+ or by an individual or Legal Entity authorized to submit on behalf of
53
+ the copyright owner. For the purposes of this definition, "submitted"
54
+ means any form of electronic, verbal, or written communication sent
55
+ to the Licensor or its representatives, including but not limited to
56
+ communication on electronic mailing lists, source code control systems,
57
+ and issue tracking systems that are managed by, or on behalf of, the
58
+ Licensor for the purpose of discussing and improving the Work, but
59
+ excluding communication that is conspicuously marked or otherwise
60
+ designated in writing by the copyright owner as "Not a Contribution."
61
+
62
+ "Contributor" shall mean Licensor and any individual or Legal Entity
63
+ on behalf of whom a Contribution has been received by Licensor and
64
+ subsequently incorporated within the Work.
65
+
66
+ 2. Grant of Copyright License. Subject to the terms and conditions of
67
+ this License, each Contributor hereby grants to You a perpetual,
68
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
69
+ copyright license to reproduce, prepare Derivative Works of,
70
+ publicly display, publicly perform, sublicense, and distribute the
71
+ Work and such Derivative Works in Source or Object form.
72
+
73
+ 3. Grant of Patent License. Subject to the terms and conditions of
74
+ this License, each Contributor hereby grants to You a perpetual,
75
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
76
+ (except as stated in this section) patent license to make, have made,
77
+ use, offer to sell, sell, import, and otherwise transfer the Work,
78
+ where such license applies only to those patent claims licensable
79
+ by such Contributor that are necessarily infringed by their
80
+ Contribution(s) alone or by combination of their Contribution(s)
81
+ with the Work to which such Contribution(s) was submitted. If You
82
+ institute patent litigation against any entity (including a
83
+ cross-claim or counterclaim in a lawsuit) alleging that the Work
84
+ or a Contribution incorporated within the Work constitutes direct
85
+ or contributory patent infringement, then any patent licenses
86
+ granted to You under this License for that Work shall terminate
87
+ as of the date such litigation is filed.
88
+
89
+ 4. Redistribution. You may reproduce and distribute copies of the
90
+ Work or Derivative Works thereof in any medium, with or without
91
+ modifications, and in Source or Object form, provided that You
92
+ meet the following conditions:
93
+
94
+ (a) You must give any other recipients of the Work or
95
+ Derivative Works a copy of this License; and
96
+
97
+ (b) You must cause any modified files to carry prominent notices
98
+ stating that You changed the files; and
99
+
100
+ (c) You must retain, in the Source form of any Derivative Works
101
+ that You distribute, all copyright, patent, trademark, and
102
+ attribution notices from the Source form of the Work,
103
+ excluding those notices that do not pertain to any part of
104
+ the Derivative Works; and
105
+
106
+ (d) If the Work includes a "NOTICE" text file as part of its
107
+ distribution, then any Derivative Works that You distribute must
108
+ include a readable copy of the attribution notices contained
109
+ within such NOTICE file, excluding those notices that do not
110
+ pertain to any part of the Derivative Works, in at least one
111
+ of the following places: within a NOTICE text file distributed
112
+ as part of the Derivative Works; within the Source form or
113
+ documentation, if provided along with the Derivative Works; or,
114
+ within a display generated by the Derivative Works, if and
115
+ wherever such third-party notices normally appear. The contents
116
+ of the NOTICE file are for informational purposes only and
117
+ do not modify the License. You may add Your own attribution
118
+ notices within Derivative Works that You distribute, alongside
119
+ or as an addendum to the NOTICE text from the Work, provided
120
+ that such additional attribution notices cannot be construed
121
+ as modifying the License.
122
+
123
+ You may add Your own copyright statement to Your modifications and
124
+ may provide additional or different license terms and conditions
125
+ for use, reproduction, or distribution of Your modifications, or
126
+ for any such Derivative Works as a whole, provided Your use,
127
+ reproduction, and distribution of the Work otherwise complies with
128
+ the conditions stated in this License.
129
+
130
+ 5. Submission of Contributions. Unless You explicitly state otherwise,
131
+ any Contribution intentionally submitted for inclusion in the Work
132
+ by You to the Licensor shall be under the terms and conditions of
133
+ this License, without any additional terms or conditions.
134
+ Notwithstanding the above, nothing herein shall supersede or modify
135
+ the terms of any separate license agreement you may have executed
136
+ with Licensor regarding such Contributions.
137
+
138
+ 6. Trademarks. This License does not grant permission to use the trade
139
+ names, trademarks, service marks, or product names of the Licensor,
140
+ except as required for reasonable and customary use in describing the
141
+ origin of the Work and reproducing the content of the NOTICE file.
142
+
143
+ 7. Disclaimer of Warranty. Unless required by applicable law or
144
+ agreed to in writing, Licensor provides the Work (and each
145
+ Contributor provides its Contributions) on an "AS IS" BASIS,
146
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
147
+ implied, including, without limitation, any warranties or conditions
148
+ of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
149
+ PARTICULAR PURPOSE. You are solely responsible for determining the
150
+ appropriateness of using or redistributing the Work and assume any
151
+ risks associated with Your exercise of permissions under this License.
152
+
153
+ 8. Limitation of Liability. In no event and under no legal theory,
154
+ whether in tort (including negligence), contract, or otherwise,
155
+ unless required by applicable law (such as deliberate and grossly
156
+ negligent acts) or agreed to in writing, shall any Contributor be
157
+ liable to You for damages, including any direct, indirect, special,
158
+ incidental, or consequential damages of any character arising as a
159
+ result of this License or out of the use or inability to use the
160
+ Work (including but not limited to damages for loss of goodwill,
161
+ work stoppage, computer failure or malfunction, or any and all
162
+ other commercial damages or losses), even if such Contributor
163
+ has been advised of the possibility of such damages.
164
+
165
+ 9. Accepting Warranty or Additional Liability. While redistributing
166
+ the Work or Derivative Works thereof, You may choose to offer,
167
+ and charge a fee for, acceptance of support, warranty, indemnity,
168
+ or other liability obligations and/or rights consistent with this
169
+ License. However, in accepting such obligations, You may act only
170
+ on Your own behalf and on Your sole responsibility, not on behalf
171
+ of any other Contributor, and only if You agree to indemnify,
172
+ defend, and hold each Contributor harmless for any liability
173
+ incurred by, or claims asserted against, such Contributor by reason
174
+ of your accepting any such warranty or additional liability.
175
+
176
+ END OF TERMS AND CONDITIONS
177
+
178
+ APPENDIX: How to apply the Apache License to your work.
179
+
180
+ To apply the Apache License to your work, attach the following
181
+ boilerplate notice, with the fields enclosed by brackets "[]"
182
+ replaced with your own identifying information. (Don't include
183
+ the brackets!) The text should be enclosed in the appropriate
184
+ comment syntax for the file format. We also recommend that a
185
+ file or class name and description of purpose be included on the
186
+ same "printed page" as the copyright notice for easier
187
+ identification within third-party archives.
188
+
189
+ Copyright The OpenTelemetry Authors
190
+
191
+ Licensed under the Apache License, Version 2.0 (the "License");
192
+ you may not use this file except in compliance with the License.
193
+ You may obtain a copy of the License at
194
+
195
+ http://www.apache.org/licenses/LICENSE-2.0
196
+
197
+ Unless required by applicable law or agreed to in writing, software
198
+ distributed under the License is distributed on an "AS IS" BASIS,
199
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
200
+ See the License for the specific language governing permissions and
201
+ limitations under the License.
data/README.md ADDED
@@ -0,0 +1,48 @@
1
+ # Opentelemetry::SemanticConventions
2
+
3
+ The `opentelemetry-semantic_conventions` gem provides auto-generated constants that represent the OpenTelemetry [Semantic Conventions][semantic-conventions].
4
+
5
+ ## What is OpenTelemetry?
6
+
7
+ OpenTelemetry is an open source observability framework, providing a general-purpose API, SDK, and related tools required for the instrumentation of cloud-native software, frameworks, and libraries.
8
+
9
+ OpenTelemetry provides a single set of APIs, libraries, agents, and collector services to capture distributed traces and metrics from your application. You can analyze them using Prometheus, Jaeger, and other observability tools.
10
+
11
+ ## How does this gem fit in?
12
+
13
+ The `opentelemetry-semantic_conventions` gem provides auto-generated constants that represent the OpenTelemetry Semantic Conventions. They may be referenced in instrumentation or end-user code in place of hard-coding the names of the conventions. Because they are generated from the YAML models in the specification, they are kept up-to-date for you.
14
+
15
+ ## How do I get started?
16
+
17
+ Install the gem using:
18
+
19
+ ```
20
+ gem install opentelemetry-semantic_conventions
21
+ ```
22
+
23
+ Or, if you use Bundler, include `opentelemetry-semantic_conventions` in your `Gemfile`.
24
+
25
+ ```rb
26
+ require 'opentelemetry/semantic_conventions'
27
+
28
+ # Use the constants however you feel necessary, eg:
29
+
30
+ puts "This is the value of #{OpenTelemetry::SemanticConventions::Trace::CODE_LINENO}"
31
+ ```
32
+
33
+ ## How do I rebuild the conventions?
34
+
35
+ Bump the version number in the Rakefile, and then run `rake generate`.
36
+
37
+ ## How can I get involved?
38
+
39
+ The `opentelemetry-semantic_conventions` gem source is on github, along with related gems.
40
+
41
+ The OpenTelemetry Ruby gems are maintained by the OpenTelemetry-Ruby special interest group (SIG). You can get involved by joining us in [GitHub Discussions][discussions-url] or attending our weekly meeting. See the meeting calendar for dates and times. For more information on this and other language SIGs, see the OpenTelemetry community page.
42
+
43
+ ## License
44
+
45
+ The `opentelemetry-semantic_conventions` gem is distributed under the Apache 2.0 license. See LICENSE for more information.
46
+
47
+ [discussions-url]: https://github.com/open-telemetry/opentelemetry-ruby/discussions
48
+ [semantic-conventions]: https://github.com/open-telemetry/opentelemetry-specification/tree/main/semantic_conventions
@@ -0,0 +1,7 @@
1
+ # frozen_string_literal: true
2
+
3
+ # Copyright The OpenTelemetry Authors
4
+ #
5
+ # SPDX-License-Identifier: Apache-2.0
6
+
7
+ require_relative './opentelemetry/semantic_conventions'
@@ -0,0 +1,14 @@
1
+ # frozen_string_literal: true
2
+
3
+ # Copyright The OpenTelemetry Authors
4
+ #
5
+ # SPDX-License-Identifier: Apache-2.0
6
+
7
+ module OpenTelemetry
8
+ # Auto-generated semantic convention constants.
9
+ module SemanticConventions
10
+ end
11
+ end
12
+
13
+ require_relative './semantic_conventions/trace'
14
+ require_relative './semantic_conventions/resource'
@@ -0,0 +1,268 @@
1
+ # frozen_string_literal: true
2
+
3
+ # Copyright The OpenTelemetry Authors
4
+ #
5
+ # SPDX-License-Identifier: Apache-2.0
6
+
7
+ module OpenTelemetry
8
+ module SemanticConventions
9
+ module Resource
10
+ # Name of the cloud provider
11
+ CLOUD_PROVIDER = 'cloud.provider'
12
+
13
+ # The cloud account ID the resource is assigned to
14
+ CLOUD_ACCOUNT_ID = 'cloud.account.id'
15
+
16
+ # The geographical region the resource is running. Refer to your provider's docs to see the available regions, for example [AWS regions](https://aws.amazon.com/about-aws/global-infrastructure/regions_az/), [Azure regions](https://azure.microsoft.com/en-us/global-infrastructure/geographies/), or [Google Cloud regions](https://cloud.google.com/about/locations)
17
+ CLOUD_REGION = 'cloud.region'
18
+
19
+ # Cloud regions often have multiple, isolated locations known as zones to increase availability. Availability zone represents the zone where the resource is running
20
+ # @note Availability zones are called "zones" on Google Cloud
21
+ CLOUD_AVAILABILITY_ZONE = 'cloud.availability_zone'
22
+
23
+ # The cloud platform in use
24
+ # @note The prefix of the service SHOULD match the one specified in `cloud.provider`
25
+ CLOUD_PLATFORM = 'cloud.platform'
26
+
27
+ # The Amazon Resource Name (ARN) of an [ECS container instance](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ECS_instances.html)
28
+ AWS_ECS_CONTAINER_ARN = 'aws.ecs.container.arn'
29
+
30
+ # The ARN of an [ECS cluster](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/clusters.html)
31
+ AWS_ECS_CLUSTER_ARN = 'aws.ecs.cluster.arn'
32
+
33
+ # The [launch type](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/launch_types.html) for an ECS task
34
+ AWS_ECS_LAUNCHTYPE = 'aws.ecs.launchtype'
35
+
36
+ # The ARN of an [ECS task definition](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task_definitions.html)
37
+ AWS_ECS_TASK_ARN = 'aws.ecs.task.arn'
38
+
39
+ # The task definition family this task definition is a member of
40
+ AWS_ECS_TASK_FAMILY = 'aws.ecs.task.family'
41
+
42
+ # The revision for this task definition
43
+ AWS_ECS_TASK_REVISION = 'aws.ecs.task.revision'
44
+
45
+ # The ARN of an EKS cluster
46
+ AWS_EKS_CLUSTER_ARN = 'aws.eks.cluster.arn'
47
+
48
+ # The name(s) of the AWS log group(s) an application is writing to
49
+ # @note Multiple log groups must be supported for cases like multi-container applications, where a single application has sidecar containers, and each write to their own log group
50
+ AWS_LOG_GROUP_NAMES = 'aws.log.group.names'
51
+
52
+ # The Amazon Resource Name(s) (ARN) of the AWS log group(s)
53
+ # @note See the [log group ARN format documentation](https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/iam-access-control-overview-cwl.html#CWL_ARN_Format)
54
+ AWS_LOG_GROUP_ARNS = 'aws.log.group.arns'
55
+
56
+ # The name(s) of the AWS log stream(s) an application is writing to
57
+ AWS_LOG_STREAM_NAMES = 'aws.log.stream.names'
58
+
59
+ # The ARN(s) of the AWS log stream(s)
60
+ # @note See the [log stream ARN format documentation](https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/iam-access-control-overview-cwl.html#CWL_ARN_Format). One log group can contain several log streams, so these ARNs necessarily identify both a log group and a log stream
61
+ AWS_LOG_STREAM_ARNS = 'aws.log.stream.arns'
62
+
63
+ # Container name
64
+ CONTAINER_NAME = 'container.name'
65
+
66
+ # Container ID. Usually a UUID, as for example used to [identify Docker containers](https://docs.docker.com/engine/reference/run/#container-identification). The UUID might be abbreviated
67
+ CONTAINER_ID = 'container.id'
68
+
69
+ # The container runtime managing this container
70
+ CONTAINER_RUNTIME = 'container.runtime'
71
+
72
+ # Name of the image the container was built on
73
+ CONTAINER_IMAGE_NAME = 'container.image.name'
74
+
75
+ # Container image tag
76
+ CONTAINER_IMAGE_TAG = 'container.image.tag'
77
+
78
+ # Name of the [deployment environment](https://en.wikipedia.org/wiki/Deployment_environment) (aka deployment tier)
79
+ DEPLOYMENT_ENVIRONMENT = 'deployment.environment'
80
+
81
+ # A unique identifier representing the device
82
+ # @note The device identifier MUST only be defined using the values outlined below. This value is not an advertising identifier and MUST NOT be used as such. On iOS (Swift or Objective-C), this value MUST be equal to the [vendor identifier](https://developer.apple.com/documentation/uikit/uidevice/1620059-identifierforvendor). On Android (Java or Kotlin), this value MUST be equal to the Firebase Installation ID or a globally unique UUID which is persisted across sessions in your application. More information can be found [here](https://developer.android.com/training/articles/user-data-ids) on best practices and exact implementation details. Caution should be taken when storing personal data or anything which can identify a user. GDPR and data protection laws may apply, ensure you do your own due diligence
83
+ DEVICE_ID = 'device.id'
84
+
85
+ # The model identifier for the device
86
+ # @note It's recommended this value represents a machine readable version of the model identifier rather than the market or consumer-friendly name of the device
87
+ DEVICE_MODEL_IDENTIFIER = 'device.model.identifier'
88
+
89
+ # The marketing name for the device model
90
+ # @note It's recommended this value represents a human readable version of the device model rather than a machine readable alternative
91
+ DEVICE_MODEL_NAME = 'device.model.name'
92
+
93
+ # The name of the function being executed
94
+ FAAS_NAME = 'faas.name'
95
+
96
+ # The unique ID of the function being executed
97
+ # @note For example, in AWS Lambda this field corresponds to the [ARN](https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) value, in GCP to the URI of the resource, and in Azure to the [FunctionDirectory](https://github.com/Azure/azure-functions-host/wiki/Retrieving-information-about-the-currently-running-function) field
98
+ FAAS_ID = 'faas.id'
99
+
100
+ # The version string of the function being executed as defined in [Version Attributes](../../resource/semantic_conventions/README.md#version-attributes)
101
+ FAAS_VERSION = 'faas.version'
102
+
103
+ # The execution environment ID as a string
104
+ FAAS_INSTANCE = 'faas.instance'
105
+
106
+ # The amount of memory available to the serverless function in MiB
107
+ # @note It's recommended to set this attribute since e.g. too little memory can easily stop a Java AWS Lambda function from working correctly. On AWS Lambda, the environment variable `AWS_LAMBDA_FUNCTION_MEMORY_SIZE` provides this information
108
+ FAAS_MAX_MEMORY = 'faas.max_memory'
109
+
110
+ # Unique host ID. For Cloud, this must be the instance_id assigned by the cloud provider
111
+ HOST_ID = 'host.id'
112
+
113
+ # Name of the host. On Unix systems, it may contain what the hostname command returns, or the fully qualified hostname, or another name specified by the user
114
+ HOST_NAME = 'host.name'
115
+
116
+ # Type of host. For Cloud, this must be the machine type
117
+ HOST_TYPE = 'host.type'
118
+
119
+ # The CPU architecture the host system is running on
120
+ HOST_ARCH = 'host.arch'
121
+
122
+ # Name of the VM image or OS install the host was instantiated from
123
+ HOST_IMAGE_NAME = 'host.image.name'
124
+
125
+ # VM image ID. For Cloud, this value is from the provider
126
+ HOST_IMAGE_ID = 'host.image.id'
127
+
128
+ # The version string of the VM image as defined in [Version Attributes](README.md#version-attributes)
129
+ HOST_IMAGE_VERSION = 'host.image.version'
130
+
131
+ # The name of the cluster
132
+ K8S_CLUSTER_NAME = 'k8s.cluster.name'
133
+
134
+ # The name of the Node
135
+ K8S_NODE_NAME = 'k8s.node.name'
136
+
137
+ # The UID of the Node
138
+ K8S_NODE_UID = 'k8s.node.uid'
139
+
140
+ # The name of the namespace that the pod is running in
141
+ K8S_NAMESPACE_NAME = 'k8s.namespace.name'
142
+
143
+ # The UID of the Pod
144
+ K8S_POD_UID = 'k8s.pod.uid'
145
+
146
+ # The name of the Pod
147
+ K8S_POD_NAME = 'k8s.pod.name'
148
+
149
+ # The name of the Container in a Pod template
150
+ K8S_CONTAINER_NAME = 'k8s.container.name'
151
+
152
+ # The UID of the ReplicaSet
153
+ K8S_REPLICASET_UID = 'k8s.replicaset.uid'
154
+
155
+ # The name of the ReplicaSet
156
+ K8S_REPLICASET_NAME = 'k8s.replicaset.name'
157
+
158
+ # The UID of the Deployment
159
+ K8S_DEPLOYMENT_UID = 'k8s.deployment.uid'
160
+
161
+ # The name of the Deployment
162
+ K8S_DEPLOYMENT_NAME = 'k8s.deployment.name'
163
+
164
+ # The UID of the StatefulSet
165
+ K8S_STATEFULSET_UID = 'k8s.statefulset.uid'
166
+
167
+ # The name of the StatefulSet
168
+ K8S_STATEFULSET_NAME = 'k8s.statefulset.name'
169
+
170
+ # The UID of the DaemonSet
171
+ K8S_DAEMONSET_UID = 'k8s.daemonset.uid'
172
+
173
+ # The name of the DaemonSet
174
+ K8S_DAEMONSET_NAME = 'k8s.daemonset.name'
175
+
176
+ # The UID of the Job
177
+ K8S_JOB_UID = 'k8s.job.uid'
178
+
179
+ # The name of the Job
180
+ K8S_JOB_NAME = 'k8s.job.name'
181
+
182
+ # The UID of the CronJob
183
+ K8S_CRONJOB_UID = 'k8s.cronjob.uid'
184
+
185
+ # The name of the CronJob
186
+ K8S_CRONJOB_NAME = 'k8s.cronjob.name'
187
+
188
+ # The operating system type
189
+ OS_TYPE = 'os.type'
190
+
191
+ # Human readable (not intended to be parsed) OS version information, like e.g. reported by `ver` or `lsb_release -a` commands
192
+ OS_DESCRIPTION = 'os.description'
193
+
194
+ # Human readable operating system name
195
+ OS_NAME = 'os.name'
196
+
197
+ # The version string of the operating system as defined in [Version Attributes](../../resource/semantic_conventions/README.md#version-attributes)
198
+ OS_VERSION = 'os.version'
199
+
200
+ # Process identifier (PID)
201
+ PROCESS_PID = 'process.pid'
202
+
203
+ # The name of the process executable. On Linux based systems, can be set to the `Name` in `proc/[pid]/status`. On Windows, can be set to the base name of `GetProcessImageFileNameW`
204
+ PROCESS_EXECUTABLE_NAME = 'process.executable.name'
205
+
206
+ # The full path to the process executable. On Linux based systems, can be set to the target of `proc/[pid]/exe`. On Windows, can be set to the result of `GetProcessImageFileNameW`
207
+ PROCESS_EXECUTABLE_PATH = 'process.executable.path'
208
+
209
+ # The command used to launch the process (i.e. the command name). On Linux based systems, can be set to the zeroth string in `proc/[pid]/cmdline`. On Windows, can be set to the first parameter extracted from `GetCommandLineW`
210
+ PROCESS_COMMAND = 'process.command'
211
+
212
+ # The full command used to launch the process as a single string representing the full command. On Windows, can be set to the result of `GetCommandLineW`. Do not set this if you have to assemble it just for monitoring; use `process.command_args` instead
213
+ PROCESS_COMMAND_LINE = 'process.command_line'
214
+
215
+ # All the command arguments (including the command/executable itself) as received by the process. On Linux-based systems (and some other Unixoid systems supporting procfs), can be set according to the list of null-delimited strings extracted from `proc/[pid]/cmdline`. For libc-based executables, this would be the full argv vector passed to `main`
216
+ PROCESS_COMMAND_ARGS = 'process.command_args'
217
+
218
+ # The username of the user that owns the process
219
+ PROCESS_OWNER = 'process.owner'
220
+
221
+ # The name of the runtime of this process. For compiled native binaries, this SHOULD be the name of the compiler
222
+ PROCESS_RUNTIME_NAME = 'process.runtime.name'
223
+
224
+ # The version of the runtime of this process, as returned by the runtime without modification
225
+ PROCESS_RUNTIME_VERSION = 'process.runtime.version'
226
+
227
+ # An additional description about the runtime of the process, for example a specific vendor customization of the runtime environment
228
+ PROCESS_RUNTIME_DESCRIPTION = 'process.runtime.description'
229
+
230
+ # Logical name of the service
231
+ # @note 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#process), e.g. `unknown_service:bash`. If `process.executable.name` is not available, the value MUST be set to `unknown_service`
232
+ SERVICE_NAME = 'service.name'
233
+
234
+ # A namespace for `service.name`
235
+ # @note 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
236
+ SERVICE_NAMESPACE = 'service.namespace'
237
+
238
+ # The string ID of the service instance
239
+ # @note MUST be unique for each instance of the same `service.namespace,service.name` pair (in other words `service.namespace,service.name,service.instance.id` triplet MUST be globally unique). The ID helps to distinguish instances of the same service that exist at the same time (e.g. instances of a horizontally scaled service). It is preferable for the ID to be persistent and stay the same for the lifetime of the service instance, however it is acceptable that the ID is ephemeral and changes during important lifetime events for the service (e.g. service restarts). If the service has no inherent unique ID that can be used as the value of this attribute it is recommended to generate a random Version 1 or Version 4 RFC 4122 UUID (services aiming for reproducible UUIDs may also use Version 5, see RFC 4122 for more recommendations)
240
+ SERVICE_INSTANCE_ID = 'service.instance.id'
241
+
242
+ # The version string of the service API or implementation
243
+ SERVICE_VERSION = 'service.version'
244
+
245
+ # The name of the telemetry SDK as defined above
246
+ TELEMETRY_SDK_NAME = 'telemetry.sdk.name'
247
+
248
+ # The language of the telemetry SDK
249
+ TELEMETRY_SDK_LANGUAGE = 'telemetry.sdk.language'
250
+
251
+ # The version string of the telemetry SDK
252
+ TELEMETRY_SDK_VERSION = 'telemetry.sdk.version'
253
+
254
+ # The version string of the auto instrumentation agent, if used
255
+ TELEMETRY_AUTO_VERSION = 'telemetry.auto.version'
256
+
257
+ # The name of the web engine
258
+ WEBENGINE_NAME = 'webengine.name'
259
+
260
+ # The version of the web engine
261
+ WEBENGINE_VERSION = 'webengine.version'
262
+
263
+ # Additional description of the web engine (e.g. detailed version and edition information)
264
+ WEBENGINE_DESCRIPTION = 'webengine.description'
265
+
266
+ end
267
+ end
268
+ end
@@ -0,0 +1,393 @@
1
+ # frozen_string_literal: true
2
+
3
+ # Copyright The OpenTelemetry Authors
4
+ #
5
+ # SPDX-License-Identifier: Apache-2.0
6
+
7
+ module OpenTelemetry
8
+ module SemanticConventions
9
+ module Trace
10
+ # An identifier for the database management system (DBMS) product being used. See below for a list of well-known identifiers
11
+ DB_SYSTEM = 'db.system'
12
+
13
+ # The connection string used to connect to the database. It is recommended to remove embedded credentials
14
+ DB_CONNECTION_STRING = 'db.connection_string'
15
+
16
+ # Username for accessing the database
17
+ DB_USER = 'db.user'
18
+
19
+ # The fully-qualified class name of the [Java Database Connectivity (JDBC)](https://docs.oracle.com/javase/8/docs/technotes/guides/jdbc/) driver used to connect
20
+ DB_JDBC_DRIVER_CLASSNAME = 'db.jdbc.driver_classname'
21
+
22
+ # If no [tech-specific attribute](#call-level-attributes-for-specific-technologies) is defined, this attribute is used to report the name of the database being accessed. For commands that switch the database, this should be set to the target database (even if the command fails)
23
+ # @note In some SQL databases, the database name to be used is called "schema name"
24
+ DB_NAME = 'db.name'
25
+
26
+ # The database statement being executed
27
+ # @note The value may be sanitized to exclude sensitive information
28
+ DB_STATEMENT = 'db.statement'
29
+
30
+ # The name of the operation being executed, e.g. the [MongoDB command name](https://docs.mongodb.com/manual/reference/command/#database-operations) such as `findAndModify`, or the SQL keyword
31
+ # @note When setting this to an SQL keyword, it is not recommended to attempt any client-side parsing of `db.statement` just to get this property, but it should be set if the operation name is provided by the library being instrumented. If the SQL statement has an ambiguous operation, or performs more than one operation, this value may be omitted
32
+ DB_OPERATION = 'db.operation'
33
+
34
+ # Remote hostname or similar, see note below
35
+ NET_PEER_NAME = 'net.peer.name'
36
+
37
+ # Remote address of the peer (dotted decimal for IPv4 or [RFC5952](https://tools.ietf.org/html/rfc5952) for IPv6)
38
+ NET_PEER_IP = 'net.peer.ip'
39
+
40
+ # Remote port number
41
+ NET_PEER_PORT = 'net.peer.port'
42
+
43
+ # Transport protocol used. See note below
44
+ NET_TRANSPORT = 'net.transport'
45
+
46
+ # The Microsoft SQL Server [instance name](https://docs.microsoft.com/en-us/sql/connect/jdbc/building-the-connection-url?view=sql-server-ver15) connecting to. This name is used to determine the port of a named instance
47
+ # @note If setting a `db.mssql.instance_name`, `net.peer.port` is no longer required (but still recommended if non-standard)
48
+ DB_MSSQL_INSTANCE_NAME = 'db.mssql.instance_name'
49
+
50
+ # The name of the keyspace being accessed. To be used instead of the generic `db.name` attribute
51
+ DB_CASSANDRA_KEYSPACE = 'db.cassandra.keyspace'
52
+
53
+ # The fetch size used for paging, i.e. how many rows will be returned at once
54
+ DB_CASSANDRA_PAGE_SIZE = 'db.cassandra.page_size'
55
+
56
+ # The consistency level of the query. Based on consistency values from [CQL](https://docs.datastax.com/en/cassandra-oss/3.0/cassandra/dml/dmlConfigConsistency.html)
57
+ DB_CASSANDRA_CONSISTENCY_LEVEL = 'db.cassandra.consistency_level'
58
+
59
+ # The name of the primary table that the operation is acting upon, including the schema name (if applicable)
60
+ # @note This mirrors the db.sql.table attribute but references cassandra rather than sql. It is not recommended to attempt any client-side parsing of `db.statement` just to get this property, but it should be set if it is provided by the library being instrumented. If the operation is acting upon an anonymous table, or more than one table, this value MUST NOT be set
61
+ DB_CASSANDRA_TABLE = 'db.cassandra.table'
62
+
63
+ # Whether or not the query is idempotent
64
+ DB_CASSANDRA_IDEMPOTENCE = 'db.cassandra.idempotence'
65
+
66
+ # The number of times a query was speculatively executed. Not set or `0` if the query was not executed speculatively
67
+ DB_CASSANDRA_SPECULATIVE_EXECUTION_COUNT = 'db.cassandra.speculative_execution_count'
68
+
69
+ # The ID of the coordinating node for a query
70
+ DB_CASSANDRA_COORDINATOR_ID = 'db.cassandra.coordinator.id'
71
+
72
+ # The data center of the coordinating node for a query
73
+ DB_CASSANDRA_COORDINATOR_DC = 'db.cassandra.coordinator.dc'
74
+
75
+ # The [HBase namespace](https://hbase.apache.org/book.html#_namespace) being accessed. To be used instead of the generic `db.name` attribute
76
+ DB_HBASE_NAMESPACE = 'db.hbase.namespace'
77
+
78
+ # The index of the database being accessed as used in the [`SELECT` command](https://redis.io/commands/select), provided as an integer. To be used instead of the generic `db.name` attribute
79
+ DB_REDIS_DATABASE_INDEX = 'db.redis.database_index'
80
+
81
+ # The collection being accessed within the database stated in `db.name`
82
+ DB_MONGODB_COLLECTION = 'db.mongodb.collection'
83
+
84
+ # The name of the primary table that the operation is acting upon, including the schema name (if applicable)
85
+ # @note It is not recommended to attempt any client-side parsing of `db.statement` just to get this property, but it should be set if it is provided by the library being instrumented. If the operation is acting upon an anonymous table, or more than one table, this value MUST NOT be set
86
+ DB_SQL_TABLE = 'db.sql.table'
87
+
88
+ # The type of the exception (its fully-qualified class name, if applicable). The dynamic type of the exception should be preferred over the static type in languages that support it
89
+ EXCEPTION_TYPE = 'exception.type'
90
+
91
+ # The exception message
92
+ EXCEPTION_MESSAGE = 'exception.message'
93
+
94
+ # A stacktrace as a string in the natural representation for the language runtime. The representation is to be determined and documented by each language SIG
95
+ EXCEPTION_STACKTRACE = 'exception.stacktrace'
96
+
97
+ # SHOULD be set to true if the exception event is recorded at a point where it is known that the exception is escaping the scope of the span
98
+ # @note An exception is considered to have escaped (or left) the scope of a span,
99
+ # if that span is ended while the exception is still logically "in flight".
100
+ # This may be actually "in flight" in some languages (e.g. if the exception
101
+ # is passed to a Context manager's `__exit__` method in Python) but will
102
+ # usually be caught at the point of recording the exception in most languages.
103
+ #
104
+ # It is usually not possible to determine at the point where an exception is thrown
105
+ # whether it will escape the scope of a span.
106
+ # However, it is trivial to know that an exception
107
+ # will escape, if one checks for an active exception just before ending the span,
108
+ # as done in the [example above](#exception-end-example).
109
+ #
110
+ # It follows that an exception may still escape the scope of the span
111
+ # even if the `exception.escaped` attribute was not set or set to false,
112
+ # since the event might have been recorded at a time where it was not
113
+ # clear whether the exception will escape
114
+ EXCEPTION_ESCAPED = 'exception.escaped'
115
+
116
+ # Type of the trigger on which the function is executed
117
+ FAAS_TRIGGER = 'faas.trigger'
118
+
119
+ # The execution ID of the current function execution
120
+ FAAS_EXECUTION = 'faas.execution'
121
+
122
+ # The name of the source on which the triggering operation was performed. For example, in Cloud Storage or S3 corresponds to the bucket name, and in Cosmos DB to the database name
123
+ FAAS_DOCUMENT_COLLECTION = 'faas.document.collection'
124
+
125
+ # Describes the type of the operation that was performed on the data
126
+ FAAS_DOCUMENT_OPERATION = 'faas.document.operation'
127
+
128
+ # A string containing the time when the data was accessed in the [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format expressed in [UTC](https://www.w3.org/TR/NOTE-datetime)
129
+ FAAS_DOCUMENT_TIME = 'faas.document.time'
130
+
131
+ # The document name/table subjected to the operation. For example, in Cloud Storage or S3 is the name of the file, and in Cosmos DB the table name
132
+ FAAS_DOCUMENT_NAME = 'faas.document.name'
133
+
134
+ # HTTP request method
135
+ HTTP_METHOD = 'http.method'
136
+
137
+ # Full HTTP request URL in the form `scheme://host[:port]/path?query[#fragment]`. Usually the fragment is not transmitted over HTTP, but if it is known, it should be included nevertheless
138
+ # @note `http.url` MUST NOT contain credentials passed via URL in form of `https://username:password@www.example.com/`. In such case the attribute's value should be `https://www.example.com/`
139
+ HTTP_URL = 'http.url'
140
+
141
+ # The full request target as passed in a HTTP request line or equivalent
142
+ HTTP_TARGET = 'http.target'
143
+
144
+ # The value of the [HTTP host header](https://tools.ietf.org/html/rfc7230#section-5.4). When the header is empty or not present, this attribute should be the same
145
+ HTTP_HOST = 'http.host'
146
+
147
+ # The URI scheme identifying the used protocol
148
+ HTTP_SCHEME = 'http.scheme'
149
+
150
+ # [HTTP response status code](https://tools.ietf.org/html/rfc7231#section-6)
151
+ HTTP_STATUS_CODE = 'http.status_code'
152
+
153
+ # Kind of HTTP protocol used
154
+ # @note If `net.transport` is not specified, it can be assumed to be `IP.TCP` except if `http.flavor` is `QUIC`, in which case `IP.UDP` is assumed
155
+ HTTP_FLAVOR = 'http.flavor'
156
+
157
+ # Value of the [HTTP User-Agent](https://tools.ietf.org/html/rfc7231#section-5.5.3) header sent by the client
158
+ HTTP_USER_AGENT = 'http.user_agent'
159
+
160
+ # 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://tools.ietf.org/html/rfc7230#section-3.3.2) header. For requests using transport encoding, this should be the compressed size
161
+ HTTP_REQUEST_CONTENT_LENGTH = 'http.request_content_length'
162
+
163
+ # The size of the uncompressed request payload body after transport decoding. Not set if transport encoding not used
164
+ HTTP_REQUEST_CONTENT_LENGTH_UNCOMPRESSED = 'http.request_content_length_uncompressed'
165
+
166
+ # 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://tools.ietf.org/html/rfc7230#section-3.3.2) header. For requests using transport encoding, this should be the compressed size
167
+ HTTP_RESPONSE_CONTENT_LENGTH = 'http.response_content_length'
168
+
169
+ # The size of the uncompressed response payload body after transport decoding. Not set if transport encoding not used
170
+ HTTP_RESPONSE_CONTENT_LENGTH_UNCOMPRESSED = 'http.response_content_length_uncompressed'
171
+
172
+ # The primary server name of the matched virtual host. This should be obtained via configuration. If no such configuration can be obtained, this attribute MUST NOT be set ( `net.host.name` should be used instead)
173
+ # @note `http.url` is usually not readily available on the server side but would have to be assembled in a cumbersome and sometimes lossy process from other information (see e.g. open-telemetry/opentelemetry-python/pull/148). It is thus preferred to supply the raw data that is available
174
+ HTTP_SERVER_NAME = 'http.server_name'
175
+
176
+ # The matched route (path template)
177
+ HTTP_ROUTE = 'http.route'
178
+
179
+ # The IP address of the original client behind all proxies, if known (e.g. from [X-Forwarded-For](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/X-Forwarded-For))
180
+ # @note This is not necessarily the same as `net.peer.ip`, which would identify the network-level peer, which may be a proxy
181
+ HTTP_CLIENT_IP = 'http.client_ip'
182
+
183
+ # Like `net.peer.ip` but for the host IP. Useful in case of a multi-IP host
184
+ NET_HOST_IP = 'net.host.ip'
185
+
186
+ # Like `net.peer.port` but for the host port
187
+ NET_HOST_PORT = 'net.host.port'
188
+
189
+ # Local hostname or similar, see note below
190
+ NET_HOST_NAME = 'net.host.name'
191
+
192
+ # A string identifying the messaging system
193
+ MESSAGING_SYSTEM = 'messaging.system'
194
+
195
+ # The message destination name. This might be equal to the span name but is required nevertheless
196
+ MESSAGING_DESTINATION = 'messaging.destination'
197
+
198
+ # The kind of message destination
199
+ MESSAGING_DESTINATION_KIND = 'messaging.destination_kind'
200
+
201
+ # A boolean that is true if the message destination is temporary
202
+ MESSAGING_TEMP_DESTINATION = 'messaging.temp_destination'
203
+
204
+ # The name of the transport protocol
205
+ MESSAGING_PROTOCOL = 'messaging.protocol'
206
+
207
+ # The version of the transport protocol
208
+ MESSAGING_PROTOCOL_VERSION = 'messaging.protocol_version'
209
+
210
+ # Connection string
211
+ MESSAGING_URL = 'messaging.url'
212
+
213
+ # A value used by the messaging system as an identifier for the message, represented as a string
214
+ MESSAGING_MESSAGE_ID = 'messaging.message_id'
215
+
216
+ # The [conversation ID](#conversations) identifying the conversation to which the message belongs, represented as a string. Sometimes called "Correlation ID"
217
+ MESSAGING_CONVERSATION_ID = 'messaging.conversation_id'
218
+
219
+ # The (uncompressed) size of the message payload in bytes. Also use this attribute if it is unknown whether the compressed or uncompressed payload size is reported
220
+ MESSAGING_MESSAGE_PAYLOAD_SIZE_BYTES = 'messaging.message_payload_size_bytes'
221
+
222
+ # The compressed size of the message payload in bytes
223
+ MESSAGING_MESSAGE_PAYLOAD_COMPRESSED_SIZE_BYTES = 'messaging.message_payload_compressed_size_bytes'
224
+
225
+ # A string containing the function invocation time in the [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format expressed in [UTC](https://www.w3.org/TR/NOTE-datetime)
226
+ FAAS_TIME = 'faas.time'
227
+
228
+ # A string containing the schedule period as [Cron Expression](https://docs.oracle.com/cd/E12058_01/doc/doc.1014/e12030/cron_expressions.htm)
229
+ FAAS_CRON = 'faas.cron'
230
+
231
+ # A boolean that is true if the serverless function is executed for the first time (aka cold-start)
232
+ FAAS_COLDSTART = 'faas.coldstart'
233
+
234
+ # The name of the invoked function
235
+ # @note SHOULD be equal to the `faas.name` resource attribute of the invoked function
236
+ FAAS_INVOKED_NAME = 'faas.invoked_name'
237
+
238
+ # The cloud provider of the invoked function
239
+ # @note SHOULD be equal to the `cloud.provider` resource attribute of the invoked function
240
+ FAAS_INVOKED_PROVIDER = 'faas.invoked_provider'
241
+
242
+ # The cloud region of the invoked function
243
+ # @note SHOULD be equal to the `cloud.region` resource attribute of the invoked function
244
+ FAAS_INVOKED_REGION = 'faas.invoked_region'
245
+
246
+ # The [`service.name`](../../resource/semantic_conventions/README.md#service) of the remote service. SHOULD be equal to the actual `service.name` resource attribute of the remote service if any
247
+ PEER_SERVICE = 'peer.service'
248
+
249
+ # Username or client_id extracted from the access token or [Authorization](https://tools.ietf.org/html/rfc7235#section-4.2) header in the inbound request from outside the system
250
+ ENDUSER_ID = 'enduser.id'
251
+
252
+ # Actual/assumed role the client is making the request under extracted from token or application security context
253
+ ENDUSER_ROLE = 'enduser.role'
254
+
255
+ # Scopes or granted authorities the client currently possesses extracted from token or application security context. The value would come from the scope associated with an [OAuth 2.0 Access Token](https://tools.ietf.org/html/rfc6749#section-3.3) or an attribute value in a [SAML 2.0 Assertion](http://docs.oasis-open.org/security/saml/Post2.0/sstc-saml-tech-overview-2.0.html)
256
+ ENDUSER_SCOPE = 'enduser.scope'
257
+
258
+ # Current "managed" thread ID (as opposed to OS thread ID)
259
+ THREAD_ID = 'thread.id'
260
+
261
+ # Current thread name
262
+ THREAD_NAME = 'thread.name'
263
+
264
+ # The method or function name, or equivalent (usually rightmost part of the code unit's name)
265
+ CODE_FUNCTION = 'code.function'
266
+
267
+ # The "namespace" within which `code.function` is defined. Usually the qualified class or module name, such that `code.namespace` + some separator + `code.function` form a unique identifier for the code unit
268
+ CODE_NAMESPACE = 'code.namespace'
269
+
270
+ # The source code file name that identifies the code unit as uniquely as possible (preferably an absolute file path)
271
+ CODE_FILEPATH = 'code.filepath'
272
+
273
+ # The line number in `code.filepath` best representing the operation. It SHOULD point within the code unit named in `code.function`
274
+ CODE_LINENO = 'code.lineno'
275
+
276
+ # The value `aws-api`
277
+ RPC_SYSTEM = 'rpc.system'
278
+
279
+ # The name of the service to which a request is made, as returned by the AWS SDK
280
+ RPC_SERVICE = 'rpc.service'
281
+
282
+ # The name of the operation corresponding to the request, as returned by the AWS SDK
283
+ RPC_METHOD = 'rpc.method'
284
+
285
+ # The keys in the `RequestItems` object field
286
+ AWS_DYNAMODB_TABLE_NAMES = 'aws.dynamodb.table_names'
287
+
288
+ # The JSON-serialized value of each item in the `ConsumedCapacity` response field
289
+ AWS_DYNAMODB_CONSUMED_CAPACITY = 'aws.dynamodb.consumed_capacity'
290
+
291
+ # The JSON-serialized value of the `ItemCollectionMetrics` response field
292
+ AWS_DYNAMODB_ITEM_COLLECTION_METRICS = 'aws.dynamodb.item_collection_metrics'
293
+
294
+ # The value of the `ProvisionedThroughput.ReadCapacityUnits` request parameter
295
+ AWS_DYNAMODB_PROVISIONED_READ_CAPACITY = 'aws.dynamodb.provisioned_read_capacity'
296
+
297
+ # The value of the `ProvisionedThroughput.WriteCapacityUnits` request parameter
298
+ AWS_DYNAMODB_PROVISIONED_WRITE_CAPACITY = 'aws.dynamodb.provisioned_write_capacity'
299
+
300
+ # The value of the `ConsistentRead` request parameter
301
+ AWS_DYNAMODB_CONSISTENT_READ = 'aws.dynamodb.consistent_read'
302
+
303
+ # The value of the `ProjectionExpression` request parameter
304
+ AWS_DYNAMODB_PROJECTION = 'aws.dynamodb.projection'
305
+
306
+ # The value of the `Limit` request parameter
307
+ AWS_DYNAMODB_LIMIT = 'aws.dynamodb.limit'
308
+
309
+ # The value of the `AttributesToGet` request parameter
310
+ AWS_DYNAMODB_ATTRIBUTES_TO_GET = 'aws.dynamodb.attributes_to_get'
311
+
312
+ # The value of the `IndexName` request parameter
313
+ AWS_DYNAMODB_INDEX_NAME = 'aws.dynamodb.index_name'
314
+
315
+ # The value of the `Select` request parameter
316
+ AWS_DYNAMODB_SELECT = 'aws.dynamodb.select'
317
+
318
+ # The JSON-serialized value of each item of the `GlobalSecondaryIndexes` request field
319
+ AWS_DYNAMODB_GLOBAL_SECONDARY_INDEXES = 'aws.dynamodb.global_secondary_indexes'
320
+
321
+ # The JSON-serialized value of each item of the `LocalSecondaryIndexes` request field
322
+ AWS_DYNAMODB_LOCAL_SECONDARY_INDEXES = 'aws.dynamodb.local_secondary_indexes'
323
+
324
+ # The value of the `ExclusiveStartTableName` request parameter
325
+ AWS_DYNAMODB_EXCLUSIVE_START_TABLE = 'aws.dynamodb.exclusive_start_table'
326
+
327
+ # The the number of items in the `TableNames` response parameter
328
+ AWS_DYNAMODB_TABLE_COUNT = 'aws.dynamodb.table_count'
329
+
330
+ # The value of the `ScanIndexForward` request parameter
331
+ AWS_DYNAMODB_SCAN_FORWARD = 'aws.dynamodb.scan_forward'
332
+
333
+ # The value of the `Segment` request parameter
334
+ AWS_DYNAMODB_SEGMENT = 'aws.dynamodb.segment'
335
+
336
+ # The value of the `TotalSegments` request parameter
337
+ AWS_DYNAMODB_TOTAL_SEGMENTS = 'aws.dynamodb.total_segments'
338
+
339
+ # The value of the `Count` response parameter
340
+ AWS_DYNAMODB_COUNT = 'aws.dynamodb.count'
341
+
342
+ # The value of the `ScannedCount` response parameter
343
+ AWS_DYNAMODB_SCANNED_COUNT = 'aws.dynamodb.scanned_count'
344
+
345
+ # The JSON-serialized value of each item in the `AttributeDefinitions` request field
346
+ AWS_DYNAMODB_ATTRIBUTE_DEFINITIONS = 'aws.dynamodb.attribute_definitions'
347
+
348
+ # The JSON-serialized value of each item in the the `GlobalSecondaryIndexUpdates` request field
349
+ AWS_DYNAMODB_GLOBAL_SECONDARY_INDEX_UPDATES = 'aws.dynamodb.global_secondary_index_updates'
350
+
351
+ # A string identifying the kind of message consumption as defined in the [Operation names](#operation-names) section above. If the operation is "send", this attribute MUST NOT be set, since the operation can be inferred from the span kind in that case
352
+ MESSAGING_OPERATION = 'messaging.operation'
353
+
354
+ # RabbitMQ message routing key
355
+ MESSAGING_RABBITMQ_ROUTING_KEY = 'messaging.rabbitmq.routing_key'
356
+
357
+ # Message keys in Kafka are used for grouping alike messages to ensure they're processed on the same partition. They differ from `messaging.message_id` in that they're not unique. If the key is `null`, the attribute MUST NOT be set
358
+ # @note If the key type is not string, it's string representation has to be supplied for the attribute. If the key has no unambiguous, canonical string form, don't include its value
359
+ MESSAGING_KAFKA_MESSAGE_KEY = 'messaging.kafka.message_key'
360
+
361
+ # Name of the Kafka Consumer Group that is handling the message. Only applies to consumers, not producers
362
+ MESSAGING_KAFKA_CONSUMER_GROUP = 'messaging.kafka.consumer_group'
363
+
364
+ # Client Id for the Consumer or Producer that is handling the message
365
+ MESSAGING_KAFKA_CLIENT_ID = 'messaging.kafka.client_id'
366
+
367
+ # Partition the message is sent to
368
+ MESSAGING_KAFKA_PARTITION = 'messaging.kafka.partition'
369
+
370
+ # A boolean that is true if the message is a tombstone
371
+ MESSAGING_KAFKA_TOMBSTONE = 'messaging.kafka.tombstone'
372
+
373
+ # The [numeric status code](https://github.com/grpc/grpc/blob/v1.33.2/doc/statuscodes.md) of the gRPC request
374
+ RPC_GRPC_STATUS_CODE = 'rpc.grpc.status_code'
375
+
376
+ # Protocol version as in `jsonrpc` property of request/response. Since JSON-RPC 1.0 does not specify this, the value can be omitted
377
+ RPC_JSONRPC_VERSION = 'rpc.jsonrpc.version'
378
+
379
+ # `method` property from request. Unlike `rpc.method`, this may not relate to the actual method being called. Useful for client-side traces since client does not know what will be called on the server
380
+ RPC_JSONRPC_METHOD = 'rpc.jsonrpc.method'
381
+
382
+ # `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
383
+ RPC_JSONRPC_REQUEST_ID = 'rpc.jsonrpc.request_id'
384
+
385
+ # `error.code` property of response if it is an error response
386
+ RPC_JSONRPC_ERROR_CODE = 'rpc.jsonrpc.error_code'
387
+
388
+ # `error.message` property of response if it is an error response
389
+ RPC_JSONRPC_ERROR_MESSAGE = 'rpc.jsonrpc.error_message'
390
+
391
+ end
392
+ end
393
+ end
@@ -0,0 +1,11 @@
1
+ # frozen_string_literal: true
2
+
3
+ # Copyright The OpenTelemetry Authors
4
+ #
5
+ # SPDX-License-Identifier: Apache-2.0
6
+
7
+ module OpenTelemetry
8
+ module SemanticConventions
9
+ VERSION = '1.4.0'
10
+ end
11
+ end
metadata ADDED
@@ -0,0 +1,168 @@
1
+ --- !ruby/object:Gem::Specification
2
+ name: opentelemetry-semantic_conventions
3
+ version: !ruby/object:Gem::Version
4
+ version: 1.4.0
5
+ platform: ruby
6
+ authors:
7
+ - OpenTelemetry Authors
8
+ autorequire:
9
+ bindir: bin
10
+ cert_chain: []
11
+ date: 2021-07-07 00:00:00.000000000 Z
12
+ dependencies:
13
+ - !ruby/object:Gem::Dependency
14
+ name: opentelemetry-api
15
+ requirement: !ruby/object:Gem::Requirement
16
+ requirements:
17
+ - - "~>"
18
+ - !ruby/object:Gem::Version
19
+ version: 1.0.0.rc2
20
+ type: :runtime
21
+ prerelease: false
22
+ version_requirements: !ruby/object:Gem::Requirement
23
+ requirements:
24
+ - - "~>"
25
+ - !ruby/object:Gem::Version
26
+ version: 1.0.0.rc2
27
+ - !ruby/object:Gem::Dependency
28
+ name: bundler
29
+ requirement: !ruby/object:Gem::Requirement
30
+ requirements:
31
+ - - ">="
32
+ - !ruby/object:Gem::Version
33
+ version: '1.17'
34
+ type: :development
35
+ prerelease: false
36
+ version_requirements: !ruby/object:Gem::Requirement
37
+ requirements:
38
+ - - ">="
39
+ - !ruby/object:Gem::Version
40
+ version: '1.17'
41
+ - !ruby/object:Gem::Dependency
42
+ name: minitest
43
+ requirement: !ruby/object:Gem::Requirement
44
+ requirements:
45
+ - - "~>"
46
+ - !ruby/object:Gem::Version
47
+ version: '5.0'
48
+ type: :development
49
+ prerelease: false
50
+ version_requirements: !ruby/object:Gem::Requirement
51
+ requirements:
52
+ - - "~>"
53
+ - !ruby/object:Gem::Version
54
+ version: '5.0'
55
+ - !ruby/object:Gem::Dependency
56
+ name: rake
57
+ requirement: !ruby/object:Gem::Requirement
58
+ requirements:
59
+ - - "~>"
60
+ - !ruby/object:Gem::Version
61
+ version: '12.0'
62
+ type: :development
63
+ prerelease: false
64
+ version_requirements: !ruby/object:Gem::Requirement
65
+ requirements:
66
+ - - "~>"
67
+ - !ruby/object:Gem::Version
68
+ version: '12.0'
69
+ - !ruby/object:Gem::Dependency
70
+ name: rubocop
71
+ requirement: !ruby/object:Gem::Requirement
72
+ requirements:
73
+ - - "~>"
74
+ - !ruby/object:Gem::Version
75
+ version: 0.73.0
76
+ type: :development
77
+ prerelease: false
78
+ version_requirements: !ruby/object:Gem::Requirement
79
+ requirements:
80
+ - - "~>"
81
+ - !ruby/object:Gem::Version
82
+ version: 0.73.0
83
+ - !ruby/object:Gem::Dependency
84
+ name: simplecov
85
+ requirement: !ruby/object:Gem::Requirement
86
+ requirements:
87
+ - - "~>"
88
+ - !ruby/object:Gem::Version
89
+ version: '0.17'
90
+ type: :development
91
+ prerelease: false
92
+ version_requirements: !ruby/object:Gem::Requirement
93
+ requirements:
94
+ - - "~>"
95
+ - !ruby/object:Gem::Version
96
+ version: '0.17'
97
+ - !ruby/object:Gem::Dependency
98
+ name: yard
99
+ requirement: !ruby/object:Gem::Requirement
100
+ requirements:
101
+ - - "~>"
102
+ - !ruby/object:Gem::Version
103
+ version: '0.9'
104
+ type: :development
105
+ prerelease: false
106
+ version_requirements: !ruby/object:Gem::Requirement
107
+ requirements:
108
+ - - "~>"
109
+ - !ruby/object:Gem::Version
110
+ version: '0.9'
111
+ - !ruby/object:Gem::Dependency
112
+ name: yard-doctest
113
+ requirement: !ruby/object:Gem::Requirement
114
+ requirements:
115
+ - - "~>"
116
+ - !ruby/object:Gem::Version
117
+ version: 0.1.6
118
+ type: :development
119
+ prerelease: false
120
+ version_requirements: !ruby/object:Gem::Requirement
121
+ requirements:
122
+ - - "~>"
123
+ - !ruby/object:Gem::Version
124
+ version: 0.1.6
125
+ description: Semantic Convention definitions for OpenTelemetry
126
+ email:
127
+ - cncf-opentelemetry-contributors@lists.cncf.io
128
+ executables: []
129
+ extensions: []
130
+ extra_rdoc_files: []
131
+ files:
132
+ - ".yardopts"
133
+ - CHANGELOG.md
134
+ - LICENSE
135
+ - README.md
136
+ - lib/opentelemetry-semantic_conventions.rb
137
+ - lib/opentelemetry/semantic_conventions.rb
138
+ - lib/opentelemetry/semantic_conventions/resource.rb
139
+ - lib/opentelemetry/semantic_conventions/trace.rb
140
+ - lib/opentelemetry/semantic_conventions/version.rb
141
+ homepage: https://github.com/open-telemetry/opentelemetry-ruby
142
+ licenses:
143
+ - Apache-2.0
144
+ metadata:
145
+ changelog_uri: https://open-telemetry.github.io/opentelemetry-ruby/opentelemetry-semantic_conventions/v1.4.0/file.CHANGELOG.html
146
+ source_code_uri: https://github.com/open-telemetry/opentelemetry-ruby/tree/main/semantic_conventions
147
+ bug_tracker_uri: https://github.com/open-telemetry/opentelemetry-ruby/issues
148
+ documentation_uri: https://open-telemetry.github.io/opentelemetry-ruby/opentelemetry-semantic_conventions/v1.4.0
149
+ post_install_message:
150
+ rdoc_options: []
151
+ require_paths:
152
+ - lib
153
+ required_ruby_version: !ruby/object:Gem::Requirement
154
+ requirements:
155
+ - - ">="
156
+ - !ruby/object:Gem::Version
157
+ version: 2.5.0
158
+ required_rubygems_version: !ruby/object:Gem::Requirement
159
+ requirements:
160
+ - - ">="
161
+ - !ruby/object:Gem::Version
162
+ version: '0'
163
+ requirements: []
164
+ rubygems_version: 3.1.6
165
+ signing_key:
166
+ specification_version: 4
167
+ summary: Semantic Convention definitions for OpenTelemetry
168
+ test_files: []