opentelemetry-semantic_conventions 1.11.0 → 1.36.0

data/lib/opentelemetry/semconv/incubating/url/attributes.rb

@@ -0,0 +1,225 @@
+# frozen_string_literal: true
+
+# Copyright The OpenTelemetry Authors
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+# SPDX-License-Identifier: Apache-2.0
+#
+# This file was autogenerated. Do not edit it by hand.
+
+module OpenTelemetry
+  module SemConv
+    module Incubating
+      module URL
+        # @!group Attribute Names
+      
+        # Domain extracted from the `url.full`, such as "opentelemetry.io".
+        #
+        # In some cases a URL may refer to an IP and/or port directly, without a domain name. In this case, the IP address would go to the domain field. If the URL contains a [literal IPv6 address](https://www.rfc-editor.org/rfc/rfc2732#section-2) enclosed by `[` and `]`, the `[` and `]` characters should also be captured in the domain field.
+        #
+        # @note Stability Level: development
+        #
+        # @example Sample Values
+        #   www.foo.bar
+        #   opentelemetry.io
+        #   3.12.167.2
+        #   [1080:0:0:0:8:800:200C:417A]
+        #
+        URL_DOMAIN = 'url.domain'
+    
+        # The file extension extracted from the `url.full`, excluding the leading dot.
+        #
+        # The file extension is only set if it exists, as not every url has a file extension. When the file name has multiple extensions `example.tar.gz`, only the last one should be captured `gz`, not `tar.gz`.
+        #
+        # @note Stability Level: development
+        #
+        # @example Sample Values
+        #   png
+        #   gz
+        #
+        URL_EXTENSION = 'url.extension'
+    
+        # The [URI fragment](https://www.rfc-editor.org/rfc/rfc3986#section-3.5) component
+        #
+        # @note Stability Level: stable
+        #
+        # @example Sample Values
+        #   SemConv
+        #
+        #
+        # @deprecated Now available in the stable namespace at {OpenTelemetry::SemConv::URL::URL_FRAGMENT}.
+        URL_FRAGMENT = 'url.fragment'
+    
+        # Absolute URL describing a network resource according to [RFC3986](https://www.rfc-editor.org/rfc/rfc3986)
+        #
+        # For network calls, URL usually has `scheme://host[:port][path][?query][#fragment]` format, where the fragment
+        # is not transmitted over HTTP, but if it is known, it SHOULD be included nevertheless.
+        #
+        # `url.full` MUST NOT contain credentials passed via URL in form of `https://username:password@www.example.com/`.
+        # In such case username and password SHOULD be redacted and attribute's value SHOULD be `https://REDACTED:REDACTED@www.example.com/`.
+        #
+        # `url.full` SHOULD capture the absolute URL when it is available (or can be reconstructed).
+        #
+        # Sensitive content provided in `url.full` SHOULD be scrubbed when instrumentations can identify it.
+        #
+        #
+        # Query string values for the following keys SHOULD be redacted by default and replaced by the
+        # value `REDACTED`:
+        #
+        # - [`AWSAccessKeyId`](https://docs.aws.amazon.com/AmazonS3/latest/userguide/RESTAuthentication.html#RESTAuthenticationQueryStringAuth)
+        # - [`Signature`](https://docs.aws.amazon.com/AmazonS3/latest/userguide/RESTAuthentication.html#RESTAuthenticationQueryStringAuth)
+        # - [`sig`](https://learn.microsoft.com/azure/storage/common/storage-sas-overview#sas-token)
+        # - [`X-Goog-Signature`](https://cloud.google.com/storage/docs/access-control/signed-urls)
+        #
+        # This list is subject to change over time.
+        #
+        # When a query string value is redacted, the query string key SHOULD still be preserved, e.g.
+        # `https://www.example.com/path?color=blue&sig=REDACTED`.
+        #
+        # @note Stability Level: stable
+        #
+        # @example Sample Values
+        #   https://www.foo.bar/search?q=OpenTelemetry#SemConv
+        #   //localhost
+        #
+        #
+        # @deprecated Now available in the stable namespace at {OpenTelemetry::SemConv::URL::URL_FULL}.
+        URL_FULL = 'url.full'
+    
+        # Unmodified original URL as seen in the event source.
+        #
+        # In network monitoring, the observed URL may be a full URL, whereas in access logs, the URL is often just represented as a path. This field is meant to represent the URL as it was observed, complete or not.
+        # `url.original` might contain credentials passed via URL in form of `https://username:password@www.example.com/`. In such case password and username SHOULD NOT be redacted and attribute's value SHOULD remain the same.
+        #
+        # @note Stability Level: development
+        #
+        # @example Sample Values
+        #   https://www.foo.bar/search?q=OpenTelemetry#SemConv
+        #   search?q=OpenTelemetry
+        #
+        URL_ORIGINAL = 'url.original'
+    
+        # The [URI path](https://www.rfc-editor.org/rfc/rfc3986#section-3.3) component
+        #
+        # Sensitive content provided in `url.path` SHOULD be scrubbed when instrumentations can identify it.
+        #
+        # @note Stability Level: stable
+        #
+        # @example Sample Values
+        #   /search
+        #
+        #
+        # @deprecated Now available in the stable namespace at {OpenTelemetry::SemConv::URL::URL_PATH}.
+        URL_PATH = 'url.path'
+    
+        # Port extracted from the `url.full`
+        #
+        # @note Stability Level: development
+        #
+        # @example Sample Values
+        #   443
+        #
+        URL_PORT = 'url.port'
+    
+        # The [URI query](https://www.rfc-editor.org/rfc/rfc3986#section-3.4) component
+        #
+        # Sensitive content provided in `url.query` SHOULD be scrubbed when instrumentations can identify it.
+        #
+        #
+        # Query string values for the following keys SHOULD be redacted by default and replaced by the value `REDACTED`:
+        #
+        # - [`AWSAccessKeyId`](https://docs.aws.amazon.com/AmazonS3/latest/userguide/RESTAuthentication.html#RESTAuthenticationQueryStringAuth)
+        # - [`Signature`](https://docs.aws.amazon.com/AmazonS3/latest/userguide/RESTAuthentication.html#RESTAuthenticationQueryStringAuth)
+        # - [`sig`](https://learn.microsoft.com/azure/storage/common/storage-sas-overview#sas-token)
+        # - [`X-Goog-Signature`](https://cloud.google.com/storage/docs/access-control/signed-urls)
+        #
+        # This list is subject to change over time.
+        #
+        # When a query string value is redacted, the query string key SHOULD still be preserved, e.g.
+        # `q=OpenTelemetry&sig=REDACTED`.
+        #
+        # @note Stability Level: stable
+        #
+        # @example Sample Values
+        #   q=OpenTelemetry
+        #
+        #
+        # @deprecated Now available in the stable namespace at {OpenTelemetry::SemConv::URL::URL_QUERY}.
+        URL_QUERY = 'url.query'
+    
+        # The highest registered url domain, stripped of the subdomain.
+        #
+        # This value can be determined precisely with the [public suffix list](https://publicsuffix.org/). For example, the registered domain for `foo.example.com` is `example.com`. Trying to approximate this by simply taking the last two labels will not work well for TLDs such as `co.uk`.
+        #
+        # @note Stability Level: development
+        #
+        # @example Sample Values
+        #   example.com
+        #   foo.co.uk
+        #
+        URL_REGISTERED_DOMAIN = 'url.registered_domain'
+    
+        # The [URI scheme](https://www.rfc-editor.org/rfc/rfc3986#section-3.1) component identifying the used protocol.
+        #
+        # @note Stability Level: stable
+        #
+        # @example Sample Values
+        #   https
+        #   ftp
+        #   telnet
+        #
+        #
+        # @deprecated Now available in the stable namespace at {OpenTelemetry::SemConv::URL::URL_SCHEME}.
+        URL_SCHEME = 'url.scheme'
+    
+        # The subdomain portion of a fully qualified domain name includes all of the names except the host name under the registered_domain. In a partially qualified domain, or if the qualification level of the full name cannot be determined, subdomain contains all of the names below the registered domain.
+        #
+        # The subdomain portion of `www.east.mydomain.co.uk` is `east`. If the domain has multiple levels of subdomain, such as `sub2.sub1.example.com`, the subdomain field should contain `sub2.sub1`, with no trailing period.
+        #
+        # @note Stability Level: development
+        #
+        # @example Sample Values
+        #   east
+        #   sub2.sub1
+        #
+        URL_SUBDOMAIN = 'url.subdomain'
+    
+        # The low-cardinality template of an [absolute path reference](https://www.rfc-editor.org/rfc/rfc3986#section-4.2).
+        #
+        # @note Stability Level: development
+        #
+        # @example Sample Values
+        #   /users/{id}
+        #   /users/:id
+        #   /users?id={id}
+        #
+        URL_TEMPLATE = 'url.template'
+    
+        # The effective top level domain (eTLD), also known as the domain suffix, is the last part of the domain name. For example, the top level domain for example.com is `com`.
+        #
+        # This value can be determined precisely with the [public suffix list](https://publicsuffix.org/).
+        #
+        # @note Stability Level: development
+        #
+        # @example Sample Values
+        #   com
+        #   co.uk
+        #
+        URL_TOP_LEVEL_DOMAIN = 'url.top_level_domain'
+    
+        # @!endgroup
+      end
+    end
+  end
+end

data/lib/opentelemetry/semconv/incubating/url.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+# Copyright The OpenTelemetry Authors
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+# SPDX-License-Identifier: Apache-2.0
+
+# This file was autogenerated. Do not edit it by hand.
+
+require_relative 'url/attributes'

data/lib/opentelemetry/semconv/incubating/user/attributes.rb

@@ -0,0 +1,87 @@
+# frozen_string_literal: true
+
+# Copyright The OpenTelemetry Authors
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+# SPDX-License-Identifier: Apache-2.0
+#
+# This file was autogenerated. Do not edit it by hand.
+
+module OpenTelemetry
+  module SemConv
+    module Incubating
+      module USER
+        # @!group Attribute Names
+      
+        # User email address.
+        #
+        # @note Stability Level: development
+        #
+        # @example Sample Values
+        #   a.einstein@example.com
+        #
+        USER_EMAIL = 'user.email'
+    
+        # User's full name
+        #
+        # @note Stability Level: development
+        #
+        # @example Sample Values
+        #   Albert Einstein
+        #
+        USER_FULL_NAME = 'user.full_name'
+    
+        # Unique user hash to correlate information for a user in anonymized form.
+        #
+        # Useful if `user.id` or `user.name` contain confidential information and cannot be used.
+        #
+        # @note Stability Level: development
+        #
+        # @example Sample Values
+        #   364fc68eaf4c8acec74a4e52d7d1feaa
+        #
+        USER_HASH = 'user.hash'
+    
+        # Unique identifier of the user.
+        #
+        # @note Stability Level: development
+        #
+        # @example Sample Values
+        #   S-1-5-21-202424912787-2692429404-2351956786-1000
+        #
+        USER_ID = 'user.id'
+    
+        # Short name or login/username of the user.
+        #
+        # @note Stability Level: development
+        #
+        # @example Sample Values
+        #   a.einstein
+        #
+        USER_NAME = 'user.name'
+    
+        # Array of user roles at the time of the event.
+        #
+        # @note Stability Level: development
+        #
+        # @example Sample Values
+        #   ["admin", "reporting_user"]
+        #
+        USER_ROLES = 'user.roles'
+    
+        # @!endgroup
+      end
+    end
+  end
+end

data/lib/opentelemetry/semconv/incubating/user.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+# Copyright The OpenTelemetry Authors
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+# SPDX-License-Identifier: Apache-2.0
+
+# This file was autogenerated. Do not edit it by hand.
+
+require_relative 'user/attributes'

data/lib/opentelemetry/semconv/incubating/user_agent/attributes.rb

@@ -0,0 +1,100 @@
+# frozen_string_literal: true
+
+# Copyright The OpenTelemetry Authors
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+# SPDX-License-Identifier: Apache-2.0
+#
+# This file was autogenerated. Do not edit it by hand.
+
+module OpenTelemetry
+  module SemConv
+    module Incubating
+      module USER_AGENT
+        # @!group Attribute Names
+      
+        # Name of the user-agent extracted from original. Usually refers to the browser's name.
+        #
+        # [Example](https://www.whatsmyua.info) of extracting browser's name from original string. In the case of using a user-agent for non-browser products, such as microservices with multiple names/versions inside the `user_agent.original`, the most significant name SHOULD be selected. In such a scenario it should align with `user_agent.version`
+        #
+        # @note Stability Level: development
+        #
+        # @example Sample Values
+        #   Safari
+        #   YourApp
+        #
+        USER_AGENT_NAME = 'user_agent.name'
+    
+        # Value of the [HTTP User-Agent](https://www.rfc-editor.org/rfc/rfc9110.html#field.user-agent) header sent by the client.
+        #
+        # @note Stability Level: stable
+        #
+        # @example Sample Values
+        #   CERN-LineMode/2.15 libwww/2.17b3
+        #   Mozilla/5.0 (iPhone; CPU iPhone OS 14_7_1 like Mac OS X) AppleWebKit/605.1.15 (KHTML, like Gecko) Version/14.1.2 Mobile/15E148 Safari/604.1
+        #   YourApp/1.0.0 grpc-java-okhttp/1.27.2
+        #
+        #
+        # @deprecated Now available in the stable namespace at {OpenTelemetry::SemConv::USER_AGENT::USER_AGENT_ORIGINAL}.
+        USER_AGENT_ORIGINAL = 'user_agent.original'
+    
+        # Human readable operating system name.
+        #
+        # For mapping user agent strings to OS names, libraries such as [ua-parser](https://github.com/ua-parser) can be utilized.
+        #
+        # @note Stability Level: development
+        #
+        # @example Sample Values
+        #   iOS
+        #   Android
+        #   Ubuntu
+        #
+        USER_AGENT_OS_NAME = 'user_agent.os.name'
+    
+        # The version string of the operating system as defined in [Version Attributes](/docs/resource/README.md#version-attributes).
+        #
+        # For mapping user agent strings to OS versions, libraries such as [ua-parser](https://github.com/ua-parser) can be utilized.
+        #
+        # @note Stability Level: development
+        #
+        # @example Sample Values
+        #   14.2.1
+        #   18.04.1
+        #
+        USER_AGENT_OS_VERSION = 'user_agent.os.version'
+    
+        # Specifies the category of synthetic traffic, such as tests or bots.
+        #
+        # This attribute MAY be derived from the contents of the `user_agent.original` attribute. Components that populate the attribute are responsible for determining what they consider to be synthetic bot or test traffic. This attribute can either be set for self-identification purposes, or on telemetry detected to be generated as a result of a synthetic request. This attribute is useful for distinguishing between genuine client traffic and synthetic traffic generated by bots or tests.
+        #
+        # @note Stability Level: development
+        USER_AGENT_SYNTHETIC_TYPE = 'user_agent.synthetic.type'
+    
+        # Version of the user-agent extracted from original. Usually refers to the browser's version
+        #
+        # [Example](https://www.whatsmyua.info) of extracting browser's version from original string. In the case of using a user-agent for non-browser products, such as microservices with multiple names/versions inside the `user_agent.original`, the most significant version SHOULD be selected. In such a scenario it should align with `user_agent.name`
+        #
+        # @note Stability Level: development
+        #
+        # @example Sample Values
+        #   14.1.2
+        #   1.0.0
+        #
+        USER_AGENT_VERSION = 'user_agent.version'
+    
+        # @!endgroup
+      end
+    end
+  end
+end

data/lib/opentelemetry/semconv/incubating/user_agent.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+# Copyright The OpenTelemetry Authors
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+# SPDX-License-Identifier: Apache-2.0
+
+# This file was autogenerated. Do not edit it by hand.
+
+require_relative 'user_agent/attributes'

data/lib/opentelemetry/semconv/incubating/v8js/attributes.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+# Copyright The OpenTelemetry Authors
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+# SPDX-License-Identifier: Apache-2.0
+#
+# This file was autogenerated. Do not edit it by hand.
+
+module OpenTelemetry
+  module SemConv
+    module Incubating
+      module V8JS
+        # @!group Attribute Names
+      
+        # The type of garbage collection.
+        #
+        # @note Stability Level: development
+        V8JS_GC_TYPE = 'v8js.gc.type'
+    
+        # The name of the space type of heap memory.
+        #
+        # Value can be retrieved from value `space_name` of [`v8.getHeapSpaceStatistics()`](https://nodejs.org/api/v8.html#v8getheapspacestatistics)
+        #
+        # @note Stability Level: development
+        V8JS_HEAP_SPACE_NAME = 'v8js.heap.space.name'
+    
+        # @!endgroup
+      end
+    end
+  end
+end

data/lib/opentelemetry/semconv/incubating/v8js/metrics.rb

@@ -0,0 +1,66 @@
+# frozen_string_literal: true
+
+# Copyright The OpenTelemetry Authors
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+# SPDX-License-Identifier: Apache-2.0
+#
+# This file was autogenerated. Do not edit it by hand.
+
+module OpenTelemetry
+  module SemConv
+    module Incubating
+      module V8JS
+        # @!group Metrics Names
+      
+        # Garbage collection duration.
+        #
+        # The values can be retrieved from [`perf_hooks.PerformanceObserver(...).observe({ entryTypes: ['gc'] })`](https://nodejs.org/api/perf_hooks.html#performanceobserverobserveoptions)
+        #
+        # @note Stability Level: development
+        V8JS_GC_DURATION = 'v8js.gc.duration'
+    
+        # Heap space available size.
+        #
+        # Value can be retrieved from value `space_available_size` of [`v8.getHeapSpaceStatistics()`](https://nodejs.org/api/v8.html#v8getheapspacestatistics)
+        #
+        # @note Stability Level: development
+        V8JS_HEAP_SPACE_AVAILABLE_SIZE = 'v8js.heap.space.available_size'
+    
+        # Committed size of a heap space.
+        #
+        # Value can be retrieved from value `physical_space_size` of [`v8.getHeapSpaceStatistics()`](https://nodejs.org/api/v8.html#v8getheapspacestatistics)
+        #
+        # @note Stability Level: development
+        V8JS_HEAP_SPACE_PHYSICAL_SIZE = 'v8js.heap.space.physical_size'
+    
+        # Total heap memory size pre-allocated.
+        #
+        # The value can be retrieved from value `space_size` of [`v8.getHeapSpaceStatistics()`](https://nodejs.org/api/v8.html#v8getheapspacestatistics)
+        #
+        # @note Stability Level: development
+        V8JS_MEMORY_HEAP_LIMIT = 'v8js.memory.heap.limit'
+    
+        # Heap Memory size allocated.
+        #
+        # The value can be retrieved from value `space_used_size` of [`v8.getHeapSpaceStatistics()`](https://nodejs.org/api/v8.html#v8getheapspacestatistics)
+        #
+        # @note Stability Level: development
+        V8JS_MEMORY_HEAP_USED = 'v8js.memory.heap.used'
+    
+        # @!endgroup
+      end
+    end
+  end
+end

data/lib/opentelemetry/semconv/incubating/v8js.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+# Copyright The OpenTelemetry Authors
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+# SPDX-License-Identifier: Apache-2.0
+
+# This file was autogenerated. Do not edit it by hand.
+
+require_relative 'v8js/attributes'
+require_relative 'v8js/metrics'