opentelemetry-semantic_conventions 1.11.0 → 1.36.0

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

@@ -0,0 +1,73 @@
+# 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 EXCEPTION
+        # @!group Attribute Names
+      
+        # Indicates that the exception is escaping the scope of the span.
+        #
+        # @note Stability Level: stable
+        # @deprecated {"note": "It's no longer recommended to record exceptions that are handled and do not escape the scope of a span.\n", "reason": "obsoleted"}
+        EXCEPTION_ESCAPED = 'exception.escaped'
+    
+        # The exception message.
+        #
+        # @note Stability Level: stable
+        #
+        # @example Sample Values
+        #   Division by zero
+        #   Can't convert 'int' object to str implicitly
+        #
+        #
+        # @deprecated Now available in the stable namespace at {OpenTelemetry::SemConv::EXCEPTION::EXCEPTION_MESSAGE}.
+        EXCEPTION_MESSAGE = 'exception.message'
+    
+        # 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.
+        #
+        # @note Stability Level: stable
+        #
+        # @example Sample Values
+        #   Exception in thread "main" java.lang.RuntimeException: Test exception\n at com.example.GenerateTrace.methodB(GenerateTrace.java:13)\n at com.example.GenerateTrace.methodA(GenerateTrace.java:9)\n at com.example.GenerateTrace.main(GenerateTrace.java:5)
+
+        #
+        #
+        # @deprecated Now available in the stable namespace at {OpenTelemetry::SemConv::EXCEPTION::EXCEPTION_STACKTRACE}.
+        EXCEPTION_STACKTRACE = 'exception.stacktrace'
+    
+        # 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.
+        #
+        # @note Stability Level: stable
+        #
+        # @example Sample Values
+        #   java.net.ConnectException
+        #   OSError
+        #
+        #
+        # @deprecated Now available in the stable namespace at {OpenTelemetry::SemConv::EXCEPTION::EXCEPTION_TYPE}.
+        EXCEPTION_TYPE = 'exception.type'
+    
+        # @!endgroup
+      end
+    end
+  end
+end

data/lib/opentelemetry/semconv/incubating/exception.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 'exception/attributes'

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

@@ -0,0 +1,200 @@
+# 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 FAAS
+        # @!group Attribute Names
+      
+        # A boolean that is true if the serverless function is executed for the first time (aka cold-start).
+        #
+        # @note Stability Level: development
+        FAAS_COLDSTART = 'faas.coldstart'
+    
+        # A string containing the schedule period as [Cron Expression](https://docs.oracle.com/cd/E12058_01/doc/doc.1014/e12030/cron_expressions.htm).
+        #
+        # @note Stability Level: development
+        #
+        # @example Sample Values
+        #   0/5 * * * ? *
+        #
+        FAAS_CRON = 'faas.cron'
+    
+        # 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.
+        #
+        # @note Stability Level: development
+        #
+        # @example Sample Values
+        #   myBucketName
+        #   myDbName
+        #
+        FAAS_DOCUMENT_COLLECTION = 'faas.document.collection'
+    
+        # 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.
+        #
+        # @note Stability Level: development
+        #
+        # @example Sample Values
+        #   myFile.txt
+        #   myTableName
+        #
+        FAAS_DOCUMENT_NAME = 'faas.document.name'
+    
+        # Describes the type of the operation that was performed on the data.
+        #
+        # @note Stability Level: development
+        FAAS_DOCUMENT_OPERATION = 'faas.document.operation'
+    
+        # 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).
+        #
+        # @note Stability Level: development
+        #
+        # @example Sample Values
+        #   2020-01-23T13:47:06Z
+        #
+        FAAS_DOCUMENT_TIME = 'faas.document.time'
+    
+        # The execution environment ID as a string, that will be potentially reused for other invocations to the same function/function version.
+        #
+        # - **AWS Lambda:** Use the (full) log stream name.
+        #
+        # @note Stability Level: development
+        #
+        # @example Sample Values
+        #   2021/06/28/[$LATEST]2f399eb14537447da05ab2a2e39309de
+        #
+        FAAS_INSTANCE = 'faas.instance'
+    
+        # The invocation ID of the current function invocation.
+        #
+        # @note Stability Level: development
+        #
+        # @example Sample Values
+        #   af9d5aa4-a685-4c5f-a22b-444f80b3cc28
+        #
+        FAAS_INVOCATION_ID = 'faas.invocation_id'
+    
+        # The name of the invoked function.
+        #
+        # SHOULD be equal to the `faas.name` resource attribute of the invoked function.
+        #
+        # @note Stability Level: development
+        #
+        # @example Sample Values
+        #   my-function
+        #
+        FAAS_INVOKED_NAME = 'faas.invoked_name'
+    
+        # The cloud provider of the invoked function.
+        #
+        # SHOULD be equal to the `cloud.provider` resource attribute of the invoked function.
+        #
+        # @note Stability Level: development
+        FAAS_INVOKED_PROVIDER = 'faas.invoked_provider'
+    
+        # The cloud region of the invoked function.
+        #
+        # SHOULD be equal to the `cloud.region` resource attribute of the invoked function.
+        #
+        # @note Stability Level: development
+        #
+        # @example Sample Values
+        #   eu-central-1
+        #
+        FAAS_INVOKED_REGION = 'faas.invoked_region'
+    
+        # The amount of memory available to the serverless function converted to Bytes.
+        #
+        # 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 (which must be multiplied by 1,048,576).
+        #
+        # @note Stability Level: development
+        #
+        # @example Sample Values
+        #   134217728
+        #
+        FAAS_MAX_MEMORY = 'faas.max_memory'
+    
+        # The name of the single function that this runtime instance executes.
+        #
+        # This is the name of the function as configured/deployed on the FaaS
+        # platform and is usually different from the name of the callback
+        # function (which may be stored in the
+        # [`code.namespace`/`code.function.name`](/docs/general/attributes.md#source-code-attributes)
+        # span attributes).
+        #
+        # For some cloud providers, the above definition is ambiguous. The following
+        # definition of function name MUST be used for this attribute
+        # (and consequently the span name) for the listed cloud providers/products:
+        #
+        # - **Azure:**  The full name `<FUNCAPP>/<FUNC>`, i.e., function app name
+        #   followed by a forward slash followed by the function name (this form
+        #   can also be seen in the resource JSON for the function).
+        #   This means that a span attribute MUST be used, as an Azure function
+        #   app can host multiple functions that would usually share
+        #   a TracerProvider (see also the `cloud.resource_id` attribute).
+        #
+        # @note Stability Level: development
+        #
+        # @example Sample Values
+        #   my-function
+        #   myazurefunctionapp/some-function-name
+        #
+        FAAS_NAME = 'faas.name'
+    
+        # 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).
+        #
+        # @note Stability Level: development
+        #
+        # @example Sample Values
+        #   2020-01-23T13:47:06Z
+        #
+        FAAS_TIME = 'faas.time'
+    
+        # Type of the trigger which caused this function invocation.
+        #
+        # @note Stability Level: development
+        FAAS_TRIGGER = 'faas.trigger'
+    
+        # The immutable version of the function being executed.
+        #
+        # Depending on the cloud provider and platform, use:
+        #
+        # - **AWS Lambda:** The [function version](https://docs.aws.amazon.com/lambda/latest/dg/configuration-versions.html)
+        #   (an integer represented as a decimal string).
+        # - **Google Cloud Run (Services):** The [revision](https://cloud.google.com/run/docs/managing/revisions)
+        #   (i.e., the function name plus the revision suffix).
+        # - **Google Cloud Functions:** The value of the
+        #   [`K_REVISION` environment variable](https://cloud.google.com/functions/docs/env-var#runtime_environment_variables_set_automatically).
+        # - **Azure Functions:** Not applicable. Do not set this attribute.
+        #
+        # @note Stability Level: development
+        #
+        # @example Sample Values
+        #   26
+        #   pinkfroid-00002
+        #
+        FAAS_VERSION = 'faas.version'
+    
+        # @!endgroup
+      end
+    end
+  end
+end

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

@@ -0,0 +1,76 @@
+# 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 FAAS
+        # @!group Metrics Names
+      
+        # Number of invocation cold starts
+        #
+        # @note Stability Level: development
+        FAAS_COLDSTARTS = 'faas.coldstarts'
+    
+        # Distribution of CPU usage per invocation
+        #
+        # @note Stability Level: development
+        FAAS_CPU_USAGE = 'faas.cpu_usage'
+    
+        # Number of invocation errors
+        #
+        # @note Stability Level: development
+        FAAS_ERRORS = 'faas.errors'
+    
+        # Measures the duration of the function's initialization, such as a cold start
+        #
+        # @note Stability Level: development
+        FAAS_INIT_DURATION = 'faas.init_duration'
+    
+        # Number of successful invocations
+        #
+        # @note Stability Level: development
+        FAAS_INVOCATIONS = 'faas.invocations'
+    
+        # Measures the duration of the function's logic execution
+        #
+        # @note Stability Level: development
+        FAAS_INVOKE_DURATION = 'faas.invoke_duration'
+    
+        # Distribution of max memory usage per invocation
+        #
+        # @note Stability Level: development
+        FAAS_MEM_USAGE = 'faas.mem_usage'
+    
+        # Distribution of net I/O usage per invocation
+        #
+        # @note Stability Level: development
+        FAAS_NET_IO = 'faas.net_io'
+    
+        # Number of invocation timeouts
+        #
+        # @note Stability Level: development
+        FAAS_TIMEOUTS = 'faas.timeouts'
+    
+        # @!endgroup
+      end
+    end
+  end
+end

data/lib/opentelemetry/semconv/incubating/faas.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 'faas/attributes'
+require_relative 'faas/metrics'

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

@@ -0,0 +1,159 @@
+# 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 FEATURE_FLAG
+        # @!group Attribute Names
+      
+        # The unique identifier for the flag evaluation context. For example, the targeting key.
+        #
+        # @note Stability Level: release_candidate
+        #
+        # @example Sample Values
+        #   5157782b-2203-4c80-a857-dbbd5e7761db
+        #
+        FEATURE_FLAG_CONTEXT_ID = 'feature_flag.context.id'
+    
+        # Deprecated, use `error.message` instead.
+        #
+        # @note Stability Level: development
+        #
+        # @example Sample Values
+        #   Flag `header-color` expected type `string` but found type `number`
+        #
+        # @deprecated {"note": "Replaced by `error.message`.", "reason": "renamed", "renamed_to": "error.message"}
+        FEATURE_FLAG_EVALUATION_ERROR_MESSAGE = 'feature_flag.evaluation.error.message'
+    
+        # Deprecated, use `feature_flag.result.reason` instead.
+        #
+        # @note Stability Level: development
+        #
+        # @example Sample Values
+        #   static
+        #   targeting_match
+        #   error
+        #   default
+        #
+        # @deprecated {"note": "Replaced by `feature_flag.result.reason`.", "reason": "renamed", "renamed_to": "feature_flag.result.reason"}
+        FEATURE_FLAG_EVALUATION_REASON = 'feature_flag.evaluation.reason'
+    
+        # The lookup key of the feature flag.
+        #
+        # @note Stability Level: release_candidate
+        #
+        # @example Sample Values
+        #   logo-color
+        #
+        FEATURE_FLAG_KEY = 'feature_flag.key'
+    
+        # Identifies the feature flag provider.
+        #
+        # @note Stability Level: release_candidate
+        #
+        # @example Sample Values
+        #   Flag Manager
+        #
+        FEATURE_FLAG_PROVIDER_NAME = 'feature_flag.provider.name'
+    
+        # The reason code which shows how a feature flag value was determined.
+        #
+        # @note Stability Level: release_candidate
+        #
+        # @example Sample Values
+        #   static
+        #   targeting_match
+        #   error
+        #   default
+        #
+        FEATURE_FLAG_RESULT_REASON = 'feature_flag.result.reason'
+    
+        # The evaluated value of the feature flag.
+        #
+        # With some feature flag providers, feature flag results can be quite large or contain private or sensitive details.
+        # Because of this, `feature_flag.result.variant` is often the preferred attribute if it is available.
+        #
+        # It may be desirable to redact or otherwise limit the size and scope of `feature_flag.result.value` if possible.
+        # Because the evaluated flag value is unstructured and may be any type, it is left to the instrumentation author to determine how best to achieve this.
+        #
+        # @note Stability Level: release_candidate
+        #
+        # @example Sample Values
+        #   #ff0000
+        #   true
+        #   3
+        #
+        FEATURE_FLAG_RESULT_VALUE = 'feature_flag.result.value'
+    
+        # A semantic identifier for an evaluated flag value.
+        #
+        # A semantic identifier, commonly referred to as a variant, provides a means
+        # for referring to a value without including the value itself. This can
+        # provide additional context for understanding the meaning behind a value.
+        # For example, the variant `red` maybe be used for the value `#c05543`.
+        #
+        # @note Stability Level: release_candidate
+        #
+        # @example Sample Values
+        #   red
+        #   true
+        #   on
+        #
+        FEATURE_FLAG_RESULT_VARIANT = 'feature_flag.result.variant'
+    
+        # The identifier of the [flag set](https://openfeature.dev/specification/glossary/#flag-set) to which the feature flag belongs.
+        #
+        # @note Stability Level: release_candidate
+        #
+        # @example Sample Values
+        #   proj-1
+        #   ab98sgs
+        #   service1/dev
+        #
+        FEATURE_FLAG_SET_ID = 'feature_flag.set.id'
+    
+        # Deprecated, use `feature_flag.result.variant` instead.
+        #
+        # @note Stability Level: development
+        #
+        # @example Sample Values
+        #   red
+        #   true
+        #   on
+        #
+        # @deprecated {"note": "Replaced by `feature_flag.result.variant`.", "reason": "renamed", "renamed_to": "feature_flag.result.variant"}
+        FEATURE_FLAG_VARIANT = 'feature_flag.variant'
+    
+        # The version of the ruleset used during the evaluation. This may be any stable value which uniquely identifies the ruleset.
+        #
+        # @note Stability Level: release_candidate
+        #
+        # @example Sample Values
+        #   1
+        #   01ABCDEF
+        #
+        FEATURE_FLAG_VERSION = 'feature_flag.version'
+    
+        # @!endgroup
+      end
+    end
+  end
+end

data/lib/opentelemetry/semconv/incubating/feature_flag.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 'feature_flag/attributes'