From 37ef6dcc0950f5523aaf4d1978bd8b8a5abcb04c Mon Sep 17 00:00:00 2001 From: Robb Kidd Date: Thu, 11 Jul 2024 16:36:27 -0400 Subject: [PATCH 01/17] use v1.10-compat semconvgen to write deprecation notices --- .../semantic_conventions/resource.rb | 252 +++++++++++ .../semantic_conventions/trace.rb | 423 ++++++++++++++++++ .../templates/semantic_conventions.j2 | 10 +- 3 files changed, 682 insertions(+), 3 deletions(-) diff --git a/semantic_conventions/lib/opentelemetry/semantic_conventions/resource.rb b/semantic_conventions/lib/opentelemetry/semantic_conventions/resource.rb index 912946f71f..5487f87e45 100644 --- a/semantic_conventions/lib/opentelemetry/semantic_conventions/resource.rb +++ b/semantic_conventions/lib/opentelemetry/semantic_conventions/resource.rb @@ -6,97 +6,181 @@ module OpenTelemetry module SemanticConventions + # @deprecated This module is deprecated in favor of the namespaced modules under + # {OpenTelemetry::SemanticCandidates} (all experimental and stable) and + # {OpenTelemetry::SemanticConventions} (stable) module Resource # Name of the cloud provider + # + # @deprecated The \{OpenTelemetry::SemanticConventions::Resource\} module is deprecated. + # See {OpenTelemetry::SemanticCandidates::CLOUD::CLOUD_PROVIDER} for its replacement. CLOUD_PROVIDER = 'cloud.provider' # The cloud account ID the resource is assigned to + # + # @deprecated The \{OpenTelemetry::SemanticConventions::Resource\} module is deprecated. + # See {OpenTelemetry::SemanticCandidates::CLOUD::CLOUD_ACCOUNT_ID} for its replacement. CLOUD_ACCOUNT_ID = 'cloud.account.id' # The geographical region the resource is running # @note Refer to your provider's docs to see the available regions, for example [Alibaba Cloud regions](https://www.alibabacloud.com/help/doc-detail/40654.htm), [AWS regions](https://aws.amazon.com/about-aws/global-infrastructure/regions_az/), [Azure regions](https://azure.microsoft.com/en-us/global-infrastructure/geographies/), [Google Cloud regions](https://cloud.google.com/about/locations), or [Tencent Cloud regions](https://intl.cloud.tencent.com/document/product/213/6091) + # + # @deprecated The \{OpenTelemetry::SemanticConventions::Resource\} module is deprecated. + # See {OpenTelemetry::SemanticCandidates::CLOUD::CLOUD_REGION} for its replacement. CLOUD_REGION = 'cloud.region' # Cloud regions often have multiple, isolated locations known as zones to increase availability. Availability zone represents the zone where the resource is running # @note Availability zones are called "zones" on Alibaba Cloud and Google Cloud + # + # @deprecated The \{OpenTelemetry::SemanticConventions::Resource\} module is deprecated. + # See {OpenTelemetry::SemanticCandidates::CLOUD::CLOUD_AVAILABILITY_ZONE} for its replacement. CLOUD_AVAILABILITY_ZONE = 'cloud.availability_zone' # The cloud platform in use # @note The prefix of the service SHOULD match the one specified in `cloud.provider` + # + # @deprecated The \{OpenTelemetry::SemanticConventions::Resource\} module is deprecated. + # See {OpenTelemetry::SemanticCandidates::CLOUD::CLOUD_PLATFORM} for its replacement. CLOUD_PLATFORM = 'cloud.platform' # The Amazon Resource Name (ARN) of an [ECS container instance](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ECS_instances.html) + # + # @deprecated The \{OpenTelemetry::SemanticConventions::Resource\} module is deprecated. + # See {OpenTelemetry::SemanticCandidates::AWS::AWS_ECS_CONTAINER_ARN} for its replacement. AWS_ECS_CONTAINER_ARN = 'aws.ecs.container.arn' # The ARN of an [ECS cluster](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/clusters.html) + # + # @deprecated The \{OpenTelemetry::SemanticConventions::Resource\} module is deprecated. + # See {OpenTelemetry::SemanticCandidates::AWS::AWS_ECS_CLUSTER_ARN} for its replacement. AWS_ECS_CLUSTER_ARN = 'aws.ecs.cluster.arn' # The [launch type](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/launch_types.html) for an ECS task + # + # @deprecated The \{OpenTelemetry::SemanticConventions::Resource\} module is deprecated. + # See {OpenTelemetry::SemanticCandidates::AWS::AWS_ECS_LAUNCHTYPE} for its replacement. AWS_ECS_LAUNCHTYPE = 'aws.ecs.launchtype' # The ARN of an [ECS task definition](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task_definitions.html) + # + # @deprecated The \{OpenTelemetry::SemanticConventions::Resource\} module is deprecated. + # See {OpenTelemetry::SemanticCandidates::AWS::AWS_ECS_TASK_ARN} for its replacement. AWS_ECS_TASK_ARN = 'aws.ecs.task.arn' # The task definition family this task definition is a member of + # + # @deprecated The \{OpenTelemetry::SemanticConventions::Resource\} module is deprecated. + # See {OpenTelemetry::SemanticCandidates::AWS::AWS_ECS_TASK_FAMILY} for its replacement. AWS_ECS_TASK_FAMILY = 'aws.ecs.task.family' # The revision for this task definition + # + # @deprecated The \{OpenTelemetry::SemanticConventions::Resource\} module is deprecated. + # See {OpenTelemetry::SemanticCandidates::AWS::AWS_ECS_TASK_REVISION} for its replacement. AWS_ECS_TASK_REVISION = 'aws.ecs.task.revision' # The ARN of an EKS cluster + # + # @deprecated The \{OpenTelemetry::SemanticConventions::Resource\} module is deprecated. + # See {OpenTelemetry::SemanticCandidates::AWS::AWS_EKS_CLUSTER_ARN} for its replacement. AWS_EKS_CLUSTER_ARN = 'aws.eks.cluster.arn' # The name(s) of the AWS log group(s) an application is writing to # @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 + # + # @deprecated The \{OpenTelemetry::SemanticConventions::Resource\} module is deprecated. + # See {OpenTelemetry::SemanticCandidates::AWS::AWS_LOG_GROUP_NAMES} for its replacement. AWS_LOG_GROUP_NAMES = 'aws.log.group.names' # The Amazon Resource Name(s) (ARN) of the AWS log group(s) # @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) + # + # @deprecated The \{OpenTelemetry::SemanticConventions::Resource\} module is deprecated. + # See {OpenTelemetry::SemanticCandidates::AWS::AWS_LOG_GROUP_ARNS} for its replacement. AWS_LOG_GROUP_ARNS = 'aws.log.group.arns' # The name(s) of the AWS log stream(s) an application is writing to + # + # @deprecated The \{OpenTelemetry::SemanticConventions::Resource\} module is deprecated. + # See {OpenTelemetry::SemanticCandidates::AWS::AWS_LOG_STREAM_NAMES} for its replacement. AWS_LOG_STREAM_NAMES = 'aws.log.stream.names' # The ARN(s) of the AWS log stream(s) # @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 + # + # @deprecated The \{OpenTelemetry::SemanticConventions::Resource\} module is deprecated. + # See {OpenTelemetry::SemanticCandidates::AWS::AWS_LOG_STREAM_ARNS} for its replacement. AWS_LOG_STREAM_ARNS = 'aws.log.stream.arns' # Container name used by container runtime + # + # @deprecated The \{OpenTelemetry::SemanticConventions::Resource\} module is deprecated. + # See {OpenTelemetry::SemanticCandidates::CONTAINER::CONTAINER_NAME} for its replacement. CONTAINER_NAME = 'container.name' # 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 + # + # @deprecated The \{OpenTelemetry::SemanticConventions::Resource\} module is deprecated. + # See {OpenTelemetry::SemanticCandidates::CONTAINER::CONTAINER_ID} for its replacement. CONTAINER_ID = 'container.id' # The container runtime managing this container + # + # @deprecated The \{OpenTelemetry::SemanticConventions::Resource\} module is deprecated. + # See {OpenTelemetry::SemanticCandidates::CONTAINER::CONTAINER_RUNTIME} for its replacement. CONTAINER_RUNTIME = 'container.runtime' # Name of the image the container was built on + # + # @deprecated The \{OpenTelemetry::SemanticConventions::Resource\} module is deprecated. + # See {OpenTelemetry::SemanticCandidates::CONTAINER::CONTAINER_IMAGE_NAME} for its replacement. CONTAINER_IMAGE_NAME = 'container.image.name' # Container image tag + # + # @deprecated The \{OpenTelemetry::SemanticConventions::Resource\} module is deprecated. + # See {OpenTelemetry::SemanticCandidates::CONTAINER::CONTAINER_IMAGE_TAG} for its replacement. CONTAINER_IMAGE_TAG = 'container.image.tag' # Name of the [deployment environment](https://en.wikipedia.org/wiki/Deployment_environment) (aka deployment tier) + # + # @deprecated The \{OpenTelemetry::SemanticConventions::Resource\} module is deprecated. + # See {OpenTelemetry::SemanticCandidates::DEPLOYMENT::DEPLOYMENT_ENVIRONMENT} for its replacement. DEPLOYMENT_ENVIRONMENT = 'deployment.environment' # A unique identifier representing the device # @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 + # + # @deprecated The \{OpenTelemetry::SemanticConventions::Resource\} module is deprecated. + # See {OpenTelemetry::SemanticCandidates::DEVICE::DEVICE_ID} for its replacement. DEVICE_ID = 'device.id' # The model identifier for the device # @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 + # + # @deprecated The \{OpenTelemetry::SemanticConventions::Resource\} module is deprecated. + # See {OpenTelemetry::SemanticCandidates::DEVICE::DEVICE_MODEL_IDENTIFIER} for its replacement. DEVICE_MODEL_IDENTIFIER = 'device.model.identifier' # The marketing name for the device model # @note It's recommended this value represents a human readable version of the device model rather than a machine readable alternative + # + # @deprecated The \{OpenTelemetry::SemanticConventions::Resource\} module is deprecated. + # See {OpenTelemetry::SemanticCandidates::DEVICE::DEVICE_MODEL_NAME} for its replacement. DEVICE_MODEL_NAME = 'device.model.name' # The name of the device manufacturer # @note The Android OS provides this field via [Build](https://developer.android.com/reference/android/os/Build#MANUFACTURER). iOS apps SHOULD hardcode the value `Apple` + # + # @deprecated The \{OpenTelemetry::SemanticConventions::Resource\} module is deprecated. + # See {OpenTelemetry::SemanticCandidates::DEVICE::DEVICE_MANUFACTURER} for its replacement. DEVICE_MANUFACTURER = 'device.manufacturer' # The name of the single function that this runtime instance executes # @note 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`](../../trace/semantic_conventions/span-general.md#source-code-attributes) span attributes) + # + # @deprecated The \{OpenTelemetry::SemanticConventions::Resource\} module is deprecated. + # See {OpenTelemetry::SemanticCandidates::FAAS::FAAS_NAME} for its replacement. FAAS_NAME = 'faas.name' # The unique ID of the single function that this runtime instance executes @@ -114,6 +198,9 @@ module Resource # part of the ARN is not available without calling another AWS API # which may be deemed too slow for a short-running lambda function. # As an alternative, consider setting `faas.id` as a span attribute instead + # + # @deprecated The \{OpenTelemetry::SemanticConventions::Resource\} module is deprecated. + # See {OpenTelemetry::SemanticCandidates::FAAS::FAAS_ID} for its replacement. FAAS_ID = 'faas.id' # The immutable version of the function being executed @@ -126,173 +213,338 @@ module Resource # * **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 + # + # @deprecated The \{OpenTelemetry::SemanticConventions::Resource\} module is deprecated. + # See {OpenTelemetry::SemanticCandidates::FAAS::FAAS_VERSION} for its replacement. FAAS_VERSION = 'faas.version' # The execution environment ID as a string, that will be potentially reused for other invocations to the same function/function version # @note * **AWS Lambda:** Use the (full) log stream name + # + # @deprecated The \{OpenTelemetry::SemanticConventions::Resource\} module is deprecated. + # See {OpenTelemetry::SemanticCandidates::FAAS::FAAS_INSTANCE} for its replacement. FAAS_INSTANCE = 'faas.instance' # The amount of memory available to the serverless function in MiB # @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 + # + # @deprecated The \{OpenTelemetry::SemanticConventions::Resource\} module is deprecated. + # See {OpenTelemetry::SemanticCandidates::FAAS::FAAS_MAX_MEMORY} for its replacement. FAAS_MAX_MEMORY = 'faas.max_memory' # Unique host ID. For Cloud, this must be the instance_id assigned by the cloud provider + # + # @deprecated The \{OpenTelemetry::SemanticConventions::Resource\} module is deprecated. + # See {OpenTelemetry::SemanticCandidates::HOST::HOST_ID} for its replacement. HOST_ID = 'host.id' # 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 + # + # @deprecated The \{OpenTelemetry::SemanticConventions::Resource\} module is deprecated. + # See {OpenTelemetry::SemanticCandidates::HOST::HOST_NAME} for its replacement. HOST_NAME = 'host.name' # Type of host. For Cloud, this must be the machine type + # + # @deprecated The \{OpenTelemetry::SemanticConventions::Resource\} module is deprecated. + # See {OpenTelemetry::SemanticCandidates::HOST::HOST_TYPE} for its replacement. HOST_TYPE = 'host.type' # The CPU architecture the host system is running on + # + # @deprecated The \{OpenTelemetry::SemanticConventions::Resource\} module is deprecated. + # See {OpenTelemetry::SemanticCandidates::HOST::HOST_ARCH} for its replacement. HOST_ARCH = 'host.arch' # Name of the VM image or OS install the host was instantiated from + # + # @deprecated The \{OpenTelemetry::SemanticConventions::Resource\} module is deprecated. + # See {OpenTelemetry::SemanticCandidates::HOST::HOST_IMAGE_NAME} for its replacement. HOST_IMAGE_NAME = 'host.image.name' # VM image ID. For Cloud, this value is from the provider + # + # @deprecated The \{OpenTelemetry::SemanticConventions::Resource\} module is deprecated. + # See {OpenTelemetry::SemanticCandidates::HOST::HOST_IMAGE_ID} for its replacement. HOST_IMAGE_ID = 'host.image.id' # The version string of the VM image as defined in [Version Attributes](README.md#version-attributes) + # + # @deprecated The \{OpenTelemetry::SemanticConventions::Resource\} module is deprecated. + # See {OpenTelemetry::SemanticCandidates::HOST::HOST_IMAGE_VERSION} for its replacement. HOST_IMAGE_VERSION = 'host.image.version' # The name of the cluster + # + # @deprecated The \{OpenTelemetry::SemanticConventions::Resource\} module is deprecated. + # See {OpenTelemetry::SemanticCandidates::K8S::K8S_CLUSTER_NAME} for its replacement. K8S_CLUSTER_NAME = 'k8s.cluster.name' # The name of the Node + # + # @deprecated The \{OpenTelemetry::SemanticConventions::Resource\} module is deprecated. + # See {OpenTelemetry::SemanticCandidates::K8S::K8S_NODE_NAME} for its replacement. K8S_NODE_NAME = 'k8s.node.name' # The UID of the Node + # + # @deprecated The \{OpenTelemetry::SemanticConventions::Resource\} module is deprecated. + # See {OpenTelemetry::SemanticCandidates::K8S::K8S_NODE_UID} for its replacement. K8S_NODE_UID = 'k8s.node.uid' # The name of the namespace that the pod is running in + # + # @deprecated The \{OpenTelemetry::SemanticConventions::Resource\} module is deprecated. + # See {OpenTelemetry::SemanticCandidates::K8S::K8S_NAMESPACE_NAME} for its replacement. K8S_NAMESPACE_NAME = 'k8s.namespace.name' # The UID of the Pod + # + # @deprecated The \{OpenTelemetry::SemanticConventions::Resource\} module is deprecated. + # See {OpenTelemetry::SemanticCandidates::K8S::K8S_POD_UID} for its replacement. K8S_POD_UID = 'k8s.pod.uid' # The name of the Pod + # + # @deprecated The \{OpenTelemetry::SemanticConventions::Resource\} module is deprecated. + # See {OpenTelemetry::SemanticCandidates::K8S::K8S_POD_NAME} for its replacement. K8S_POD_NAME = 'k8s.pod.name' # The name of the Container from Pod specification, must be unique within a Pod. Container runtime usually uses different globally unique name (`container.name`) + # + # @deprecated The \{OpenTelemetry::SemanticConventions::Resource\} module is deprecated. + # See {OpenTelemetry::SemanticCandidates::K8S::K8S_CONTAINER_NAME} for its replacement. K8S_CONTAINER_NAME = 'k8s.container.name' # Number of times the container was restarted. This attribute can be used to identify a particular container (running or stopped) within a container spec + # + # @deprecated The \{OpenTelemetry::SemanticConventions::Resource\} module is deprecated. + # See {OpenTelemetry::SemanticCandidates::K8S::K8S_CONTAINER_RESTART_COUNT} for its replacement. K8S_CONTAINER_RESTART_COUNT = 'k8s.container.restart_count' # The UID of the ReplicaSet + # + # @deprecated The \{OpenTelemetry::SemanticConventions::Resource\} module is deprecated. + # See {OpenTelemetry::SemanticCandidates::K8S::K8S_REPLICASET_UID} for its replacement. K8S_REPLICASET_UID = 'k8s.replicaset.uid' # The name of the ReplicaSet + # + # @deprecated The \{OpenTelemetry::SemanticConventions::Resource\} module is deprecated. + # See {OpenTelemetry::SemanticCandidates::K8S::K8S_REPLICASET_NAME} for its replacement. K8S_REPLICASET_NAME = 'k8s.replicaset.name' # The UID of the Deployment + # + # @deprecated The \{OpenTelemetry::SemanticConventions::Resource\} module is deprecated. + # See {OpenTelemetry::SemanticCandidates::K8S::K8S_DEPLOYMENT_UID} for its replacement. K8S_DEPLOYMENT_UID = 'k8s.deployment.uid' # The name of the Deployment + # + # @deprecated The \{OpenTelemetry::SemanticConventions::Resource\} module is deprecated. + # See {OpenTelemetry::SemanticCandidates::K8S::K8S_DEPLOYMENT_NAME} for its replacement. K8S_DEPLOYMENT_NAME = 'k8s.deployment.name' # The UID of the StatefulSet + # + # @deprecated The \{OpenTelemetry::SemanticConventions::Resource\} module is deprecated. + # See {OpenTelemetry::SemanticCandidates::K8S::K8S_STATEFULSET_UID} for its replacement. K8S_STATEFULSET_UID = 'k8s.statefulset.uid' # The name of the StatefulSet + # + # @deprecated The \{OpenTelemetry::SemanticConventions::Resource\} module is deprecated. + # See {OpenTelemetry::SemanticCandidates::K8S::K8S_STATEFULSET_NAME} for its replacement. K8S_STATEFULSET_NAME = 'k8s.statefulset.name' # The UID of the DaemonSet + # + # @deprecated The \{OpenTelemetry::SemanticConventions::Resource\} module is deprecated. + # See {OpenTelemetry::SemanticCandidates::K8S::K8S_DAEMONSET_UID} for its replacement. K8S_DAEMONSET_UID = 'k8s.daemonset.uid' # The name of the DaemonSet + # + # @deprecated The \{OpenTelemetry::SemanticConventions::Resource\} module is deprecated. + # See {OpenTelemetry::SemanticCandidates::K8S::K8S_DAEMONSET_NAME} for its replacement. K8S_DAEMONSET_NAME = 'k8s.daemonset.name' # The UID of the Job + # + # @deprecated The \{OpenTelemetry::SemanticConventions::Resource\} module is deprecated. + # See {OpenTelemetry::SemanticCandidates::K8S::K8S_JOB_UID} for its replacement. K8S_JOB_UID = 'k8s.job.uid' # The name of the Job + # + # @deprecated The \{OpenTelemetry::SemanticConventions::Resource\} module is deprecated. + # See {OpenTelemetry::SemanticCandidates::K8S::K8S_JOB_NAME} for its replacement. K8S_JOB_NAME = 'k8s.job.name' # The UID of the CronJob + # + # @deprecated The \{OpenTelemetry::SemanticConventions::Resource\} module is deprecated. + # See {OpenTelemetry::SemanticCandidates::K8S::K8S_CRONJOB_UID} for its replacement. K8S_CRONJOB_UID = 'k8s.cronjob.uid' # The name of the CronJob + # + # @deprecated The \{OpenTelemetry::SemanticConventions::Resource\} module is deprecated. + # See {OpenTelemetry::SemanticCandidates::K8S::K8S_CRONJOB_NAME} for its replacement. K8S_CRONJOB_NAME = 'k8s.cronjob.name' # The operating system type + # + # @deprecated The \{OpenTelemetry::SemanticConventions::Resource\} module is deprecated. + # See {OpenTelemetry::SemanticCandidates::OS::OS_TYPE} for its replacement. OS_TYPE = 'os.type' # Human readable (not intended to be parsed) OS version information, like e.g. reported by `ver` or `lsb_release -a` commands + # + # @deprecated The \{OpenTelemetry::SemanticConventions::Resource\} module is deprecated. + # See {OpenTelemetry::SemanticCandidates::OS::OS_DESCRIPTION} for its replacement. OS_DESCRIPTION = 'os.description' # Human readable operating system name + # + # @deprecated The \{OpenTelemetry::SemanticConventions::Resource\} module is deprecated. + # See {OpenTelemetry::SemanticCandidates::OS::OS_NAME} for its replacement. OS_NAME = 'os.name' # The version string of the operating system as defined in [Version Attributes](../../resource/semantic_conventions/README.md#version-attributes) + # + # @deprecated The \{OpenTelemetry::SemanticConventions::Resource\} module is deprecated. + # See {OpenTelemetry::SemanticCandidates::OS::OS_VERSION} for its replacement. OS_VERSION = 'os.version' # Process identifier (PID) + # + # @deprecated The \{OpenTelemetry::SemanticConventions::Resource\} module is deprecated. + # See {OpenTelemetry::SemanticCandidates::PROCESS::PROCESS_PID} for its replacement. PROCESS_PID = 'process.pid' # 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` + # + # @deprecated The \{OpenTelemetry::SemanticConventions::Resource\} module is deprecated. + # See {OpenTelemetry::SemanticCandidates::PROCESS::PROCESS_EXECUTABLE_NAME} for its replacement. PROCESS_EXECUTABLE_NAME = 'process.executable.name' # 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` + # + # @deprecated The \{OpenTelemetry::SemanticConventions::Resource\} module is deprecated. + # See {OpenTelemetry::SemanticCandidates::PROCESS::PROCESS_EXECUTABLE_PATH} for its replacement. PROCESS_EXECUTABLE_PATH = 'process.executable.path' # 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` + # + # @deprecated The \{OpenTelemetry::SemanticConventions::Resource\} module is deprecated. + # See {OpenTelemetry::SemanticCandidates::PROCESS::PROCESS_COMMAND} for its replacement. PROCESS_COMMAND = 'process.command' # 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 + # + # @deprecated The \{OpenTelemetry::SemanticConventions::Resource\} module is deprecated. + # See {OpenTelemetry::SemanticCandidates::PROCESS::PROCESS_COMMAND_LINE} for its replacement. PROCESS_COMMAND_LINE = 'process.command_line' # 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` + # + # @deprecated The \{OpenTelemetry::SemanticConventions::Resource\} module is deprecated. + # See {OpenTelemetry::SemanticCandidates::PROCESS::PROCESS_COMMAND_ARGS} for its replacement. PROCESS_COMMAND_ARGS = 'process.command_args' # The username of the user that owns the process + # + # @deprecated The \{OpenTelemetry::SemanticConventions::Resource\} module is deprecated. + # See {OpenTelemetry::SemanticCandidates::PROCESS::PROCESS_OWNER} for its replacement. PROCESS_OWNER = 'process.owner' # The name of the runtime of this process. For compiled native binaries, this SHOULD be the name of the compiler + # + # @deprecated The \{OpenTelemetry::SemanticConventions::Resource\} module is deprecated. + # See {OpenTelemetry::SemanticCandidates::PROCESS::PROCESS_RUNTIME_NAME} for its replacement. PROCESS_RUNTIME_NAME = 'process.runtime.name' # The version of the runtime of this process, as returned by the runtime without modification + # + # @deprecated The \{OpenTelemetry::SemanticConventions::Resource\} module is deprecated. + # See {OpenTelemetry::SemanticCandidates::PROCESS::PROCESS_RUNTIME_VERSION} for its replacement. PROCESS_RUNTIME_VERSION = 'process.runtime.version' # An additional description about the runtime of the process, for example a specific vendor customization of the runtime environment + # + # @deprecated The \{OpenTelemetry::SemanticConventions::Resource\} module is deprecated. + # See {OpenTelemetry::SemanticCandidates::PROCESS::PROCESS_RUNTIME_DESCRIPTION} for its replacement. PROCESS_RUNTIME_DESCRIPTION = 'process.runtime.description' # Logical name of the service # @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` + # + # @deprecated The \{OpenTelemetry::SemanticConventions::Resource\} module is deprecated. + # See {OpenTelemetry::SemanticCandidates::SERVICE::SERVICE_NAME} for its replacement. SERVICE_NAME = 'service.name' # A namespace for `service.name` # @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 + # + # @deprecated The \{OpenTelemetry::SemanticConventions::Resource\} module is deprecated. + # See {OpenTelemetry::SemanticCandidates::SERVICE::SERVICE_NAMESPACE} for its replacement. SERVICE_NAMESPACE = 'service.namespace' # The string ID of the service instance # @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) + # + # @deprecated The \{OpenTelemetry::SemanticConventions::Resource\} module is deprecated. + # See {OpenTelemetry::SemanticCandidates::SERVICE::SERVICE_INSTANCE_ID} for its replacement. SERVICE_INSTANCE_ID = 'service.instance.id' # The version string of the service API or implementation + # + # @deprecated The \{OpenTelemetry::SemanticConventions::Resource\} module is deprecated. + # See {OpenTelemetry::SemanticCandidates::SERVICE::SERVICE_VERSION} for its replacement. SERVICE_VERSION = 'service.version' # The name of the telemetry SDK as defined above + # + # @deprecated The \{OpenTelemetry::SemanticConventions::Resource\} module is deprecated. + # See {OpenTelemetry::SemanticCandidates::TELEMETRY::TELEMETRY_SDK_NAME} for its replacement. TELEMETRY_SDK_NAME = 'telemetry.sdk.name' # The language of the telemetry SDK + # + # @deprecated The \{OpenTelemetry::SemanticConventions::Resource\} module is deprecated. + # See {OpenTelemetry::SemanticCandidates::TELEMETRY::TELEMETRY_SDK_LANGUAGE} for its replacement. TELEMETRY_SDK_LANGUAGE = 'telemetry.sdk.language' # The version string of the telemetry SDK + # + # @deprecated The \{OpenTelemetry::SemanticConventions::Resource\} module is deprecated. + # See {OpenTelemetry::SemanticCandidates::TELEMETRY::TELEMETRY_SDK_VERSION} for its replacement. TELEMETRY_SDK_VERSION = 'telemetry.sdk.version' # The version string of the auto instrumentation agent, if used + # + # @deprecated The \{OpenTelemetry::SemanticConventions::Resource\} module is deprecated. + # See {OpenTelemetry::SemanticCandidates::TELEMETRY::TELEMETRY_AUTO_VERSION} for its replacement. TELEMETRY_AUTO_VERSION = 'telemetry.auto.version' # The name of the web engine + # + # @deprecated The \{OpenTelemetry::SemanticConventions::Resource\} module is deprecated. + # See {OpenTelemetry::SemanticCandidates::WEBENGINE::WEBENGINE_NAME} for its replacement. WEBENGINE_NAME = 'webengine.name' # The version of the web engine + # + # @deprecated The \{OpenTelemetry::SemanticConventions::Resource\} module is deprecated. + # See {OpenTelemetry::SemanticCandidates::WEBENGINE::WEBENGINE_VERSION} for its replacement. WEBENGINE_VERSION = 'webengine.version' # Additional description of the web engine (e.g. detailed version and edition information) + # + # @deprecated The \{OpenTelemetry::SemanticConventions::Resource\} module is deprecated. + # See {OpenTelemetry::SemanticCandidates::WEBENGINE::WEBENGINE_DESCRIPTION} for its replacement. WEBENGINE_DESCRIPTION = 'webengine.description' end diff --git a/semantic_conventions/lib/opentelemetry/semantic_conventions/trace.rb b/semantic_conventions/lib/opentelemetry/semantic_conventions/trace.rb index 452315a2ac..e0a03ba2b6 100644 --- a/semantic_conventions/lib/opentelemetry/semantic_conventions/trace.rb +++ b/semantic_conventions/lib/opentelemetry/semantic_conventions/trace.rb @@ -6,109 +6,208 @@ module OpenTelemetry module SemanticConventions + # @deprecated This module is deprecated in favor of the namespaced modules under + # {OpenTelemetry::SemanticCandidates} (all experimental and stable) and + # {OpenTelemetry::SemanticConventions} (stable) module Trace # The full invoked ARN as provided on the `Context` passed to the function (`Lambda-Runtime-Invoked-Function-Arn` header on the `/runtime/invocation/next` applicable) # @note This may be different from `faas.id` if an alias is involved + # + # @deprecated The \{OpenTelemetry::SemanticConventions::Trace\} module is deprecated. + # See {OpenTelemetry::SemanticCandidates::AWS::AWS_LAMBDA_INVOKED_ARN} for its replacement. AWS_LAMBDA_INVOKED_ARN = 'aws.lambda.invoked_arn' # The [event_id](https://github.com/cloudevents/spec/blob/v1.0.2/cloudevents/spec.md#id) uniquely identifies the event + # + # @deprecated The \{OpenTelemetry::SemanticConventions::Trace\} module is deprecated. + # See {OpenTelemetry::SemanticCandidates::CLOUDEVENTS::CLOUDEVENTS_EVENT_ID} for its replacement. CLOUDEVENTS_EVENT_ID = 'cloudevents.event_id' # The [source](https://github.com/cloudevents/spec/blob/v1.0.2/cloudevents/spec.md#source-1) identifies the context in which an event happened + # + # @deprecated The \{OpenTelemetry::SemanticConventions::Trace\} module is deprecated. + # See {OpenTelemetry::SemanticCandidates::CLOUDEVENTS::CLOUDEVENTS_EVENT_SOURCE} for its replacement. CLOUDEVENTS_EVENT_SOURCE = 'cloudevents.event_source' # The [version of the CloudEvents specification](https://github.com/cloudevents/spec/blob/v1.0.2/cloudevents/spec.md#specversion) which the event uses + # + # @deprecated The \{OpenTelemetry::SemanticConventions::Trace\} module is deprecated. + # See {OpenTelemetry::SemanticCandidates::CLOUDEVENTS::CLOUDEVENTS_EVENT_SPEC_VERSION} for its replacement. CLOUDEVENTS_EVENT_SPEC_VERSION = 'cloudevents.event_spec_version' # The [event_type](https://github.com/cloudevents/spec/blob/v1.0.2/cloudevents/spec.md#type) contains a value describing the type of event related to the originating occurrence + # + # @deprecated The \{OpenTelemetry::SemanticConventions::Trace\} module is deprecated. + # See {OpenTelemetry::SemanticCandidates::CLOUDEVENTS::CLOUDEVENTS_EVENT_TYPE} for its replacement. CLOUDEVENTS_EVENT_TYPE = 'cloudevents.event_type' # The [subject](https://github.com/cloudevents/spec/blob/v1.0.2/cloudevents/spec.md#subject) of the event in the context of the event producer (identified by source) + # + # @deprecated The \{OpenTelemetry::SemanticConventions::Trace\} module is deprecated. + # See {OpenTelemetry::SemanticCandidates::CLOUDEVENTS::CLOUDEVENTS_EVENT_SUBJECT} for its replacement. CLOUDEVENTS_EVENT_SUBJECT = 'cloudevents.event_subject' # Parent-child Reference type # @note The causal relationship between a child Span and a parent Span + # + # @deprecated The \{OpenTelemetry::SemanticConventions::Trace\} module is deprecated. + # See {OpenTelemetry::SemanticCandidates::OPENTRACING::OPENTRACING_REF_TYPE} for its replacement. OPENTRACING_REF_TYPE = 'opentracing.ref_type' # An identifier for the database management system (DBMS) product being used. See below for a list of well-known identifiers + # + # @deprecated The \{OpenTelemetry::SemanticConventions::Trace\} module is deprecated. + # See {OpenTelemetry::SemanticCandidates::DB::DB_SYSTEM} for its replacement. DB_SYSTEM = 'db.system' # The connection string used to connect to the database. It is recommended to remove embedded credentials + # + # @deprecated The \{OpenTelemetry::SemanticConventions::Trace\} module is deprecated. + # See {OpenTelemetry::SemanticCandidates::DB::DB_CONNECTION_STRING} for its replacement. DB_CONNECTION_STRING = 'db.connection_string' # Username for accessing the database + # + # @deprecated The \{OpenTelemetry::SemanticConventions::Trace\} module is deprecated. + # See {OpenTelemetry::SemanticCandidates::DB::DB_USER} for its replacement. DB_USER = 'db.user' # 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 + # + # @deprecated The \{OpenTelemetry::SemanticConventions::Trace\} module is deprecated. + # See {OpenTelemetry::SemanticCandidates::DB::DB_JDBC_DRIVER_CLASSNAME} for its replacement. DB_JDBC_DRIVER_CLASSNAME = 'db.jdbc.driver_classname' # 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) # @note In some SQL databases, the database name to be used is called "schema name". In case there are multiple layers that could be considered for database name (e.g. Oracle instance name and schema name), the database name to be used is the more specific layer (e.g. Oracle schema name) + # + # @deprecated The \{OpenTelemetry::SemanticConventions::Trace\} module is deprecated. + # See {OpenTelemetry::SemanticCandidates::DB::DB_NAME} for its replacement. DB_NAME = 'db.name' # The database statement being executed # @note The value may be sanitized to exclude sensitive information + # + # @deprecated The \{OpenTelemetry::SemanticConventions::Trace\} module is deprecated. + # See {OpenTelemetry::SemanticCandidates::DB::DB_STATEMENT} for its replacement. DB_STATEMENT = 'db.statement' # 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 # @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 + # + # @deprecated The \{OpenTelemetry::SemanticConventions::Trace\} module is deprecated. + # See {OpenTelemetry::SemanticCandidates::DB::DB_OPERATION} for its replacement. DB_OPERATION = 'db.operation' # Remote hostname or similar, see note below + # + # @deprecated The \{OpenTelemetry::SemanticConventions::Trace\} module is deprecated. + # See {OpenTelemetry::SemanticCandidates::NET::NET_PEER_NAME} for its replacement. NET_PEER_NAME = 'net.peer.name' # Remote address of the peer (dotted decimal for IPv4 or [RFC5952](https://tools.ietf.org/html/rfc5952) for IPv6) + # + # @deprecated The \{OpenTelemetry::SemanticConventions::Trace\} module is deprecated. + # See {OpenTelemetry::SemanticCandidates::NET::NET_PEER_IP} for its replacement. NET_PEER_IP = 'net.peer.ip' # Remote port number + # + # @deprecated The \{OpenTelemetry::SemanticConventions::Trace\} module is deprecated. + # See {OpenTelemetry::SemanticCandidates::NET::NET_PEER_PORT} for its replacement. NET_PEER_PORT = 'net.peer.port' # Transport protocol used. See note below + # + # @deprecated The \{OpenTelemetry::SemanticConventions::Trace\} module is deprecated. + # See {OpenTelemetry::SemanticCandidates::NET::NET_TRANSPORT} for its replacement. NET_TRANSPORT = 'net.transport' # 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 # @note If setting a `db.mssql.instance_name`, `net.peer.port` is no longer required (but still recommended if non-standard) + # + # @deprecated The \{OpenTelemetry::SemanticConventions::Trace\} module is deprecated. + # See {OpenTelemetry::SemanticCandidates::DB::DB_MSSQL_INSTANCE_NAME} for its replacement. DB_MSSQL_INSTANCE_NAME = 'db.mssql.instance_name' # The fetch size used for paging, i.e. how many rows will be returned at once + # + # @deprecated The \{OpenTelemetry::SemanticConventions::Trace\} module is deprecated. + # See {OpenTelemetry::SemanticCandidates::DB::DB_CASSANDRA_PAGE_SIZE} for its replacement. DB_CASSANDRA_PAGE_SIZE = 'db.cassandra.page_size' # 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) + # + # @deprecated The \{OpenTelemetry::SemanticConventions::Trace\} module is deprecated. + # See {OpenTelemetry::SemanticCandidates::DB::DB_CASSANDRA_CONSISTENCY_LEVEL} for its replacement. DB_CASSANDRA_CONSISTENCY_LEVEL = 'db.cassandra.consistency_level' # The name of the primary table that the operation is acting upon, including the keyspace name (if applicable) # @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 + # + # @deprecated The \{OpenTelemetry::SemanticConventions::Trace\} module is deprecated. + # See {OpenTelemetry::SemanticCandidates::DB::DB_CASSANDRA_TABLE} for its replacement. DB_CASSANDRA_TABLE = 'db.cassandra.table' # Whether or not the query is idempotent + # + # @deprecated The \{OpenTelemetry::SemanticConventions::Trace\} module is deprecated. + # See {OpenTelemetry::SemanticCandidates::DB::DB_CASSANDRA_IDEMPOTENCE} for its replacement. DB_CASSANDRA_IDEMPOTENCE = 'db.cassandra.idempotence' # The number of times a query was speculatively executed. Not set or `0` if the query was not executed speculatively + # + # @deprecated The \{OpenTelemetry::SemanticConventions::Trace\} module is deprecated. + # See {OpenTelemetry::SemanticCandidates::DB::DB_CASSANDRA_SPECULATIVE_EXECUTION_COUNT} for its replacement. DB_CASSANDRA_SPECULATIVE_EXECUTION_COUNT = 'db.cassandra.speculative_execution_count' # The ID of the coordinating node for a query + # + # @deprecated The \{OpenTelemetry::SemanticConventions::Trace\} module is deprecated. + # See {OpenTelemetry::SemanticCandidates::DB::DB_CASSANDRA_COORDINATOR_ID} for its replacement. DB_CASSANDRA_COORDINATOR_ID = 'db.cassandra.coordinator.id' # The data center of the coordinating node for a query + # + # @deprecated The \{OpenTelemetry::SemanticConventions::Trace\} module is deprecated. + # See {OpenTelemetry::SemanticCandidates::DB::DB_CASSANDRA_COORDINATOR_DC} for its replacement. DB_CASSANDRA_COORDINATOR_DC = 'db.cassandra.coordinator.dc' # 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 + # + # @deprecated The \{OpenTelemetry::SemanticConventions::Trace\} module is deprecated. + # See {OpenTelemetry::SemanticCandidates::DB::DB_REDIS_DATABASE_INDEX} for its replacement. DB_REDIS_DATABASE_INDEX = 'db.redis.database_index' # The collection being accessed within the database stated in `db.name` + # + # @deprecated The \{OpenTelemetry::SemanticConventions::Trace\} module is deprecated. + # See {OpenTelemetry::SemanticCandidates::DB::DB_MONGODB_COLLECTION} for its replacement. DB_MONGODB_COLLECTION = 'db.mongodb.collection' # The name of the primary table that the operation is acting upon, including the database name (if applicable) # @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 + # + # @deprecated The \{OpenTelemetry::SemanticConventions::Trace\} module is deprecated. + # See {OpenTelemetry::SemanticCandidates::DB::DB_SQL_TABLE} for its replacement. DB_SQL_TABLE = 'db.sql.table' # 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 + # + # @deprecated The \{OpenTelemetry::SemanticConventions::Trace\} module is deprecated. + # See {OpenTelemetry::SemanticCandidates::EXCEPTION::EXCEPTION_TYPE} for its replacement. EXCEPTION_TYPE = 'exception.type' # The exception message + # + # @deprecated The \{OpenTelemetry::SemanticConventions::Trace\} module is deprecated. + # See {OpenTelemetry::SemanticCandidates::EXCEPTION::EXCEPTION_MESSAGE} for its replacement. 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 + # + # @deprecated The \{OpenTelemetry::SemanticConventions::Trace\} module is deprecated. + # See {OpenTelemetry::SemanticCandidates::EXCEPTION::EXCEPTION_STACKTRACE} for its replacement. EXCEPTION_STACKTRACE = 'exception.stacktrace' # 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 @@ -128,6 +227,9 @@ module Trace # even if the `exception.escaped` attribute was not set or set to false, # since the event might have been recorded at a time where it was not # clear whether the exception will escape + # + # @deprecated The \{OpenTelemetry::SemanticConventions::Trace\} module is deprecated. + # See {OpenTelemetry::SemanticCandidates::EXCEPTION::EXCEPTION_ESCAPED} for its replacement. EXCEPTION_ESCAPED = 'exception.escaped' # Type of the trigger which caused this function execution @@ -140,70 +242,133 @@ module Trace # trigger that corresponding incoming would have (i.e., this has # nothing to do with the underlying transport used to make the API # call to invoke the lambda, which is often HTTP) + # + # @deprecated The \{OpenTelemetry::SemanticConventions::Trace\} module is deprecated. + # See {OpenTelemetry::SemanticCandidates::FAAS::FAAS_TRIGGER} for its replacement. FAAS_TRIGGER = 'faas.trigger' # The execution ID of the current function execution + # + # @deprecated The \{OpenTelemetry::SemanticConventions::Trace\} module is deprecated. + # See {OpenTelemetry::SemanticCandidates::FAAS::FAAS_EXECUTION} for its replacement. FAAS_EXECUTION = 'faas.execution' # 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 + # + # @deprecated The \{OpenTelemetry::SemanticConventions::Trace\} module is deprecated. + # See {OpenTelemetry::SemanticCandidates::FAAS::FAAS_DOCUMENT_COLLECTION} for its replacement. FAAS_DOCUMENT_COLLECTION = 'faas.document.collection' # Describes the type of the operation that was performed on the data + # + # @deprecated The \{OpenTelemetry::SemanticConventions::Trace\} module is deprecated. + # See {OpenTelemetry::SemanticCandidates::FAAS::FAAS_DOCUMENT_OPERATION} for its replacement. 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) + # + # @deprecated The \{OpenTelemetry::SemanticConventions::Trace\} module is deprecated. + # See {OpenTelemetry::SemanticCandidates::FAAS::FAAS_DOCUMENT_TIME} for its replacement. FAAS_DOCUMENT_TIME = 'faas.document.time' # 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 + # + # @deprecated The \{OpenTelemetry::SemanticConventions::Trace\} module is deprecated. + # See {OpenTelemetry::SemanticCandidates::FAAS::FAAS_DOCUMENT_NAME} for its replacement. FAAS_DOCUMENT_NAME = 'faas.document.name' # HTTP request method + # + # @deprecated The \{OpenTelemetry::SemanticConventions::Trace\} module is deprecated. + # See {OpenTelemetry::SemanticCandidates::HTTP::HTTP_METHOD} for its replacement. HTTP_METHOD = 'http.method' # 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 # @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/` + # + # @deprecated The \{OpenTelemetry::SemanticConventions::Trace\} module is deprecated. + # See {OpenTelemetry::SemanticCandidates::HTTP::HTTP_URL} for its replacement. HTTP_URL = 'http.url' # The full request target as passed in a HTTP request line or equivalent + # + # @deprecated The \{OpenTelemetry::SemanticConventions::Trace\} module is deprecated. + # See {OpenTelemetry::SemanticCandidates::HTTP::HTTP_TARGET} for its replacement. HTTP_TARGET = 'http.target' # The value of the [HTTP host header](https://tools.ietf.org/html/rfc7230#section-5.4). An empty Host header should also be reported, see note # @note When the header is present but empty the attribute SHOULD be set to the empty string. Note that this is a valid situation that is expected in certain cases, according the aforementioned [section of RFC 7230](https://tools.ietf.org/html/rfc7230#section-5.4). When the header is not set the attribute MUST NOT be set + # + # @deprecated The \{OpenTelemetry::SemanticConventions::Trace\} module is deprecated. + # See {OpenTelemetry::SemanticCandidates::HTTP::HTTP_HOST} for its replacement. HTTP_HOST = 'http.host' # The URI scheme identifying the used protocol + # + # @deprecated The \{OpenTelemetry::SemanticConventions::Trace\} module is deprecated. + # See {OpenTelemetry::SemanticCandidates::HTTP::HTTP_SCHEME} for its replacement. HTTP_SCHEME = 'http.scheme' # [HTTP response status code](https://tools.ietf.org/html/rfc7231#section-6) + # + # @deprecated The \{OpenTelemetry::SemanticConventions::Trace\} module is deprecated. + # See {OpenTelemetry::SemanticCandidates::HTTP::HTTP_STATUS_CODE} for its replacement. HTTP_STATUS_CODE = 'http.status_code' # Kind of HTTP protocol used # @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 + # + # @deprecated The \{OpenTelemetry::SemanticConventions::Trace\} module is deprecated. + # See {OpenTelemetry::SemanticCandidates::HTTP::HTTP_FLAVOR} for its replacement. HTTP_FLAVOR = 'http.flavor' # Value of the [HTTP User-Agent](https://tools.ietf.org/html/rfc7231#section-5.5.3) header sent by the client + # + # @deprecated The \{OpenTelemetry::SemanticConventions::Trace\} module is deprecated. + # See {OpenTelemetry::SemanticCandidates::HTTP::HTTP_USER_AGENT} for its replacement. HTTP_USER_AGENT = 'http.user_agent' # 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 + # + # @deprecated The \{OpenTelemetry::SemanticConventions::Trace\} module is deprecated. + # See {OpenTelemetry::SemanticCandidates::HTTP::HTTP_REQUEST_CONTENT_LENGTH} for its replacement. HTTP_REQUEST_CONTENT_LENGTH = 'http.request_content_length' # The size of the uncompressed request payload body after transport decoding. Not set if transport encoding not used + # + # @deprecated The \{OpenTelemetry::SemanticConventions::Trace\} module is deprecated. + # See {OpenTelemetry::SemanticCandidates::HTTP::HTTP_REQUEST_CONTENT_LENGTH_UNCOMPRESSED} for its replacement. HTTP_REQUEST_CONTENT_LENGTH_UNCOMPRESSED = 'http.request_content_length_uncompressed' # 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 + # + # @deprecated The \{OpenTelemetry::SemanticConventions::Trace\} module is deprecated. + # See {OpenTelemetry::SemanticCandidates::HTTP::HTTP_RESPONSE_CONTENT_LENGTH} for its replacement. HTTP_RESPONSE_CONTENT_LENGTH = 'http.response_content_length' # The size of the uncompressed response payload body after transport decoding. Not set if transport encoding not used + # + # @deprecated The \{OpenTelemetry::SemanticConventions::Trace\} module is deprecated. + # See {OpenTelemetry::SemanticCandidates::HTTP::HTTP_RESPONSE_CONTENT_LENGTH_UNCOMPRESSED} for its replacement. HTTP_RESPONSE_CONTENT_LENGTH_UNCOMPRESSED = 'http.response_content_length_uncompressed' # The ordinal number of request re-sending attempt + # + # @deprecated The \{OpenTelemetry::SemanticConventions::Trace\} module is deprecated. + # See {OpenTelemetry::SemanticCandidates::HTTP::HTTP_RETRY_COUNT} for its replacement. HTTP_RETRY_COUNT = 'http.retry_count' # 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) # @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 + # + # @deprecated The \{OpenTelemetry::SemanticConventions::Trace\} module is deprecated. + # See {OpenTelemetry::SemanticCandidates::HTTP::HTTP_SERVER_NAME} for its replacement. HTTP_SERVER_NAME = 'http.server_name' # The matched route (path template) + # + # @deprecated The \{OpenTelemetry::SemanticConventions::Trace\} module is deprecated. + # See {OpenTelemetry::SemanticCandidates::HTTP::HTTP_ROUTE} for its replacement. HTTP_ROUTE = 'http.route' # 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)) @@ -218,268 +383,526 @@ module Trace # `http.client_ip` when it's the same as `net.peer.ip` means that # one is at least somewhat confident that the address is not that of # the closest proxy + # + # @deprecated The \{OpenTelemetry::SemanticConventions::Trace\} module is deprecated. + # See {OpenTelemetry::SemanticCandidates::HTTP::HTTP_CLIENT_IP} for its replacement. HTTP_CLIENT_IP = 'http.client_ip' # Like `net.peer.ip` but for the host IP. Useful in case of a multi-IP host + # + # @deprecated The \{OpenTelemetry::SemanticConventions::Trace\} module is deprecated. + # See {OpenTelemetry::SemanticCandidates::NET::NET_HOST_IP} for its replacement. NET_HOST_IP = 'net.host.ip' # Like `net.peer.port` but for the host port + # + # @deprecated The \{OpenTelemetry::SemanticConventions::Trace\} module is deprecated. + # See {OpenTelemetry::SemanticCandidates::NET::NET_HOST_PORT} for its replacement. NET_HOST_PORT = 'net.host.port' # Local hostname or similar, see note below + # + # @deprecated The \{OpenTelemetry::SemanticConventions::Trace\} module is deprecated. + # See {OpenTelemetry::SemanticCandidates::NET::NET_HOST_NAME} for its replacement. NET_HOST_NAME = 'net.host.name' # The internet connection type currently being used by the host + # + # @deprecated The \{OpenTelemetry::SemanticConventions::Trace\} module is deprecated. + # See {OpenTelemetry::SemanticCandidates::NET::NET_HOST_CONNECTION_TYPE} for its replacement. NET_HOST_CONNECTION_TYPE = 'net.host.connection.type' # This describes more details regarding the connection.type. It may be the type of cell technology connection, but it could be used for describing details about a wifi connection + # + # @deprecated The \{OpenTelemetry::SemanticConventions::Trace\} module is deprecated. + # See {OpenTelemetry::SemanticCandidates::NET::NET_HOST_CONNECTION_SUBTYPE} for its replacement. NET_HOST_CONNECTION_SUBTYPE = 'net.host.connection.subtype' # The name of the mobile carrier + # + # @deprecated The \{OpenTelemetry::SemanticConventions::Trace\} module is deprecated. + # See {OpenTelemetry::SemanticCandidates::NET::NET_HOST_CARRIER_NAME} for its replacement. NET_HOST_CARRIER_NAME = 'net.host.carrier.name' # The mobile carrier country code + # + # @deprecated The \{OpenTelemetry::SemanticConventions::Trace\} module is deprecated. + # See {OpenTelemetry::SemanticCandidates::NET::NET_HOST_CARRIER_MCC} for its replacement. NET_HOST_CARRIER_MCC = 'net.host.carrier.mcc' # The mobile carrier network code + # + # @deprecated The \{OpenTelemetry::SemanticConventions::Trace\} module is deprecated. + # See {OpenTelemetry::SemanticCandidates::NET::NET_HOST_CARRIER_MNC} for its replacement. NET_HOST_CARRIER_MNC = 'net.host.carrier.mnc' # The ISO 3166-1 alpha-2 2-character country code associated with the mobile carrier network + # + # @deprecated The \{OpenTelemetry::SemanticConventions::Trace\} module is deprecated. + # See {OpenTelemetry::SemanticCandidates::NET::NET_HOST_CARRIER_ICC} for its replacement. NET_HOST_CARRIER_ICC = 'net.host.carrier.icc' # A string identifying the messaging system + # + # @deprecated The \{OpenTelemetry::SemanticConventions::Trace\} module is deprecated. + # See {OpenTelemetry::SemanticCandidates::MESSAGING::MESSAGING_SYSTEM} for its replacement. MESSAGING_SYSTEM = 'messaging.system' # The message destination name. This might be equal to the span name but is required nevertheless + # + # @deprecated The \{OpenTelemetry::SemanticConventions::Trace\} module is deprecated. + # See {OpenTelemetry::SemanticCandidates::MESSAGING::MESSAGING_DESTINATION} for its replacement. MESSAGING_DESTINATION = 'messaging.destination' # The kind of message destination + # + # @deprecated The \{OpenTelemetry::SemanticConventions::Trace\} module is deprecated. + # See {OpenTelemetry::SemanticCandidates::MESSAGING::MESSAGING_DESTINATION_KIND} for its replacement. MESSAGING_DESTINATION_KIND = 'messaging.destination_kind' # A boolean that is true if the message destination is temporary + # + # @deprecated The \{OpenTelemetry::SemanticConventions::Trace\} module is deprecated. + # See {OpenTelemetry::SemanticCandidates::MESSAGING::MESSAGING_TEMP_DESTINATION} for its replacement. MESSAGING_TEMP_DESTINATION = 'messaging.temp_destination' # The name of the transport protocol + # + # @deprecated The \{OpenTelemetry::SemanticConventions::Trace\} module is deprecated. + # See {OpenTelemetry::SemanticCandidates::MESSAGING::MESSAGING_PROTOCOL} for its replacement. MESSAGING_PROTOCOL = 'messaging.protocol' # The version of the transport protocol + # + # @deprecated The \{OpenTelemetry::SemanticConventions::Trace\} module is deprecated. + # See {OpenTelemetry::SemanticCandidates::MESSAGING::MESSAGING_PROTOCOL_VERSION} for its replacement. MESSAGING_PROTOCOL_VERSION = 'messaging.protocol_version' # Connection string + # + # @deprecated The \{OpenTelemetry::SemanticConventions::Trace\} module is deprecated. + # See {OpenTelemetry::SemanticCandidates::MESSAGING::MESSAGING_URL} for its replacement. MESSAGING_URL = 'messaging.url' # A value used by the messaging system as an identifier for the message, represented as a string + # + # @deprecated The \{OpenTelemetry::SemanticConventions::Trace\} module is deprecated. + # See {OpenTelemetry::SemanticCandidates::MESSAGING::MESSAGING_MESSAGE_ID} for its replacement. MESSAGING_MESSAGE_ID = 'messaging.message_id' # The [conversation ID](#conversations) identifying the conversation to which the message belongs, represented as a string. Sometimes called "Correlation ID" + # + # @deprecated The \{OpenTelemetry::SemanticConventions::Trace\} module is deprecated. + # See {OpenTelemetry::SemanticCandidates::MESSAGING::MESSAGING_CONVERSATION_ID} for its replacement. MESSAGING_CONVERSATION_ID = 'messaging.conversation_id' # 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 + # + # @deprecated The \{OpenTelemetry::SemanticConventions::Trace\} module is deprecated. + # See {OpenTelemetry::SemanticCandidates::MESSAGING::MESSAGING_MESSAGE_PAYLOAD_SIZE_BYTES} for its replacement. MESSAGING_MESSAGE_PAYLOAD_SIZE_BYTES = 'messaging.message_payload_size_bytes' # The compressed size of the message payload in bytes + # + # @deprecated The \{OpenTelemetry::SemanticConventions::Trace\} module is deprecated. + # See {OpenTelemetry::SemanticCandidates::MESSAGING::MESSAGING_MESSAGE_PAYLOAD_COMPRESSED_SIZE_BYTES} for its replacement. MESSAGING_MESSAGE_PAYLOAD_COMPRESSED_SIZE_BYTES = 'messaging.message_payload_compressed_size_bytes' # 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) + # + # @deprecated The \{OpenTelemetry::SemanticConventions::Trace\} module is deprecated. + # See {OpenTelemetry::SemanticCandidates::FAAS::FAAS_TIME} for its replacement. FAAS_TIME = 'faas.time' # A string containing the schedule period as [Cron Expression](https://docs.oracle.com/cd/E12058_01/doc/doc.1014/e12030/cron_expressions.htm) + # + # @deprecated The \{OpenTelemetry::SemanticConventions::Trace\} module is deprecated. + # See {OpenTelemetry::SemanticCandidates::FAAS::FAAS_CRON} for its replacement. FAAS_CRON = 'faas.cron' # A boolean that is true if the serverless function is executed for the first time (aka cold-start) + # + # @deprecated The \{OpenTelemetry::SemanticConventions::Trace\} module is deprecated. + # See {OpenTelemetry::SemanticCandidates::FAAS::FAAS_COLDSTART} for its replacement. FAAS_COLDSTART = 'faas.coldstart' # The name of the invoked function # @note SHOULD be equal to the `faas.name` resource attribute of the invoked function + # + # @deprecated The \{OpenTelemetry::SemanticConventions::Trace\} module is deprecated. + # See {OpenTelemetry::SemanticCandidates::FAAS::FAAS_INVOKED_NAME} for its replacement. FAAS_INVOKED_NAME = 'faas.invoked_name' # The cloud provider of the invoked function # @note SHOULD be equal to the `cloud.provider` resource attribute of the invoked function + # + # @deprecated The \{OpenTelemetry::SemanticConventions::Trace\} module is deprecated. + # See {OpenTelemetry::SemanticCandidates::FAAS::FAAS_INVOKED_PROVIDER} for its replacement. FAAS_INVOKED_PROVIDER = 'faas.invoked_provider' # The cloud region of the invoked function # @note SHOULD be equal to the `cloud.region` resource attribute of the invoked function + # + # @deprecated The \{OpenTelemetry::SemanticConventions::Trace\} module is deprecated. + # See {OpenTelemetry::SemanticCandidates::FAAS::FAAS_INVOKED_REGION} for its replacement. FAAS_INVOKED_REGION = 'faas.invoked_region' # 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 + # + # @deprecated The \{OpenTelemetry::SemanticConventions::Trace\} module is deprecated. + # See {OpenTelemetry::SemanticCandidates::PEER::PEER_SERVICE} for its replacement. PEER_SERVICE = 'peer.service' # 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 + # + # @deprecated The \{OpenTelemetry::SemanticConventions::Trace\} module is deprecated. + # See {OpenTelemetry::SemanticCandidates::ENDUSER::ENDUSER_ID} for its replacement. ENDUSER_ID = 'enduser.id' # Actual/assumed role the client is making the request under extracted from token or application security context + # + # @deprecated The \{OpenTelemetry::SemanticConventions::Trace\} module is deprecated. + # See {OpenTelemetry::SemanticCandidates::ENDUSER::ENDUSER_ROLE} for its replacement. ENDUSER_ROLE = 'enduser.role' # 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) + # + # @deprecated The \{OpenTelemetry::SemanticConventions::Trace\} module is deprecated. + # See {OpenTelemetry::SemanticCandidates::ENDUSER::ENDUSER_SCOPE} for its replacement. ENDUSER_SCOPE = 'enduser.scope' # Current "managed" thread ID (as opposed to OS thread ID) + # + # @deprecated The \{OpenTelemetry::SemanticConventions::Trace\} module is deprecated. + # See {OpenTelemetry::SemanticCandidates::THREAD::THREAD_ID} for its replacement. THREAD_ID = 'thread.id' # Current thread name + # + # @deprecated The \{OpenTelemetry::SemanticConventions::Trace\} module is deprecated. + # See {OpenTelemetry::SemanticCandidates::THREAD::THREAD_NAME} for its replacement. THREAD_NAME = 'thread.name' # The method or function name, or equivalent (usually rightmost part of the code unit's name) + # + # @deprecated The \{OpenTelemetry::SemanticConventions::Trace\} module is deprecated. + # See {OpenTelemetry::SemanticCandidates::CODE::CODE_FUNCTION} for its replacement. CODE_FUNCTION = 'code.function' # 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 + # + # @deprecated The \{OpenTelemetry::SemanticConventions::Trace\} module is deprecated. + # See {OpenTelemetry::SemanticCandidates::CODE::CODE_NAMESPACE} for its replacement. CODE_NAMESPACE = 'code.namespace' # The source code file name that identifies the code unit as uniquely as possible (preferably an absolute file path) + # + # @deprecated The \{OpenTelemetry::SemanticConventions::Trace\} module is deprecated. + # See {OpenTelemetry::SemanticCandidates::CODE::CODE_FILEPATH} for its replacement. CODE_FILEPATH = 'code.filepath' # The line number in `code.filepath` best representing the operation. It SHOULD point within the code unit named in `code.function` + # + # @deprecated The \{OpenTelemetry::SemanticConventions::Trace\} module is deprecated. + # See {OpenTelemetry::SemanticCandidates::CODE::CODE_LINENO} for its replacement. CODE_LINENO = 'code.lineno' # The value `aws-api` + # + # @deprecated The \{OpenTelemetry::SemanticConventions::Trace\} module is deprecated. + # See {OpenTelemetry::SemanticCandidates::RPC::RPC_SYSTEM} for its replacement. RPC_SYSTEM = 'rpc.system' # The name of the service to which a request is made, as returned by the AWS SDK # @note This is the logical name of the service from the RPC interface perspective, which can be different from the name of any implementing class. The `code.namespace` attribute may be used to store the latter (despite the attribute name, it may include a class name; e.g., class with method actually executing the call on the server side, RPC client stub class on the client side) + # + # @deprecated The \{OpenTelemetry::SemanticConventions::Trace\} module is deprecated. + # See {OpenTelemetry::SemanticCandidates::RPC::RPC_SERVICE} for its replacement. RPC_SERVICE = 'rpc.service' # The name of the operation corresponding to the request, as returned by the AWS SDK # @note This is the logical name of the method from the RPC interface perspective, which can be different from the name of any implementing method/function. The `code.function` attribute may be used to store the latter (e.g., method actually executing the call on the server side, RPC client stub method on the client side) + # + # @deprecated The \{OpenTelemetry::SemanticConventions::Trace\} module is deprecated. + # See {OpenTelemetry::SemanticCandidates::RPC::RPC_METHOD} for its replacement. RPC_METHOD = 'rpc.method' # The keys in the `RequestItems` object field + # + # @deprecated The \{OpenTelemetry::SemanticConventions::Trace\} module is deprecated. + # See {OpenTelemetry::SemanticCandidates::AWS::AWS_DYNAMODB_TABLE_NAMES} for its replacement. AWS_DYNAMODB_TABLE_NAMES = 'aws.dynamodb.table_names' # The JSON-serialized value of each item in the `ConsumedCapacity` response field + # + # @deprecated The \{OpenTelemetry::SemanticConventions::Trace\} module is deprecated. + # See {OpenTelemetry::SemanticCandidates::AWS::AWS_DYNAMODB_CONSUMED_CAPACITY} for its replacement. AWS_DYNAMODB_CONSUMED_CAPACITY = 'aws.dynamodb.consumed_capacity' # The JSON-serialized value of the `ItemCollectionMetrics` response field + # + # @deprecated The \{OpenTelemetry::SemanticConventions::Trace\} module is deprecated. + # See {OpenTelemetry::SemanticCandidates::AWS::AWS_DYNAMODB_ITEM_COLLECTION_METRICS} for its replacement. AWS_DYNAMODB_ITEM_COLLECTION_METRICS = 'aws.dynamodb.item_collection_metrics' # The value of the `ProvisionedThroughput.ReadCapacityUnits` request parameter + # + # @deprecated The \{OpenTelemetry::SemanticConventions::Trace\} module is deprecated. + # See {OpenTelemetry::SemanticCandidates::AWS::AWS_DYNAMODB_PROVISIONED_READ_CAPACITY} for its replacement. AWS_DYNAMODB_PROVISIONED_READ_CAPACITY = 'aws.dynamodb.provisioned_read_capacity' # The value of the `ProvisionedThroughput.WriteCapacityUnits` request parameter + # + # @deprecated The \{OpenTelemetry::SemanticConventions::Trace\} module is deprecated. + # See {OpenTelemetry::SemanticCandidates::AWS::AWS_DYNAMODB_PROVISIONED_WRITE_CAPACITY} for its replacement. AWS_DYNAMODB_PROVISIONED_WRITE_CAPACITY = 'aws.dynamodb.provisioned_write_capacity' # The value of the `ConsistentRead` request parameter + # + # @deprecated The \{OpenTelemetry::SemanticConventions::Trace\} module is deprecated. + # See {OpenTelemetry::SemanticCandidates::AWS::AWS_DYNAMODB_CONSISTENT_READ} for its replacement. AWS_DYNAMODB_CONSISTENT_READ = 'aws.dynamodb.consistent_read' # The value of the `ProjectionExpression` request parameter + # + # @deprecated The \{OpenTelemetry::SemanticConventions::Trace\} module is deprecated. + # See {OpenTelemetry::SemanticCandidates::AWS::AWS_DYNAMODB_PROJECTION} for its replacement. AWS_DYNAMODB_PROJECTION = 'aws.dynamodb.projection' # The value of the `Limit` request parameter + # + # @deprecated The \{OpenTelemetry::SemanticConventions::Trace\} module is deprecated. + # See {OpenTelemetry::SemanticCandidates::AWS::AWS_DYNAMODB_LIMIT} for its replacement. AWS_DYNAMODB_LIMIT = 'aws.dynamodb.limit' # The value of the `AttributesToGet` request parameter + # + # @deprecated The \{OpenTelemetry::SemanticConventions::Trace\} module is deprecated. + # See {OpenTelemetry::SemanticCandidates::AWS::AWS_DYNAMODB_ATTRIBUTES_TO_GET} for its replacement. AWS_DYNAMODB_ATTRIBUTES_TO_GET = 'aws.dynamodb.attributes_to_get' # The value of the `IndexName` request parameter + # + # @deprecated The \{OpenTelemetry::SemanticConventions::Trace\} module is deprecated. + # See {OpenTelemetry::SemanticCandidates::AWS::AWS_DYNAMODB_INDEX_NAME} for its replacement. AWS_DYNAMODB_INDEX_NAME = 'aws.dynamodb.index_name' # The value of the `Select` request parameter + # + # @deprecated The \{OpenTelemetry::SemanticConventions::Trace\} module is deprecated. + # See {OpenTelemetry::SemanticCandidates::AWS::AWS_DYNAMODB_SELECT} for its replacement. AWS_DYNAMODB_SELECT = 'aws.dynamodb.select' # The JSON-serialized value of each item of the `GlobalSecondaryIndexes` request field + # + # @deprecated The \{OpenTelemetry::SemanticConventions::Trace\} module is deprecated. + # See {OpenTelemetry::SemanticCandidates::AWS::AWS_DYNAMODB_GLOBAL_SECONDARY_INDEXES} for its replacement. AWS_DYNAMODB_GLOBAL_SECONDARY_INDEXES = 'aws.dynamodb.global_secondary_indexes' # The JSON-serialized value of each item of the `LocalSecondaryIndexes` request field + # + # @deprecated The \{OpenTelemetry::SemanticConventions::Trace\} module is deprecated. + # See {OpenTelemetry::SemanticCandidates::AWS::AWS_DYNAMODB_LOCAL_SECONDARY_INDEXES} for its replacement. AWS_DYNAMODB_LOCAL_SECONDARY_INDEXES = 'aws.dynamodb.local_secondary_indexes' # The value of the `ExclusiveStartTableName` request parameter + # + # @deprecated The \{OpenTelemetry::SemanticConventions::Trace\} module is deprecated. + # See {OpenTelemetry::SemanticCandidates::AWS::AWS_DYNAMODB_EXCLUSIVE_START_TABLE} for its replacement. AWS_DYNAMODB_EXCLUSIVE_START_TABLE = 'aws.dynamodb.exclusive_start_table' # The the number of items in the `TableNames` response parameter + # + # @deprecated The \{OpenTelemetry::SemanticConventions::Trace\} module is deprecated. + # See {OpenTelemetry::SemanticCandidates::AWS::AWS_DYNAMODB_TABLE_COUNT} for its replacement. AWS_DYNAMODB_TABLE_COUNT = 'aws.dynamodb.table_count' # The value of the `ScanIndexForward` request parameter + # + # @deprecated The \{OpenTelemetry::SemanticConventions::Trace\} module is deprecated. + # See {OpenTelemetry::SemanticCandidates::AWS::AWS_DYNAMODB_SCAN_FORWARD} for its replacement. AWS_DYNAMODB_SCAN_FORWARD = 'aws.dynamodb.scan_forward' # The value of the `Segment` request parameter + # + # @deprecated The \{OpenTelemetry::SemanticConventions::Trace\} module is deprecated. + # See {OpenTelemetry::SemanticCandidates::AWS::AWS_DYNAMODB_SEGMENT} for its replacement. AWS_DYNAMODB_SEGMENT = 'aws.dynamodb.segment' # The value of the `TotalSegments` request parameter + # + # @deprecated The \{OpenTelemetry::SemanticConventions::Trace\} module is deprecated. + # See {OpenTelemetry::SemanticCandidates::AWS::AWS_DYNAMODB_TOTAL_SEGMENTS} for its replacement. AWS_DYNAMODB_TOTAL_SEGMENTS = 'aws.dynamodb.total_segments' # The value of the `Count` response parameter + # + # @deprecated The \{OpenTelemetry::SemanticConventions::Trace\} module is deprecated. + # See {OpenTelemetry::SemanticCandidates::AWS::AWS_DYNAMODB_COUNT} for its replacement. AWS_DYNAMODB_COUNT = 'aws.dynamodb.count' # The value of the `ScannedCount` response parameter + # + # @deprecated The \{OpenTelemetry::SemanticConventions::Trace\} module is deprecated. + # See {OpenTelemetry::SemanticCandidates::AWS::AWS_DYNAMODB_SCANNED_COUNT} for its replacement. AWS_DYNAMODB_SCANNED_COUNT = 'aws.dynamodb.scanned_count' # The JSON-serialized value of each item in the `AttributeDefinitions` request field + # + # @deprecated The \{OpenTelemetry::SemanticConventions::Trace\} module is deprecated. + # See {OpenTelemetry::SemanticCandidates::AWS::AWS_DYNAMODB_ATTRIBUTE_DEFINITIONS} for its replacement. AWS_DYNAMODB_ATTRIBUTE_DEFINITIONS = 'aws.dynamodb.attribute_definitions' # The JSON-serialized value of each item in the the `GlobalSecondaryIndexUpdates` request field + # + # @deprecated The \{OpenTelemetry::SemanticConventions::Trace\} module is deprecated. + # See {OpenTelemetry::SemanticCandidates::AWS::AWS_DYNAMODB_GLOBAL_SECONDARY_INDEX_UPDATES} for its replacement. AWS_DYNAMODB_GLOBAL_SECONDARY_INDEX_UPDATES = 'aws.dynamodb.global_secondary_index_updates' # 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 + # + # @deprecated The \{OpenTelemetry::SemanticConventions::Trace\} module is deprecated. + # See {OpenTelemetry::SemanticCandidates::MESSAGING::MESSAGING_OPERATION} for its replacement. MESSAGING_OPERATION = 'messaging.operation' # The identifier for the consumer receiving a message. For Kafka, set it to `{messaging.kafka.consumer_group} - {messaging.kafka.client_id}`, if both are present, or only `messaging.kafka.consumer_group`. For brokers, such as RabbitMQ and Artemis, set it to the `client_id` of the client consuming the message + # + # @deprecated The \{OpenTelemetry::SemanticConventions::Trace\} module is deprecated. + # See {OpenTelemetry::SemanticCandidates::MESSAGING::MESSAGING_CONSUMER_ID} for its replacement. MESSAGING_CONSUMER_ID = 'messaging.consumer_id' # RabbitMQ message routing key + # + # @deprecated The \{OpenTelemetry::SemanticConventions::Trace\} module is deprecated. + # See {OpenTelemetry::SemanticCandidates::MESSAGING::MESSAGING_RABBITMQ_ROUTING_KEY} for its replacement. MESSAGING_RABBITMQ_ROUTING_KEY = 'messaging.rabbitmq.routing_key' # 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 # @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 + # + # @deprecated The \{OpenTelemetry::SemanticConventions::Trace\} module is deprecated. + # See {OpenTelemetry::SemanticCandidates::MESSAGING::MESSAGING_KAFKA_MESSAGE_KEY} for its replacement. MESSAGING_KAFKA_MESSAGE_KEY = 'messaging.kafka.message_key' # Name of the Kafka Consumer Group that is handling the message. Only applies to consumers, not producers + # + # @deprecated The \{OpenTelemetry::SemanticConventions::Trace\} module is deprecated. + # See {OpenTelemetry::SemanticCandidates::MESSAGING::MESSAGING_KAFKA_CONSUMER_GROUP} for its replacement. MESSAGING_KAFKA_CONSUMER_GROUP = 'messaging.kafka.consumer_group' # Client Id for the Consumer or Producer that is handling the message + # + # @deprecated The \{OpenTelemetry::SemanticConventions::Trace\} module is deprecated. + # See {OpenTelemetry::SemanticCandidates::MESSAGING::MESSAGING_KAFKA_CLIENT_ID} for its replacement. MESSAGING_KAFKA_CLIENT_ID = 'messaging.kafka.client_id' # Partition the message is sent to + # + # @deprecated The \{OpenTelemetry::SemanticConventions::Trace\} module is deprecated. + # See {OpenTelemetry::SemanticCandidates::MESSAGING::MESSAGING_KAFKA_PARTITION} for its replacement. MESSAGING_KAFKA_PARTITION = 'messaging.kafka.partition' # A boolean that is true if the message is a tombstone + # + # @deprecated The \{OpenTelemetry::SemanticConventions::Trace\} module is deprecated. + # See {OpenTelemetry::SemanticCandidates::MESSAGING::MESSAGING_KAFKA_TOMBSTONE} for its replacement. MESSAGING_KAFKA_TOMBSTONE = 'messaging.kafka.tombstone' # Namespace of RocketMQ resources, resources in different namespaces are individual + # + # @deprecated The \{OpenTelemetry::SemanticConventions::Trace\} module is deprecated. + # See {OpenTelemetry::SemanticCandidates::MESSAGING::MESSAGING_ROCKETMQ_NAMESPACE} for its replacement. MESSAGING_ROCKETMQ_NAMESPACE = 'messaging.rocketmq.namespace' # Name of the RocketMQ producer/consumer group that is handling the message. The client type is identified by the SpanKind + # + # @deprecated The \{OpenTelemetry::SemanticConventions::Trace\} module is deprecated. + # See {OpenTelemetry::SemanticCandidates::MESSAGING::MESSAGING_ROCKETMQ_CLIENT_GROUP} for its replacement. MESSAGING_ROCKETMQ_CLIENT_GROUP = 'messaging.rocketmq.client_group' # The unique identifier for each client + # + # @deprecated The \{OpenTelemetry::SemanticConventions::Trace\} module is deprecated. + # See {OpenTelemetry::SemanticCandidates::MESSAGING::MESSAGING_ROCKETMQ_CLIENT_ID} for its replacement. MESSAGING_ROCKETMQ_CLIENT_ID = 'messaging.rocketmq.client_id' # Type of message + # + # @deprecated The \{OpenTelemetry::SemanticConventions::Trace\} module is deprecated. + # See {OpenTelemetry::SemanticCandidates::MESSAGING::MESSAGING_ROCKETMQ_MESSAGE_TYPE} for its replacement. MESSAGING_ROCKETMQ_MESSAGE_TYPE = 'messaging.rocketmq.message_type' # The secondary classifier of message besides topic + # + # @deprecated The \{OpenTelemetry::SemanticConventions::Trace\} module is deprecated. + # See {OpenTelemetry::SemanticCandidates::MESSAGING::MESSAGING_ROCKETMQ_MESSAGE_TAG} for its replacement. MESSAGING_ROCKETMQ_MESSAGE_TAG = 'messaging.rocketmq.message_tag' # Key(s) of message, another way to mark message besides message id + # + # @deprecated The \{OpenTelemetry::SemanticConventions::Trace\} module is deprecated. + # See {OpenTelemetry::SemanticCandidates::MESSAGING::MESSAGING_ROCKETMQ_MESSAGE_KEYS} for its replacement. MESSAGING_ROCKETMQ_MESSAGE_KEYS = 'messaging.rocketmq.message_keys' # Model of message consumption. This only applies to consumer spans + # + # @deprecated The \{OpenTelemetry::SemanticConventions::Trace\} module is deprecated. + # See {OpenTelemetry::SemanticCandidates::MESSAGING::MESSAGING_ROCKETMQ_CONSUMPTION_MODEL} for its replacement. MESSAGING_ROCKETMQ_CONSUMPTION_MODEL = 'messaging.rocketmq.consumption_model' # The [numeric status code](https://github.com/grpc/grpc/blob/v1.33.2/doc/statuscodes.md) of the gRPC request + # + # @deprecated The \{OpenTelemetry::SemanticConventions::Trace\} module is deprecated. + # See {OpenTelemetry::SemanticCandidates::RPC::RPC_GRPC_STATUS_CODE} for its replacement. RPC_GRPC_STATUS_CODE = 'rpc.grpc.status_code' # Protocol version as in `jsonrpc` property of request/response. Since JSON-RPC 1.0 does not specify this, the value can be omitted + # + # @deprecated The \{OpenTelemetry::SemanticConventions::Trace\} module is deprecated. + # See {OpenTelemetry::SemanticCandidates::RPC::RPC_JSONRPC_VERSION} for its replacement. RPC_JSONRPC_VERSION = 'rpc.jsonrpc.version' # `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 + # + # @deprecated The \{OpenTelemetry::SemanticConventions::Trace\} module is deprecated. + # See {OpenTelemetry::SemanticCandidates::RPC::RPC_JSONRPC_REQUEST_ID} for its replacement. RPC_JSONRPC_REQUEST_ID = 'rpc.jsonrpc.request_id' # `error.code` property of response if it is an error response + # + # @deprecated The \{OpenTelemetry::SemanticConventions::Trace\} module is deprecated. + # See {OpenTelemetry::SemanticCandidates::RPC::RPC_JSONRPC_ERROR_CODE} for its replacement. RPC_JSONRPC_ERROR_CODE = 'rpc.jsonrpc.error_code' # `error.message` property of response if it is an error response + # + # @deprecated The \{OpenTelemetry::SemanticConventions::Trace\} module is deprecated. + # See {OpenTelemetry::SemanticCandidates::RPC::RPC_JSONRPC_ERROR_MESSAGE} for its replacement. RPC_JSONRPC_ERROR_MESSAGE = 'rpc.jsonrpc.error_message' # Whether this is a received or sent message + # + # @deprecated The \{OpenTelemetry::SemanticConventions::Trace\} module is deprecated. + # See {OpenTelemetry::SemanticCandidates::MESSAGE::MESSAGE_TYPE} for its replacement. MESSAGE_TYPE = 'message.type' # MUST be calculated as two different counters starting from `1` one for sent messages and one for received message # @note This way we guarantee that the values will be consistent between different implementations + # + # @deprecated The \{OpenTelemetry::SemanticConventions::Trace\} module is deprecated. + # See {OpenTelemetry::SemanticCandidates::MESSAGE::MESSAGE_ID} for its replacement. MESSAGE_ID = 'message.id' # Compressed size of the message in bytes + # + # @deprecated The \{OpenTelemetry::SemanticConventions::Trace\} module is deprecated. + # See {OpenTelemetry::SemanticCandidates::MESSAGE::MESSAGE_COMPRESSED_SIZE} for its replacement. MESSAGE_COMPRESSED_SIZE = 'message.compressed_size' # Uncompressed size of the message in bytes + # + # @deprecated The \{OpenTelemetry::SemanticConventions::Trace\} module is deprecated. + # See {OpenTelemetry::SemanticCandidates::MESSAGE::MESSAGE_UNCOMPRESSED_SIZE} for its replacement. MESSAGE_UNCOMPRESSED_SIZE = 'message.uncompressed_size' end diff --git a/semantic_conventions/templates/semantic_conventions.j2 b/semantic_conventions/templates/semantic_conventions.j2 index fce6c974e5..a627fed8ab 100644 --- a/semantic_conventions/templates/semantic_conventions.j2 +++ b/semantic_conventions/templates/semantic_conventions.j2 @@ -6,15 +6,19 @@ module OpenTelemetry module SemanticConventions + # @deprecated This module is deprecated in favor of the namespaced modules under + # {OpenTelemetry::SemanticCandidates} (all experimental and stable) and + # {OpenTelemetry::SemanticConventions} (stable) module {{module}} {%- for attribute in attributes | unique(attribute="fqn") %} + {%- set root_namespace = attribute.fqn.split('.')[0] %} # {{ attribute.brief | to_doc_brief | regex_replace(pattern="\n", replace="\n # ") }} {%- if attribute.note %} # @note {{ attribute.note | to_doc_brief | regex_replace(pattern="\n", replace="\n # ") }} {%- endif %} - {%- if attribute.deprecated %} - # @deprecated {{ attribute.deprecated | to_doc_brief | regex_replace(pattern="\n", replace="\n # ") }} - {%- endif %} + # + # @deprecated The \{OpenTelemetry::SemanticConventions::{{module}}\} module is deprecated. + # See {OpenTelemetry::SemanticCandidates::{{ root_namespace | to_const_name}}::{{attribute.fqn | to_const_name}}} for its replacement. {{ attribute.fqn | to_const_name }} = '{{ attribute.fqn }}' {# blank line #} {%- endfor %} From 855904a15948f3f60f0127960ca76e9a854f5cd4 Mon Sep 17 00:00:00 2001 From: Robb Kidd Date: Wed, 10 Jul 2024 17:58:09 -0400 Subject: [PATCH 02/17] update semconv rake targets and templates for v1.26 * pull from the new semconv repo * update jinja2 template for the new structure of convention data * stable semconv names will appear in OpenTelemetry::SemanticConventions while all semconv names (experimental, deprecated, stable, etc) appear in OpenTelemetry::SemanticCandidates - This maps to what other langs (Java, Python, JS) are putting into "Incubating" modules. We opted for "candidates" because OpenTelemetry::SemanticConventions::Incubating::... was getting too long and OpenTelemetry::SemanticIncubating didn't make much sense. * generate a module per root semconv namespace to make navigating docs more focused and to decrease the number of constants loaded when using more precise requires in downstream code * generates only attribute name constants and to an attributes subfolder to prepare for metric name constants to be generated to metrics subfolders, also for decreasing the scope of what gets loaded when downstream instrumentation requires these constants Co-authored-by: Kayla Reopelle (she/her) <87386821+kaylareopelle@users.noreply.github.com> --- semantic_conventions/.rubocop.yml | 2 + semantic_conventions/.yardopts | 3 +- semantic_conventions/Rakefile | 80 +++++++++++++------ .../lib/opentelemetry/semantic_conventions.rb | 4 + .../semantic_conventions/resource.rb | 8 +- .../semantic_conventions/trace.rb | 10 +-- .../semantic_conventions/version.rb | 2 +- semantic_conventions/templates/attributes.j2 | 52 ++++++++++++ semantic_conventions/templates/common.j2 | 25 ++++++ .../templates/semantic_conventions.j2 | 27 ------- 10 files changed, 149 insertions(+), 64 deletions(-) create mode 100644 semantic_conventions/templates/attributes.j2 create mode 100644 semantic_conventions/templates/common.j2 delete mode 100644 semantic_conventions/templates/semantic_conventions.j2 diff --git a/semantic_conventions/.rubocop.yml b/semantic_conventions/.rubocop.yml index e89d75b460..89c24f4c8a 100644 --- a/semantic_conventions/.rubocop.yml +++ b/semantic_conventions/.rubocop.yml @@ -26,6 +26,8 @@ Metrics/MethodLength: Metrics/ModuleLength: Enabled: false +Naming/ClassAndModuleCamelCase: # because the source for generating module names isn't Rubyish enough + Enabled: false Naming/FileName: Exclude: - lib/opentelemetry-semantic_conventions.rb diff --git a/semantic_conventions/.yardopts b/semantic_conventions/.yardopts index b03450ae05..fd17675afe 100644 --- a/semantic_conventions/.yardopts +++ b/semantic_conventions/.yardopts @@ -2,8 +2,7 @@ --title=OpenTelemetry Semantic Conventions --markup=markdown --main=README.md -./lib/opentelemetry/semantic_conventions/**/*.rb -./lib/opentelemetry/semantic_conventions.rb +./lib/opentelemetry/**/*.rb - README.md CHANGELOG.md diff --git a/semantic_conventions/Rakefile b/semantic_conventions/Rakefile index a6cbb8dcf7..eceb09f6b9 100644 --- a/semantic_conventions/Rakefile +++ b/semantic_conventions/Rakefile @@ -9,8 +9,7 @@ require 'rake/testtask' require 'yard' require 'rubocop/rake_task' require 'tmpdir' - -SPEC_VERSION = '1.10.0' +require 'pathname' RuboCop::RakeTask.new @@ -31,34 +30,65 @@ else task default: %i[generate test rubocop yard] end -task :generate do - cwd = Dir.pwd +SPEC_VERSION = '1.26.0' +GENERATOR_VERSION = '0.24.0' +semconv_source_dir = Pathname.new("./tmpsemconvrepo_v#{SPEC_VERSION}") +conventions_output_dir = Pathname.new('./lib/opentelemetry/semantic_conventions') +candidates_output_dir = Pathname.new('./lib/opentelemetry/semantic_candidates') - Dir.mktmpdir('opentelemetry-specification', Dir.pwd) do |tmpdir| - `git clone https://github.com/open-telemetry/opentelemetry-specification.git #{tmpdir}` - Dir.chdir(tmpdir) do - `git fetch` - `git checkout "v#{SPEC_VERSION}"` - end +task generate: %i[update_gem_version generate_stable_attributes generate_candidate_attributes] - %w[trace resource].each do |kind| - cmd = %W[ - docker run --rm - -v "#{tmpdir}/semantic_conventions/#{kind}":/source - -v "#{cwd}/templates":/templates - -v "#{cwd}/lib":/output - otel/semconvgen:0.11.1 - -f /source code - --template /templates/semantic_conventions.j2 - --output /output/opentelemetry/semantic_conventions/#{kind}.rb - -Dmodule=#{kind[0].upcase}#{kind[1..]} - ] +directory semconv_source_dir do + `git clone --depth=1 --branch v#{SPEC_VERSION} https://github.com/open-telemetry/semantic-conventions.git #{semconv_source_dir}` +end - puts "Running: #{cmd.join(' ')}" - `#{cmd.join(' ')}` - end +task check_out_semconv_version: [semconv_source_dir] do + Dir.chdir(semconv_source_dir) do + `git fetch` + `git checkout "v#{SPEC_VERSION}"` end +end + +task generate_stable_attributes: [:check_out_semconv_version] do + conventions_output_dir + .join('attributes') + .glob('*.rb') + .then { |files| FileUtils.rm(files) } + semconvgen(semconv_source_dir, output_root: conventions_output_dir, kind: 'attributes', selector: 'is_stable') +end + +task generate_candidate_attributes: [:check_out_semconv_version] do + candidates_output_dir + .join('attributes') + .glob('*.rb') + .then { |files| FileUtils.rm(files) } + semconvgen(semconv_source_dir, output_root: candidates_output_dir, kind: 'attributes', selector: 'any') +end + +def semconvgen(semconv_source, output_root:, kind:, selector:) + mkdir_p output_root + kind + cwd = Dir.pwd + output_filenames_template = Pathname.new('/output').join(output_root, kind, '{{snake_prefix}}.rb') + cmd = %W[ + docker run --rm + -v "#{semconv_source}/model":/source + -v "#{cwd}/templates":/templates + -v "#{cwd}":/output + otel/semconvgen:#{GENERATOR_VERSION} + --yaml-root /source + --continue-on-validation-errors + code + --file-per-group root_namespace + --template /templates/#{kind}.j2 + --output "#{output_filenames_template}" + -Dselector=#{selector} + ] + + puts "Running: #{cmd.join(' ')}" + `#{cmd.join(' ')}` +end +task :update_gem_version do `sed -i.bak "s/VERSION = '.*'/VERSION = '#{SPEC_VERSION}'/g" lib/opentelemetry/semantic_conventions/version.rb` `rm lib/opentelemetry/semantic_conventions/version.rb.bak` end diff --git a/semantic_conventions/lib/opentelemetry/semantic_conventions.rb b/semantic_conventions/lib/opentelemetry/semantic_conventions.rb index a5c118072f..0cd4a6cdec 100644 --- a/semantic_conventions/lib/opentelemetry/semantic_conventions.rb +++ b/semantic_conventions/lib/opentelemetry/semantic_conventions.rb @@ -10,5 +10,9 @@ module SemanticConventions end end +# TODO: test to make sure the trace and resource constants are present in SemanticCandidates +# TODO: test to make sure the SemanticConventions (stable) constants are all still present in the SemanticCandidates constants +# TODO: remove these convenience requires in the next major version require_relative 'semantic_conventions/trace' require_relative 'semantic_conventions/resource' +# TODO: we're not going to add any more convenience requires here; require directly what you use diff --git a/semantic_conventions/lib/opentelemetry/semantic_conventions/resource.rb b/semantic_conventions/lib/opentelemetry/semantic_conventions/resource.rb index 5487f87e45..2e2db40d1d 100644 --- a/semantic_conventions/lib/opentelemetry/semantic_conventions/resource.rb +++ b/semantic_conventions/lib/opentelemetry/semantic_conventions/resource.rb @@ -185,14 +185,14 @@ module Resource # The unique ID of the single function that this runtime instance executes # @note Depending on the cloud provider, use: - # + # # * **AWS Lambda:** The function [ARN](https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html). # Take care not to use the "invoked ARN" directly but replace any # [alias suffix](https://docs.aws.amazon.com/lambda/latest/dg/configuration-aliases.html) with the resolved function version, as the same runtime instance may be invokable with multiple # different aliases. # * **GCP:** The [URI of the resource](https://cloud.google.com/iam/docs/full-resource-names) # * **Azure:** The [Fully Qualified Resource ID](https://docs.microsoft.com/en-us/rest/api/resources/resources/get-by-id). - # + # # On some providers, it may not be possible to determine the full ID at startup, # which is why this field cannot be made required. For example, on AWS the account ID # part of the ARN is not available without calling another AWS API @@ -205,7 +205,7 @@ module Resource # The immutable version of the function being executed # @note 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:** The [revision](https://cloud.google.com/run/docs/managing/revisions) @@ -549,4 +549,4 @@ module Resource end end -end \ No newline at end of file +end diff --git a/semantic_conventions/lib/opentelemetry/semantic_conventions/trace.rb b/semantic_conventions/lib/opentelemetry/semantic_conventions/trace.rb index e0a03ba2b6..788a53c6e4 100644 --- a/semantic_conventions/lib/opentelemetry/semantic_conventions/trace.rb +++ b/semantic_conventions/lib/opentelemetry/semantic_conventions/trace.rb @@ -216,13 +216,13 @@ module Trace # This may be actually "in flight" in some languages (e.g. if the exception # is passed to a Context manager's `__exit__` method in Python) but will # usually be caught at the point of recording the exception in most languages. - # + # # It is usually not possible to determine at the point where an exception is thrown # whether it will escape the scope of a span. # However, it is trivial to know that an exception # will escape, if one checks for an active exception just before ending the span, # as done in the [example above](#recording-an-exception). - # + # # It follows that an exception may still escape the scope of the span # even if the `exception.escaped` attribute was not set or set to false, # since the event might have been recorded at a time where it was not @@ -235,7 +235,7 @@ module Trace # Type of the trigger which caused this function execution # @note For the server/consumer span on the incoming side, # `faas.trigger` MUST be set. - # + # # Clients invoking FaaS instances usually cannot set `faas.trigger`, # since they would typically need to look in the payload to determine # the event type. If clients set it, it should be the same as the @@ -374,7 +374,7 @@ module Trace # 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)) # @note This is not necessarily the same as `net.peer.ip`, which would # identify the network-level peer, which may be a proxy. - # + # # This attribute should be set when a source of information different # from the one used for `net.peer.ip`, is available even if that other # source just confirms the same value as `net.peer.ip`. @@ -907,4 +907,4 @@ module Trace end end -end \ No newline at end of file +end diff --git a/semantic_conventions/lib/opentelemetry/semantic_conventions/version.rb b/semantic_conventions/lib/opentelemetry/semantic_conventions/version.rb index b323abd7e3..47751f20d0 100644 --- a/semantic_conventions/lib/opentelemetry/semantic_conventions/version.rb +++ b/semantic_conventions/lib/opentelemetry/semantic_conventions/version.rb @@ -6,6 +6,6 @@ module OpenTelemetry module SemanticConventions - VERSION = '1.10.0' + VERSION = '1.26.0' end end diff --git a/semantic_conventions/templates/attributes.j2 b/semantic_conventions/templates/attributes.j2 new file mode 100644 index 0000000000..5d29d850a0 --- /dev/null +++ b/semantic_conventions/templates/attributes.j2 @@ -0,0 +1,52 @@ +{#- +# 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. +#} +{%- import 'common.j2' as common -%} +{%- if selector == 'any' -%} +{%- set filtered_attributes = attributes_and_templates | list -%} +{%- set module_name = 'SemanticCandidates' -%} +{%- elif selector == 'is_stable' -%} +{%- set filtered_attributes = attributes_and_templates | select(selector) | list -%} +{%- set module_name = 'SemanticConventions' -%} +{%- endif -%} +{%- if filtered_attributes | count > 0 -%} {# only produce code if there are attributes #} +{{- common.file_header() }} + +module OpenTelemetry + module {{ module_name }} + module {{ root_namespace | to_const_name }} {# TODO: macro to PascalCase with exceptions for AspNetCore, HTTP, etc? #} + # @!group Attribute Names + {% for attribute in filtered_attributes %} + # {{ common.to_docstring(attribute.brief) }} + {%- if attribute.note %} + # + # {{ common.to_docstring(attribute.note) }} + {%- endif %} + # + # @note {{ attribute.stability }} + {%- if attribute | is_deprecated %} + # + # @deprecated {{ common.to_docstring(attribute.deprecated) }} + {%- elif attribute | is_stable and selector == 'any' %} + # + # @deprecated Now available in the stable namespace at {OpenTelemetry::SemanticConventions::{{ root_namespace | to_const_name }}::{{ attribute.attr_id | to_const_name }}}. + {%- endif %} + {{ attribute.fqn | to_const_name }} = '{{ attribute.fqn }}' + {% endfor %} + # @!endgroup + end + end +end + +{%- endif -%} {# only produce code if there are attributes #} diff --git a/semantic_conventions/templates/common.j2 b/semantic_conventions/templates/common.j2 new file mode 100644 index 0000000000..432c05e8dc --- /dev/null +++ b/semantic_conventions/templates/common.j2 @@ -0,0 +1,25 @@ +{%- macro file_header() -%} +# 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. +{%- endmacro -%} + +{%- macro to_docstring(str) -%} +{{ str | to_doc_brief | regex_replace(pattern="\n", replace="\n # ") }} +{%- endmacro -%} diff --git a/semantic_conventions/templates/semantic_conventions.j2 b/semantic_conventions/templates/semantic_conventions.j2 deleted file mode 100644 index a627fed8ab..0000000000 --- a/semantic_conventions/templates/semantic_conventions.j2 +++ /dev/null @@ -1,27 +0,0 @@ -# frozen_string_literal: true - -# Copyright The OpenTelemetry Authors -# -# SPDX-License-Identifier: Apache-2.0 - -module OpenTelemetry - module SemanticConventions - # @deprecated This module is deprecated in favor of the namespaced modules under - # {OpenTelemetry::SemanticCandidates} (all experimental and stable) and - # {OpenTelemetry::SemanticConventions} (stable) - module {{module}} - {%- for attribute in attributes | unique(attribute="fqn") %} - {%- set root_namespace = attribute.fqn.split('.')[0] %} - # {{ attribute.brief | to_doc_brief | regex_replace(pattern="\n", replace="\n # ") }} - {%- if attribute.note %} - # @note {{ attribute.note | to_doc_brief | regex_replace(pattern="\n", replace="\n # ") }} - {%- endif %} - # - # @deprecated The \{OpenTelemetry::SemanticConventions::{{module}}\} module is deprecated. - # See {OpenTelemetry::SemanticCandidates::{{ root_namespace | to_const_name}}::{{attribute.fqn | to_const_name}}} for its replacement. - {{ attribute.fqn | to_const_name }} = '{{ attribute.fqn }}' -{# blank line #} - {%- endfor %} - end - end -end From e942876c72e9183d43fd254fd41eb4698f9aaa58 Mon Sep 17 00:00:00 2001 From: Robb Kidd Date: Wed, 10 Jul 2024 17:58:53 -0400 Subject: [PATCH 03/17] the code generated --- .../semantic_candidates/attributes/android.rb | 41 +++ .../attributes/aspnetcore.rb | 78 +++++ .../semantic_candidates/attributes/aws.rb | 293 ++++++++++++++++++ .../semantic_candidates/attributes/browser.rb | 58 ++++ .../semantic_candidates/attributes/client.rb | 47 +++ .../semantic_candidates/attributes/cloud.rb | 83 +++++ .../attributes/cloudevents.rb | 54 ++++ .../semantic_candidates/attributes/code.rb | 59 ++++ .../attributes/container.rb | 104 +++++++ .../semantic_candidates/attributes/db.rb | 256 +++++++++++++++ .../attributes/deployment.rb | 42 +++ .../attributes/destination.rb | 41 +++ .../semantic_candidates/attributes/device.rb | 57 ++++ .../semantic_candidates/attributes/disk.rb | 34 ++ .../semantic_candidates/attributes/dns.rb | 36 +++ .../semantic_candidates/attributes/enduser.rb | 44 +++ .../semantic_candidates/attributes/error.rb | 56 ++++ .../semantic_candidates/attributes/event.rb | 36 +++ .../attributes/exception.rb | 74 +++++ .../semantic_candidates/attributes/faas.rb | 146 +++++++++ .../attributes/feature_flag.rb | 53 ++++ .../semantic_candidates/attributes/file.rb | 56 ++++ .../semantic_candidates/attributes/gcp.rb | 49 +++ .../semantic_candidates/attributes/gen_ai.rb | 95 ++++++ .../semantic_candidates/attributes/graphql.rb | 46 +++ .../semantic_candidates/attributes/heroku.rb | 44 +++ .../semantic_candidates/attributes/host.rb | 110 +++++++ .../semantic_candidates/attributes/http.rb | 229 ++++++++++++++ .../semantic_candidates/attributes/ios.rb | 38 +++ .../semantic_candidates/attributes/jvm.rb | 84 +++++ .../semantic_candidates/attributes/k8s.rb | 179 +++++++++++ .../semantic_candidates/attributes/log.rb | 62 ++++ .../semantic_candidates/attributes/message.rb | 57 ++++ .../attributes/messaging.rb | 277 +++++++++++++++++ .../semantic_candidates/attributes/net.rb | 134 ++++++++ .../semantic_candidates/attributes/network.rb | 132 ++++++++ .../semantic_candidates/attributes/oci.rb | 37 +++ .../attributes/opentracing.rb | 36 +++ .../semantic_candidates/attributes/os.rb | 54 ++++ .../semantic_candidates/attributes/otel.rb | 71 +++++ .../semantic_candidates/attributes/other.rb | 36 +++ .../semantic_candidates/attributes/peer.rb | 34 ++ .../semantic_candidates/attributes/pool.rb | 36 +++ .../semantic_candidates/attributes/process.rb | 166 ++++++++++ .../semantic_candidates/attributes/rpc.rb | 128 ++++++++ .../semantic_candidates/attributes/server.rb | 47 +++ .../semantic_candidates/attributes/service.rb | 84 +++++ .../semantic_candidates/attributes/session.rb | 39 +++ .../semantic_candidates/attributes/signalr.rb | 43 +++ .../semantic_candidates/attributes/source.rb | 41 +++ .../semantic_candidates/attributes/system.rb | 101 ++++++ .../attributes/telemetry.rb | 70 +++++ .../semantic_candidates/attributes/thread.rb | 39 +++ .../semantic_candidates/attributes/tls.rb | 176 +++++++++++ .../semantic_candidates/attributes/url.rb | 125 ++++++++ .../attributes/user_agent.rb | 50 +++ .../attributes/webengine.rb | 44 +++ .../attributes/aspnetcore.rb | 64 ++++ .../semantic_conventions/attributes/client.rb | 43 +++ .../semantic_conventions/attributes/error.rb | 54 ++++ .../attributes/exception.rb | 66 ++++ .../semantic_conventions/attributes/http.rb | 92 ++++++ .../semantic_conventions/attributes/jvm.rb | 65 ++++ .../attributes/network.rb | 81 +++++ .../semantic_conventions/attributes/otel.rb | 49 +++ .../semantic_conventions/attributes/server.rb | 43 +++ .../attributes/service.rb | 41 +++ .../attributes/signalr.rb | 39 +++ .../attributes/telemetry.rb | 51 +++ .../semantic_conventions/attributes/url.rb | 62 ++++ .../attributes/user_agent.rb | 34 ++ 71 files changed, 5525 insertions(+) create mode 100644 semantic_conventions/lib/opentelemetry/semantic_candidates/attributes/android.rb create mode 100644 semantic_conventions/lib/opentelemetry/semantic_candidates/attributes/aspnetcore.rb create mode 100644 semantic_conventions/lib/opentelemetry/semantic_candidates/attributes/aws.rb create mode 100644 semantic_conventions/lib/opentelemetry/semantic_candidates/attributes/browser.rb create mode 100644 semantic_conventions/lib/opentelemetry/semantic_candidates/attributes/client.rb create mode 100644 semantic_conventions/lib/opentelemetry/semantic_candidates/attributes/cloud.rb create mode 100644 semantic_conventions/lib/opentelemetry/semantic_candidates/attributes/cloudevents.rb create mode 100644 semantic_conventions/lib/opentelemetry/semantic_candidates/attributes/code.rb create mode 100644 semantic_conventions/lib/opentelemetry/semantic_candidates/attributes/container.rb create mode 100644 semantic_conventions/lib/opentelemetry/semantic_candidates/attributes/db.rb create mode 100644 semantic_conventions/lib/opentelemetry/semantic_candidates/attributes/deployment.rb create mode 100644 semantic_conventions/lib/opentelemetry/semantic_candidates/attributes/destination.rb create mode 100644 semantic_conventions/lib/opentelemetry/semantic_candidates/attributes/device.rb create mode 100644 semantic_conventions/lib/opentelemetry/semantic_candidates/attributes/disk.rb create mode 100644 semantic_conventions/lib/opentelemetry/semantic_candidates/attributes/dns.rb create mode 100644 semantic_conventions/lib/opentelemetry/semantic_candidates/attributes/enduser.rb create mode 100644 semantic_conventions/lib/opentelemetry/semantic_candidates/attributes/error.rb create mode 100644 semantic_conventions/lib/opentelemetry/semantic_candidates/attributes/event.rb create mode 100644 semantic_conventions/lib/opentelemetry/semantic_candidates/attributes/exception.rb create mode 100644 semantic_conventions/lib/opentelemetry/semantic_candidates/attributes/faas.rb create mode 100644 semantic_conventions/lib/opentelemetry/semantic_candidates/attributes/feature_flag.rb create mode 100644 semantic_conventions/lib/opentelemetry/semantic_candidates/attributes/file.rb create mode 100644 semantic_conventions/lib/opentelemetry/semantic_candidates/attributes/gcp.rb create mode 100644 semantic_conventions/lib/opentelemetry/semantic_candidates/attributes/gen_ai.rb create mode 100644 semantic_conventions/lib/opentelemetry/semantic_candidates/attributes/graphql.rb create mode 100644 semantic_conventions/lib/opentelemetry/semantic_candidates/attributes/heroku.rb create mode 100644 semantic_conventions/lib/opentelemetry/semantic_candidates/attributes/host.rb create mode 100644 semantic_conventions/lib/opentelemetry/semantic_candidates/attributes/http.rb create mode 100644 semantic_conventions/lib/opentelemetry/semantic_candidates/attributes/ios.rb create mode 100644 semantic_conventions/lib/opentelemetry/semantic_candidates/attributes/jvm.rb create mode 100644 semantic_conventions/lib/opentelemetry/semantic_candidates/attributes/k8s.rb create mode 100644 semantic_conventions/lib/opentelemetry/semantic_candidates/attributes/log.rb create mode 100644 semantic_conventions/lib/opentelemetry/semantic_candidates/attributes/message.rb create mode 100644 semantic_conventions/lib/opentelemetry/semantic_candidates/attributes/messaging.rb create mode 100644 semantic_conventions/lib/opentelemetry/semantic_candidates/attributes/net.rb create mode 100644 semantic_conventions/lib/opentelemetry/semantic_candidates/attributes/network.rb create mode 100644 semantic_conventions/lib/opentelemetry/semantic_candidates/attributes/oci.rb create mode 100644 semantic_conventions/lib/opentelemetry/semantic_candidates/attributes/opentracing.rb create mode 100644 semantic_conventions/lib/opentelemetry/semantic_candidates/attributes/os.rb create mode 100644 semantic_conventions/lib/opentelemetry/semantic_candidates/attributes/otel.rb create mode 100644 semantic_conventions/lib/opentelemetry/semantic_candidates/attributes/other.rb create mode 100644 semantic_conventions/lib/opentelemetry/semantic_candidates/attributes/peer.rb create mode 100644 semantic_conventions/lib/opentelemetry/semantic_candidates/attributes/pool.rb create mode 100644 semantic_conventions/lib/opentelemetry/semantic_candidates/attributes/process.rb create mode 100644 semantic_conventions/lib/opentelemetry/semantic_candidates/attributes/rpc.rb create mode 100644 semantic_conventions/lib/opentelemetry/semantic_candidates/attributes/server.rb create mode 100644 semantic_conventions/lib/opentelemetry/semantic_candidates/attributes/service.rb create mode 100644 semantic_conventions/lib/opentelemetry/semantic_candidates/attributes/session.rb create mode 100644 semantic_conventions/lib/opentelemetry/semantic_candidates/attributes/signalr.rb create mode 100644 semantic_conventions/lib/opentelemetry/semantic_candidates/attributes/source.rb create mode 100644 semantic_conventions/lib/opentelemetry/semantic_candidates/attributes/system.rb create mode 100644 semantic_conventions/lib/opentelemetry/semantic_candidates/attributes/telemetry.rb create mode 100644 semantic_conventions/lib/opentelemetry/semantic_candidates/attributes/thread.rb create mode 100644 semantic_conventions/lib/opentelemetry/semantic_candidates/attributes/tls.rb create mode 100644 semantic_conventions/lib/opentelemetry/semantic_candidates/attributes/url.rb create mode 100644 semantic_conventions/lib/opentelemetry/semantic_candidates/attributes/user_agent.rb create mode 100644 semantic_conventions/lib/opentelemetry/semantic_candidates/attributes/webengine.rb create mode 100644 semantic_conventions/lib/opentelemetry/semantic_conventions/attributes/aspnetcore.rb create mode 100644 semantic_conventions/lib/opentelemetry/semantic_conventions/attributes/client.rb create mode 100644 semantic_conventions/lib/opentelemetry/semantic_conventions/attributes/error.rb create mode 100644 semantic_conventions/lib/opentelemetry/semantic_conventions/attributes/exception.rb create mode 100644 semantic_conventions/lib/opentelemetry/semantic_conventions/attributes/http.rb create mode 100644 semantic_conventions/lib/opentelemetry/semantic_conventions/attributes/jvm.rb create mode 100644 semantic_conventions/lib/opentelemetry/semantic_conventions/attributes/network.rb create mode 100644 semantic_conventions/lib/opentelemetry/semantic_conventions/attributes/otel.rb create mode 100644 semantic_conventions/lib/opentelemetry/semantic_conventions/attributes/server.rb create mode 100644 semantic_conventions/lib/opentelemetry/semantic_conventions/attributes/service.rb create mode 100644 semantic_conventions/lib/opentelemetry/semantic_conventions/attributes/signalr.rb create mode 100644 semantic_conventions/lib/opentelemetry/semantic_conventions/attributes/telemetry.rb create mode 100644 semantic_conventions/lib/opentelemetry/semantic_conventions/attributes/url.rb create mode 100644 semantic_conventions/lib/opentelemetry/semantic_conventions/attributes/user_agent.rb diff --git a/semantic_conventions/lib/opentelemetry/semantic_candidates/attributes/android.rb b/semantic_conventions/lib/opentelemetry/semantic_candidates/attributes/android.rb new file mode 100644 index 0000000000..71ed6dfabe --- /dev/null +++ b/semantic_conventions/lib/opentelemetry/semantic_candidates/attributes/android.rb @@ -0,0 +1,41 @@ +# 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 SemanticCandidates + module ANDROID + # @!group Attribute Names + + # Uniquely identifies the framework API revision offered by a version (`os.version`) of the android operating system. More information can be found [here](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels) + # + # @note StabilityLevel.EXPERIMENTAL + ANDROID_OS_API_LEVEL = 'android.os.api_level' + + # Deprecated use the `device.app.lifecycle` event definition including `android.state` as a payload field instead + # + # The Android lifecycle states are defined in [Activity lifecycle callbacks](https://developer.android.com/guide/components/activities/activity-lifecycle#lc), and from which the `OS identifiers` are derived + # + # @note StabilityLevel.EXPERIMENTAL + ANDROID_STATE = 'android.state' + + # @!endgroup + end + end +end \ No newline at end of file diff --git a/semantic_conventions/lib/opentelemetry/semantic_candidates/attributes/aspnetcore.rb b/semantic_conventions/lib/opentelemetry/semantic_candidates/attributes/aspnetcore.rb new file mode 100644 index 0000000000..68ca0e5890 --- /dev/null +++ b/semantic_conventions/lib/opentelemetry/semantic_candidates/attributes/aspnetcore.rb @@ -0,0 +1,78 @@ +# 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 SemanticCandidates + module ASPNETCORE + # @!group Attribute Names + + # ASP.NET Core exception middleware handling result + # + # @note StabilityLevel.STABLE + # + # @deprecated Now available in the stable namespace at {OpenTelemetry::SemanticConventions::ASPNETCORE::DIAGNOSTICS_EXCEPTION_RESULT}. + ASPNETCORE_DIAGNOSTICS_EXCEPTION_RESULT = 'aspnetcore.diagnostics.exception.result' + + # Full type name of the [`IExceptionHandler`](https://learn.microsoft.com/dotnet/api/microsoft.aspnetcore.diagnostics.iexceptionhandler) implementation that handled the exception + # + # @note StabilityLevel.STABLE + # + # @deprecated Now available in the stable namespace at {OpenTelemetry::SemanticConventions::ASPNETCORE::DIAGNOSTICS_HANDLER_TYPE}. + ASPNETCORE_DIAGNOSTICS_HANDLER_TYPE = 'aspnetcore.diagnostics.handler.type' + + # Rate limiting policy name + # + # @note StabilityLevel.STABLE + # + # @deprecated Now available in the stable namespace at {OpenTelemetry::SemanticConventions::ASPNETCORE::RATE_LIMITING_POLICY}. + ASPNETCORE_RATE_LIMITING_POLICY = 'aspnetcore.rate_limiting.policy' + + # Rate-limiting result, shows whether the lease was acquired or contains a rejection reason + # + # @note StabilityLevel.STABLE + # + # @deprecated Now available in the stable namespace at {OpenTelemetry::SemanticConventions::ASPNETCORE::RATE_LIMITING_RESULT}. + ASPNETCORE_RATE_LIMITING_RESULT = 'aspnetcore.rate_limiting.result' + + # Flag indicating if request was handled by the application pipeline + # + # @note StabilityLevel.STABLE + # + # @deprecated Now available in the stable namespace at {OpenTelemetry::SemanticConventions::ASPNETCORE::REQUEST_IS_UNHANDLED}. + ASPNETCORE_REQUEST_IS_UNHANDLED = 'aspnetcore.request.is_unhandled' + + # A value that indicates whether the matched route is a fallback route + # + # @note StabilityLevel.STABLE + # + # @deprecated Now available in the stable namespace at {OpenTelemetry::SemanticConventions::ASPNETCORE::ROUTING_IS_FALLBACK}. + ASPNETCORE_ROUTING_IS_FALLBACK = 'aspnetcore.routing.is_fallback' + + # Match result - success or failure + # + # @note StabilityLevel.STABLE + # + # @deprecated Now available in the stable namespace at {OpenTelemetry::SemanticConventions::ASPNETCORE::ROUTING_MATCH_STATUS}. + ASPNETCORE_ROUTING_MATCH_STATUS = 'aspnetcore.routing.match_status' + + # @!endgroup + end + end +end \ No newline at end of file diff --git a/semantic_conventions/lib/opentelemetry/semantic_candidates/attributes/aws.rb b/semantic_conventions/lib/opentelemetry/semantic_candidates/attributes/aws.rb new file mode 100644 index 0000000000..99098466b9 --- /dev/null +++ b/semantic_conventions/lib/opentelemetry/semantic_candidates/attributes/aws.rb @@ -0,0 +1,293 @@ +# 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 SemanticCandidates + module AWS + # @!group Attribute Names + + # The JSON-serialized value of each item in the `AttributeDefinitions` request field + # + # @note StabilityLevel.EXPERIMENTAL + AWS_DYNAMODB_ATTRIBUTE_DEFINITIONS = 'aws.dynamodb.attribute_definitions' + + # The value of the `AttributesToGet` request parameter + # + # @note StabilityLevel.EXPERIMENTAL + AWS_DYNAMODB_ATTRIBUTES_TO_GET = 'aws.dynamodb.attributes_to_get' + + # The value of the `ConsistentRead` request parameter + # + # @note StabilityLevel.EXPERIMENTAL + AWS_DYNAMODB_CONSISTENT_READ = 'aws.dynamodb.consistent_read' + + # The JSON-serialized value of each item in the `ConsumedCapacity` response field + # + # @note StabilityLevel.EXPERIMENTAL + AWS_DYNAMODB_CONSUMED_CAPACITY = 'aws.dynamodb.consumed_capacity' + + # The value of the `Count` response parameter + # + # @note StabilityLevel.EXPERIMENTAL + AWS_DYNAMODB_COUNT = 'aws.dynamodb.count' + + # The value of the `ExclusiveStartTableName` request parameter + # + # @note StabilityLevel.EXPERIMENTAL + AWS_DYNAMODB_EXCLUSIVE_START_TABLE = 'aws.dynamodb.exclusive_start_table' + + # The JSON-serialized value of each item in the `GlobalSecondaryIndexUpdates` request field + # + # @note StabilityLevel.EXPERIMENTAL + AWS_DYNAMODB_GLOBAL_SECONDARY_INDEX_UPDATES = 'aws.dynamodb.global_secondary_index_updates' + + # The JSON-serialized value of each item of the `GlobalSecondaryIndexes` request field + # + # @note StabilityLevel.EXPERIMENTAL + AWS_DYNAMODB_GLOBAL_SECONDARY_INDEXES = 'aws.dynamodb.global_secondary_indexes' + + # The value of the `IndexName` request parameter + # + # @note StabilityLevel.EXPERIMENTAL + AWS_DYNAMODB_INDEX_NAME = 'aws.dynamodb.index_name' + + # The JSON-serialized value of the `ItemCollectionMetrics` response field + # + # @note StabilityLevel.EXPERIMENTAL + AWS_DYNAMODB_ITEM_COLLECTION_METRICS = 'aws.dynamodb.item_collection_metrics' + + # The value of the `Limit` request parameter + # + # @note StabilityLevel.EXPERIMENTAL + AWS_DYNAMODB_LIMIT = 'aws.dynamodb.limit' + + # The JSON-serialized value of each item of the `LocalSecondaryIndexes` request field + # + # @note StabilityLevel.EXPERIMENTAL + AWS_DYNAMODB_LOCAL_SECONDARY_INDEXES = 'aws.dynamodb.local_secondary_indexes' + + # The value of the `ProjectionExpression` request parameter + # + # @note StabilityLevel.EXPERIMENTAL + AWS_DYNAMODB_PROJECTION = 'aws.dynamodb.projection' + + # The value of the `ProvisionedThroughput.ReadCapacityUnits` request parameter + # + # @note StabilityLevel.EXPERIMENTAL + AWS_DYNAMODB_PROVISIONED_READ_CAPACITY = 'aws.dynamodb.provisioned_read_capacity' + + # The value of the `ProvisionedThroughput.WriteCapacityUnits` request parameter + # + # @note StabilityLevel.EXPERIMENTAL + AWS_DYNAMODB_PROVISIONED_WRITE_CAPACITY = 'aws.dynamodb.provisioned_write_capacity' + + # The value of the `ScanIndexForward` request parameter + # + # @note StabilityLevel.EXPERIMENTAL + AWS_DYNAMODB_SCAN_FORWARD = 'aws.dynamodb.scan_forward' + + # The value of the `ScannedCount` response parameter + # + # @note StabilityLevel.EXPERIMENTAL + AWS_DYNAMODB_SCANNED_COUNT = 'aws.dynamodb.scanned_count' + + # The value of the `Segment` request parameter + # + # @note StabilityLevel.EXPERIMENTAL + AWS_DYNAMODB_SEGMENT = 'aws.dynamodb.segment' + + # The value of the `Select` request parameter + # + # @note StabilityLevel.EXPERIMENTAL + AWS_DYNAMODB_SELECT = 'aws.dynamodb.select' + + # The number of items in the `TableNames` response parameter + # + # @note StabilityLevel.EXPERIMENTAL + AWS_DYNAMODB_TABLE_COUNT = 'aws.dynamodb.table_count' + + # The keys in the `RequestItems` object field + # + # @note StabilityLevel.EXPERIMENTAL + AWS_DYNAMODB_TABLE_NAMES = 'aws.dynamodb.table_names' + + # The value of the `TotalSegments` request parameter + # + # @note StabilityLevel.EXPERIMENTAL + AWS_DYNAMODB_TOTAL_SEGMENTS = 'aws.dynamodb.total_segments' + + # The ARN of an [ECS cluster](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/clusters.html) + # + # @note StabilityLevel.EXPERIMENTAL + AWS_ECS_CLUSTER_ARN = 'aws.ecs.cluster.arn' + + # The Amazon Resource Name (ARN) of an [ECS container instance](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ECS_instances.html) + # + # @note StabilityLevel.EXPERIMENTAL + AWS_ECS_CONTAINER_ARN = 'aws.ecs.container.arn' + + # The [launch type](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/launch_types.html) for an ECS task + # + # @note StabilityLevel.EXPERIMENTAL + AWS_ECS_LAUNCHTYPE = 'aws.ecs.launchtype' + + # The ARN of a running [ECS task](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-account-settings.html#ecs-resource-ids) + # + # @note StabilityLevel.EXPERIMENTAL + AWS_ECS_TASK_ARN = 'aws.ecs.task.arn' + + # The family name of the [ECS task definition](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task_definitions.html) used to create the ECS task + # + # @note StabilityLevel.EXPERIMENTAL + AWS_ECS_TASK_FAMILY = 'aws.ecs.task.family' + + # The ID of a running ECS task. The ID MUST be extracted from `task.arn` + # + # @note StabilityLevel.EXPERIMENTAL + AWS_ECS_TASK_ID = 'aws.ecs.task.id' + + # The revision for the task definition used to create the ECS task + # + # @note StabilityLevel.EXPERIMENTAL + AWS_ECS_TASK_REVISION = 'aws.ecs.task.revision' + + # The ARN of an EKS cluster + # + # @note StabilityLevel.EXPERIMENTAL + AWS_EKS_CLUSTER_ARN = 'aws.eks.cluster.arn' + + # The full invoked ARN as provided on the `Context` passed to the function (`Lambda-Runtime-Invoked-Function-Arn` header on the `/runtime/invocation/next` applicable) + # + # This may be different from `cloud.resource_id` if an alias is involved + # + # @note StabilityLevel.EXPERIMENTAL + AWS_LAMBDA_INVOKED_ARN = 'aws.lambda.invoked_arn' + + # The Amazon Resource Name(s) (ARN) of the AWS log group(s) + # + # See the [log group ARN format documentation](https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/iam-access-control-overview-cwl.html#CWL_ARN_Format) + # + # @note StabilityLevel.EXPERIMENTAL + AWS_LOG_GROUP_ARNS = 'aws.log.group.arns' + + # The name(s) of the AWS log group(s) an application is writing to + # + # 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 + # + # @note StabilityLevel.EXPERIMENTAL + AWS_LOG_GROUP_NAMES = 'aws.log.group.names' + + # The ARN(s) of the AWS log stream(s) + # + # 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 + # + # @note StabilityLevel.EXPERIMENTAL + AWS_LOG_STREAM_ARNS = 'aws.log.stream.arns' + + # The name(s) of the AWS log stream(s) an application is writing to + # + # @note StabilityLevel.EXPERIMENTAL + AWS_LOG_STREAM_NAMES = 'aws.log.stream.names' + + # The AWS request ID as returned in the response headers `x-amz-request-id` or `x-amz-requestid` + # + # @note StabilityLevel.EXPERIMENTAL + AWS_REQUEST_ID = 'aws.request_id' + + # The S3 bucket name the request refers to. Corresponds to the `--bucket` parameter of the [S3 API](https://docs.aws.amazon.com/cli/latest/reference/s3api/index.html) operations + # + # The `bucket` attribute is applicable to all S3 operations that reference a bucket, i.e. that require the bucket name as a mandatory parameter. + # This applies to almost all S3 operations except `list-buckets` + # + # @note StabilityLevel.EXPERIMENTAL + AWS_S3_BUCKET = 'aws.s3.bucket' + + # The source object (in the form `bucket`/`key`) for the copy operation + # + # The `copy_source` attribute applies to S3 copy operations and corresponds to the `--copy-source` parameter + # of the [copy-object operation within the S3 API](https://docs.aws.amazon.com/cli/latest/reference/s3api/copy-object.html). + # This applies in particular to the following operations: + # + # - [copy-object](https://docs.aws.amazon.com/cli/latest/reference/s3api/copy-object.html) + # - [upload-part-copy](https://docs.aws.amazon.com/cli/latest/reference/s3api/upload-part-copy.html) + # + # @note StabilityLevel.EXPERIMENTAL + AWS_S3_COPY_SOURCE = 'aws.s3.copy_source' + + # The delete request container that specifies the objects to be deleted + # + # The `delete` attribute is only applicable to the [delete-object](https://docs.aws.amazon.com/cli/latest/reference/s3api/delete-object.html) operation. + # The `delete` attribute corresponds to the `--delete` parameter of the + # [delete-objects operation within the S3 API](https://docs.aws.amazon.com/cli/latest/reference/s3api/delete-objects.html) + # + # @note StabilityLevel.EXPERIMENTAL + AWS_S3_DELETE = 'aws.s3.delete' + + # The S3 object key the request refers to. Corresponds to the `--key` parameter of the [S3 API](https://docs.aws.amazon.com/cli/latest/reference/s3api/index.html) operations + # + # The `key` attribute is applicable to all object-related S3 operations, i.e. that require the object key as a mandatory parameter. + # This applies in particular to the following operations: + # + # - [copy-object](https://docs.aws.amazon.com/cli/latest/reference/s3api/copy-object.html) + # - [delete-object](https://docs.aws.amazon.com/cli/latest/reference/s3api/delete-object.html) + # - [get-object](https://docs.aws.amazon.com/cli/latest/reference/s3api/get-object.html) + # - [head-object](https://docs.aws.amazon.com/cli/latest/reference/s3api/head-object.html) + # - [put-object](https://docs.aws.amazon.com/cli/latest/reference/s3api/put-object.html) + # - [restore-object](https://docs.aws.amazon.com/cli/latest/reference/s3api/restore-object.html) + # - [select-object-content](https://docs.aws.amazon.com/cli/latest/reference/s3api/select-object-content.html) + # - [abort-multipart-upload](https://docs.aws.amazon.com/cli/latest/reference/s3api/abort-multipart-upload.html) + # - [complete-multipart-upload](https://docs.aws.amazon.com/cli/latest/reference/s3api/complete-multipart-upload.html) + # - [create-multipart-upload](https://docs.aws.amazon.com/cli/latest/reference/s3api/create-multipart-upload.html) + # - [list-parts](https://docs.aws.amazon.com/cli/latest/reference/s3api/list-parts.html) + # - [upload-part](https://docs.aws.amazon.com/cli/latest/reference/s3api/upload-part.html) + # - [upload-part-copy](https://docs.aws.amazon.com/cli/latest/reference/s3api/upload-part-copy.html) + # + # @note StabilityLevel.EXPERIMENTAL + AWS_S3_KEY = 'aws.s3.key' + + # The part number of the part being uploaded in a multipart-upload operation. This is a positive integer between 1 and 10,000 + # + # The `part_number` attribute is only applicable to the [upload-part](https://docs.aws.amazon.com/cli/latest/reference/s3api/upload-part.html) + # and [upload-part-copy](https://docs.aws.amazon.com/cli/latest/reference/s3api/upload-part-copy.html) operations. + # The `part_number` attribute corresponds to the `--part-number` parameter of the + # [upload-part operation within the S3 API](https://docs.aws.amazon.com/cli/latest/reference/s3api/upload-part.html) + # + # @note StabilityLevel.EXPERIMENTAL + AWS_S3_PART_NUMBER = 'aws.s3.part_number' + + # Upload ID that identifies the multipart upload + # + # The `upload_id` attribute applies to S3 multipart-upload operations and corresponds to the `--upload-id` parameter + # of the [S3 API](https://docs.aws.amazon.com/cli/latest/reference/s3api/index.html) multipart operations. + # This applies in particular to the following operations: + # + # - [abort-multipart-upload](https://docs.aws.amazon.com/cli/latest/reference/s3api/abort-multipart-upload.html) + # - [complete-multipart-upload](https://docs.aws.amazon.com/cli/latest/reference/s3api/complete-multipart-upload.html) + # - [list-parts](https://docs.aws.amazon.com/cli/latest/reference/s3api/list-parts.html) + # - [upload-part](https://docs.aws.amazon.com/cli/latest/reference/s3api/upload-part.html) + # - [upload-part-copy](https://docs.aws.amazon.com/cli/latest/reference/s3api/upload-part-copy.html) + # + # @note StabilityLevel.EXPERIMENTAL + AWS_S3_UPLOAD_ID = 'aws.s3.upload_id' + + # @!endgroup + end + end +end \ No newline at end of file diff --git a/semantic_conventions/lib/opentelemetry/semantic_candidates/attributes/browser.rb b/semantic_conventions/lib/opentelemetry/semantic_candidates/attributes/browser.rb new file mode 100644 index 0000000000..954d50f3a3 --- /dev/null +++ b/semantic_conventions/lib/opentelemetry/semantic_candidates/attributes/browser.rb @@ -0,0 +1,58 @@ +# 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 SemanticCandidates + module BROWSER + # @!group Attribute Names + + # Array of brand name and version separated by a space + # + # This value is intended to be taken from the [UA client hints API](https://wicg.github.io/ua-client-hints/#interface) (`navigator.userAgentData.brands`) + # + # @note StabilityLevel.EXPERIMENTAL + BROWSER_BRANDS = 'browser.brands' + + # Preferred language of the user using the browser + # + # This value is intended to be taken from the Navigator API `navigator.language` + # + # @note StabilityLevel.EXPERIMENTAL + BROWSER_LANGUAGE = 'browser.language' + + # A boolean that is true if the browser is running on a mobile device + # + # This value is intended to be taken from the [UA client hints API](https://wicg.github.io/ua-client-hints/#interface) (`navigator.userAgentData.mobile`). If unavailable, this attribute SHOULD be left unset + # + # @note StabilityLevel.EXPERIMENTAL + BROWSER_MOBILE = 'browser.mobile' + + # The platform on which the browser is running + # + # This value is intended to be taken from the [UA client hints API](https://wicg.github.io/ua-client-hints/#interface) (`navigator.userAgentData.platform`). If unavailable, the legacy `navigator.platform` API SHOULD NOT be used instead and this attribute SHOULD be left unset in order for the values to be consistent. + # The list of possible values is defined in the [W3C User-Agent Client Hints specification](https://wicg.github.io/ua-client-hints/#sec-ch-ua-platform). Note that some (but not all) of these values can overlap with values in the [`os.type` and `os.name` attributes](./os.md). However, for consistency, the values in the `browser.platform` attribute should capture the exact value that the user agent provides + # + # @note StabilityLevel.EXPERIMENTAL + BROWSER_PLATFORM = 'browser.platform' + + # @!endgroup + end + end +end \ No newline at end of file diff --git a/semantic_conventions/lib/opentelemetry/semantic_candidates/attributes/client.rb b/semantic_conventions/lib/opentelemetry/semantic_candidates/attributes/client.rb new file mode 100644 index 0000000000..d8d5679132 --- /dev/null +++ b/semantic_conventions/lib/opentelemetry/semantic_candidates/attributes/client.rb @@ -0,0 +1,47 @@ +# 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 SemanticCandidates + module CLIENT + # @!group Attribute Names + + # Client address - domain name if available without reverse DNS lookup; otherwise, IP address or Unix domain socket name + # + # When observed from the server side, and when communicating through an intermediary, `client.address` SHOULD represent the client address behind any intermediaries, for example proxies, if it's available + # + # @note StabilityLevel.STABLE + # + # @deprecated Now available in the stable namespace at {OpenTelemetry::SemanticConventions::CLIENT::ADDRESS}. + CLIENT_ADDRESS = 'client.address' + + # Client port number + # + # When observed from the server side, and when communicating through an intermediary, `client.port` SHOULD represent the client port behind any intermediaries, for example proxies, if it's available + # + # @note StabilityLevel.STABLE + # + # @deprecated Now available in the stable namespace at {OpenTelemetry::SemanticConventions::CLIENT::PORT}. + CLIENT_PORT = 'client.port' + + # @!endgroup + end + end +end \ No newline at end of file diff --git a/semantic_conventions/lib/opentelemetry/semantic_candidates/attributes/cloud.rb b/semantic_conventions/lib/opentelemetry/semantic_candidates/attributes/cloud.rb new file mode 100644 index 0000000000..a3defbf358 --- /dev/null +++ b/semantic_conventions/lib/opentelemetry/semantic_candidates/attributes/cloud.rb @@ -0,0 +1,83 @@ +# 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 SemanticCandidates + module CLOUD + # @!group Attribute Names + + # The cloud account ID the resource is assigned to + # + # @note StabilityLevel.EXPERIMENTAL + CLOUD_ACCOUNT_ID = 'cloud.account.id' + + # Cloud regions often have multiple, isolated locations known as zones to increase availability. Availability zone represents the zone where the resource is running + # + # Availability zones are called "zones" on Alibaba Cloud and Google Cloud + # + # @note StabilityLevel.EXPERIMENTAL + CLOUD_AVAILABILITY_ZONE = 'cloud.availability_zone' + + # The cloud platform in use + # + # The prefix of the service SHOULD match the one specified in `cloud.provider` + # + # @note StabilityLevel.EXPERIMENTAL + CLOUD_PLATFORM = 'cloud.platform' + + # Name of the cloud provider + # + # @note StabilityLevel.EXPERIMENTAL + CLOUD_PROVIDER = 'cloud.provider' + + # The geographical region the resource is running + # + # Refer to your provider's docs to see the available regions, for example [Alibaba Cloud regions](https://www.alibabacloud.com/help/doc-detail/40654.htm), [AWS regions](https://aws.amazon.com/about-aws/global-infrastructure/regions_az/), [Azure regions](https://azure.microsoft.com/global-infrastructure/geographies/), [Google Cloud regions](https://cloud.google.com/about/locations), or [Tencent Cloud regions](https://www.tencentcloud.com/document/product/213/6091) + # + # @note StabilityLevel.EXPERIMENTAL + CLOUD_REGION = 'cloud.region' + + # Cloud provider-specific native identifier of the monitored cloud resource (e.g. an [ARN](https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) on AWS, a [fully qualified resource ID](https://learn.microsoft.com/rest/api/resources/resources/get-by-id) on Azure, a [full resource name](https://cloud.google.com/apis/design/resource_names#full_resource_name) on GCP) + # + # On some cloud providers, it may not be possible to determine the full ID at startup, + # so it may be necessary to set `cloud.resource_id` as a span attribute instead. + # + # The exact value to use for `cloud.resource_id` depends on the cloud provider. + # The following well-known definitions MUST be used if you set this attribute and they apply: + # + # * **AWS Lambda:** The function [ARN](https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html). + # Take care not to use the "invoked ARN" directly but replace any + # [alias suffix](https://docs.aws.amazon.com/lambda/latest/dg/configuration-aliases.html) + # with the resolved function version, as the same runtime instance may be invokable with + # multiple different aliases. + # * **GCP:** The [URI of the resource](https://cloud.google.com/iam/docs/full-resource-names) + # * **Azure:** The [Fully Qualified Resource ID](https://docs.microsoft.com/rest/api/resources/resources/get-by-id) of the invoked function, + # *not* the function app, having the form + # `/subscriptions//resourceGroups//providers/Microsoft.Web/sites//functions/`. + # This means that a span attribute MUST be used, as an Azure function app can host multiple functions that would usually share + # a TracerProvider + # + # @note StabilityLevel.EXPERIMENTAL + CLOUD_RESOURCE_ID = 'cloud.resource_id' + + # @!endgroup + end + end +end \ No newline at end of file diff --git a/semantic_conventions/lib/opentelemetry/semantic_candidates/attributes/cloudevents.rb b/semantic_conventions/lib/opentelemetry/semantic_candidates/attributes/cloudevents.rb new file mode 100644 index 0000000000..f57284343e --- /dev/null +++ b/semantic_conventions/lib/opentelemetry/semantic_candidates/attributes/cloudevents.rb @@ -0,0 +1,54 @@ +# 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 SemanticCandidates + module CLOUDEVENTS + # @!group Attribute Names + + # The [event_id](https://github.com/cloudevents/spec/blob/v1.0.2/cloudevents/spec.md#id) uniquely identifies the event + # + # @note StabilityLevel.EXPERIMENTAL + CLOUDEVENTS_EVENT_ID = 'cloudevents.event_id' + + # The [source](https://github.com/cloudevents/spec/blob/v1.0.2/cloudevents/spec.md#source-1) identifies the context in which an event happened + # + # @note StabilityLevel.EXPERIMENTAL + CLOUDEVENTS_EVENT_SOURCE = 'cloudevents.event_source' + + # The [version of the CloudEvents specification](https://github.com/cloudevents/spec/blob/v1.0.2/cloudevents/spec.md#specversion) which the event uses + # + # @note StabilityLevel.EXPERIMENTAL + CLOUDEVENTS_EVENT_SPEC_VERSION = 'cloudevents.event_spec_version' + + # The [subject](https://github.com/cloudevents/spec/blob/v1.0.2/cloudevents/spec.md#subject) of the event in the context of the event producer (identified by source) + # + # @note StabilityLevel.EXPERIMENTAL + CLOUDEVENTS_EVENT_SUBJECT = 'cloudevents.event_subject' + + # The [event_type](https://github.com/cloudevents/spec/blob/v1.0.2/cloudevents/spec.md#type) contains a value describing the type of event related to the originating occurrence + # + # @note StabilityLevel.EXPERIMENTAL + CLOUDEVENTS_EVENT_TYPE = 'cloudevents.event_type' + + # @!endgroup + end + end +end \ No newline at end of file diff --git a/semantic_conventions/lib/opentelemetry/semantic_candidates/attributes/code.rb b/semantic_conventions/lib/opentelemetry/semantic_candidates/attributes/code.rb new file mode 100644 index 0000000000..5e42ce29b8 --- /dev/null +++ b/semantic_conventions/lib/opentelemetry/semantic_candidates/attributes/code.rb @@ -0,0 +1,59 @@ +# 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 SemanticCandidates + module CODE + # @!group Attribute Names + + # The column number in `code.filepath` best representing the operation. It SHOULD point within the code unit named in `code.function` + # + # @note StabilityLevel.EXPERIMENTAL + CODE_COLUMN = 'code.column' + + # The source code file name that identifies the code unit as uniquely as possible (preferably an absolute file path) + # + # @note StabilityLevel.EXPERIMENTAL + CODE_FILEPATH = 'code.filepath' + + # The method or function name, or equivalent (usually rightmost part of the code unit's name) + # + # @note StabilityLevel.EXPERIMENTAL + CODE_FUNCTION = 'code.function' + + # The line number in `code.filepath` best representing the operation. It SHOULD point within the code unit named in `code.function` + # + # @note StabilityLevel.EXPERIMENTAL + CODE_LINENO = 'code.lineno' + + # 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 + # + # @note StabilityLevel.EXPERIMENTAL + CODE_NAMESPACE = 'code.namespace' + + # 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 StabilityLevel.EXPERIMENTAL + CODE_STACKTRACE = 'code.stacktrace' + + # @!endgroup + end + end +end \ No newline at end of file diff --git a/semantic_conventions/lib/opentelemetry/semantic_candidates/attributes/container.rb b/semantic_conventions/lib/opentelemetry/semantic_candidates/attributes/container.rb new file mode 100644 index 0000000000..6bdf251cf9 --- /dev/null +++ b/semantic_conventions/lib/opentelemetry/semantic_candidates/attributes/container.rb @@ -0,0 +1,104 @@ +# 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 SemanticCandidates + module CONTAINER + # @!group Attribute Names + + # The command used to run the container (i.e. the command name) + # + # If using embedded credentials or sensitive data, it is recommended to remove them to prevent potential leakage + # + # @note StabilityLevel.EXPERIMENTAL + CONTAINER_COMMAND = 'container.command' + + # All the command arguments (including the command/executable itself) run by the container. [2] + # + # @note StabilityLevel.EXPERIMENTAL + CONTAINER_COMMAND_ARGS = 'container.command_args' + + # The full command run by the container as a single string representing the full command. [2] + # + # @note StabilityLevel.EXPERIMENTAL + CONTAINER_COMMAND_LINE = 'container.command_line' + + # The CPU state for this data point + # + # @note StabilityLevel.EXPERIMENTAL + CONTAINER_CPU_STATE = 'container.cpu.state' + + # 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 + # + # @note StabilityLevel.EXPERIMENTAL + CONTAINER_ID = 'container.id' + + # Runtime specific image identifier. Usually a hash algorithm followed by a UUID + # + # Docker defines a sha256 of the image id; `container.image.id` corresponds to the `Image` field from the Docker container inspect [API](https://docs.docker.com/engine/api/v1.43/#tag/Container/operation/ContainerInspect) endpoint. + # K8s defines a link to the container registry repository with digest `"imageID": "registry.azurecr.io /namespace/service/dockerfile@sha256:bdeabd40c3a8a492eaf9e8e44d0ebbb84bac7ee25ac0cf8a7159d25f62555625"`. + # The ID is assigned by the container runtime and can vary in different environments. Consider using `oci.manifest.digest` if it is important to identify the same image in different environments/runtimes + # + # @note StabilityLevel.EXPERIMENTAL + CONTAINER_IMAGE_ID = 'container.image.id' + + # Name of the image the container was built on + # + # @note StabilityLevel.EXPERIMENTAL + CONTAINER_IMAGE_NAME = 'container.image.name' + + # Repo digests of the container image as provided by the container runtime + # + # [Docker](https://docs.docker.com/engine/api/v1.43/#tag/Image/operation/ImageInspect) and [CRI](https://github.com/kubernetes/cri-api/blob/c75ef5b473bbe2d0a4fc92f82235efd665ea8e9f/pkg/apis/runtime/v1/api.proto#L1237-L1238) report those under the `RepoDigests` field + # + # @note StabilityLevel.EXPERIMENTAL + CONTAINER_IMAGE_REPO_DIGESTS = 'container.image.repo_digests' + + # Container image tags. An example can be found in [Docker Image Inspect](https://docs.docker.com/engine/api/v1.43/#tag/Image/operation/ImageInspect). Should be only the `` section of the full name for example from `registry.example.com/my-org/my-image:` + # + # @note StabilityLevel.EXPERIMENTAL + CONTAINER_IMAGE_TAGS = 'container.image.tags' + + # Container labels, `` being the label name, the value being the label value + # + # @note StabilityLevel.EXPERIMENTAL + CONTAINER_LABEL = 'container.label' + + # Deprecated, use `container.label` instead + # + # @note StabilityLevel.EXPERIMENTAL + # + # @deprecated Replaced by `container.label` + CONTAINER_LABELS = 'container.labels' + + # Container name used by container runtime + # + # @note StabilityLevel.EXPERIMENTAL + CONTAINER_NAME = 'container.name' + + # The container runtime managing this container + # + # @note StabilityLevel.EXPERIMENTAL + CONTAINER_RUNTIME = 'container.runtime' + + # @!endgroup + end + end +end \ No newline at end of file diff --git a/semantic_conventions/lib/opentelemetry/semantic_candidates/attributes/db.rb b/semantic_conventions/lib/opentelemetry/semantic_candidates/attributes/db.rb new file mode 100644 index 0000000000..d8efc88f79 --- /dev/null +++ b/semantic_conventions/lib/opentelemetry/semantic_candidates/attributes/db.rb @@ -0,0 +1,256 @@ +# 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 SemanticCandidates + module DB + # @!group Attribute Names + + # 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) + # + # @note StabilityLevel.EXPERIMENTAL + DB_CASSANDRA_CONSISTENCY_LEVEL = 'db.cassandra.consistency_level' + + # The data center of the coordinating node for a query + # + # @note StabilityLevel.EXPERIMENTAL + DB_CASSANDRA_COORDINATOR_DC = 'db.cassandra.coordinator.dc' + + # The ID of the coordinating node for a query + # + # @note StabilityLevel.EXPERIMENTAL + DB_CASSANDRA_COORDINATOR_ID = 'db.cassandra.coordinator.id' + + # Whether or not the query is idempotent + # + # @note StabilityLevel.EXPERIMENTAL + DB_CASSANDRA_IDEMPOTENCE = 'db.cassandra.idempotence' + + # The fetch size used for paging, i.e. how many rows will be returned at once + # + # @note StabilityLevel.EXPERIMENTAL + DB_CASSANDRA_PAGE_SIZE = 'db.cassandra.page_size' + + # The number of times a query was speculatively executed. Not set or `0` if the query was not executed speculatively + # + # @note StabilityLevel.EXPERIMENTAL + DB_CASSANDRA_SPECULATIVE_EXECUTION_COUNT = 'db.cassandra.speculative_execution_count' + + # Deprecated, use `db.collection.name` instead + # + # @note StabilityLevel.EXPERIMENTAL + # + # @deprecated Replaced by `db.collection.name` + DB_CASSANDRA_TABLE = 'db.cassandra.table' + + # The name of the connection pool; unique within the instrumented application. In case the connection pool implementation doesn't provide a name, instrumentation should use a combination of `server.address` and `server.port` attributes formatted as `server.address:server.port` + # + # @note StabilityLevel.EXPERIMENTAL + DB_CLIENT_CONNECTIONS_POOL_NAME = 'db.client.connections.pool.name' + + # The state of a connection in the pool + # + # @note StabilityLevel.EXPERIMENTAL + DB_CLIENT_CONNECTIONS_STATE = 'db.client.connections.state' + + # The name of a collection (table, container) within the database + # + # If the collection name is parsed from the query, it SHOULD match the value provided in the query and may be qualified with the schema and database name. + # It is RECOMMENDED to capture the value as provided by the application without attempting to do any case normalization + # + # @note StabilityLevel.EXPERIMENTAL + DB_COLLECTION_NAME = 'db.collection.name' + + # Deprecated, use `server.address`, `server.port` attributes instead + # + # @note StabilityLevel.EXPERIMENTAL + # + # @deprecated "Replaced by `server.address` and `server.port`." + DB_CONNECTION_STRING = 'db.connection_string' + + # Unique Cosmos client instance id + # + # @note StabilityLevel.EXPERIMENTAL + DB_COSMOSDB_CLIENT_ID = 'db.cosmosdb.client_id' + + # Cosmos client connection mode + # + # @note StabilityLevel.EXPERIMENTAL + DB_COSMOSDB_CONNECTION_MODE = 'db.cosmosdb.connection_mode' + + # Deprecated, use `db.collection.name` instead + # + # @note StabilityLevel.EXPERIMENTAL + # + # @deprecated Replaced by `db.collection.name` + DB_COSMOSDB_CONTAINER = 'db.cosmosdb.container' + + # CosmosDB Operation Type + # + # @note StabilityLevel.EXPERIMENTAL + DB_COSMOSDB_OPERATION_TYPE = 'db.cosmosdb.operation_type' + + # RU consumed for that operation + # + # @note StabilityLevel.EXPERIMENTAL + DB_COSMOSDB_REQUEST_CHARGE = 'db.cosmosdb.request_charge' + + # Request payload size in bytes + # + # @note StabilityLevel.EXPERIMENTAL + DB_COSMOSDB_REQUEST_CONTENT_LENGTH = 'db.cosmosdb.request_content_length' + + # Cosmos DB status code + # + # @note StabilityLevel.EXPERIMENTAL + DB_COSMOSDB_STATUS_CODE = 'db.cosmosdb.status_code' + + # Cosmos DB sub status code + # + # @note StabilityLevel.EXPERIMENTAL + DB_COSMOSDB_SUB_STATUS_CODE = 'db.cosmosdb.sub_status_code' + + # Represents the identifier of an Elasticsearch cluster + # + # @note StabilityLevel.EXPERIMENTAL + DB_ELASTICSEARCH_CLUSTER_NAME = 'db.elasticsearch.cluster.name' + + # Represents the human-readable identifier of the node/instance to which a request was routed + # + # @note StabilityLevel.EXPERIMENTAL + DB_ELASTICSEARCH_NODE_NAME = 'db.elasticsearch.node.name' + + # A dynamic value in the url path + # + # Many Elasticsearch url paths allow dynamic values. These SHOULD be recorded in span attributes in the format `db.elasticsearch.path_parts.`, where `` is the url path part name. The implementation SHOULD reference the [elasticsearch schema](https://raw.githubusercontent.com/elastic/elasticsearch-specification/main/output/schema/schema.json) in order to map the path part values to their names + # + # @note StabilityLevel.EXPERIMENTAL + DB_ELASTICSEARCH_PATH_PARTS = 'db.elasticsearch.path_parts' + + # Deprecated, no general replacement at this time. For Elasticsearch, use `db.elasticsearch.node.name` instead + # + # @note StabilityLevel.EXPERIMENTAL + # + # @deprecated Deprecated, no general replacement at this time. For Elasticsearch, use `db.elasticsearch.node.name` instead + DB_INSTANCE_ID = 'db.instance.id' + + # Removed, no replacement at this time + # + # @note StabilityLevel.EXPERIMENTAL + # + # @deprecated Removed as not used + DB_JDBC_DRIVER_CLASSNAME = 'db.jdbc.driver_classname' + + # Deprecated, use `db.collection.name` instead + # + # @note StabilityLevel.EXPERIMENTAL + # + # @deprecated Replaced by `db.collection.name` + DB_MONGODB_COLLECTION = 'db.mongodb.collection' + + # Deprecated, SQL Server instance is now populated as a part of `db.namespace` attribute + # + # @note StabilityLevel.EXPERIMENTAL + # + # @deprecated Deprecated, no replacement at this time + DB_MSSQL_INSTANCE_NAME = 'db.mssql.instance_name' + + # Deprecated, use `db.namespace` instead + # + # @note StabilityLevel.EXPERIMENTAL + # + # @deprecated Replaced by `db.namespace` + DB_NAME = 'db.name' + + # The name of the database, fully qualified within the server address and port + # + # If a database system has multiple namespace components, they SHOULD be concatenated (potentially using database system specific conventions) from most general to most specific namespace component, and more specific namespaces SHOULD NOT be captured without the more general namespaces, to ensure that "startswith" queries for the more general namespaces will be valid. + # Semantic conventions for individual database systems SHOULD document what `db.namespace` means in the context of that system. + # It is RECOMMENDED to capture the value as provided by the application without attempting to do any case normalization + # + # @note StabilityLevel.EXPERIMENTAL + DB_NAMESPACE = 'db.namespace' + + # Deprecated, use `db.operation.name` instead + # + # @note StabilityLevel.EXPERIMENTAL + # + # @deprecated Replaced by `db.operation.name` + DB_OPERATION = 'db.operation' + + # The name of the operation or command being executed + # + # It is RECOMMENDED to capture the value as provided by the application without attempting to do any case normalization + # + # @note StabilityLevel.EXPERIMENTAL + DB_OPERATION_NAME = 'db.operation.name' + + # The query parameters used in `db.query.text`, with `` being the parameter name, and the attribute value being the parameter value + # + # Query parameters should only be captured when `db.query.text` is parameterized with placeholders. + # If a parameter has no name and instead is referenced only by index, then `` SHOULD be the 0-based index + # + # @note StabilityLevel.EXPERIMENTAL + DB_QUERY_PARAMETER = 'db.query.parameter' + + # The database query being executed + # + # @note StabilityLevel.EXPERIMENTAL + DB_QUERY_TEXT = 'db.query.text' + + # Deprecated, use `db.namespace` instead + # + # @note StabilityLevel.EXPERIMENTAL + # + # @deprecated Replaced by `db.namespace` + DB_REDIS_DATABASE_INDEX = 'db.redis.database_index' + + # Deprecated, use `db.collection.name` instead + # + # @note StabilityLevel.EXPERIMENTAL + # + # @deprecated Replaced by `db.collection.name` + DB_SQL_TABLE = 'db.sql.table' + + # The database statement being executed + # + # @note StabilityLevel.EXPERIMENTAL + # + # @deprecated Replaced by `db.query.text` + DB_STATEMENT = 'db.statement' + + # The database management system (DBMS) product as identified by the client instrumentation + # + # The actual DBMS may differ from the one identified by the client. For example, when using PostgreSQL client libraries to connect to a CockroachDB, the `db.system` is set to `postgresql` based on the instrumentation's best knowledge + # + # @note StabilityLevel.EXPERIMENTAL + DB_SYSTEM = 'db.system' + + # Deprecated, no replacement at this time + # + # @note StabilityLevel.EXPERIMENTAL + # + # @deprecated No replacement at this time + DB_USER = 'db.user' + + # @!endgroup + end + end +end \ No newline at end of file diff --git a/semantic_conventions/lib/opentelemetry/semantic_candidates/attributes/deployment.rb b/semantic_conventions/lib/opentelemetry/semantic_candidates/attributes/deployment.rb new file mode 100644 index 0000000000..a70fc2396f --- /dev/null +++ b/semantic_conventions/lib/opentelemetry/semantic_candidates/attributes/deployment.rb @@ -0,0 +1,42 @@ +# 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 SemanticCandidates + module DEPLOYMENT + # @!group Attribute Names + + # Name of the [deployment environment](https://wikipedia.org/wiki/Deployment_environment) (aka deployment tier) + # + # `deployment.environment` does not affect the uniqueness constraints defined through + # the `service.namespace`, `service.name` and `service.instance.id` resource attributes. + # This implies that resources carrying the following attribute combinations MUST be + # considered to be identifying the same service: + # + # * `service.name=frontend`, `deployment.environment=production` + # * `service.name=frontend`, `deployment.environment=staging` + # + # @note StabilityLevel.EXPERIMENTAL + DEPLOYMENT_ENVIRONMENT = 'deployment.environment' + + # @!endgroup + end + end +end \ No newline at end of file diff --git a/semantic_conventions/lib/opentelemetry/semantic_candidates/attributes/destination.rb b/semantic_conventions/lib/opentelemetry/semantic_candidates/attributes/destination.rb new file mode 100644 index 0000000000..5a5a9b8e47 --- /dev/null +++ b/semantic_conventions/lib/opentelemetry/semantic_candidates/attributes/destination.rb @@ -0,0 +1,41 @@ +# 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 SemanticCandidates + module DESTINATION + # @!group Attribute Names + + # Destination address - domain name if available without reverse DNS lookup; otherwise, IP address or Unix domain socket name + # + # When observed from the source side, and when communicating through an intermediary, `destination.address` SHOULD represent the destination address behind any intermediaries, for example proxies, if it's available + # + # @note StabilityLevel.EXPERIMENTAL + DESTINATION_ADDRESS = 'destination.address' + + # Destination port number + # + # @note StabilityLevel.EXPERIMENTAL + DESTINATION_PORT = 'destination.port' + + # @!endgroup + end + end +end \ No newline at end of file diff --git a/semantic_conventions/lib/opentelemetry/semantic_candidates/attributes/device.rb b/semantic_conventions/lib/opentelemetry/semantic_candidates/attributes/device.rb new file mode 100644 index 0000000000..ca6a99b9d2 --- /dev/null +++ b/semantic_conventions/lib/opentelemetry/semantic_candidates/attributes/device.rb @@ -0,0 +1,57 @@ +# 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 SemanticCandidates + module DEVICE + # @!group Attribute Names + + # A unique identifier representing the device + # + # 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 + # + # @note StabilityLevel.EXPERIMENTAL + DEVICE_ID = 'device.id' + + # The name of the device manufacturer + # + # The Android OS provides this field via [Build](https://developer.android.com/reference/android/os/Build#MANUFACTURER). iOS apps SHOULD hardcode the value `Apple` + # + # @note StabilityLevel.EXPERIMENTAL + DEVICE_MANUFACTURER = 'device.manufacturer' + + # The model identifier for the device + # + # 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 + # + # @note StabilityLevel.EXPERIMENTAL + DEVICE_MODEL_IDENTIFIER = 'device.model.identifier' + + # The marketing name for the device model + # + # It's recommended this value represents a human-readable version of the device model rather than a machine-readable alternative + # + # @note StabilityLevel.EXPERIMENTAL + DEVICE_MODEL_NAME = 'device.model.name' + + # @!endgroup + end + end +end \ No newline at end of file diff --git a/semantic_conventions/lib/opentelemetry/semantic_candidates/attributes/disk.rb b/semantic_conventions/lib/opentelemetry/semantic_candidates/attributes/disk.rb new file mode 100644 index 0000000000..22010f1f40 --- /dev/null +++ b/semantic_conventions/lib/opentelemetry/semantic_candidates/attributes/disk.rb @@ -0,0 +1,34 @@ +# 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 SemanticCandidates + module DISK + # @!group Attribute Names + + # The disk IO operation direction + # + # @note StabilityLevel.EXPERIMENTAL + DISK_IO_DIRECTION = 'disk.io.direction' + + # @!endgroup + end + end +end \ No newline at end of file diff --git a/semantic_conventions/lib/opentelemetry/semantic_candidates/attributes/dns.rb b/semantic_conventions/lib/opentelemetry/semantic_candidates/attributes/dns.rb new file mode 100644 index 0000000000..a176c2c635 --- /dev/null +++ b/semantic_conventions/lib/opentelemetry/semantic_candidates/attributes/dns.rb @@ -0,0 +1,36 @@ +# 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 SemanticCandidates + module DNS + # @!group Attribute Names + + # The name being queried + # + # If the name field contains non-printable characters (below 32 or above 126), those characters should be represented as escaped base 10 integers (\DDD). Back slashes and quotes should be escaped. Tabs, carriage returns, and line feeds should be converted to \t, \r, and \n respectively + # + # @note StabilityLevel.EXPERIMENTAL + DNS_QUESTION_NAME = 'dns.question.name' + + # @!endgroup + end + end +end \ No newline at end of file diff --git a/semantic_conventions/lib/opentelemetry/semantic_candidates/attributes/enduser.rb b/semantic_conventions/lib/opentelemetry/semantic_candidates/attributes/enduser.rb new file mode 100644 index 0000000000..1b2a42d435 --- /dev/null +++ b/semantic_conventions/lib/opentelemetry/semantic_candidates/attributes/enduser.rb @@ -0,0 +1,44 @@ +# 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 SemanticCandidates + module ENDUSER + # @!group Attribute Names + + # 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 + # + # @note StabilityLevel.EXPERIMENTAL + ENDUSER_ID = 'enduser.id' + + # Actual/assumed role the client is making the request under extracted from token or application security context + # + # @note StabilityLevel.EXPERIMENTAL + ENDUSER_ROLE = 'enduser.role' + + # 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) + # + # @note StabilityLevel.EXPERIMENTAL + ENDUSER_SCOPE = 'enduser.scope' + + # @!endgroup + end + end +end \ No newline at end of file diff --git a/semantic_conventions/lib/opentelemetry/semantic_candidates/attributes/error.rb b/semantic_conventions/lib/opentelemetry/semantic_candidates/attributes/error.rb new file mode 100644 index 0000000000..c5ec472226 --- /dev/null +++ b/semantic_conventions/lib/opentelemetry/semantic_candidates/attributes/error.rb @@ -0,0 +1,56 @@ +# 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 SemanticCandidates + module ERROR + # @!group Attribute Names + + # Describes a class of error the operation ended with + # + # The `error.type` SHOULD be predictable, and SHOULD have low cardinality. + # + # When `error.type` is set to a type (e.g., an exception type), its + # canonical class name identifying the type within the artifact SHOULD be used. + # + # Instrumentations SHOULD document the list of errors they report. + # + # The cardinality of `error.type` within one instrumentation library SHOULD be low. + # Telemetry consumers that aggregate data from multiple instrumentation libraries and applications + # should be prepared for `error.type` to have high cardinality at query time when no + # additional filters are applied. + # + # If the operation has completed successfully, instrumentations SHOULD NOT set `error.type`. + # + # If a specific domain defines its own set of error identifiers (such as HTTP or gRPC status codes), + # it's RECOMMENDED to: + # + # * Use a domain-specific attribute + # * Set `error.type` to capture all errors, regardless of whether they are defined within the domain-specific set or not + # + # @note StabilityLevel.STABLE + # + # @deprecated Now available in the stable namespace at {OpenTelemetry::SemanticConventions::ERROR::TYPE}. + ERROR_TYPE = 'error.type' + + # @!endgroup + end + end +end \ No newline at end of file diff --git a/semantic_conventions/lib/opentelemetry/semantic_candidates/attributes/event.rb b/semantic_conventions/lib/opentelemetry/semantic_candidates/attributes/event.rb new file mode 100644 index 0000000000..4b9174006c --- /dev/null +++ b/semantic_conventions/lib/opentelemetry/semantic_candidates/attributes/event.rb @@ -0,0 +1,36 @@ +# 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 SemanticCandidates + module EVENT + # @!group Attribute Names + + # Identifies the class / type of event + # + # Event names are subject to the same rules as [attribute names](https://github.com/open-telemetry/opentelemetry-specification/tree/v1.33.0/specification/common/attribute-naming.md). Notably, event names are namespaced to avoid collisions and provide a clean separation of semantics for events in separate domains like browser, mobile, and kubernetes + # + # @note StabilityLevel.EXPERIMENTAL + EVENT_NAME = 'event.name' + + # @!endgroup + end + end +end \ No newline at end of file diff --git a/semantic_conventions/lib/opentelemetry/semantic_candidates/attributes/exception.rb b/semantic_conventions/lib/opentelemetry/semantic_candidates/attributes/exception.rb new file mode 100644 index 0000000000..6576d51a21 --- /dev/null +++ b/semantic_conventions/lib/opentelemetry/semantic_candidates/attributes/exception.rb @@ -0,0 +1,74 @@ +# 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 SemanticCandidates + module EXCEPTION + # @!group Attribute Names + + # 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 + # + # An exception is considered to have escaped (or left) the scope of a span, + # if that span is ended while the exception is still logically "in flight". + # This may be actually "in flight" in some languages (e.g. if the exception + # is passed to a Context manager's `__exit__` method in Python) but will + # usually be caught at the point of recording the exception in most languages. + # + # It is usually not possible to determine at the point where an exception is thrown + # whether it will escape the scope of a span. + # However, it is trivial to know that an exception + # will escape, if one checks for an active exception just before ending the span, + # as done in the [example for recording span exceptions](https://opentelemetry.io/docs/specs/semconv/exceptions/exceptions-spans/#recording-an-exception). + # + # It follows that an exception may still escape the scope of the span + # even if the `exception.escaped` attribute was not set or set to false, + # since the event might have been recorded at a time where it was not + # clear whether the exception will escape + # + # @note StabilityLevel.STABLE + # + # @deprecated Now available in the stable namespace at {OpenTelemetry::SemanticConventions::EXCEPTION::ESCAPED}. + EXCEPTION_ESCAPED = 'exception.escaped' + + # The exception message + # + # @note StabilityLevel.STABLE + # + # @deprecated Now available in the stable namespace at {OpenTelemetry::SemanticConventions::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 StabilityLevel.STABLE + # + # @deprecated Now available in the stable namespace at {OpenTelemetry::SemanticConventions::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 StabilityLevel.STABLE + # + # @deprecated Now available in the stable namespace at {OpenTelemetry::SemanticConventions::EXCEPTION::TYPE}. + EXCEPTION_TYPE = 'exception.type' + + # @!endgroup + end + end +end \ No newline at end of file diff --git a/semantic_conventions/lib/opentelemetry/semantic_candidates/attributes/faas.rb b/semantic_conventions/lib/opentelemetry/semantic_candidates/attributes/faas.rb new file mode 100644 index 0000000000..1f97b8b95a --- /dev/null +++ b/semantic_conventions/lib/opentelemetry/semantic_candidates/attributes/faas.rb @@ -0,0 +1,146 @@ +# 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 SemanticCandidates + module FAAS + # @!group Attribute Names + + # A boolean that is true if the serverless function is executed for the first time (aka cold-start) + # + # @note StabilityLevel.EXPERIMENTAL + 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 StabilityLevel.EXPERIMENTAL + 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 StabilityLevel.EXPERIMENTAL + 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 StabilityLevel.EXPERIMENTAL + FAAS_DOCUMENT_NAME = 'faas.document.name' + + # Describes the type of the operation that was performed on the data + # + # @note StabilityLevel.EXPERIMENTAL + 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 StabilityLevel.EXPERIMENTAL + 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 StabilityLevel.EXPERIMENTAL + FAAS_INSTANCE = 'faas.instance' + + # The invocation ID of the current function invocation + # + # @note StabilityLevel.EXPERIMENTAL + 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 StabilityLevel.EXPERIMENTAL + 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 StabilityLevel.EXPERIMENTAL + 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 StabilityLevel.EXPERIMENTAL + 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 StabilityLevel.EXPERIMENTAL + 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`](/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 `/`, 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 StabilityLevel.EXPERIMENTAL + 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 StabilityLevel.EXPERIMENTAL + FAAS_TIME = 'faas.time' + + # Type of the trigger which caused this function invocation + # + # @note StabilityLevel.EXPERIMENTAL + 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 StabilityLevel.EXPERIMENTAL + FAAS_VERSION = 'faas.version' + + # @!endgroup + end + end +end \ No newline at end of file diff --git a/semantic_conventions/lib/opentelemetry/semantic_candidates/attributes/feature_flag.rb b/semantic_conventions/lib/opentelemetry/semantic_candidates/attributes/feature_flag.rb new file mode 100644 index 0000000000..b0f33d0440 --- /dev/null +++ b/semantic_conventions/lib/opentelemetry/semantic_candidates/attributes/feature_flag.rb @@ -0,0 +1,53 @@ +# 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 SemanticCandidates + module FEATURE_FLAG + # @!group Attribute Names + + # The unique identifier of the feature flag + # + # @note StabilityLevel.EXPERIMENTAL + FEATURE_FLAG_KEY = 'feature_flag.key' + + # The name of the service provider that performs the flag evaluation + # + # @note StabilityLevel.EXPERIMENTAL + FEATURE_FLAG_PROVIDER_NAME = 'feature_flag.provider_name' + + # SHOULD be a semantic identifier for a value. If one is unavailable, a stringified version of the value can be used + # + # 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`. + # + # A stringified version of the value can be used in situations where a + # semantic identifier is unavailable. String representation of the value + # should be determined by the implementer + # + # @note StabilityLevel.EXPERIMENTAL + FEATURE_FLAG_VARIANT = 'feature_flag.variant' + + # @!endgroup + end + end +end \ No newline at end of file diff --git a/semantic_conventions/lib/opentelemetry/semantic_candidates/attributes/file.rb b/semantic_conventions/lib/opentelemetry/semantic_candidates/attributes/file.rb new file mode 100644 index 0000000000..b9be01690f --- /dev/null +++ b/semantic_conventions/lib/opentelemetry/semantic_candidates/attributes/file.rb @@ -0,0 +1,56 @@ +# 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 SemanticCandidates + module FILE + # @!group Attribute Names + + # Directory where the file is located. It should include the drive letter, when appropriate + # + # @note StabilityLevel.EXPERIMENTAL + FILE_DIRECTORY = 'file.directory' + + # File extension, excluding the leading dot + # + # When the file name has multiple extensions (example.tar.gz), only the last one should be captured ("gz", not "tar.gz") + # + # @note StabilityLevel.EXPERIMENTAL + FILE_EXTENSION = 'file.extension' + + # Name of the file including the extension, without the directory + # + # @note StabilityLevel.EXPERIMENTAL + FILE_NAME = 'file.name' + + # Full path to the file, including the file name. It should include the drive letter, when appropriate + # + # @note StabilityLevel.EXPERIMENTAL + FILE_PATH = 'file.path' + + # File size in bytes + # + # @note StabilityLevel.EXPERIMENTAL + FILE_SIZE = 'file.size' + + # @!endgroup + end + end +end \ No newline at end of file diff --git a/semantic_conventions/lib/opentelemetry/semantic_candidates/attributes/gcp.rb b/semantic_conventions/lib/opentelemetry/semantic_candidates/attributes/gcp.rb new file mode 100644 index 0000000000..64bf21b688 --- /dev/null +++ b/semantic_conventions/lib/opentelemetry/semantic_candidates/attributes/gcp.rb @@ -0,0 +1,49 @@ +# 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 SemanticCandidates + module GCP + # @!group Attribute Names + + # The name of the Cloud Run [execution](https://cloud.google.com/run/docs/managing/job-executions) being run for the Job, as set by the [`CLOUD_RUN_EXECUTION`](https://cloud.google.com/run/docs/container-contract#jobs-env-vars) environment variable + # + # @note StabilityLevel.EXPERIMENTAL + GCP_CLOUD_RUN_JOB_EXECUTION = 'gcp.cloud_run.job.execution' + + # The index for a task within an execution as provided by the [`CLOUD_RUN_TASK_INDEX`](https://cloud.google.com/run/docs/container-contract#jobs-env-vars) environment variable + # + # @note StabilityLevel.EXPERIMENTAL + GCP_CLOUD_RUN_JOB_TASK_INDEX = 'gcp.cloud_run.job.task_index' + + # The hostname of a GCE instance. This is the full value of the default or [custom hostname](https://cloud.google.com/compute/docs/instances/custom-hostname-vm) + # + # @note StabilityLevel.EXPERIMENTAL + GCP_GCE_INSTANCE_HOSTNAME = 'gcp.gce.instance.hostname' + + # The instance name of a GCE instance. This is the value provided by `host.name`, the visible name of the instance in the Cloud Console UI, and the prefix for the default hostname of the instance as defined by the [default internal DNS name](https://cloud.google.com/compute/docs/internal-dns#instance-fully-qualified-domain-names) + # + # @note StabilityLevel.EXPERIMENTAL + GCP_GCE_INSTANCE_NAME = 'gcp.gce.instance.name' + + # @!endgroup + end + end +end \ No newline at end of file diff --git a/semantic_conventions/lib/opentelemetry/semantic_candidates/attributes/gen_ai.rb b/semantic_conventions/lib/opentelemetry/semantic_candidates/attributes/gen_ai.rb new file mode 100644 index 0000000000..6e5018e357 --- /dev/null +++ b/semantic_conventions/lib/opentelemetry/semantic_candidates/attributes/gen_ai.rb @@ -0,0 +1,95 @@ +# 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 SemanticCandidates + module GEN_AI + # @!group Attribute Names + + # The full response received from the LLM + # + # It's RECOMMENDED to format completions as JSON string matching [OpenAI messages format](https://platform.openai.com/docs/guides/text-generation) + # + # @note StabilityLevel.EXPERIMENTAL + GEN_AI_COMPLETION = 'gen_ai.completion' + + # The full prompt sent to an LLM + # + # It's RECOMMENDED to format prompts as JSON string matching [OpenAI messages format](https://platform.openai.com/docs/guides/text-generation) + # + # @note StabilityLevel.EXPERIMENTAL + GEN_AI_PROMPT = 'gen_ai.prompt' + + # The maximum number of tokens the LLM generates for a request + # + # @note StabilityLevel.EXPERIMENTAL + GEN_AI_REQUEST_MAX_TOKENS = 'gen_ai.request.max_tokens' + + # The name of the LLM a request is being made to + # + # @note StabilityLevel.EXPERIMENTAL + GEN_AI_REQUEST_MODEL = 'gen_ai.request.model' + + # The temperature setting for the LLM request + # + # @note StabilityLevel.EXPERIMENTAL + GEN_AI_REQUEST_TEMPERATURE = 'gen_ai.request.temperature' + + # The top_p sampling setting for the LLM request + # + # @note StabilityLevel.EXPERIMENTAL + GEN_AI_REQUEST_TOP_P = 'gen_ai.request.top_p' + + # Array of reasons the model stopped generating tokens, corresponding to each generation received + # + # @note StabilityLevel.EXPERIMENTAL + GEN_AI_RESPONSE_FINISH_REASONS = 'gen_ai.response.finish_reasons' + + # The unique identifier for the completion + # + # @note StabilityLevel.EXPERIMENTAL + GEN_AI_RESPONSE_ID = 'gen_ai.response.id' + + # The name of the LLM a response was generated from + # + # @note StabilityLevel.EXPERIMENTAL + GEN_AI_RESPONSE_MODEL = 'gen_ai.response.model' + + # The Generative AI product as identified by the client instrumentation + # + # The actual GenAI product may differ from the one identified by the client. For example, when using OpenAI client libraries to communicate with Mistral, the `gen_ai.system` is set to `openai` based on the instrumentation's best knowledge + # + # @note StabilityLevel.EXPERIMENTAL + GEN_AI_SYSTEM = 'gen_ai.system' + + # The number of tokens used in the LLM response (completion) + # + # @note StabilityLevel.EXPERIMENTAL + GEN_AI_USAGE_COMPLETION_TOKENS = 'gen_ai.usage.completion_tokens' + + # The number of tokens used in the LLM prompt + # + # @note StabilityLevel.EXPERIMENTAL + GEN_AI_USAGE_PROMPT_TOKENS = 'gen_ai.usage.prompt_tokens' + + # @!endgroup + end + end +end \ No newline at end of file diff --git a/semantic_conventions/lib/opentelemetry/semantic_candidates/attributes/graphql.rb b/semantic_conventions/lib/opentelemetry/semantic_candidates/attributes/graphql.rb new file mode 100644 index 0000000000..4ed58c6152 --- /dev/null +++ b/semantic_conventions/lib/opentelemetry/semantic_candidates/attributes/graphql.rb @@ -0,0 +1,46 @@ +# 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 SemanticCandidates + module GRAPHQL + # @!group Attribute Names + + # The GraphQL document being executed + # + # The value may be sanitized to exclude sensitive information + # + # @note StabilityLevel.EXPERIMENTAL + GRAPHQL_DOCUMENT = 'graphql.document' + + # The name of the operation being executed + # + # @note StabilityLevel.EXPERIMENTAL + GRAPHQL_OPERATION_NAME = 'graphql.operation.name' + + # The type of the operation being executed + # + # @note StabilityLevel.EXPERIMENTAL + GRAPHQL_OPERATION_TYPE = 'graphql.operation.type' + + # @!endgroup + end + end +end \ No newline at end of file diff --git a/semantic_conventions/lib/opentelemetry/semantic_candidates/attributes/heroku.rb b/semantic_conventions/lib/opentelemetry/semantic_candidates/attributes/heroku.rb new file mode 100644 index 0000000000..172cda73c4 --- /dev/null +++ b/semantic_conventions/lib/opentelemetry/semantic_candidates/attributes/heroku.rb @@ -0,0 +1,44 @@ +# 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 SemanticCandidates + module HEROKU + # @!group Attribute Names + + # Unique identifier for the application + # + # @note StabilityLevel.EXPERIMENTAL + HEROKU_APP_ID = 'heroku.app.id' + + # Commit hash for the current release + # + # @note StabilityLevel.EXPERIMENTAL + HEROKU_RELEASE_COMMIT = 'heroku.release.commit' + + # Time and date the release was created + # + # @note StabilityLevel.EXPERIMENTAL + HEROKU_RELEASE_CREATION_TIMESTAMP = 'heroku.release.creation_timestamp' + + # @!endgroup + end + end +end \ No newline at end of file diff --git a/semantic_conventions/lib/opentelemetry/semantic_candidates/attributes/host.rb b/semantic_conventions/lib/opentelemetry/semantic_candidates/attributes/host.rb new file mode 100644 index 0000000000..1abd7a9c42 --- /dev/null +++ b/semantic_conventions/lib/opentelemetry/semantic_candidates/attributes/host.rb @@ -0,0 +1,110 @@ +# 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 SemanticCandidates + module HOST + # @!group Attribute Names + + # The CPU architecture the host system is running on + # + # @note StabilityLevel.EXPERIMENTAL + HOST_ARCH = 'host.arch' + + # The amount of level 2 memory cache available to the processor (in Bytes) + # + # @note StabilityLevel.EXPERIMENTAL + HOST_CPU_CACHE_L2_SIZE = 'host.cpu.cache.l2.size' + + # Family or generation of the CPU + # + # @note StabilityLevel.EXPERIMENTAL + HOST_CPU_FAMILY = 'host.cpu.family' + + # Model identifier. It provides more granular information about the CPU, distinguishing it from other CPUs within the same family + # + # @note StabilityLevel.EXPERIMENTAL + HOST_CPU_MODEL_ID = 'host.cpu.model.id' + + # Model designation of the processor + # + # @note StabilityLevel.EXPERIMENTAL + HOST_CPU_MODEL_NAME = 'host.cpu.model.name' + + # Stepping or core revisions + # + # @note StabilityLevel.EXPERIMENTAL + HOST_CPU_STEPPING = 'host.cpu.stepping' + + # Processor manufacturer identifier. A maximum 12-character string + # + # [CPUID](https://wiki.osdev.org/CPUID) command returns the vendor ID string in EBX, EDX and ECX registers. Writing these to memory in this order results in a 12-character string + # + # @note StabilityLevel.EXPERIMENTAL + HOST_CPU_VENDOR_ID = 'host.cpu.vendor.id' + + # Unique host ID. For Cloud, this must be the instance_id assigned by the cloud provider. For non-containerized systems, this should be the `machine-id`. See the table below for the sources to use to determine the `machine-id` based on operating system + # + # @note StabilityLevel.EXPERIMENTAL + HOST_ID = 'host.id' + + # VM image ID or host OS image ID. For Cloud, this value is from the provider + # + # @note StabilityLevel.EXPERIMENTAL + HOST_IMAGE_ID = 'host.image.id' + + # Name of the VM image or OS install the host was instantiated from + # + # @note StabilityLevel.EXPERIMENTAL + HOST_IMAGE_NAME = 'host.image.name' + + # The version string of the VM image or host OS as defined in [Version Attributes](/docs/resource/README.md#version-attributes) + # + # @note StabilityLevel.EXPERIMENTAL + HOST_IMAGE_VERSION = 'host.image.version' + + # Available IP addresses of the host, excluding loopback interfaces + # + # IPv4 Addresses MUST be specified in dotted-quad notation. IPv6 addresses MUST be specified in the [RFC 5952](https://www.rfc-editor.org/rfc/rfc5952.html) format + # + # @note StabilityLevel.EXPERIMENTAL + HOST_IP = 'host.ip' + + # Available MAC addresses of the host, excluding loopback interfaces + # + # MAC Addresses MUST be represented in [IEEE RA hexadecimal form](https://standards.ieee.org/wp-content/uploads/import/documents/tutorials/eui.pdf): as hyphen-separated octets in uppercase hexadecimal form from most to least significant + # + # @note StabilityLevel.EXPERIMENTAL + HOST_MAC = 'host.mac' + + # 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 + # + # @note StabilityLevel.EXPERIMENTAL + HOST_NAME = 'host.name' + + # Type of host. For Cloud, this must be the machine type + # + # @note StabilityLevel.EXPERIMENTAL + HOST_TYPE = 'host.type' + + # @!endgroup + end + end +end \ No newline at end of file diff --git a/semantic_conventions/lib/opentelemetry/semantic_candidates/attributes/http.rb b/semantic_conventions/lib/opentelemetry/semantic_candidates/attributes/http.rb new file mode 100644 index 0000000000..fdc2f52662 --- /dev/null +++ b/semantic_conventions/lib/opentelemetry/semantic_candidates/attributes/http.rb @@ -0,0 +1,229 @@ +# 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 SemanticCandidates + module HTTP + # @!group Attribute Names + + # Deprecated, use `client.address` instead + # + # @note StabilityLevel.EXPERIMENTAL + # + # @deprecated Replaced by `client.address` + HTTP_CLIENT_IP = 'http.client_ip' + + # State of the HTTP connection in the HTTP connection pool + # + # @note StabilityLevel.EXPERIMENTAL + HTTP_CONNECTION_STATE = 'http.connection.state' + + # Deprecated, use `network.protocol.name` instead + # + # @note StabilityLevel.EXPERIMENTAL + # + # @deprecated Replaced by `network.protocol.name` + HTTP_FLAVOR = 'http.flavor' + + # Deprecated, use one of `server.address`, `client.address` or `http.request.header.host` instead, depending on the usage + # + # @note StabilityLevel.EXPERIMENTAL + # + # @deprecated Replaced by one of `server.address`, `client.address` or `http.request.header.host`, depending on the usage + HTTP_HOST = 'http.host' + + # Deprecated, use `http.request.method` instead + # + # @note StabilityLevel.EXPERIMENTAL + # + # @deprecated Replaced by `http.request.method` + HTTP_METHOD = 'http.method' + + # The size of the request payload body in bytes. This is the number of bytes transferred excluding headers and is often, but not always, present as the [Content-Length](https://www.rfc-editor.org/rfc/rfc9110.html#field.content-length) header. For requests using transport encoding, this should be the compressed size + # + # @note StabilityLevel.EXPERIMENTAL + HTTP_REQUEST_BODY_SIZE = 'http.request.body.size' + + # HTTP request headers, `` being the normalized HTTP Header name (lowercase), the value being the header values + # + # Instrumentations SHOULD require an explicit configuration of which headers are to be captured. Including all request headers can be a security risk - explicit configuration helps avoid leaking sensitive information. + # The `User-Agent` header is already captured in the `user_agent.original` attribute. Users MAY explicitly configure instrumentations to capture them even though it is not recommended. + # The attribute value MUST consist of either multiple header values as an array of strings or a single-item array containing a possibly comma-concatenated string, depending on the way the HTTP library provides access to headers + # + # @note StabilityLevel.STABLE + # + # @deprecated Now available in the stable namespace at {OpenTelemetry::SemanticConventions::HTTP::REQUEST_HEADER}. + HTTP_REQUEST_HEADER = 'http.request.header' + + # HTTP request method + # + # HTTP request method value SHOULD be "known" to the instrumentation. + # By default, this convention defines "known" methods as the ones listed in [RFC9110](https://www.rfc-editor.org/rfc/rfc9110.html#name-methods) + # and the PATCH method defined in [RFC5789](https://www.rfc-editor.org/rfc/rfc5789.html). + # + # If the HTTP request method is not known to instrumentation, it MUST set the `http.request.method` attribute to `_OTHER`. + # + # If the HTTP instrumentation could end up converting valid HTTP request methods to `_OTHER`, then it MUST provide a way to override + # the list of known HTTP methods. If this override is done via environment variable, then the environment variable MUST be named + # OTEL_INSTRUMENTATION_HTTP_KNOWN_METHODS and support a comma-separated list of case-sensitive known HTTP methods + # (this list MUST be a full override of the default known method, it is not a list of known methods in addition to the defaults). + # + # HTTP method names are case-sensitive and `http.request.method` attribute value MUST match a known HTTP method name exactly. + # Instrumentations for specific web frameworks that consider HTTP methods to be case insensitive, SHOULD populate a canonical equivalent. + # Tracing instrumentations that do so, MUST also set `http.request.method_original` to the original value + # + # @note StabilityLevel.STABLE + # + # @deprecated Now available in the stable namespace at {OpenTelemetry::SemanticConventions::HTTP::REQUEST_METHOD}. + HTTP_REQUEST_METHOD = 'http.request.method' + + # Original HTTP method sent by the client in the request line + # + # @note StabilityLevel.STABLE + # + # @deprecated Now available in the stable namespace at {OpenTelemetry::SemanticConventions::HTTP::REQUEST_METHOD_ORIGINAL}. + HTTP_REQUEST_METHOD_ORIGINAL = 'http.request.method_original' + + # The ordinal number of request resending attempt (for any reason, including redirects) + # + # The resend count SHOULD be updated each time an HTTP request gets resent by the client, regardless of what was the cause of the resending (e.g. redirection, authorization failure, 503 Server Unavailable, network issues, or any other) + # + # @note StabilityLevel.STABLE + # + # @deprecated Now available in the stable namespace at {OpenTelemetry::SemanticConventions::HTTP::REQUEST_RESEND_COUNT}. + HTTP_REQUEST_RESEND_COUNT = 'http.request.resend_count' + + # The total size of the request in bytes. This should be the total number of bytes sent over the wire, including the request line (HTTP/1.1), framing (HTTP/2 and HTTP/3), headers, and request body if any + # + # @note StabilityLevel.EXPERIMENTAL + HTTP_REQUEST_SIZE = 'http.request.size' + + # Deprecated, use `http.request.header.content-length` instead + # + # @note StabilityLevel.EXPERIMENTAL + # + # @deprecated Replaced by `http.request.header.content-length` + HTTP_REQUEST_CONTENT_LENGTH = 'http.request_content_length' + + # Deprecated, use `http.request.body.size` instead + # + # @note StabilityLevel.EXPERIMENTAL + # + # @deprecated Replaced by `http.request.body.size` + HTTP_REQUEST_CONTENT_LENGTH_UNCOMPRESSED = 'http.request_content_length_uncompressed' + + # The size of the response payload body in bytes. This is the number of bytes transferred excluding headers and is often, but not always, present as the [Content-Length](https://www.rfc-editor.org/rfc/rfc9110.html#field.content-length) header. For requests using transport encoding, this should be the compressed size + # + # @note StabilityLevel.EXPERIMENTAL + HTTP_RESPONSE_BODY_SIZE = 'http.response.body.size' + + # HTTP response headers, `` being the normalized HTTP Header name (lowercase), the value being the header values + # + # Instrumentations SHOULD require an explicit configuration of which headers are to be captured. Including all response headers can be a security risk - explicit configuration helps avoid leaking sensitive information. + # Users MAY explicitly configure instrumentations to capture them even though it is not recommended. + # The attribute value MUST consist of either multiple header values as an array of strings or a single-item array containing a possibly comma-concatenated string, depending on the way the HTTP library provides access to headers + # + # @note StabilityLevel.STABLE + # + # @deprecated Now available in the stable namespace at {OpenTelemetry::SemanticConventions::HTTP::RESPONSE_HEADER}. + HTTP_RESPONSE_HEADER = 'http.response.header' + + # The total size of the response in bytes. This should be the total number of bytes sent over the wire, including the status line (HTTP/1.1), framing (HTTP/2 and HTTP/3), headers, and response body and trailers if any + # + # @note StabilityLevel.EXPERIMENTAL + HTTP_RESPONSE_SIZE = 'http.response.size' + + # [HTTP response status code](https://tools.ietf.org/html/rfc7231#section-6) + # + # @note StabilityLevel.STABLE + # + # @deprecated Now available in the stable namespace at {OpenTelemetry::SemanticConventions::HTTP::RESPONSE_STATUS_CODE}. + HTTP_RESPONSE_STATUS_CODE = 'http.response.status_code' + + # Deprecated, use `http.response.header.content-length` instead + # + # @note StabilityLevel.EXPERIMENTAL + # + # @deprecated Replaced by `http.response.header.content-length` + HTTP_RESPONSE_CONTENT_LENGTH = 'http.response_content_length' + + # Deprecated, use `http.response.body.size` instead + # + # @note StabilityLevel.EXPERIMENTAL + # + # @deprecated Replace by `http.response.body.size` + HTTP_RESPONSE_CONTENT_LENGTH_UNCOMPRESSED = 'http.response_content_length_uncompressed' + + # The matched route, that is, the path template in the format used by the respective server framework + # + # MUST NOT be populated when this is not supported by the HTTP server framework as the route attribute should have low-cardinality and the URI path can NOT substitute it. + # SHOULD include the [application root](/docs/http/http-spans.md#http-server-definitions) if there is one + # + # @note StabilityLevel.STABLE + # + # @deprecated Now available in the stable namespace at {OpenTelemetry::SemanticConventions::HTTP::ROUTE}. + HTTP_ROUTE = 'http.route' + + # Deprecated, use `url.scheme` instead + # + # @note StabilityLevel.EXPERIMENTAL + # + # @deprecated Replaced by `url.scheme` instead + HTTP_SCHEME = 'http.scheme' + + # Deprecated, use `server.address` instead + # + # @note StabilityLevel.EXPERIMENTAL + # + # @deprecated Replaced by `server.address` + HTTP_SERVER_NAME = 'http.server_name' + + # Deprecated, use `http.response.status_code` instead + # + # @note StabilityLevel.EXPERIMENTAL + # + # @deprecated Replaced by `http.response.status_code` + HTTP_STATUS_CODE = 'http.status_code' + + # Deprecated, use `url.path` and `url.query` instead + # + # @note StabilityLevel.EXPERIMENTAL + # + # @deprecated Split to `url.path` and `url.query + HTTP_TARGET = 'http.target' + + # Deprecated, use `url.full` instead + # + # @note StabilityLevel.EXPERIMENTAL + # + # @deprecated Replaced by `url.full` + HTTP_URL = 'http.url' + + # Deprecated, use `user_agent.original` instead + # + # @note StabilityLevel.EXPERIMENTAL + # + # @deprecated Replaced by `user_agent.original` + HTTP_USER_AGENT = 'http.user_agent' + + # @!endgroup + end + end +end \ No newline at end of file diff --git a/semantic_conventions/lib/opentelemetry/semantic_candidates/attributes/ios.rb b/semantic_conventions/lib/opentelemetry/semantic_candidates/attributes/ios.rb new file mode 100644 index 0000000000..08a763198c --- /dev/null +++ b/semantic_conventions/lib/opentelemetry/semantic_candidates/attributes/ios.rb @@ -0,0 +1,38 @@ +# 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 SemanticCandidates + module IOS + # @!group Attribute Names + + # Deprecated use the `device.app.lifecycle` event definition including `ios.state` as a payload field instead + # + # The iOS lifecycle states are defined in the [UIApplicationDelegate documentation](https://developer.apple.com/documentation/uikit/uiapplicationdelegate#1656902), and from which the `OS terminology` column values are derived + # + # @note StabilityLevel.EXPERIMENTAL + # + # @deprecated Moved to a payload field of `device.app.lifecycle` + IOS_STATE = 'ios.state' + + # @!endgroup + end + end +end \ No newline at end of file diff --git a/semantic_conventions/lib/opentelemetry/semantic_candidates/attributes/jvm.rb b/semantic_conventions/lib/opentelemetry/semantic_candidates/attributes/jvm.rb new file mode 100644 index 0000000000..ee0998b250 --- /dev/null +++ b/semantic_conventions/lib/opentelemetry/semantic_candidates/attributes/jvm.rb @@ -0,0 +1,84 @@ +# 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 SemanticCandidates + module JVM + # @!group Attribute Names + + # Name of the buffer pool + # + # Pool names are generally obtained via [BufferPoolMXBean#getName()](https://docs.oracle.com/en/java/javase/11/docs/api/java.management/java/lang/management/BufferPoolMXBean.html#getName()) + # + # @note StabilityLevel.EXPERIMENTAL + JVM_BUFFER_POOL_NAME = 'jvm.buffer.pool.name' + + # Name of the garbage collector action + # + # Garbage collector action is generally obtained via [GarbageCollectionNotificationInfo#getGcAction()](https://docs.oracle.com/en/java/javase/11/docs/api/jdk.management/com/sun/management/GarbageCollectionNotificationInfo.html#getGcAction()) + # + # @note StabilityLevel.STABLE + # + # @deprecated Now available in the stable namespace at {OpenTelemetry::SemanticConventions::JVM::GC_ACTION}. + JVM_GC_ACTION = 'jvm.gc.action' + + # Name of the garbage collector + # + # Garbage collector name is generally obtained via [GarbageCollectionNotificationInfo#getGcName()](https://docs.oracle.com/en/java/javase/11/docs/api/jdk.management/com/sun/management/GarbageCollectionNotificationInfo.html#getGcName()) + # + # @note StabilityLevel.STABLE + # + # @deprecated Now available in the stable namespace at {OpenTelemetry::SemanticConventions::JVM::GC_NAME}. + JVM_GC_NAME = 'jvm.gc.name' + + # Name of the memory pool + # + # Pool names are generally obtained via [MemoryPoolMXBean#getName()](https://docs.oracle.com/en/java/javase/11/docs/api/java.management/java/lang/management/MemoryPoolMXBean.html#getName()) + # + # @note StabilityLevel.STABLE + # + # @deprecated Now available in the stable namespace at {OpenTelemetry::SemanticConventions::JVM::MEMORY_POOL_NAME}. + JVM_MEMORY_POOL_NAME = 'jvm.memory.pool.name' + + # The type of memory + # + # @note StabilityLevel.STABLE + # + # @deprecated Now available in the stable namespace at {OpenTelemetry::SemanticConventions::JVM::MEMORY_TYPE}. + JVM_MEMORY_TYPE = 'jvm.memory.type' + + # Whether the thread is daemon or not + # + # @note StabilityLevel.STABLE + # + # @deprecated Now available in the stable namespace at {OpenTelemetry::SemanticConventions::JVM::THREAD_DAEMON}. + JVM_THREAD_DAEMON = 'jvm.thread.daemon' + + # State of the thread + # + # @note StabilityLevel.STABLE + # + # @deprecated Now available in the stable namespace at {OpenTelemetry::SemanticConventions::JVM::THREAD_STATE}. + JVM_THREAD_STATE = 'jvm.thread.state' + + # @!endgroup + end + end +end \ No newline at end of file diff --git a/semantic_conventions/lib/opentelemetry/semantic_candidates/attributes/k8s.rb b/semantic_conventions/lib/opentelemetry/semantic_candidates/attributes/k8s.rb new file mode 100644 index 0000000000..22c8aa49c7 --- /dev/null +++ b/semantic_conventions/lib/opentelemetry/semantic_candidates/attributes/k8s.rb @@ -0,0 +1,179 @@ +# 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 SemanticCandidates + module K8S + # @!group Attribute Names + + # The name of the cluster + # + # @note StabilityLevel.EXPERIMENTAL + K8S_CLUSTER_NAME = 'k8s.cluster.name' + + # A pseudo-ID for the cluster, set to the UID of the `kube-system` namespace + # + # K8s doesn't have support for obtaining a cluster ID. If this is ever + # added, we will recommend collecting the `k8s.cluster.uid` through the + # official APIs. In the meantime, we are able to use the `uid` of the + # `kube-system` namespace as a proxy for cluster ID. Read on for the + # rationale. + # + # Every object created in a K8s cluster is assigned a distinct UID. The + # `kube-system` namespace is used by Kubernetes itself and will exist + # for the lifetime of the cluster. Using the `uid` of the `kube-system` + # namespace is a reasonable proxy for the K8s ClusterID as it will only + # change if the cluster is rebuilt. Furthermore, Kubernetes UIDs are + # UUIDs as standardized by + # [ISO/IEC 9834-8 and ITU-T X.667](https://www.itu.int/ITU-T/studygroups/com17/oid.html). + # Which states: + # + # > If generated according to one of the mechanisms defined in Rec. + # ITU-T X.667 | ISO/IEC 9834-8, a UUID is either guaranteed to be + # different from all other UUIDs generated before 3603 A.D., or is + # extremely likely to be different (depending on the mechanism chosen). + # + # Therefore, UIDs between clusters should be extremely unlikely to + # conflict + # + # @note StabilityLevel.EXPERIMENTAL + K8S_CLUSTER_UID = 'k8s.cluster.uid' + + # The name of the Container from Pod specification, must be unique within a Pod. Container runtime usually uses different globally unique name (`container.name`) + # + # @note StabilityLevel.EXPERIMENTAL + K8S_CONTAINER_NAME = 'k8s.container.name' + + # Number of times the container was restarted. This attribute can be used to identify a particular container (running or stopped) within a container spec + # + # @note StabilityLevel.EXPERIMENTAL + K8S_CONTAINER_RESTART_COUNT = 'k8s.container.restart_count' + + # Last terminated reason of the Container + # + # @note StabilityLevel.EXPERIMENTAL + K8S_CONTAINER_STATUS_LAST_TERMINATED_REASON = 'k8s.container.status.last_terminated_reason' + + # The name of the CronJob + # + # @note StabilityLevel.EXPERIMENTAL + K8S_CRONJOB_NAME = 'k8s.cronjob.name' + + # The UID of the CronJob + # + # @note StabilityLevel.EXPERIMENTAL + K8S_CRONJOB_UID = 'k8s.cronjob.uid' + + # The name of the DaemonSet + # + # @note StabilityLevel.EXPERIMENTAL + K8S_DAEMONSET_NAME = 'k8s.daemonset.name' + + # The UID of the DaemonSet + # + # @note StabilityLevel.EXPERIMENTAL + K8S_DAEMONSET_UID = 'k8s.daemonset.uid' + + # The name of the Deployment + # + # @note StabilityLevel.EXPERIMENTAL + K8S_DEPLOYMENT_NAME = 'k8s.deployment.name' + + # The UID of the Deployment + # + # @note StabilityLevel.EXPERIMENTAL + K8S_DEPLOYMENT_UID = 'k8s.deployment.uid' + + # The name of the Job + # + # @note StabilityLevel.EXPERIMENTAL + K8S_JOB_NAME = 'k8s.job.name' + + # The UID of the Job + # + # @note StabilityLevel.EXPERIMENTAL + K8S_JOB_UID = 'k8s.job.uid' + + # The name of the namespace that the pod is running in + # + # @note StabilityLevel.EXPERIMENTAL + K8S_NAMESPACE_NAME = 'k8s.namespace.name' + + # The name of the Node + # + # @note StabilityLevel.EXPERIMENTAL + K8S_NODE_NAME = 'k8s.node.name' + + # The UID of the Node + # + # @note StabilityLevel.EXPERIMENTAL + K8S_NODE_UID = 'k8s.node.uid' + + # The annotation key-value pairs placed on the Pod, the `` being the annotation name, the value being the annotation value + # + # @note StabilityLevel.EXPERIMENTAL + K8S_POD_ANNOTATION = 'k8s.pod.annotation' + + # The label key-value pairs placed on the Pod, the `` being the label name, the value being the label value + # + # @note StabilityLevel.EXPERIMENTAL + K8S_POD_LABEL = 'k8s.pod.label' + + # Deprecated, use `k8s.pod.label` instead + # + # @note StabilityLevel.EXPERIMENTAL + # + # @deprecated Replaced by `k8s.pod.label` + K8S_POD_LABELS = 'k8s.pod.labels' + + # The name of the Pod + # + # @note StabilityLevel.EXPERIMENTAL + K8S_POD_NAME = 'k8s.pod.name' + + # The UID of the Pod + # + # @note StabilityLevel.EXPERIMENTAL + K8S_POD_UID = 'k8s.pod.uid' + + # The name of the ReplicaSet + # + # @note StabilityLevel.EXPERIMENTAL + K8S_REPLICASET_NAME = 'k8s.replicaset.name' + + # The UID of the ReplicaSet + # + # @note StabilityLevel.EXPERIMENTAL + K8S_REPLICASET_UID = 'k8s.replicaset.uid' + + # The name of the StatefulSet + # + # @note StabilityLevel.EXPERIMENTAL + K8S_STATEFULSET_NAME = 'k8s.statefulset.name' + + # The UID of the StatefulSet + # + # @note StabilityLevel.EXPERIMENTAL + K8S_STATEFULSET_UID = 'k8s.statefulset.uid' + + # @!endgroup + end + end +end \ No newline at end of file diff --git a/semantic_conventions/lib/opentelemetry/semantic_candidates/attributes/log.rb b/semantic_conventions/lib/opentelemetry/semantic_candidates/attributes/log.rb new file mode 100644 index 0000000000..74659a3534 --- /dev/null +++ b/semantic_conventions/lib/opentelemetry/semantic_candidates/attributes/log.rb @@ -0,0 +1,62 @@ +# 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 SemanticCandidates + module LOG + # @!group Attribute Names + + # The basename of the file + # + # @note StabilityLevel.EXPERIMENTAL + LOG_FILE_NAME = 'log.file.name' + + # The basename of the file, with symlinks resolved + # + # @note StabilityLevel.EXPERIMENTAL + LOG_FILE_NAME_RESOLVED = 'log.file.name_resolved' + + # The full path to the file + # + # @note StabilityLevel.EXPERIMENTAL + LOG_FILE_PATH = 'log.file.path' + + # The full path to the file, with symlinks resolved + # + # @note StabilityLevel.EXPERIMENTAL + LOG_FILE_PATH_RESOLVED = 'log.file.path_resolved' + + # The stream associated with the log. See below for a list of well-known values + # + # @note StabilityLevel.EXPERIMENTAL + LOG_IOSTREAM = 'log.iostream' + + # A unique identifier for the Log Record + # + # If an id is provided, other log records with the same id will be considered duplicates and can be removed safely. This means, that two distinguishable log records MUST have different values. + # The id MAY be an [Universally Unique Lexicographically Sortable Identifier (ULID)](https://github.com/ulid/spec), but other identifiers (e.g. UUID) may be used as needed + # + # @note StabilityLevel.EXPERIMENTAL + LOG_RECORD_UID = 'log.record.uid' + + # @!endgroup + end + end +end \ No newline at end of file diff --git a/semantic_conventions/lib/opentelemetry/semantic_candidates/attributes/message.rb b/semantic_conventions/lib/opentelemetry/semantic_candidates/attributes/message.rb new file mode 100644 index 0000000000..c749d7e7a1 --- /dev/null +++ b/semantic_conventions/lib/opentelemetry/semantic_candidates/attributes/message.rb @@ -0,0 +1,57 @@ +# 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 SemanticCandidates + module MESSAGE + # @!group Attribute Names + + # Deprecated, use `rpc.message.compressed_size` instead + # + # @note StabilityLevel.EXPERIMENTAL + # + # @deprecated Replaced by `rpc.message.compressed_size` + MESSAGE_COMPRESSED_SIZE = 'message.compressed_size' + + # Deprecated, use `rpc.message.id` instead + # + # @note StabilityLevel.EXPERIMENTAL + # + # @deprecated Replaced by `rpc.message.id` + MESSAGE_ID = 'message.id' + + # Deprecated, use `rpc.message.type` instead + # + # @note StabilityLevel.EXPERIMENTAL + # + # @deprecated Replaced by `rpc.message.type` + MESSAGE_TYPE = 'message.type' + + # Deprecated, use `rpc.message.uncompressed_size` instead + # + # @note StabilityLevel.EXPERIMENTAL + # + # @deprecated Replaced by `rpc.message.uncompressed_size` + MESSAGE_UNCOMPRESSED_SIZE = 'message.uncompressed_size' + + # @!endgroup + end + end +end \ No newline at end of file diff --git a/semantic_conventions/lib/opentelemetry/semantic_candidates/attributes/messaging.rb b/semantic_conventions/lib/opentelemetry/semantic_candidates/attributes/messaging.rb new file mode 100644 index 0000000000..d9aaa90360 --- /dev/null +++ b/semantic_conventions/lib/opentelemetry/semantic_candidates/attributes/messaging.rb @@ -0,0 +1,277 @@ +# 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 SemanticCandidates + module MESSAGING + # @!group Attribute Names + + # The number of messages sent, received, or processed in the scope of the batching operation + # + # Instrumentations SHOULD NOT set `messaging.batch.message_count` on spans that operate with a single message. When a messaging client library supports both batch and single-message API for the same operation, instrumentations SHOULD use `messaging.batch.message_count` for batching APIs and SHOULD NOT use it for single-message APIs + # + # @note StabilityLevel.EXPERIMENTAL + MESSAGING_BATCH_MESSAGE_COUNT = 'messaging.batch.message_count' + + # A unique identifier for the client that consumes or produces a message + # + # @note StabilityLevel.EXPERIMENTAL + MESSAGING_CLIENT_ID = 'messaging.client.id' + + # Deprecated, use `messaging.client.id` instead + # + # @note StabilityLevel.EXPERIMENTAL + # + # @deprecated Replaced by `messaging.client.id` + MESSAGING_CLIENT_ID = 'messaging.client_id' + + # A boolean that is true if the message destination is anonymous (could be unnamed or have auto-generated name) + # + # @note StabilityLevel.EXPERIMENTAL + MESSAGING_DESTINATION_ANONYMOUS = 'messaging.destination.anonymous' + + # The message destination name + # + # Destination name SHOULD uniquely identify a specific queue, topic or other entity within the broker. If + # the broker doesn't have such notion, the destination name SHOULD uniquely identify the broker + # + # @note StabilityLevel.EXPERIMENTAL + MESSAGING_DESTINATION_NAME = 'messaging.destination.name' + + # The identifier of the partition messages are sent to or received from, unique within the `messaging.destination.name` + # + # @note StabilityLevel.EXPERIMENTAL + MESSAGING_DESTINATION_PARTITION_ID = 'messaging.destination.partition.id' + + # Low cardinality representation of the messaging destination name + # + # Destination names could be constructed from templates. An example would be a destination name involving a user name or product id. Although the destination name in this case is of high cardinality, the underlying template is of low cardinality and can be effectively used for grouping and aggregation + # + # @note StabilityLevel.EXPERIMENTAL + MESSAGING_DESTINATION_TEMPLATE = 'messaging.destination.template' + + # A boolean that is true if the message destination is temporary and might not exist anymore after messages are processed + # + # @note StabilityLevel.EXPERIMENTAL + MESSAGING_DESTINATION_TEMPORARY = 'messaging.destination.temporary' + + # A boolean that is true if the publish message destination is anonymous (could be unnamed or have auto-generated name) + # + # @note StabilityLevel.EXPERIMENTAL + MESSAGING_DESTINATION_PUBLISH_ANONYMOUS = 'messaging.destination_publish.anonymous' + + # The name of the original destination the message was published to + # + # The name SHOULD uniquely identify a specific queue, topic, or other entity within the broker. If + # the broker doesn't have such notion, the original destination name SHOULD uniquely identify the broker + # + # @note StabilityLevel.EXPERIMENTAL + MESSAGING_DESTINATION_PUBLISH_NAME = 'messaging.destination_publish.name' + + # The name of the consumer group the event consumer is associated with + # + # @note StabilityLevel.EXPERIMENTAL + MESSAGING_EVENTHUBS_CONSUMER_GROUP = 'messaging.eventhubs.consumer.group' + + # The UTC epoch seconds at which the message has been accepted and stored in the entity + # + # @note StabilityLevel.EXPERIMENTAL + MESSAGING_EVENTHUBS_MESSAGE_ENQUEUED_TIME = 'messaging.eventhubs.message.enqueued_time' + + # The ack deadline in seconds set for the modify ack deadline request + # + # @note StabilityLevel.EXPERIMENTAL + MESSAGING_GCP_PUBSUB_MESSAGE_ACK_DEADLINE = 'messaging.gcp_pubsub.message.ack_deadline' + + # The ack id for a given message + # + # @note StabilityLevel.EXPERIMENTAL + MESSAGING_GCP_PUBSUB_MESSAGE_ACK_ID = 'messaging.gcp_pubsub.message.ack_id' + + # The delivery attempt for a given message + # + # @note StabilityLevel.EXPERIMENTAL + MESSAGING_GCP_PUBSUB_MESSAGE_DELIVERY_ATTEMPT = 'messaging.gcp_pubsub.message.delivery_attempt' + + # The ordering key for a given message. If the attribute is not present, the message does not have an ordering key + # + # @note StabilityLevel.EXPERIMENTAL + MESSAGING_GCP_PUBSUB_MESSAGE_ORDERING_KEY = 'messaging.gcp_pubsub.message.ordering_key' + + # Name of the Kafka Consumer Group that is handling the message. Only applies to consumers, not producers + # + # @note StabilityLevel.EXPERIMENTAL + MESSAGING_KAFKA_CONSUMER_GROUP = 'messaging.kafka.consumer.group' + + # Deprecated, use `messaging.destination.partition.id` instead + # + # @note StabilityLevel.EXPERIMENTAL + # + # @deprecated Replaced by `messaging.destination.partition.id` + MESSAGING_KAFKA_DESTINATION_PARTITION = 'messaging.kafka.destination.partition' + + # 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 + # + # 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 + # + # @note StabilityLevel.EXPERIMENTAL + MESSAGING_KAFKA_MESSAGE_KEY = 'messaging.kafka.message.key' + + # The offset of a record in the corresponding Kafka partition + # + # @note StabilityLevel.EXPERIMENTAL + MESSAGING_KAFKA_MESSAGE_OFFSET = 'messaging.kafka.message.offset' + + # A boolean that is true if the message is a tombstone + # + # @note StabilityLevel.EXPERIMENTAL + MESSAGING_KAFKA_MESSAGE_TOMBSTONE = 'messaging.kafka.message.tombstone' + + # The size of the message body in bytes + # + # This can refer to both the compressed or uncompressed body size. If both sizes are known, the uncompressed + # body size should be used + # + # @note StabilityLevel.EXPERIMENTAL + MESSAGING_MESSAGE_BODY_SIZE = 'messaging.message.body.size' + + # The conversation ID identifying the conversation to which the message belongs, represented as a string. Sometimes called "Correlation ID" + # + # @note StabilityLevel.EXPERIMENTAL + MESSAGING_MESSAGE_CONVERSATION_ID = 'messaging.message.conversation_id' + + # The size of the message body and metadata in bytes + # + # This can refer to both the compressed or uncompressed size. If both sizes are known, the uncompressed + # size should be used + # + # @note StabilityLevel.EXPERIMENTAL + MESSAGING_MESSAGE_ENVELOPE_SIZE = 'messaging.message.envelope.size' + + # A value used by the messaging system as an identifier for the message, represented as a string + # + # @note StabilityLevel.EXPERIMENTAL + MESSAGING_MESSAGE_ID = 'messaging.message.id' + + # Deprecated, use `messaging.operation.type` instead + # + # @note StabilityLevel.EXPERIMENTAL + # + # @deprecated Replaced by `messaging.operation.type` + MESSAGING_OPERATION = 'messaging.operation' + + # The system-specific name of the messaging operation + # + # @note StabilityLevel.EXPERIMENTAL + MESSAGING_OPERATION_NAME = 'messaging.operation.name' + + # A string identifying the type of the messaging operation + # + # If a custom value is used, it MUST be of low cardinality + # + # @note StabilityLevel.EXPERIMENTAL + MESSAGING_OPERATION_TYPE = 'messaging.operation.type' + + # RabbitMQ message routing key + # + # @note StabilityLevel.EXPERIMENTAL + MESSAGING_RABBITMQ_DESTINATION_ROUTING_KEY = 'messaging.rabbitmq.destination.routing_key' + + # RabbitMQ message delivery tag + # + # @note StabilityLevel.EXPERIMENTAL + MESSAGING_RABBITMQ_MESSAGE_DELIVERY_TAG = 'messaging.rabbitmq.message.delivery_tag' + + # Name of the RocketMQ producer/consumer group that is handling the message. The client type is identified by the SpanKind + # + # @note StabilityLevel.EXPERIMENTAL + MESSAGING_ROCKETMQ_CLIENT_GROUP = 'messaging.rocketmq.client_group' + + # Model of message consumption. This only applies to consumer spans + # + # @note StabilityLevel.EXPERIMENTAL + MESSAGING_ROCKETMQ_CONSUMPTION_MODEL = 'messaging.rocketmq.consumption_model' + + # The delay time level for delay message, which determines the message delay time + # + # @note StabilityLevel.EXPERIMENTAL + MESSAGING_ROCKETMQ_MESSAGE_DELAY_TIME_LEVEL = 'messaging.rocketmq.message.delay_time_level' + + # The timestamp in milliseconds that the delay message is expected to be delivered to consumer + # + # @note StabilityLevel.EXPERIMENTAL + MESSAGING_ROCKETMQ_MESSAGE_DELIVERY_TIMESTAMP = 'messaging.rocketmq.message.delivery_timestamp' + + # It is essential for FIFO message. Messages that belong to the same message group are always processed one by one within the same consumer group + # + # @note StabilityLevel.EXPERIMENTAL + MESSAGING_ROCKETMQ_MESSAGE_GROUP = 'messaging.rocketmq.message.group' + + # Key(s) of message, another way to mark message besides message id + # + # @note StabilityLevel.EXPERIMENTAL + MESSAGING_ROCKETMQ_MESSAGE_KEYS = 'messaging.rocketmq.message.keys' + + # The secondary classifier of message besides topic + # + # @note StabilityLevel.EXPERIMENTAL + MESSAGING_ROCKETMQ_MESSAGE_TAG = 'messaging.rocketmq.message.tag' + + # Type of message + # + # @note StabilityLevel.EXPERIMENTAL + MESSAGING_ROCKETMQ_MESSAGE_TYPE = 'messaging.rocketmq.message.type' + + # Namespace of RocketMQ resources, resources in different namespaces are individual + # + # @note StabilityLevel.EXPERIMENTAL + MESSAGING_ROCKETMQ_NAMESPACE = 'messaging.rocketmq.namespace' + + # The name of the subscription in the topic messages are received from + # + # @note StabilityLevel.EXPERIMENTAL + MESSAGING_SERVICEBUS_DESTINATION_SUBSCRIPTION_NAME = 'messaging.servicebus.destination.subscription_name' + + # Describes the [settlement type](https://learn.microsoft.com/azure/service-bus-messaging/message-transfers-locks-settlement#peeklock) + # + # @note StabilityLevel.EXPERIMENTAL + MESSAGING_SERVICEBUS_DISPOSITION_STATUS = 'messaging.servicebus.disposition_status' + + # Number of deliveries that have been attempted for this message + # + # @note StabilityLevel.EXPERIMENTAL + MESSAGING_SERVICEBUS_MESSAGE_DELIVERY_COUNT = 'messaging.servicebus.message.delivery_count' + + # The UTC epoch seconds at which the message has been accepted and stored in the entity + # + # @note StabilityLevel.EXPERIMENTAL + MESSAGING_SERVICEBUS_MESSAGE_ENQUEUED_TIME = 'messaging.servicebus.message.enqueued_time' + + # The messaging system as identified by the client instrumentation + # + # The actual messaging system may differ from the one known by the client. For example, when using Kafka client libraries to communicate with Azure Event Hubs, the `messaging.system` is set to `kafka` based on the instrumentation's best knowledge + # + # @note StabilityLevel.EXPERIMENTAL + MESSAGING_SYSTEM = 'messaging.system' + + # @!endgroup + end + end +end \ No newline at end of file diff --git a/semantic_conventions/lib/opentelemetry/semantic_candidates/attributes/net.rb b/semantic_conventions/lib/opentelemetry/semantic_candidates/attributes/net.rb new file mode 100644 index 0000000000..11ebe26010 --- /dev/null +++ b/semantic_conventions/lib/opentelemetry/semantic_candidates/attributes/net.rb @@ -0,0 +1,134 @@ +# 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 SemanticCandidates + module NET + # @!group Attribute Names + + # Deprecated, use `network.local.address` + # + # @note StabilityLevel.EXPERIMENTAL + # + # @deprecated Replaced by `network.local.address` + NET_HOST_IP = 'net.host.ip' + + # Deprecated, use `server.address` + # + # @note StabilityLevel.EXPERIMENTAL + # + # @deprecated Replaced by `server.address` + NET_HOST_NAME = 'net.host.name' + + # Deprecated, use `server.port` + # + # @note StabilityLevel.EXPERIMENTAL + # + # @deprecated Replaced by `server.port` + NET_HOST_PORT = 'net.host.port' + + # Deprecated, use `network.peer.address` + # + # @note StabilityLevel.EXPERIMENTAL + # + # @deprecated Replaced by `network.peer.address` + NET_PEER_IP = 'net.peer.ip' + + # Deprecated, use `server.address` on client spans and `client.address` on server spans + # + # @note StabilityLevel.EXPERIMENTAL + # + # @deprecated Replaced by `server.address` on client spans and `client.address` on server spans + NET_PEER_NAME = 'net.peer.name' + + # Deprecated, use `server.port` on client spans and `client.port` on server spans + # + # @note StabilityLevel.EXPERIMENTAL + # + # @deprecated Replaced by `server.port` on client spans and `client.port` on server spans + NET_PEER_PORT = 'net.peer.port' + + # Deprecated, use `network.protocol.name` + # + # @note StabilityLevel.EXPERIMENTAL + # + # @deprecated Replaced by `network.protocol.name` + NET_PROTOCOL_NAME = 'net.protocol.name' + + # Deprecated, use `network.protocol.version` + # + # @note StabilityLevel.EXPERIMENTAL + # + # @deprecated Replaced by `network.protocol.version` + NET_PROTOCOL_VERSION = 'net.protocol.version' + + # Deprecated, use `network.transport` and `network.type` + # + # @note StabilityLevel.EXPERIMENTAL + # + # @deprecated Split to `network.transport` and `network.type` + NET_SOCK_FAMILY = 'net.sock.family' + + # Deprecated, use `network.local.address` + # + # @note StabilityLevel.EXPERIMENTAL + # + # @deprecated Replaced by `network.local.address` + NET_SOCK_HOST_ADDR = 'net.sock.host.addr' + + # Deprecated, use `network.local.port` + # + # @note StabilityLevel.EXPERIMENTAL + # + # @deprecated Replaced by `network.local.port` + NET_SOCK_HOST_PORT = 'net.sock.host.port' + + # Deprecated, use `network.peer.address` + # + # @note StabilityLevel.EXPERIMENTAL + # + # @deprecated Replaced by `network.peer.address` + NET_SOCK_PEER_ADDR = 'net.sock.peer.addr' + + # Deprecated, no replacement at this time + # + # @note StabilityLevel.EXPERIMENTAL + # + # @deprecated Removed + NET_SOCK_PEER_NAME = 'net.sock.peer.name' + + # Deprecated, use `network.peer.port` + # + # @note StabilityLevel.EXPERIMENTAL + # + # @deprecated Replaced by `network.peer.port` + NET_SOCK_PEER_PORT = 'net.sock.peer.port' + + # Deprecated, use `network.transport` + # + # @note StabilityLevel.EXPERIMENTAL + # + # @deprecated Replaced by `network.transport` + NET_TRANSPORT = 'net.transport' + + # @!endgroup + end + end +end \ No newline at end of file diff --git a/semantic_conventions/lib/opentelemetry/semantic_candidates/attributes/network.rb b/semantic_conventions/lib/opentelemetry/semantic_candidates/attributes/network.rb new file mode 100644 index 0000000000..d5eb99b614 --- /dev/null +++ b/semantic_conventions/lib/opentelemetry/semantic_candidates/attributes/network.rb @@ -0,0 +1,132 @@ +# 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 SemanticCandidates + module NETWORK + # @!group Attribute Names + + # The ISO 3166-1 alpha-2 2-character country code associated with the mobile carrier network + # + # @note StabilityLevel.EXPERIMENTAL + NETWORK_CARRIER_ICC = 'network.carrier.icc' + + # The mobile carrier country code + # + # @note StabilityLevel.EXPERIMENTAL + NETWORK_CARRIER_MCC = 'network.carrier.mcc' + + # The mobile carrier network code + # + # @note StabilityLevel.EXPERIMENTAL + NETWORK_CARRIER_MNC = 'network.carrier.mnc' + + # The name of the mobile carrier + # + # @note StabilityLevel.EXPERIMENTAL + NETWORK_CARRIER_NAME = 'network.carrier.name' + + # This describes more details regarding the connection.type. It may be the type of cell technology connection, but it could be used for describing details about a wifi connection + # + # @note StabilityLevel.EXPERIMENTAL + NETWORK_CONNECTION_SUBTYPE = 'network.connection.subtype' + + # The internet connection type + # + # @note StabilityLevel.EXPERIMENTAL + NETWORK_CONNECTION_TYPE = 'network.connection.type' + + # The network IO operation direction + # + # @note StabilityLevel.EXPERIMENTAL + NETWORK_IO_DIRECTION = 'network.io.direction' + + # Local address of the network connection - IP address or Unix domain socket name + # + # @note StabilityLevel.STABLE + # + # @deprecated Now available in the stable namespace at {OpenTelemetry::SemanticConventions::NETWORK::LOCAL_ADDRESS}. + NETWORK_LOCAL_ADDRESS = 'network.local.address' + + # Local port number of the network connection + # + # @note StabilityLevel.STABLE + # + # @deprecated Now available in the stable namespace at {OpenTelemetry::SemanticConventions::NETWORK::LOCAL_PORT}. + NETWORK_LOCAL_PORT = 'network.local.port' + + # Peer address of the network connection - IP address or Unix domain socket name + # + # @note StabilityLevel.STABLE + # + # @deprecated Now available in the stable namespace at {OpenTelemetry::SemanticConventions::NETWORK::PEER_ADDRESS}. + NETWORK_PEER_ADDRESS = 'network.peer.address' + + # Peer port number of the network connection + # + # @note StabilityLevel.STABLE + # + # @deprecated Now available in the stable namespace at {OpenTelemetry::SemanticConventions::NETWORK::PEER_PORT}. + NETWORK_PEER_PORT = 'network.peer.port' + + # [OSI application layer](https://osi-model.com/application-layer/) or non-OSI equivalent + # + # The value SHOULD be normalized to lowercase + # + # @note StabilityLevel.STABLE + # + # @deprecated Now available in the stable namespace at {OpenTelemetry::SemanticConventions::NETWORK::PROTOCOL_NAME}. + NETWORK_PROTOCOL_NAME = 'network.protocol.name' + + # The actual version of the protocol used for network communication + # + # If protocol version is subject to negotiation (for example using [ALPN](https://www.rfc-editor.org/rfc/rfc7301.html)), this attribute SHOULD be set to the negotiated version. If the actual protocol version is not known, this attribute SHOULD NOT be set + # + # @note StabilityLevel.STABLE + # + # @deprecated Now available in the stable namespace at {OpenTelemetry::SemanticConventions::NETWORK::PROTOCOL_VERSION}. + NETWORK_PROTOCOL_VERSION = 'network.protocol.version' + + # [OSI transport layer](https://osi-model.com/transport-layer/) or [inter-process communication method](https://wikipedia.org/wiki/Inter-process_communication) + # + # The value SHOULD be normalized to lowercase. + # + # Consider always setting the transport when setting a port number, since + # a port number is ambiguous without knowing the transport. For example + # different processes could be listening on TCP port 12345 and UDP port 12345 + # + # @note StabilityLevel.STABLE + # + # @deprecated Now available in the stable namespace at {OpenTelemetry::SemanticConventions::NETWORK::TRANSPORT}. + NETWORK_TRANSPORT = 'network.transport' + + # [OSI network layer](https://osi-model.com/network-layer/) or non-OSI equivalent + # + # The value SHOULD be normalized to lowercase + # + # @note StabilityLevel.STABLE + # + # @deprecated Now available in the stable namespace at {OpenTelemetry::SemanticConventions::NETWORK::TYPE}. + NETWORK_TYPE = 'network.type' + + # @!endgroup + end + end +end \ No newline at end of file diff --git a/semantic_conventions/lib/opentelemetry/semantic_candidates/attributes/oci.rb b/semantic_conventions/lib/opentelemetry/semantic_candidates/attributes/oci.rb new file mode 100644 index 0000000000..65a716bd29 --- /dev/null +++ b/semantic_conventions/lib/opentelemetry/semantic_candidates/attributes/oci.rb @@ -0,0 +1,37 @@ +# 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 SemanticCandidates + module OCI + # @!group Attribute Names + + # The digest of the OCI image manifest. For container images specifically is the digest by which the container image is known + # + # Follows [OCI Image Manifest Specification](https://github.com/opencontainers/image-spec/blob/main/manifest.md), and specifically the [Digest property](https://github.com/opencontainers/image-spec/blob/main/descriptor.md#digests). + # An example can be found in [Example Image Manifest](https://docs.docker.com/registry/spec/manifest-v2-2/#example-image-manifest) + # + # @note StabilityLevel.EXPERIMENTAL + OCI_MANIFEST_DIGEST = 'oci.manifest.digest' + + # @!endgroup + end + end +end \ No newline at end of file diff --git a/semantic_conventions/lib/opentelemetry/semantic_candidates/attributes/opentracing.rb b/semantic_conventions/lib/opentelemetry/semantic_candidates/attributes/opentracing.rb new file mode 100644 index 0000000000..237ea71396 --- /dev/null +++ b/semantic_conventions/lib/opentelemetry/semantic_candidates/attributes/opentracing.rb @@ -0,0 +1,36 @@ +# 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 SemanticCandidates + module OPENTRACING + # @!group Attribute Names + + # Parent-child Reference type + # + # The causal relationship between a child Span and a parent Span + # + # @note StabilityLevel.EXPERIMENTAL + OPENTRACING_REF_TYPE = 'opentracing.ref_type' + + # @!endgroup + end + end +end \ No newline at end of file diff --git a/semantic_conventions/lib/opentelemetry/semantic_candidates/attributes/os.rb b/semantic_conventions/lib/opentelemetry/semantic_candidates/attributes/os.rb new file mode 100644 index 0000000000..8e241d4f9b --- /dev/null +++ b/semantic_conventions/lib/opentelemetry/semantic_candidates/attributes/os.rb @@ -0,0 +1,54 @@ +# 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 SemanticCandidates + module OS + # @!group Attribute Names + + # Unique identifier for a particular build or compilation of the operating system + # + # @note StabilityLevel.EXPERIMENTAL + OS_BUILD_ID = 'os.build_id' + + # Human readable (not intended to be parsed) OS version information, like e.g. reported by `ver` or `lsb_release -a` commands + # + # @note StabilityLevel.EXPERIMENTAL + OS_DESCRIPTION = 'os.description' + + # Human readable operating system name + # + # @note StabilityLevel.EXPERIMENTAL + OS_NAME = 'os.name' + + # The operating system type + # + # @note StabilityLevel.EXPERIMENTAL + OS_TYPE = 'os.type' + + # The version string of the operating system as defined in [Version Attributes](/docs/resource/README.md#version-attributes) + # + # @note StabilityLevel.EXPERIMENTAL + OS_VERSION = 'os.version' + + # @!endgroup + end + end +end \ No newline at end of file diff --git a/semantic_conventions/lib/opentelemetry/semantic_candidates/attributes/otel.rb b/semantic_conventions/lib/opentelemetry/semantic_candidates/attributes/otel.rb new file mode 100644 index 0000000000..2a72cf28d9 --- /dev/null +++ b/semantic_conventions/lib/opentelemetry/semantic_candidates/attributes/otel.rb @@ -0,0 +1,71 @@ +# 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 SemanticCandidates + module OTEL + # @!group Attribute Names + + # None + # + # @note StabilityLevel.EXPERIMENTAL + # + # @deprecated use the `otel.scope.name` attribute + OTEL_LIBRARY_NAME = 'otel.library.name' + + # None + # + # @note StabilityLevel.EXPERIMENTAL + # + # @deprecated use the `otel.scope.version` attribute + OTEL_LIBRARY_VERSION = 'otel.library.version' + + # The name of the instrumentation scope - (`InstrumentationScope.Name` in OTLP) + # + # @note StabilityLevel.STABLE + # + # @deprecated Now available in the stable namespace at {OpenTelemetry::SemanticConventions::OTEL::NAME}. + OTEL_SCOPE_NAME = 'otel.scope.name' + + # The version of the instrumentation scope - (`InstrumentationScope.Version` in OTLP) + # + # @note StabilityLevel.STABLE + # + # @deprecated Now available in the stable namespace at {OpenTelemetry::SemanticConventions::OTEL::VERSION}. + OTEL_SCOPE_VERSION = 'otel.scope.version' + + # Name of the code, either "OK" or "ERROR". MUST NOT be set if the status code is UNSET + # + # @note StabilityLevel.STABLE + # + # @deprecated Now available in the stable namespace at {OpenTelemetry::SemanticConventions::OTEL::STATUS_CODE}. + OTEL_STATUS_CODE = 'otel.status_code' + + # Description of the Status if it has a value, otherwise not set + # + # @note StabilityLevel.STABLE + # + # @deprecated Now available in the stable namespace at {OpenTelemetry::SemanticConventions::OTEL::STATUS_DESCRIPTION}. + OTEL_STATUS_DESCRIPTION = 'otel.status_description' + + # @!endgroup + end + end +end \ No newline at end of file diff --git a/semantic_conventions/lib/opentelemetry/semantic_candidates/attributes/other.rb b/semantic_conventions/lib/opentelemetry/semantic_candidates/attributes/other.rb new file mode 100644 index 0000000000..d31a16a7e4 --- /dev/null +++ b/semantic_conventions/lib/opentelemetry/semantic_candidates/attributes/other.rb @@ -0,0 +1,36 @@ +# 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 SemanticCandidates + module OTHER + # @!group Attribute Names + + # Deprecated, use `db.client.connections.state` instead + # + # @note StabilityLevel.EXPERIMENTAL + # + # @deprecated Replaced by `db.client.connections.state` + STATE = 'state' + + # @!endgroup + end + end +end \ No newline at end of file diff --git a/semantic_conventions/lib/opentelemetry/semantic_candidates/attributes/peer.rb b/semantic_conventions/lib/opentelemetry/semantic_candidates/attributes/peer.rb new file mode 100644 index 0000000000..6303345eff --- /dev/null +++ b/semantic_conventions/lib/opentelemetry/semantic_candidates/attributes/peer.rb @@ -0,0 +1,34 @@ +# 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 SemanticCandidates + module PEER + # @!group Attribute Names + + # The [`service.name`](/docs/resource/README.md#service) of the remote service. SHOULD be equal to the actual `service.name` resource attribute of the remote service if any + # + # @note StabilityLevel.EXPERIMENTAL + PEER_SERVICE = 'peer.service' + + # @!endgroup + end + end +end \ No newline at end of file diff --git a/semantic_conventions/lib/opentelemetry/semantic_candidates/attributes/pool.rb b/semantic_conventions/lib/opentelemetry/semantic_candidates/attributes/pool.rb new file mode 100644 index 0000000000..ad0fc9ed49 --- /dev/null +++ b/semantic_conventions/lib/opentelemetry/semantic_candidates/attributes/pool.rb @@ -0,0 +1,36 @@ +# 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 SemanticCandidates + module POOL + # @!group Attribute Names + + # Deprecated, use `db.client.connections.pool.name` instead + # + # @note StabilityLevel.EXPERIMENTAL + # + # @deprecated Replaced by `db.client.connections.pool.name` + POOL_NAME = 'pool.name' + + # @!endgroup + end + end +end \ No newline at end of file diff --git a/semantic_conventions/lib/opentelemetry/semantic_candidates/attributes/process.rb b/semantic_conventions/lib/opentelemetry/semantic_candidates/attributes/process.rb new file mode 100644 index 0000000000..a1e7c21fbb --- /dev/null +++ b/semantic_conventions/lib/opentelemetry/semantic_candidates/attributes/process.rb @@ -0,0 +1,166 @@ +# 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 SemanticCandidates + module PROCESS + # @!group Attribute Names + + # 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` + # + # @note StabilityLevel.EXPERIMENTAL + PROCESS_COMMAND = 'process.command' + + # 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` + # + # @note StabilityLevel.EXPERIMENTAL + PROCESS_COMMAND_ARGS = 'process.command_args' + + # 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 + # + # @note StabilityLevel.EXPERIMENTAL + PROCESS_COMMAND_LINE = 'process.command_line' + + # Specifies whether the context switches for this data point were voluntary or involuntary + # + # @note StabilityLevel.EXPERIMENTAL + PROCESS_CONTEXT_SWITCH_TYPE = 'process.context_switch_type' + + # The CPU state of the process + # + # @note StabilityLevel.EXPERIMENTAL + PROCESS_CPU_STATE = 'process.cpu.state' + + # The date and time the process was created, in ISO 8601 format + # + # @note StabilityLevel.EXPERIMENTAL + PROCESS_CREATION_TIME = 'process.creation.time' + + # 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` + # + # @note StabilityLevel.EXPERIMENTAL + PROCESS_EXECUTABLE_NAME = 'process.executable.name' + + # 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` + # + # @note StabilityLevel.EXPERIMENTAL + PROCESS_EXECUTABLE_PATH = 'process.executable.path' + + # The exit code of the process + # + # @note StabilityLevel.EXPERIMENTAL + PROCESS_EXIT_CODE = 'process.exit.code' + + # The date and time the process exited, in ISO 8601 format + # + # @note StabilityLevel.EXPERIMENTAL + PROCESS_EXIT_TIME = 'process.exit.time' + + # The PID of the process's group leader. This is also the process group ID (PGID) of the process + # + # @note StabilityLevel.EXPERIMENTAL + PROCESS_GROUP_LEADER_PID = 'process.group_leader.pid' + + # Whether the process is connected to an interactive shell + # + # @note StabilityLevel.EXPERIMENTAL + PROCESS_INTERACTIVE = 'process.interactive' + + # The username of the user that owns the process + # + # @note StabilityLevel.EXPERIMENTAL + PROCESS_OWNER = 'process.owner' + + # The type of page fault for this data point. Type `major` is for major/hard page faults, and `minor` is for minor/soft page faults + # + # @note StabilityLevel.EXPERIMENTAL + PROCESS_PAGING_FAULT_TYPE = 'process.paging.fault_type' + + # Parent Process identifier (PPID) + # + # @note StabilityLevel.EXPERIMENTAL + PROCESS_PARENT_PID = 'process.parent_pid' + + # Process identifier (PID) + # + # @note StabilityLevel.EXPERIMENTAL + PROCESS_PID = 'process.pid' + + # The real user ID (RUID) of the process + # + # @note StabilityLevel.EXPERIMENTAL + PROCESS_REAL_USER_ID = 'process.real_user.id' + + # The username of the real user of the process + # + # @note StabilityLevel.EXPERIMENTAL + PROCESS_REAL_USER_NAME = 'process.real_user.name' + + # An additional description about the runtime of the process, for example a specific vendor customization of the runtime environment + # + # @note StabilityLevel.EXPERIMENTAL + PROCESS_RUNTIME_DESCRIPTION = 'process.runtime.description' + + # The name of the runtime of this process. For compiled native binaries, this SHOULD be the name of the compiler + # + # @note StabilityLevel.EXPERIMENTAL + PROCESS_RUNTIME_NAME = 'process.runtime.name' + + # The version of the runtime of this process, as returned by the runtime without modification + # + # @note StabilityLevel.EXPERIMENTAL + PROCESS_RUNTIME_VERSION = 'process.runtime.version' + + # The saved user ID (SUID) of the process + # + # @note StabilityLevel.EXPERIMENTAL + PROCESS_SAVED_USER_ID = 'process.saved_user.id' + + # The username of the saved user + # + # @note StabilityLevel.EXPERIMENTAL + PROCESS_SAVED_USER_NAME = 'process.saved_user.name' + + # The PID of the process's session leader. This is also the session ID (SID) of the process + # + # @note StabilityLevel.EXPERIMENTAL + PROCESS_SESSION_LEADER_PID = 'process.session_leader.pid' + + # The effective user ID (EUID) of the process + # + # @note StabilityLevel.EXPERIMENTAL + PROCESS_USER_ID = 'process.user.id' + + # The username of the effective user of the process + # + # @note StabilityLevel.EXPERIMENTAL + PROCESS_USER_NAME = 'process.user.name' + + # Virtual process identifier + # + # The process ID within a PID namespace. This is not necessarily unique across all processes on the host but it is unique within the process namespace that the process exists within + # + # @note StabilityLevel.EXPERIMENTAL + PROCESS_VPID = 'process.vpid' + + # @!endgroup + end + end +end \ No newline at end of file diff --git a/semantic_conventions/lib/opentelemetry/semantic_candidates/attributes/rpc.rb b/semantic_conventions/lib/opentelemetry/semantic_candidates/attributes/rpc.rb new file mode 100644 index 0000000000..9436ba19ed --- /dev/null +++ b/semantic_conventions/lib/opentelemetry/semantic_candidates/attributes/rpc.rb @@ -0,0 +1,128 @@ +# 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 SemanticCandidates + module RPC + # @!group Attribute Names + + # The [error codes](https://connect.build/docs/protocol/#error-codes) of the Connect request. Error codes are always string values + # + # @note StabilityLevel.EXPERIMENTAL + RPC_CONNECT_RPC_ERROR_CODE = 'rpc.connect_rpc.error_code' + + # Connect request metadata, `` being the normalized Connect Metadata key (lowercase), the value being the metadata values + # + # Instrumentations SHOULD require an explicit configuration of which metadata values are to be captured. Including all request metadata values can be a security risk - explicit configuration helps avoid leaking sensitive information + # + # @note StabilityLevel.EXPERIMENTAL + RPC_CONNECT_RPC_REQUEST_METADATA = 'rpc.connect_rpc.request.metadata' + + # Connect response metadata, `` being the normalized Connect Metadata key (lowercase), the value being the metadata values + # + # Instrumentations SHOULD require an explicit configuration of which metadata values are to be captured. Including all response metadata values can be a security risk - explicit configuration helps avoid leaking sensitive information + # + # @note StabilityLevel.EXPERIMENTAL + RPC_CONNECT_RPC_RESPONSE_METADATA = 'rpc.connect_rpc.response.metadata' + + # gRPC request metadata, `` being the normalized gRPC Metadata key (lowercase), the value being the metadata values + # + # Instrumentations SHOULD require an explicit configuration of which metadata values are to be captured. Including all request metadata values can be a security risk - explicit configuration helps avoid leaking sensitive information + # + # @note StabilityLevel.EXPERIMENTAL + RPC_GRPC_REQUEST_METADATA = 'rpc.grpc.request.metadata' + + # gRPC response metadata, `` being the normalized gRPC Metadata key (lowercase), the value being the metadata values + # + # Instrumentations SHOULD require an explicit configuration of which metadata values are to be captured. Including all response metadata values can be a security risk - explicit configuration helps avoid leaking sensitive information + # + # @note StabilityLevel.EXPERIMENTAL + RPC_GRPC_RESPONSE_METADATA = 'rpc.grpc.response.metadata' + + # The [numeric status code](https://github.com/grpc/grpc/blob/v1.33.2/doc/statuscodes.md) of the gRPC request + # + # @note StabilityLevel.EXPERIMENTAL + RPC_GRPC_STATUS_CODE = 'rpc.grpc.status_code' + + # `error.code` property of response if it is an error response + # + # @note StabilityLevel.EXPERIMENTAL + RPC_JSONRPC_ERROR_CODE = 'rpc.jsonrpc.error_code' + + # `error.message` property of response if it is an error response + # + # @note StabilityLevel.EXPERIMENTAL + RPC_JSONRPC_ERROR_MESSAGE = 'rpc.jsonrpc.error_message' + + # `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 + # + # @note StabilityLevel.EXPERIMENTAL + RPC_JSONRPC_REQUEST_ID = 'rpc.jsonrpc.request_id' + + # Protocol version as in `jsonrpc` property of request/response. Since JSON-RPC 1.0 doesn't specify this, the value can be omitted + # + # @note StabilityLevel.EXPERIMENTAL + RPC_JSONRPC_VERSION = 'rpc.jsonrpc.version' + + # Compressed size of the message in bytes + # + # @note StabilityLevel.EXPERIMENTAL + RPC_MESSAGE_COMPRESSED_SIZE = 'rpc.message.compressed_size' + + # MUST be calculated as two different counters starting from `1` one for sent messages and one for received message + # + # This way we guarantee that the values will be consistent between different implementations + # + # @note StabilityLevel.EXPERIMENTAL + RPC_MESSAGE_ID = 'rpc.message.id' + + # Whether this is a received or sent message + # + # @note StabilityLevel.EXPERIMENTAL + RPC_MESSAGE_TYPE = 'rpc.message.type' + + # Uncompressed size of the message in bytes + # + # @note StabilityLevel.EXPERIMENTAL + RPC_MESSAGE_UNCOMPRESSED_SIZE = 'rpc.message.uncompressed_size' + + # The name of the (logical) method being called, must be equal to the $method part in the span name + # + # This is the logical name of the method from the RPC interface perspective, which can be different from the name of any implementing method/function. The `code.function` attribute may be used to store the latter (e.g., method actually executing the call on the server side, RPC client stub method on the client side) + # + # @note StabilityLevel.EXPERIMENTAL + RPC_METHOD = 'rpc.method' + + # The full (logical) name of the service being called, including its package name, if applicable + # + # This is the logical name of the service from the RPC interface perspective, which can be different from the name of any implementing class. The `code.namespace` attribute may be used to store the latter (despite the attribute name, it may include a class name; e.g., class with method actually executing the call on the server side, RPC client stub class on the client side) + # + # @note StabilityLevel.EXPERIMENTAL + RPC_SERVICE = 'rpc.service' + + # A string identifying the remoting system. See below for a list of well-known identifiers + # + # @note StabilityLevel.EXPERIMENTAL + RPC_SYSTEM = 'rpc.system' + + # @!endgroup + end + end +end \ No newline at end of file diff --git a/semantic_conventions/lib/opentelemetry/semantic_candidates/attributes/server.rb b/semantic_conventions/lib/opentelemetry/semantic_candidates/attributes/server.rb new file mode 100644 index 0000000000..273ca50d1d --- /dev/null +++ b/semantic_conventions/lib/opentelemetry/semantic_candidates/attributes/server.rb @@ -0,0 +1,47 @@ +# 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 SemanticCandidates + module SERVER + # @!group Attribute Names + + # Server domain name if available without reverse DNS lookup; otherwise, IP address or Unix domain socket name + # + # When observed from the client side, and when communicating through an intermediary, `server.address` SHOULD represent the server address behind any intermediaries, for example proxies, if it's available + # + # @note StabilityLevel.STABLE + # + # @deprecated Now available in the stable namespace at {OpenTelemetry::SemanticConventions::SERVER::ADDRESS}. + SERVER_ADDRESS = 'server.address' + + # Server port number + # + # When observed from the client side, and when communicating through an intermediary, `server.port` SHOULD represent the server port behind any intermediaries, for example proxies, if it's available + # + # @note StabilityLevel.STABLE + # + # @deprecated Now available in the stable namespace at {OpenTelemetry::SemanticConventions::SERVER::PORT}. + SERVER_PORT = 'server.port' + + # @!endgroup + end + end +end \ No newline at end of file diff --git a/semantic_conventions/lib/opentelemetry/semantic_candidates/attributes/service.rb b/semantic_conventions/lib/opentelemetry/semantic_candidates/attributes/service.rb new file mode 100644 index 0000000000..5287007bb1 --- /dev/null +++ b/semantic_conventions/lib/opentelemetry/semantic_candidates/attributes/service.rb @@ -0,0 +1,84 @@ +# 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 SemanticCandidates + module SERVICE + # @!group Attribute Names + + # The string ID of the service instance + # + # 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). + # + # Implementations, such as SDKs, are recommended to generate a random Version 1 or Version 4 [RFC + # 4122](https://www.ietf.org/rfc/rfc4122.txt) UUID, but are free to use an inherent unique ID as the source of + # this value if stability is desirable. In that case, the ID SHOULD be used as source of a UUID Version 5 and + # SHOULD use the following UUID as the namespace: `4d63009a-8d0f-11ee-aad7-4c796ed8e320`. + # + # UUIDs are typically recommended, as only an opaque value for the purposes of identifying a service instance is + # needed. Similar to what can be seen in the man page for the + # [`/etc/machine-id`](https://www.freedesktop.org/software/systemd/man/machine-id.html) file, the underlying + # data, such as pod name and namespace should be treated as confidential, being the user's choice to expose it + # or not via another resource attribute. + # + # For applications running behind an application server (like unicorn), we do not recommend using one identifier + # for all processes participating in the application. Instead, it's recommended each division (e.g. a worker + # thread in unicorn) to have its own instance.id. + # + # It's not recommended for a Collector to set `service.instance.id` if it can't unambiguously determine the + # service instance that is generating that telemetry. For instance, creating an UUID based on `pod.name` will + # likely be wrong, as the Collector might not know from which container within that pod the telemetry originated. + # However, Collectors can set the `service.instance.id` if they can unambiguously determine the service instance + # for that telemetry. This is typically the case for scraping receivers, as they know the target address and + # port + # + # @note StabilityLevel.EXPERIMENTAL + SERVICE_INSTANCE_ID = 'service.instance.id' + + # Logical name of the service + # + # MUST be the same for all instances of horizontally scaled services. If the value was not specified, SDKs MUST fallback to `unknown_service:` concatenated with [`process.executable.name`](process.md), e.g. `unknown_service:bash`. If `process.executable.name` is not available, the value MUST be set to `unknown_service` + # + # @note StabilityLevel.STABLE + # + # @deprecated Now available in the stable namespace at {OpenTelemetry::SemanticConventions::SERVICE::NAME}. + SERVICE_NAME = 'service.name' + + # A namespace for `service.name` + # + # 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 + # + # @note StabilityLevel.EXPERIMENTAL + SERVICE_NAMESPACE = 'service.namespace' + + # The version string of the service API or implementation. The format is not defined by these conventions + # + # @note StabilityLevel.STABLE + # + # @deprecated Now available in the stable namespace at {OpenTelemetry::SemanticConventions::SERVICE::VERSION}. + SERVICE_VERSION = 'service.version' + + # @!endgroup + end + end +end \ No newline at end of file diff --git a/semantic_conventions/lib/opentelemetry/semantic_candidates/attributes/session.rb b/semantic_conventions/lib/opentelemetry/semantic_candidates/attributes/session.rb new file mode 100644 index 0000000000..b673e43794 --- /dev/null +++ b/semantic_conventions/lib/opentelemetry/semantic_candidates/attributes/session.rb @@ -0,0 +1,39 @@ +# 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 SemanticCandidates + module SESSION + # @!group Attribute Names + + # A unique id to identify a session + # + # @note StabilityLevel.EXPERIMENTAL + SESSION_ID = 'session.id' + + # The previous `session.id` for this user, when known + # + # @note StabilityLevel.EXPERIMENTAL + SESSION_PREVIOUS_ID = 'session.previous_id' + + # @!endgroup + end + end +end \ No newline at end of file diff --git a/semantic_conventions/lib/opentelemetry/semantic_candidates/attributes/signalr.rb b/semantic_conventions/lib/opentelemetry/semantic_candidates/attributes/signalr.rb new file mode 100644 index 0000000000..dac17b2969 --- /dev/null +++ b/semantic_conventions/lib/opentelemetry/semantic_candidates/attributes/signalr.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 SemanticCandidates + module SIGNALR + # @!group Attribute Names + + # SignalR HTTP connection closure status + # + # @note StabilityLevel.STABLE + # + # @deprecated Now available in the stable namespace at {OpenTelemetry::SemanticConventions::SIGNALR::CONNECTION_STATUS}. + SIGNALR_CONNECTION_STATUS = 'signalr.connection.status' + + # [SignalR transport type](https://github.com/dotnet/aspnetcore/blob/main/src/SignalR/docs/specs/TransportProtocols.md) + # + # @note StabilityLevel.STABLE + # + # @deprecated Now available in the stable namespace at {OpenTelemetry::SemanticConventions::SIGNALR::TRANSPORT}. + SIGNALR_TRANSPORT = 'signalr.transport' + + # @!endgroup + end + end +end \ No newline at end of file diff --git a/semantic_conventions/lib/opentelemetry/semantic_candidates/attributes/source.rb b/semantic_conventions/lib/opentelemetry/semantic_candidates/attributes/source.rb new file mode 100644 index 0000000000..3309bfcd06 --- /dev/null +++ b/semantic_conventions/lib/opentelemetry/semantic_candidates/attributes/source.rb @@ -0,0 +1,41 @@ +# 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 SemanticCandidates + module SOURCE + # @!group Attribute Names + + # Source address - domain name if available without reverse DNS lookup; otherwise, IP address or Unix domain socket name + # + # When observed from the destination side, and when communicating through an intermediary, `source.address` SHOULD represent the source address behind any intermediaries, for example proxies, if it's available + # + # @note StabilityLevel.EXPERIMENTAL + SOURCE_ADDRESS = 'source.address' + + # Source port number + # + # @note StabilityLevel.EXPERIMENTAL + SOURCE_PORT = 'source.port' + + # @!endgroup + end + end +end \ No newline at end of file diff --git a/semantic_conventions/lib/opentelemetry/semantic_candidates/attributes/system.rb b/semantic_conventions/lib/opentelemetry/semantic_candidates/attributes/system.rb new file mode 100644 index 0000000000..1fd29db5c0 --- /dev/null +++ b/semantic_conventions/lib/opentelemetry/semantic_candidates/attributes/system.rb @@ -0,0 +1,101 @@ +# 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 SemanticCandidates + module SYSTEM + # @!group Attribute Names + + # The logical CPU number [0..n-1] + # + # @note StabilityLevel.EXPERIMENTAL + SYSTEM_CPU_LOGICAL_NUMBER = 'system.cpu.logical_number' + + # The state of the CPU + # + # @note StabilityLevel.EXPERIMENTAL + SYSTEM_CPU_STATE = 'system.cpu.state' + + # The device identifier + # + # @note StabilityLevel.EXPERIMENTAL + SYSTEM_DEVICE = 'system.device' + + # The filesystem mode + # + # @note StabilityLevel.EXPERIMENTAL + SYSTEM_FILESYSTEM_MODE = 'system.filesystem.mode' + + # The filesystem mount path + # + # @note StabilityLevel.EXPERIMENTAL + SYSTEM_FILESYSTEM_MOUNTPOINT = 'system.filesystem.mountpoint' + + # The filesystem state + # + # @note StabilityLevel.EXPERIMENTAL + SYSTEM_FILESYSTEM_STATE = 'system.filesystem.state' + + # The filesystem type + # + # @note StabilityLevel.EXPERIMENTAL + SYSTEM_FILESYSTEM_TYPE = 'system.filesystem.type' + + # The memory state + # + # @note StabilityLevel.EXPERIMENTAL + SYSTEM_MEMORY_STATE = 'system.memory.state' + + # A stateless protocol MUST NOT set this attribute + # + # @note StabilityLevel.EXPERIMENTAL + SYSTEM_NETWORK_STATE = 'system.network.state' + + # The paging access direction + # + # @note StabilityLevel.EXPERIMENTAL + SYSTEM_PAGING_DIRECTION = 'system.paging.direction' + + # The memory paging state + # + # @note StabilityLevel.EXPERIMENTAL + SYSTEM_PAGING_STATE = 'system.paging.state' + + # The memory paging type + # + # @note StabilityLevel.EXPERIMENTAL + SYSTEM_PAGING_TYPE = 'system.paging.type' + + # The process state, e.g., [Linux Process State Codes](https://man7.org/linux/man-pages/man1/ps.1.html#PROCESS_STATE_CODES) + # + # @note StabilityLevel.EXPERIMENTAL + SYSTEM_PROCESS_STATUS = 'system.process.status' + + # Deprecated, use `system.process.status` instead + # + # @note StabilityLevel.EXPERIMENTAL + # + # @deprecated Replaced by `system.process.status` + SYSTEM_PROCESSES_STATUS = 'system.processes.status' + + # @!endgroup + end + end +end \ No newline at end of file diff --git a/semantic_conventions/lib/opentelemetry/semantic_candidates/attributes/telemetry.rb b/semantic_conventions/lib/opentelemetry/semantic_candidates/attributes/telemetry.rb new file mode 100644 index 0000000000..23203e662c --- /dev/null +++ b/semantic_conventions/lib/opentelemetry/semantic_candidates/attributes/telemetry.rb @@ -0,0 +1,70 @@ +# 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 SemanticCandidates + module TELEMETRY + # @!group Attribute Names + + # The name of the auto instrumentation agent or distribution, if used + # + # Official auto instrumentation agents and distributions SHOULD set the `telemetry.distro.name` attribute to + # a string starting with `opentelemetry-`, e.g. `opentelemetry-java-instrumentation` + # + # @note StabilityLevel.EXPERIMENTAL + TELEMETRY_DISTRO_NAME = 'telemetry.distro.name' + + # The version string of the auto instrumentation agent or distribution, if used + # + # @note StabilityLevel.EXPERIMENTAL + TELEMETRY_DISTRO_VERSION = 'telemetry.distro.version' + + # The language of the telemetry SDK + # + # @note StabilityLevel.STABLE + # + # @deprecated Now available in the stable namespace at {OpenTelemetry::SemanticConventions::TELEMETRY::SDK_LANGUAGE}. + TELEMETRY_SDK_LANGUAGE = 'telemetry.sdk.language' + + # The name of the telemetry SDK as defined above + # + # The OpenTelemetry SDK MUST set the `telemetry.sdk.name` attribute to `opentelemetry`. + # If another SDK, like a fork or a vendor-provided implementation, is used, this SDK MUST set the + # `telemetry.sdk.name` attribute to the fully-qualified class or module name of this SDK's main entry point + # or another suitable identifier depending on the language. + # The identifier `opentelemetry` is reserved and MUST NOT be used in this case. + # All custom identifiers SHOULD be stable across different versions of an implementation + # + # @note StabilityLevel.STABLE + # + # @deprecated Now available in the stable namespace at {OpenTelemetry::SemanticConventions::TELEMETRY::SDK_NAME}. + TELEMETRY_SDK_NAME = 'telemetry.sdk.name' + + # The version string of the telemetry SDK + # + # @note StabilityLevel.STABLE + # + # @deprecated Now available in the stable namespace at {OpenTelemetry::SemanticConventions::TELEMETRY::SDK_VERSION}. + TELEMETRY_SDK_VERSION = 'telemetry.sdk.version' + + # @!endgroup + end + end +end \ No newline at end of file diff --git a/semantic_conventions/lib/opentelemetry/semantic_candidates/attributes/thread.rb b/semantic_conventions/lib/opentelemetry/semantic_candidates/attributes/thread.rb new file mode 100644 index 0000000000..05776d00a0 --- /dev/null +++ b/semantic_conventions/lib/opentelemetry/semantic_candidates/attributes/thread.rb @@ -0,0 +1,39 @@ +# 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 SemanticCandidates + module THREAD + # @!group Attribute Names + + # Current "managed" thread ID (as opposed to OS thread ID) + # + # @note StabilityLevel.EXPERIMENTAL + THREAD_ID = 'thread.id' + + # Current thread name + # + # @note StabilityLevel.EXPERIMENTAL + THREAD_NAME = 'thread.name' + + # @!endgroup + end + end +end \ No newline at end of file diff --git a/semantic_conventions/lib/opentelemetry/semantic_candidates/attributes/tls.rb b/semantic_conventions/lib/opentelemetry/semantic_candidates/attributes/tls.rb new file mode 100644 index 0000000000..c36bc8238b --- /dev/null +++ b/semantic_conventions/lib/opentelemetry/semantic_candidates/attributes/tls.rb @@ -0,0 +1,176 @@ +# 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 SemanticCandidates + module TLS + # @!group Attribute Names + + # String indicating the [cipher](https://datatracker.ietf.org/doc/html/rfc5246#appendix-A.5) used during the current connection + # + # The values allowed for `tls.cipher` MUST be one of the `Descriptions` of the [registered TLS Cipher Suits](https://www.iana.org/assignments/tls-parameters/tls-parameters.xhtml#table-tls-parameters-4) + # + # @note StabilityLevel.EXPERIMENTAL + TLS_CIPHER = 'tls.cipher' + + # PEM-encoded stand-alone certificate offered by the client. This is usually mutually-exclusive of `client.certificate_chain` since this value also exists in that list + # + # @note StabilityLevel.EXPERIMENTAL + TLS_CLIENT_CERTIFICATE = 'tls.client.certificate' + + # Array of PEM-encoded certificates that make up the certificate chain offered by the client. This is usually mutually-exclusive of `client.certificate` since that value should be the first certificate in the chain + # + # @note StabilityLevel.EXPERIMENTAL + TLS_CLIENT_CERTIFICATE_CHAIN = 'tls.client.certificate_chain' + + # Certificate fingerprint using the MD5 digest of DER-encoded version of certificate offered by the client. For consistency with other hash values, this value should be formatted as an uppercase hash + # + # @note StabilityLevel.EXPERIMENTAL + TLS_CLIENT_HASH_MD5 = 'tls.client.hash.md5' + + # Certificate fingerprint using the SHA1 digest of DER-encoded version of certificate offered by the client. For consistency with other hash values, this value should be formatted as an uppercase hash + # + # @note StabilityLevel.EXPERIMENTAL + TLS_CLIENT_HASH_SHA1 = 'tls.client.hash.sha1' + + # Certificate fingerprint using the SHA256 digest of DER-encoded version of certificate offered by the client. For consistency with other hash values, this value should be formatted as an uppercase hash + # + # @note StabilityLevel.EXPERIMENTAL + TLS_CLIENT_HASH_SHA256 = 'tls.client.hash.sha256' + + # Distinguished name of [subject](https://datatracker.ietf.org/doc/html/rfc5280#section-4.1.2.6) of the issuer of the x.509 certificate presented by the client + # + # @note StabilityLevel.EXPERIMENTAL + TLS_CLIENT_ISSUER = 'tls.client.issuer' + + # A hash that identifies clients based on how they perform an SSL/TLS handshake + # + # @note StabilityLevel.EXPERIMENTAL + TLS_CLIENT_JA3 = 'tls.client.ja3' + + # Date/Time indicating when client certificate is no longer considered valid + # + # @note StabilityLevel.EXPERIMENTAL + TLS_CLIENT_NOT_AFTER = 'tls.client.not_after' + + # Date/Time indicating when client certificate is first considered valid + # + # @note StabilityLevel.EXPERIMENTAL + TLS_CLIENT_NOT_BEFORE = 'tls.client.not_before' + + # Also called an SNI, this tells the server which hostname to which the client is attempting to connect to + # + # @note StabilityLevel.EXPERIMENTAL + TLS_CLIENT_SERVER_NAME = 'tls.client.server_name' + + # Distinguished name of subject of the x.509 certificate presented by the client + # + # @note StabilityLevel.EXPERIMENTAL + TLS_CLIENT_SUBJECT = 'tls.client.subject' + + # Array of ciphers offered by the client during the client hello + # + # @note StabilityLevel.EXPERIMENTAL + TLS_CLIENT_SUPPORTED_CIPHERS = 'tls.client.supported_ciphers' + + # String indicating the curve used for the given cipher, when applicable + # + # @note StabilityLevel.EXPERIMENTAL + TLS_CURVE = 'tls.curve' + + # Boolean flag indicating if the TLS negotiation was successful and transitioned to an encrypted tunnel + # + # @note StabilityLevel.EXPERIMENTAL + TLS_ESTABLISHED = 'tls.established' + + # String indicating the protocol being tunneled. Per the values in the [IANA registry](https://www.iana.org/assignments/tls-extensiontype-values/tls-extensiontype-values.xhtml#alpn-protocol-ids), this string should be lower case + # + # @note StabilityLevel.EXPERIMENTAL + TLS_NEXT_PROTOCOL = 'tls.next_protocol' + + # Normalized lowercase protocol name parsed from original string of the negotiated [SSL/TLS protocol version](https://www.openssl.org/docs/man1.1.1/man3/SSL_get_version.html#RETURN-VALUES) + # + # @note StabilityLevel.EXPERIMENTAL + TLS_PROTOCOL_NAME = 'tls.protocol.name' + + # Numeric part of the version parsed from the original string of the negotiated [SSL/TLS protocol version](https://www.openssl.org/docs/man1.1.1/man3/SSL_get_version.html#RETURN-VALUES) + # + # @note StabilityLevel.EXPERIMENTAL + TLS_PROTOCOL_VERSION = 'tls.protocol.version' + + # Boolean flag indicating if this TLS connection was resumed from an existing TLS negotiation + # + # @note StabilityLevel.EXPERIMENTAL + TLS_RESUMED = 'tls.resumed' + + # PEM-encoded stand-alone certificate offered by the server. This is usually mutually-exclusive of `server.certificate_chain` since this value also exists in that list + # + # @note StabilityLevel.EXPERIMENTAL + TLS_SERVER_CERTIFICATE = 'tls.server.certificate' + + # Array of PEM-encoded certificates that make up the certificate chain offered by the server. This is usually mutually-exclusive of `server.certificate` since that value should be the first certificate in the chain + # + # @note StabilityLevel.EXPERIMENTAL + TLS_SERVER_CERTIFICATE_CHAIN = 'tls.server.certificate_chain' + + # Certificate fingerprint using the MD5 digest of DER-encoded version of certificate offered by the server. For consistency with other hash values, this value should be formatted as an uppercase hash + # + # @note StabilityLevel.EXPERIMENTAL + TLS_SERVER_HASH_MD5 = 'tls.server.hash.md5' + + # Certificate fingerprint using the SHA1 digest of DER-encoded version of certificate offered by the server. For consistency with other hash values, this value should be formatted as an uppercase hash + # + # @note StabilityLevel.EXPERIMENTAL + TLS_SERVER_HASH_SHA1 = 'tls.server.hash.sha1' + + # Certificate fingerprint using the SHA256 digest of DER-encoded version of certificate offered by the server. For consistency with other hash values, this value should be formatted as an uppercase hash + # + # @note StabilityLevel.EXPERIMENTAL + TLS_SERVER_HASH_SHA256 = 'tls.server.hash.sha256' + + # Distinguished name of [subject](https://datatracker.ietf.org/doc/html/rfc5280#section-4.1.2.6) of the issuer of the x.509 certificate presented by the client + # + # @note StabilityLevel.EXPERIMENTAL + TLS_SERVER_ISSUER = 'tls.server.issuer' + + # A hash that identifies servers based on how they perform an SSL/TLS handshake + # + # @note StabilityLevel.EXPERIMENTAL + TLS_SERVER_JA3S = 'tls.server.ja3s' + + # Date/Time indicating when server certificate is no longer considered valid + # + # @note StabilityLevel.EXPERIMENTAL + TLS_SERVER_NOT_AFTER = 'tls.server.not_after' + + # Date/Time indicating when server certificate is first considered valid + # + # @note StabilityLevel.EXPERIMENTAL + TLS_SERVER_NOT_BEFORE = 'tls.server.not_before' + + # Distinguished name of subject of the x.509 certificate presented by the server + # + # @note StabilityLevel.EXPERIMENTAL + TLS_SERVER_SUBJECT = 'tls.server.subject' + + # @!endgroup + end + end +end \ No newline at end of file diff --git a/semantic_conventions/lib/opentelemetry/semantic_candidates/attributes/url.rb b/semantic_conventions/lib/opentelemetry/semantic_candidates/attributes/url.rb new file mode 100644 index 0000000000..eb919de1da --- /dev/null +++ b/semantic_conventions/lib/opentelemetry/semantic_candidates/attributes/url.rb @@ -0,0 +1,125 @@ +# 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 SemanticCandidates + 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 StabilityLevel.EXPERIMENTAL + 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 StabilityLevel.EXPERIMENTAL + URL_EXTENSION = 'url.extension' + + # The [URI fragment](https://www.rfc-editor.org/rfc/rfc3986#section-3.5) component + # + # @note StabilityLevel.STABLE + # + # @deprecated Now available in the stable namespace at {OpenTelemetry::SemanticConventions::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 + # + # @note StabilityLevel.STABLE + # + # @deprecated Now available in the stable namespace at {OpenTelemetry::SemanticConventions::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 StabilityLevel.EXPERIMENTAL + 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 StabilityLevel.STABLE + # + # @deprecated Now available in the stable namespace at {OpenTelemetry::SemanticConventions::URL::PATH}. + URL_PATH = 'url.path' + + # Port extracted from the `url.full` + # + # @note StabilityLevel.EXPERIMENTAL + 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 + # + # @note StabilityLevel.STABLE + # + # @deprecated Now available in the stable namespace at {OpenTelemetry::SemanticConventions::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](http://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 StabilityLevel.EXPERIMENTAL + 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 StabilityLevel.STABLE + # + # @deprecated Now available in the stable namespace at {OpenTelemetry::SemanticConventions::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 StabilityLevel.EXPERIMENTAL + URL_SUBDOMAIN = 'url.subdomain' + + # The low-cardinality template of an [absolute path reference](https://www.rfc-editor.org/rfc/rfc3986#section-4.2) + # + # @note StabilityLevel.EXPERIMENTAL + 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](http://publicsuffix.org) + # + # @note StabilityLevel.EXPERIMENTAL + URL_TOP_LEVEL_DOMAIN = 'url.top_level_domain' + + # @!endgroup + end + end +end \ No newline at end of file diff --git a/semantic_conventions/lib/opentelemetry/semantic_candidates/attributes/user_agent.rb b/semantic_conventions/lib/opentelemetry/semantic_candidates/attributes/user_agent.rb new file mode 100644 index 0000000000..84c9a25a90 --- /dev/null +++ b/semantic_conventions/lib/opentelemetry/semantic_candidates/attributes/user_agent.rb @@ -0,0 +1,50 @@ +# 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 SemanticCandidates + 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 StabilityLevel.EXPERIMENTAL + 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 StabilityLevel.STABLE + # + # @deprecated Now available in the stable namespace at {OpenTelemetry::SemanticConventions::USER_AGENT::ORIGINAL}. + USER_AGENT_ORIGINAL = 'user_agent.original' + + # 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 StabilityLevel.EXPERIMENTAL + USER_AGENT_VERSION = 'user_agent.version' + + # @!endgroup + end + end +end \ No newline at end of file diff --git a/semantic_conventions/lib/opentelemetry/semantic_candidates/attributes/webengine.rb b/semantic_conventions/lib/opentelemetry/semantic_candidates/attributes/webengine.rb new file mode 100644 index 0000000000..d62e02ff41 --- /dev/null +++ b/semantic_conventions/lib/opentelemetry/semantic_candidates/attributes/webengine.rb @@ -0,0 +1,44 @@ +# 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 SemanticCandidates + module WEBENGINE + # @!group Attribute Names + + # Additional description of the web engine (e.g. detailed version and edition information) + # + # @note StabilityLevel.EXPERIMENTAL + WEBENGINE_DESCRIPTION = 'webengine.description' + + # The name of the web engine + # + # @note StabilityLevel.EXPERIMENTAL + WEBENGINE_NAME = 'webengine.name' + + # The version of the web engine + # + # @note StabilityLevel.EXPERIMENTAL + WEBENGINE_VERSION = 'webengine.version' + + # @!endgroup + end + end +end \ No newline at end of file diff --git a/semantic_conventions/lib/opentelemetry/semantic_conventions/attributes/aspnetcore.rb b/semantic_conventions/lib/opentelemetry/semantic_conventions/attributes/aspnetcore.rb new file mode 100644 index 0000000000..a95ae588f7 --- /dev/null +++ b/semantic_conventions/lib/opentelemetry/semantic_conventions/attributes/aspnetcore.rb @@ -0,0 +1,64 @@ +# 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 SemanticConventions + module ASPNETCORE + # @!group Attribute Names + + # ASP.NET Core exception middleware handling result + # + # @note StabilityLevel.STABLE + ASPNETCORE_DIAGNOSTICS_EXCEPTION_RESULT = 'aspnetcore.diagnostics.exception.result' + + # Full type name of the [`IExceptionHandler`](https://learn.microsoft.com/dotnet/api/microsoft.aspnetcore.diagnostics.iexceptionhandler) implementation that handled the exception + # + # @note StabilityLevel.STABLE + ASPNETCORE_DIAGNOSTICS_HANDLER_TYPE = 'aspnetcore.diagnostics.handler.type' + + # Rate limiting policy name + # + # @note StabilityLevel.STABLE + ASPNETCORE_RATE_LIMITING_POLICY = 'aspnetcore.rate_limiting.policy' + + # Rate-limiting result, shows whether the lease was acquired or contains a rejection reason + # + # @note StabilityLevel.STABLE + ASPNETCORE_RATE_LIMITING_RESULT = 'aspnetcore.rate_limiting.result' + + # Flag indicating if request was handled by the application pipeline + # + # @note StabilityLevel.STABLE + ASPNETCORE_REQUEST_IS_UNHANDLED = 'aspnetcore.request.is_unhandled' + + # A value that indicates whether the matched route is a fallback route + # + # @note StabilityLevel.STABLE + ASPNETCORE_ROUTING_IS_FALLBACK = 'aspnetcore.routing.is_fallback' + + # Match result - success or failure + # + # @note StabilityLevel.STABLE + ASPNETCORE_ROUTING_MATCH_STATUS = 'aspnetcore.routing.match_status' + + # @!endgroup + end + end +end \ No newline at end of file diff --git a/semantic_conventions/lib/opentelemetry/semantic_conventions/attributes/client.rb b/semantic_conventions/lib/opentelemetry/semantic_conventions/attributes/client.rb new file mode 100644 index 0000000000..56e86d09da --- /dev/null +++ b/semantic_conventions/lib/opentelemetry/semantic_conventions/attributes/client.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 SemanticConventions + module CLIENT + # @!group Attribute Names + + # Client address - domain name if available without reverse DNS lookup; otherwise, IP address or Unix domain socket name + # + # When observed from the server side, and when communicating through an intermediary, `client.address` SHOULD represent the client address behind any intermediaries, for example proxies, if it's available + # + # @note StabilityLevel.STABLE + CLIENT_ADDRESS = 'client.address' + + # Client port number + # + # When observed from the server side, and when communicating through an intermediary, `client.port` SHOULD represent the client port behind any intermediaries, for example proxies, if it's available + # + # @note StabilityLevel.STABLE + CLIENT_PORT = 'client.port' + + # @!endgroup + end + end +end \ No newline at end of file diff --git a/semantic_conventions/lib/opentelemetry/semantic_conventions/attributes/error.rb b/semantic_conventions/lib/opentelemetry/semantic_conventions/attributes/error.rb new file mode 100644 index 0000000000..acdb5bc119 --- /dev/null +++ b/semantic_conventions/lib/opentelemetry/semantic_conventions/attributes/error.rb @@ -0,0 +1,54 @@ +# 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 SemanticConventions + module ERROR + # @!group Attribute Names + + # Describes a class of error the operation ended with + # + # The `error.type` SHOULD be predictable, and SHOULD have low cardinality. + # + # When `error.type` is set to a type (e.g., an exception type), its + # canonical class name identifying the type within the artifact SHOULD be used. + # + # Instrumentations SHOULD document the list of errors they report. + # + # The cardinality of `error.type` within one instrumentation library SHOULD be low. + # Telemetry consumers that aggregate data from multiple instrumentation libraries and applications + # should be prepared for `error.type` to have high cardinality at query time when no + # additional filters are applied. + # + # If the operation has completed successfully, instrumentations SHOULD NOT set `error.type`. + # + # If a specific domain defines its own set of error identifiers (such as HTTP or gRPC status codes), + # it's RECOMMENDED to: + # + # * Use a domain-specific attribute + # * Set `error.type` to capture all errors, regardless of whether they are defined within the domain-specific set or not + # + # @note StabilityLevel.STABLE + ERROR_TYPE = 'error.type' + + # @!endgroup + end + end +end \ No newline at end of file diff --git a/semantic_conventions/lib/opentelemetry/semantic_conventions/attributes/exception.rb b/semantic_conventions/lib/opentelemetry/semantic_conventions/attributes/exception.rb new file mode 100644 index 0000000000..436d6f0694 --- /dev/null +++ b/semantic_conventions/lib/opentelemetry/semantic_conventions/attributes/exception.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 SemanticConventions + module EXCEPTION + # @!group Attribute Names + + # 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 + # + # An exception is considered to have escaped (or left) the scope of a span, + # if that span is ended while the exception is still logically "in flight". + # This may be actually "in flight" in some languages (e.g. if the exception + # is passed to a Context manager's `__exit__` method in Python) but will + # usually be caught at the point of recording the exception in most languages. + # + # It is usually not possible to determine at the point where an exception is thrown + # whether it will escape the scope of a span. + # However, it is trivial to know that an exception + # will escape, if one checks for an active exception just before ending the span, + # as done in the [example for recording span exceptions](https://opentelemetry.io/docs/specs/semconv/exceptions/exceptions-spans/#recording-an-exception). + # + # It follows that an exception may still escape the scope of the span + # even if the `exception.escaped` attribute was not set or set to false, + # since the event might have been recorded at a time where it was not + # clear whether the exception will escape + # + # @note StabilityLevel.STABLE + EXCEPTION_ESCAPED = 'exception.escaped' + + # The exception message + # + # @note StabilityLevel.STABLE + 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 StabilityLevel.STABLE + 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 StabilityLevel.STABLE + EXCEPTION_TYPE = 'exception.type' + + # @!endgroup + end + end +end \ No newline at end of file diff --git a/semantic_conventions/lib/opentelemetry/semantic_conventions/attributes/http.rb b/semantic_conventions/lib/opentelemetry/semantic_conventions/attributes/http.rb new file mode 100644 index 0000000000..898f477f07 --- /dev/null +++ b/semantic_conventions/lib/opentelemetry/semantic_conventions/attributes/http.rb @@ -0,0 +1,92 @@ +# 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 SemanticConventions + module HTTP + # @!group Attribute Names + + # HTTP request headers, `` being the normalized HTTP Header name (lowercase), the value being the header values + # + # Instrumentations SHOULD require an explicit configuration of which headers are to be captured. Including all request headers can be a security risk - explicit configuration helps avoid leaking sensitive information. + # The `User-Agent` header is already captured in the `user_agent.original` attribute. Users MAY explicitly configure instrumentations to capture them even though it is not recommended. + # The attribute value MUST consist of either multiple header values as an array of strings or a single-item array containing a possibly comma-concatenated string, depending on the way the HTTP library provides access to headers + # + # @note StabilityLevel.STABLE + HTTP_REQUEST_HEADER = 'http.request.header' + + # HTTP request method + # + # HTTP request method value SHOULD be "known" to the instrumentation. + # By default, this convention defines "known" methods as the ones listed in [RFC9110](https://www.rfc-editor.org/rfc/rfc9110.html#name-methods) + # and the PATCH method defined in [RFC5789](https://www.rfc-editor.org/rfc/rfc5789.html). + # + # If the HTTP request method is not known to instrumentation, it MUST set the `http.request.method` attribute to `_OTHER`. + # + # If the HTTP instrumentation could end up converting valid HTTP request methods to `_OTHER`, then it MUST provide a way to override + # the list of known HTTP methods. If this override is done via environment variable, then the environment variable MUST be named + # OTEL_INSTRUMENTATION_HTTP_KNOWN_METHODS and support a comma-separated list of case-sensitive known HTTP methods + # (this list MUST be a full override of the default known method, it is not a list of known methods in addition to the defaults). + # + # HTTP method names are case-sensitive and `http.request.method` attribute value MUST match a known HTTP method name exactly. + # Instrumentations for specific web frameworks that consider HTTP methods to be case insensitive, SHOULD populate a canonical equivalent. + # Tracing instrumentations that do so, MUST also set `http.request.method_original` to the original value + # + # @note StabilityLevel.STABLE + HTTP_REQUEST_METHOD = 'http.request.method' + + # Original HTTP method sent by the client in the request line + # + # @note StabilityLevel.STABLE + HTTP_REQUEST_METHOD_ORIGINAL = 'http.request.method_original' + + # The ordinal number of request resending attempt (for any reason, including redirects) + # + # The resend count SHOULD be updated each time an HTTP request gets resent by the client, regardless of what was the cause of the resending (e.g. redirection, authorization failure, 503 Server Unavailable, network issues, or any other) + # + # @note StabilityLevel.STABLE + HTTP_REQUEST_RESEND_COUNT = 'http.request.resend_count' + + # HTTP response headers, `` being the normalized HTTP Header name (lowercase), the value being the header values + # + # Instrumentations SHOULD require an explicit configuration of which headers are to be captured. Including all response headers can be a security risk - explicit configuration helps avoid leaking sensitive information. + # Users MAY explicitly configure instrumentations to capture them even though it is not recommended. + # The attribute value MUST consist of either multiple header values as an array of strings or a single-item array containing a possibly comma-concatenated string, depending on the way the HTTP library provides access to headers + # + # @note StabilityLevel.STABLE + HTTP_RESPONSE_HEADER = 'http.response.header' + + # [HTTP response status code](https://tools.ietf.org/html/rfc7231#section-6) + # + # @note StabilityLevel.STABLE + HTTP_RESPONSE_STATUS_CODE = 'http.response.status_code' + + # The matched route, that is, the path template in the format used by the respective server framework + # + # MUST NOT be populated when this is not supported by the HTTP server framework as the route attribute should have low-cardinality and the URI path can NOT substitute it. + # SHOULD include the [application root](/docs/http/http-spans.md#http-server-definitions) if there is one + # + # @note StabilityLevel.STABLE + HTTP_ROUTE = 'http.route' + + # @!endgroup + end + end +end \ No newline at end of file diff --git a/semantic_conventions/lib/opentelemetry/semantic_conventions/attributes/jvm.rb b/semantic_conventions/lib/opentelemetry/semantic_conventions/attributes/jvm.rb new file mode 100644 index 0000000000..4de8fa7a51 --- /dev/null +++ b/semantic_conventions/lib/opentelemetry/semantic_conventions/attributes/jvm.rb @@ -0,0 +1,65 @@ +# 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 SemanticConventions + module JVM + # @!group Attribute Names + + # Name of the garbage collector action + # + # Garbage collector action is generally obtained via [GarbageCollectionNotificationInfo#getGcAction()](https://docs.oracle.com/en/java/javase/11/docs/api/jdk.management/com/sun/management/GarbageCollectionNotificationInfo.html#getGcAction()) + # + # @note StabilityLevel.STABLE + JVM_GC_ACTION = 'jvm.gc.action' + + # Name of the garbage collector + # + # Garbage collector name is generally obtained via [GarbageCollectionNotificationInfo#getGcName()](https://docs.oracle.com/en/java/javase/11/docs/api/jdk.management/com/sun/management/GarbageCollectionNotificationInfo.html#getGcName()) + # + # @note StabilityLevel.STABLE + JVM_GC_NAME = 'jvm.gc.name' + + # Name of the memory pool + # + # Pool names are generally obtained via [MemoryPoolMXBean#getName()](https://docs.oracle.com/en/java/javase/11/docs/api/java.management/java/lang/management/MemoryPoolMXBean.html#getName()) + # + # @note StabilityLevel.STABLE + JVM_MEMORY_POOL_NAME = 'jvm.memory.pool.name' + + # The type of memory + # + # @note StabilityLevel.STABLE + JVM_MEMORY_TYPE = 'jvm.memory.type' + + # Whether the thread is daemon or not + # + # @note StabilityLevel.STABLE + JVM_THREAD_DAEMON = 'jvm.thread.daemon' + + # State of the thread + # + # @note StabilityLevel.STABLE + JVM_THREAD_STATE = 'jvm.thread.state' + + # @!endgroup + end + end +end \ No newline at end of file diff --git a/semantic_conventions/lib/opentelemetry/semantic_conventions/attributes/network.rb b/semantic_conventions/lib/opentelemetry/semantic_conventions/attributes/network.rb new file mode 100644 index 0000000000..14a33a8819 --- /dev/null +++ b/semantic_conventions/lib/opentelemetry/semantic_conventions/attributes/network.rb @@ -0,0 +1,81 @@ +# 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 SemanticConventions + module NETWORK + # @!group Attribute Names + + # Local address of the network connection - IP address or Unix domain socket name + # + # @note StabilityLevel.STABLE + NETWORK_LOCAL_ADDRESS = 'network.local.address' + + # Local port number of the network connection + # + # @note StabilityLevel.STABLE + NETWORK_LOCAL_PORT = 'network.local.port' + + # Peer address of the network connection - IP address or Unix domain socket name + # + # @note StabilityLevel.STABLE + NETWORK_PEER_ADDRESS = 'network.peer.address' + + # Peer port number of the network connection + # + # @note StabilityLevel.STABLE + NETWORK_PEER_PORT = 'network.peer.port' + + # [OSI application layer](https://osi-model.com/application-layer/) or non-OSI equivalent + # + # The value SHOULD be normalized to lowercase + # + # @note StabilityLevel.STABLE + NETWORK_PROTOCOL_NAME = 'network.protocol.name' + + # The actual version of the protocol used for network communication + # + # If protocol version is subject to negotiation (for example using [ALPN](https://www.rfc-editor.org/rfc/rfc7301.html)), this attribute SHOULD be set to the negotiated version. If the actual protocol version is not known, this attribute SHOULD NOT be set + # + # @note StabilityLevel.STABLE + NETWORK_PROTOCOL_VERSION = 'network.protocol.version' + + # [OSI transport layer](https://osi-model.com/transport-layer/) or [inter-process communication method](https://wikipedia.org/wiki/Inter-process_communication) + # + # The value SHOULD be normalized to lowercase. + # + # Consider always setting the transport when setting a port number, since + # a port number is ambiguous without knowing the transport. For example + # different processes could be listening on TCP port 12345 and UDP port 12345 + # + # @note StabilityLevel.STABLE + NETWORK_TRANSPORT = 'network.transport' + + # [OSI network layer](https://osi-model.com/network-layer/) or non-OSI equivalent + # + # The value SHOULD be normalized to lowercase + # + # @note StabilityLevel.STABLE + NETWORK_TYPE = 'network.type' + + # @!endgroup + end + end +end \ No newline at end of file diff --git a/semantic_conventions/lib/opentelemetry/semantic_conventions/attributes/otel.rb b/semantic_conventions/lib/opentelemetry/semantic_conventions/attributes/otel.rb new file mode 100644 index 0000000000..254e005cfc --- /dev/null +++ b/semantic_conventions/lib/opentelemetry/semantic_conventions/attributes/otel.rb @@ -0,0 +1,49 @@ +# 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 SemanticConventions + module OTEL + # @!group Attribute Names + + # The name of the instrumentation scope - (`InstrumentationScope.Name` in OTLP) + # + # @note StabilityLevel.STABLE + OTEL_SCOPE_NAME = 'otel.scope.name' + + # The version of the instrumentation scope - (`InstrumentationScope.Version` in OTLP) + # + # @note StabilityLevel.STABLE + OTEL_SCOPE_VERSION = 'otel.scope.version' + + # Name of the code, either "OK" or "ERROR". MUST NOT be set if the status code is UNSET + # + # @note StabilityLevel.STABLE + OTEL_STATUS_CODE = 'otel.status_code' + + # Description of the Status if it has a value, otherwise not set + # + # @note StabilityLevel.STABLE + OTEL_STATUS_DESCRIPTION = 'otel.status_description' + + # @!endgroup + end + end +end \ No newline at end of file diff --git a/semantic_conventions/lib/opentelemetry/semantic_conventions/attributes/server.rb b/semantic_conventions/lib/opentelemetry/semantic_conventions/attributes/server.rb new file mode 100644 index 0000000000..68816e4f96 --- /dev/null +++ b/semantic_conventions/lib/opentelemetry/semantic_conventions/attributes/server.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 SemanticConventions + module SERVER + # @!group Attribute Names + + # Server domain name if available without reverse DNS lookup; otherwise, IP address or Unix domain socket name + # + # When observed from the client side, and when communicating through an intermediary, `server.address` SHOULD represent the server address behind any intermediaries, for example proxies, if it's available + # + # @note StabilityLevel.STABLE + SERVER_ADDRESS = 'server.address' + + # Server port number + # + # When observed from the client side, and when communicating through an intermediary, `server.port` SHOULD represent the server port behind any intermediaries, for example proxies, if it's available + # + # @note StabilityLevel.STABLE + SERVER_PORT = 'server.port' + + # @!endgroup + end + end +end \ No newline at end of file diff --git a/semantic_conventions/lib/opentelemetry/semantic_conventions/attributes/service.rb b/semantic_conventions/lib/opentelemetry/semantic_conventions/attributes/service.rb new file mode 100644 index 0000000000..5a679dc08c --- /dev/null +++ b/semantic_conventions/lib/opentelemetry/semantic_conventions/attributes/service.rb @@ -0,0 +1,41 @@ +# 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 SemanticConventions + module SERVICE + # @!group Attribute Names + + # Logical name of the service + # + # MUST be the same for all instances of horizontally scaled services. If the value was not specified, SDKs MUST fallback to `unknown_service:` concatenated with [`process.executable.name`](process.md), e.g. `unknown_service:bash`. If `process.executable.name` is not available, the value MUST be set to `unknown_service` + # + # @note StabilityLevel.STABLE + SERVICE_NAME = 'service.name' + + # The version string of the service API or implementation. The format is not defined by these conventions + # + # @note StabilityLevel.STABLE + SERVICE_VERSION = 'service.version' + + # @!endgroup + end + end +end \ No newline at end of file diff --git a/semantic_conventions/lib/opentelemetry/semantic_conventions/attributes/signalr.rb b/semantic_conventions/lib/opentelemetry/semantic_conventions/attributes/signalr.rb new file mode 100644 index 0000000000..0a7a189eaf --- /dev/null +++ b/semantic_conventions/lib/opentelemetry/semantic_conventions/attributes/signalr.rb @@ -0,0 +1,39 @@ +# 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 SemanticConventions + module SIGNALR + # @!group Attribute Names + + # SignalR HTTP connection closure status + # + # @note StabilityLevel.STABLE + SIGNALR_CONNECTION_STATUS = 'signalr.connection.status' + + # [SignalR transport type](https://github.com/dotnet/aspnetcore/blob/main/src/SignalR/docs/specs/TransportProtocols.md) + # + # @note StabilityLevel.STABLE + SIGNALR_TRANSPORT = 'signalr.transport' + + # @!endgroup + end + end +end \ No newline at end of file diff --git a/semantic_conventions/lib/opentelemetry/semantic_conventions/attributes/telemetry.rb b/semantic_conventions/lib/opentelemetry/semantic_conventions/attributes/telemetry.rb new file mode 100644 index 0000000000..ffd1dc27f8 --- /dev/null +++ b/semantic_conventions/lib/opentelemetry/semantic_conventions/attributes/telemetry.rb @@ -0,0 +1,51 @@ +# 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 SemanticConventions + module TELEMETRY + # @!group Attribute Names + + # The language of the telemetry SDK + # + # @note StabilityLevel.STABLE + TELEMETRY_SDK_LANGUAGE = 'telemetry.sdk.language' + + # The name of the telemetry SDK as defined above + # + # The OpenTelemetry SDK MUST set the `telemetry.sdk.name` attribute to `opentelemetry`. + # If another SDK, like a fork or a vendor-provided implementation, is used, this SDK MUST set the + # `telemetry.sdk.name` attribute to the fully-qualified class or module name of this SDK's main entry point + # or another suitable identifier depending on the language. + # The identifier `opentelemetry` is reserved and MUST NOT be used in this case. + # All custom identifiers SHOULD be stable across different versions of an implementation + # + # @note StabilityLevel.STABLE + TELEMETRY_SDK_NAME = 'telemetry.sdk.name' + + # The version string of the telemetry SDK + # + # @note StabilityLevel.STABLE + TELEMETRY_SDK_VERSION = 'telemetry.sdk.version' + + # @!endgroup + end + end +end \ No newline at end of file diff --git a/semantic_conventions/lib/opentelemetry/semantic_conventions/attributes/url.rb b/semantic_conventions/lib/opentelemetry/semantic_conventions/attributes/url.rb new file mode 100644 index 0000000000..9adb90ebb2 --- /dev/null +++ b/semantic_conventions/lib/opentelemetry/semantic_conventions/attributes/url.rb @@ -0,0 +1,62 @@ +# 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 SemanticConventions + module URL + # @!group Attribute Names + + # The [URI fragment](https://www.rfc-editor.org/rfc/rfc3986#section-3.5) component + # + # @note StabilityLevel.STABLE + 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 + # + # @note StabilityLevel.STABLE + URL_FULL = 'url.full' + + # 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 StabilityLevel.STABLE + URL_PATH = 'url.path' + + # 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 + # + # @note StabilityLevel.STABLE + URL_QUERY = 'url.query' + + # The [URI scheme](https://www.rfc-editor.org/rfc/rfc3986#section-3.1) component identifying the used protocol + # + # @note StabilityLevel.STABLE + URL_SCHEME = 'url.scheme' + + # @!endgroup + end + end +end \ No newline at end of file diff --git a/semantic_conventions/lib/opentelemetry/semantic_conventions/attributes/user_agent.rb b/semantic_conventions/lib/opentelemetry/semantic_conventions/attributes/user_agent.rb new file mode 100644 index 0000000000..27db46d4cc --- /dev/null +++ b/semantic_conventions/lib/opentelemetry/semantic_conventions/attributes/user_agent.rb @@ -0,0 +1,34 @@ +# 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 SemanticConventions + module USER_AGENT + # @!group Attribute Names + + # Value of the [HTTP User-Agent](https://www.rfc-editor.org/rfc/rfc9110.html#field.user-agent) header sent by the client + # + # @note StabilityLevel.STABLE + USER_AGENT_ORIGINAL = 'user_agent.original' + + # @!endgroup + end + end +end \ No newline at end of file From 09dfa27c471cdae8b251c5babe16b2966e39ee41 Mon Sep 17 00:00:00 2001 From: Robb Kidd Date: Wed, 10 Jul 2024 19:13:43 -0400 Subject: [PATCH 04/17] add ability to exclude specific attrs from code gen Because converting to SCREAMING_SNAKE_CASE cannot distinguish between ... screaming.snake_case ... and ... screaming.snake.case So, like other languages, ignore the deprecated messaging.client_id in favor of its replacement and let backends deal with the changed attr name. --- semantic_conventions/Rakefile | 3 +++ .../semantic_candidates/attributes/messaging.rb | 4 +++- semantic_conventions/templates/attributes.j2 | 6 ++++++ 3 files changed, 12 insertions(+), 1 deletion(-) diff --git a/semantic_conventions/Rakefile b/semantic_conventions/Rakefile index eceb09f6b9..bf22f05b09 100644 --- a/semantic_conventions/Rakefile +++ b/semantic_conventions/Rakefile @@ -36,6 +36,8 @@ semconv_source_dir = Pathname.new("./tmpsemconvrepo_v#{SPEC_VERSION}") conventions_output_dir = Pathname.new('./lib/opentelemetry/semantic_conventions') candidates_output_dir = Pathname.new('./lib/opentelemetry/semantic_candidates') +EXCLUDED_ATTRIBUTES = %w[messaging.client_id] + task generate: %i[update_gem_version generate_stable_attributes generate_candidate_attributes] directory semconv_source_dir do @@ -82,6 +84,7 @@ def semconvgen(semconv_source, output_root:, kind:, selector:) --template /templates/#{kind}.j2 --output "#{output_filenames_template}" -Dselector=#{selector} + -Dexcluded_attributes="#{EXCLUDED_ATTRIBUTES.join(' ')}" ] puts "Running: #{cmd.join(' ')}" diff --git a/semantic_conventions/lib/opentelemetry/semantic_candidates/attributes/messaging.rb b/semantic_conventions/lib/opentelemetry/semantic_candidates/attributes/messaging.rb index d9aaa90360..9a69a7b14c 100644 --- a/semantic_conventions/lib/opentelemetry/semantic_candidates/attributes/messaging.rb +++ b/semantic_conventions/lib/opentelemetry/semantic_candidates/attributes/messaging.rb @@ -40,7 +40,9 @@ module MESSAGING # @note StabilityLevel.EXPERIMENTAL # # @deprecated Replaced by `messaging.client.id` - MESSAGING_CLIENT_ID = 'messaging.client_id' + # + # @note This attribute has been excluded from code generation. + # MESSAGING_CLIENT_ID = 'messaging.client_id' # A boolean that is true if the message destination is anonymous (could be unnamed or have auto-generated name) # diff --git a/semantic_conventions/templates/attributes.j2 b/semantic_conventions/templates/attributes.j2 index 5d29d850a0..ebb46b663c 100644 --- a/semantic_conventions/templates/attributes.j2 +++ b/semantic_conventions/templates/attributes.j2 @@ -42,7 +42,13 @@ module OpenTelemetry # # @deprecated Now available in the stable namespace at {OpenTelemetry::SemanticConventions::{{ root_namespace | to_const_name }}::{{ attribute.attr_id | to_const_name }}}. {%- endif %} + {%- if attribute.fqn in excluded_attributes %} + # + # @note This attribute has been excluded from code generation. + # {{ attribute.fqn | to_const_name }} = '{{ attribute.fqn }}' + {%- else %} {{ attribute.fqn | to_const_name }} = '{{ attribute.fqn }}' + {%- endif %} {% endfor %} # @!endgroup end From 5ce2eae86f29631b5bab4552c157a925f7e7bba2 Mon Sep 17 00:00:00 2001 From: Robb Kidd Date: Thu, 11 Jul 2024 17:02:29 -0400 Subject: [PATCH 05/17] reference the full name in the deprecation notice toward stable --- .../semantic_candidates/attributes/aspnetcore.rb | 14 +++++++------- .../semantic_candidates/attributes/client.rb | 4 ++-- .../semantic_candidates/attributes/error.rb | 2 +- .../semantic_candidates/attributes/exception.rb | 8 ++++---- .../semantic_candidates/attributes/http.rb | 14 +++++++------- .../semantic_candidates/attributes/jvm.rb | 12 ++++++------ .../semantic_candidates/attributes/network.rb | 16 ++++++++-------- .../semantic_candidates/attributes/otel.rb | 8 ++++---- .../semantic_candidates/attributes/server.rb | 4 ++-- .../semantic_candidates/attributes/service.rb | 4 ++-- .../semantic_candidates/attributes/signalr.rb | 4 ++-- .../semantic_candidates/attributes/telemetry.rb | 6 +++--- .../semantic_candidates/attributes/url.rb | 10 +++++----- .../semantic_candidates/attributes/user_agent.rb | 2 +- semantic_conventions/templates/attributes.j2 | 2 +- 15 files changed, 55 insertions(+), 55 deletions(-) diff --git a/semantic_conventions/lib/opentelemetry/semantic_candidates/attributes/aspnetcore.rb b/semantic_conventions/lib/opentelemetry/semantic_candidates/attributes/aspnetcore.rb index 68ca0e5890..5e35b95fa1 100644 --- a/semantic_conventions/lib/opentelemetry/semantic_candidates/attributes/aspnetcore.rb +++ b/semantic_conventions/lib/opentelemetry/semantic_candidates/attributes/aspnetcore.rb @@ -27,49 +27,49 @@ module ASPNETCORE # # @note StabilityLevel.STABLE # - # @deprecated Now available in the stable namespace at {OpenTelemetry::SemanticConventions::ASPNETCORE::DIAGNOSTICS_EXCEPTION_RESULT}. + # @deprecated Now available in the stable namespace at {OpenTelemetry::SemanticConventions::ASPNETCORE::ASPNETCORE_DIAGNOSTICS_EXCEPTION_RESULT}. ASPNETCORE_DIAGNOSTICS_EXCEPTION_RESULT = 'aspnetcore.diagnostics.exception.result' # Full type name of the [`IExceptionHandler`](https://learn.microsoft.com/dotnet/api/microsoft.aspnetcore.diagnostics.iexceptionhandler) implementation that handled the exception # # @note StabilityLevel.STABLE # - # @deprecated Now available in the stable namespace at {OpenTelemetry::SemanticConventions::ASPNETCORE::DIAGNOSTICS_HANDLER_TYPE}. + # @deprecated Now available in the stable namespace at {OpenTelemetry::SemanticConventions::ASPNETCORE::ASPNETCORE_DIAGNOSTICS_HANDLER_TYPE}. ASPNETCORE_DIAGNOSTICS_HANDLER_TYPE = 'aspnetcore.diagnostics.handler.type' # Rate limiting policy name # # @note StabilityLevel.STABLE # - # @deprecated Now available in the stable namespace at {OpenTelemetry::SemanticConventions::ASPNETCORE::RATE_LIMITING_POLICY}. + # @deprecated Now available in the stable namespace at {OpenTelemetry::SemanticConventions::ASPNETCORE::ASPNETCORE_RATE_LIMITING_POLICY}. ASPNETCORE_RATE_LIMITING_POLICY = 'aspnetcore.rate_limiting.policy' # Rate-limiting result, shows whether the lease was acquired or contains a rejection reason # # @note StabilityLevel.STABLE # - # @deprecated Now available in the stable namespace at {OpenTelemetry::SemanticConventions::ASPNETCORE::RATE_LIMITING_RESULT}. + # @deprecated Now available in the stable namespace at {OpenTelemetry::SemanticConventions::ASPNETCORE::ASPNETCORE_RATE_LIMITING_RESULT}. ASPNETCORE_RATE_LIMITING_RESULT = 'aspnetcore.rate_limiting.result' # Flag indicating if request was handled by the application pipeline # # @note StabilityLevel.STABLE # - # @deprecated Now available in the stable namespace at {OpenTelemetry::SemanticConventions::ASPNETCORE::REQUEST_IS_UNHANDLED}. + # @deprecated Now available in the stable namespace at {OpenTelemetry::SemanticConventions::ASPNETCORE::ASPNETCORE_REQUEST_IS_UNHANDLED}. ASPNETCORE_REQUEST_IS_UNHANDLED = 'aspnetcore.request.is_unhandled' # A value that indicates whether the matched route is a fallback route # # @note StabilityLevel.STABLE # - # @deprecated Now available in the stable namespace at {OpenTelemetry::SemanticConventions::ASPNETCORE::ROUTING_IS_FALLBACK}. + # @deprecated Now available in the stable namespace at {OpenTelemetry::SemanticConventions::ASPNETCORE::ASPNETCORE_ROUTING_IS_FALLBACK}. ASPNETCORE_ROUTING_IS_FALLBACK = 'aspnetcore.routing.is_fallback' # Match result - success or failure # # @note StabilityLevel.STABLE # - # @deprecated Now available in the stable namespace at {OpenTelemetry::SemanticConventions::ASPNETCORE::ROUTING_MATCH_STATUS}. + # @deprecated Now available in the stable namespace at {OpenTelemetry::SemanticConventions::ASPNETCORE::ASPNETCORE_ROUTING_MATCH_STATUS}. ASPNETCORE_ROUTING_MATCH_STATUS = 'aspnetcore.routing.match_status' # @!endgroup diff --git a/semantic_conventions/lib/opentelemetry/semantic_candidates/attributes/client.rb b/semantic_conventions/lib/opentelemetry/semantic_candidates/attributes/client.rb index d8d5679132..98e6e9443d 100644 --- a/semantic_conventions/lib/opentelemetry/semantic_candidates/attributes/client.rb +++ b/semantic_conventions/lib/opentelemetry/semantic_candidates/attributes/client.rb @@ -29,7 +29,7 @@ module CLIENT # # @note StabilityLevel.STABLE # - # @deprecated Now available in the stable namespace at {OpenTelemetry::SemanticConventions::CLIENT::ADDRESS}. + # @deprecated Now available in the stable namespace at {OpenTelemetry::SemanticConventions::CLIENT::CLIENT_ADDRESS}. CLIENT_ADDRESS = 'client.address' # Client port number @@ -38,7 +38,7 @@ module CLIENT # # @note StabilityLevel.STABLE # - # @deprecated Now available in the stable namespace at {OpenTelemetry::SemanticConventions::CLIENT::PORT}. + # @deprecated Now available in the stable namespace at {OpenTelemetry::SemanticConventions::CLIENT::CLIENT_PORT}. CLIENT_PORT = 'client.port' # @!endgroup diff --git a/semantic_conventions/lib/opentelemetry/semantic_candidates/attributes/error.rb b/semantic_conventions/lib/opentelemetry/semantic_candidates/attributes/error.rb index c5ec472226..df326fa00b 100644 --- a/semantic_conventions/lib/opentelemetry/semantic_candidates/attributes/error.rb +++ b/semantic_conventions/lib/opentelemetry/semantic_candidates/attributes/error.rb @@ -47,7 +47,7 @@ module ERROR # # @note StabilityLevel.STABLE # - # @deprecated Now available in the stable namespace at {OpenTelemetry::SemanticConventions::ERROR::TYPE}. + # @deprecated Now available in the stable namespace at {OpenTelemetry::SemanticConventions::ERROR::ERROR_TYPE}. ERROR_TYPE = 'error.type' # @!endgroup diff --git a/semantic_conventions/lib/opentelemetry/semantic_candidates/attributes/exception.rb b/semantic_conventions/lib/opentelemetry/semantic_candidates/attributes/exception.rb index 6576d51a21..d3055ffcc3 100644 --- a/semantic_conventions/lib/opentelemetry/semantic_candidates/attributes/exception.rb +++ b/semantic_conventions/lib/opentelemetry/semantic_candidates/attributes/exception.rb @@ -44,28 +44,28 @@ module EXCEPTION # # @note StabilityLevel.STABLE # - # @deprecated Now available in the stable namespace at {OpenTelemetry::SemanticConventions::EXCEPTION::ESCAPED}. + # @deprecated Now available in the stable namespace at {OpenTelemetry::SemanticConventions::EXCEPTION::EXCEPTION_ESCAPED}. EXCEPTION_ESCAPED = 'exception.escaped' # The exception message # # @note StabilityLevel.STABLE # - # @deprecated Now available in the stable namespace at {OpenTelemetry::SemanticConventions::EXCEPTION::MESSAGE}. + # @deprecated Now available in the stable namespace at {OpenTelemetry::SemanticConventions::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 StabilityLevel.STABLE # - # @deprecated Now available in the stable namespace at {OpenTelemetry::SemanticConventions::EXCEPTION::STACKTRACE}. + # @deprecated Now available in the stable namespace at {OpenTelemetry::SemanticConventions::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 StabilityLevel.STABLE # - # @deprecated Now available in the stable namespace at {OpenTelemetry::SemanticConventions::EXCEPTION::TYPE}. + # @deprecated Now available in the stable namespace at {OpenTelemetry::SemanticConventions::EXCEPTION::EXCEPTION_TYPE}. EXCEPTION_TYPE = 'exception.type' # @!endgroup diff --git a/semantic_conventions/lib/opentelemetry/semantic_candidates/attributes/http.rb b/semantic_conventions/lib/opentelemetry/semantic_candidates/attributes/http.rb index fdc2f52662..13c7757147 100644 --- a/semantic_conventions/lib/opentelemetry/semantic_candidates/attributes/http.rb +++ b/semantic_conventions/lib/opentelemetry/semantic_candidates/attributes/http.rb @@ -69,7 +69,7 @@ module HTTP # # @note StabilityLevel.STABLE # - # @deprecated Now available in the stable namespace at {OpenTelemetry::SemanticConventions::HTTP::REQUEST_HEADER}. + # @deprecated Now available in the stable namespace at {OpenTelemetry::SemanticConventions::HTTP::HTTP_REQUEST_HEADER}. HTTP_REQUEST_HEADER = 'http.request.header' # HTTP request method @@ -91,14 +91,14 @@ module HTTP # # @note StabilityLevel.STABLE # - # @deprecated Now available in the stable namespace at {OpenTelemetry::SemanticConventions::HTTP::REQUEST_METHOD}. + # @deprecated Now available in the stable namespace at {OpenTelemetry::SemanticConventions::HTTP::HTTP_REQUEST_METHOD}. HTTP_REQUEST_METHOD = 'http.request.method' # Original HTTP method sent by the client in the request line # # @note StabilityLevel.STABLE # - # @deprecated Now available in the stable namespace at {OpenTelemetry::SemanticConventions::HTTP::REQUEST_METHOD_ORIGINAL}. + # @deprecated Now available in the stable namespace at {OpenTelemetry::SemanticConventions::HTTP::HTTP_REQUEST_METHOD_ORIGINAL}. HTTP_REQUEST_METHOD_ORIGINAL = 'http.request.method_original' # The ordinal number of request resending attempt (for any reason, including redirects) @@ -107,7 +107,7 @@ module HTTP # # @note StabilityLevel.STABLE # - # @deprecated Now available in the stable namespace at {OpenTelemetry::SemanticConventions::HTTP::REQUEST_RESEND_COUNT}. + # @deprecated Now available in the stable namespace at {OpenTelemetry::SemanticConventions::HTTP::HTTP_REQUEST_RESEND_COUNT}. HTTP_REQUEST_RESEND_COUNT = 'http.request.resend_count' # The total size of the request in bytes. This should be the total number of bytes sent over the wire, including the request line (HTTP/1.1), framing (HTTP/2 and HTTP/3), headers, and request body if any @@ -142,7 +142,7 @@ module HTTP # # @note StabilityLevel.STABLE # - # @deprecated Now available in the stable namespace at {OpenTelemetry::SemanticConventions::HTTP::RESPONSE_HEADER}. + # @deprecated Now available in the stable namespace at {OpenTelemetry::SemanticConventions::HTTP::HTTP_RESPONSE_HEADER}. HTTP_RESPONSE_HEADER = 'http.response.header' # The total size of the response in bytes. This should be the total number of bytes sent over the wire, including the status line (HTTP/1.1), framing (HTTP/2 and HTTP/3), headers, and response body and trailers if any @@ -154,7 +154,7 @@ module HTTP # # @note StabilityLevel.STABLE # - # @deprecated Now available in the stable namespace at {OpenTelemetry::SemanticConventions::HTTP::RESPONSE_STATUS_CODE}. + # @deprecated Now available in the stable namespace at {OpenTelemetry::SemanticConventions::HTTP::HTTP_RESPONSE_STATUS_CODE}. HTTP_RESPONSE_STATUS_CODE = 'http.response.status_code' # Deprecated, use `http.response.header.content-length` instead @@ -178,7 +178,7 @@ module HTTP # # @note StabilityLevel.STABLE # - # @deprecated Now available in the stable namespace at {OpenTelemetry::SemanticConventions::HTTP::ROUTE}. + # @deprecated Now available in the stable namespace at {OpenTelemetry::SemanticConventions::HTTP::HTTP_ROUTE}. HTTP_ROUTE = 'http.route' # Deprecated, use `url.scheme` instead diff --git a/semantic_conventions/lib/opentelemetry/semantic_candidates/attributes/jvm.rb b/semantic_conventions/lib/opentelemetry/semantic_candidates/attributes/jvm.rb index ee0998b250..de6c0d7112 100644 --- a/semantic_conventions/lib/opentelemetry/semantic_candidates/attributes/jvm.rb +++ b/semantic_conventions/lib/opentelemetry/semantic_candidates/attributes/jvm.rb @@ -36,7 +36,7 @@ module JVM # # @note StabilityLevel.STABLE # - # @deprecated Now available in the stable namespace at {OpenTelemetry::SemanticConventions::JVM::GC_ACTION}. + # @deprecated Now available in the stable namespace at {OpenTelemetry::SemanticConventions::JVM::JVM_GC_ACTION}. JVM_GC_ACTION = 'jvm.gc.action' # Name of the garbage collector @@ -45,7 +45,7 @@ module JVM # # @note StabilityLevel.STABLE # - # @deprecated Now available in the stable namespace at {OpenTelemetry::SemanticConventions::JVM::GC_NAME}. + # @deprecated Now available in the stable namespace at {OpenTelemetry::SemanticConventions::JVM::JVM_GC_NAME}. JVM_GC_NAME = 'jvm.gc.name' # Name of the memory pool @@ -54,28 +54,28 @@ module JVM # # @note StabilityLevel.STABLE # - # @deprecated Now available in the stable namespace at {OpenTelemetry::SemanticConventions::JVM::MEMORY_POOL_NAME}. + # @deprecated Now available in the stable namespace at {OpenTelemetry::SemanticConventions::JVM::JVM_MEMORY_POOL_NAME}. JVM_MEMORY_POOL_NAME = 'jvm.memory.pool.name' # The type of memory # # @note StabilityLevel.STABLE # - # @deprecated Now available in the stable namespace at {OpenTelemetry::SemanticConventions::JVM::MEMORY_TYPE}. + # @deprecated Now available in the stable namespace at {OpenTelemetry::SemanticConventions::JVM::JVM_MEMORY_TYPE}. JVM_MEMORY_TYPE = 'jvm.memory.type' # Whether the thread is daemon or not # # @note StabilityLevel.STABLE # - # @deprecated Now available in the stable namespace at {OpenTelemetry::SemanticConventions::JVM::THREAD_DAEMON}. + # @deprecated Now available in the stable namespace at {OpenTelemetry::SemanticConventions::JVM::JVM_THREAD_DAEMON}. JVM_THREAD_DAEMON = 'jvm.thread.daemon' # State of the thread # # @note StabilityLevel.STABLE # - # @deprecated Now available in the stable namespace at {OpenTelemetry::SemanticConventions::JVM::THREAD_STATE}. + # @deprecated Now available in the stable namespace at {OpenTelemetry::SemanticConventions::JVM::JVM_THREAD_STATE}. JVM_THREAD_STATE = 'jvm.thread.state' # @!endgroup diff --git a/semantic_conventions/lib/opentelemetry/semantic_candidates/attributes/network.rb b/semantic_conventions/lib/opentelemetry/semantic_candidates/attributes/network.rb index d5eb99b614..ba7c46a305 100644 --- a/semantic_conventions/lib/opentelemetry/semantic_candidates/attributes/network.rb +++ b/semantic_conventions/lib/opentelemetry/semantic_candidates/attributes/network.rb @@ -62,28 +62,28 @@ module NETWORK # # @note StabilityLevel.STABLE # - # @deprecated Now available in the stable namespace at {OpenTelemetry::SemanticConventions::NETWORK::LOCAL_ADDRESS}. + # @deprecated Now available in the stable namespace at {OpenTelemetry::SemanticConventions::NETWORK::NETWORK_LOCAL_ADDRESS}. NETWORK_LOCAL_ADDRESS = 'network.local.address' # Local port number of the network connection # # @note StabilityLevel.STABLE # - # @deprecated Now available in the stable namespace at {OpenTelemetry::SemanticConventions::NETWORK::LOCAL_PORT}. + # @deprecated Now available in the stable namespace at {OpenTelemetry::SemanticConventions::NETWORK::NETWORK_LOCAL_PORT}. NETWORK_LOCAL_PORT = 'network.local.port' # Peer address of the network connection - IP address or Unix domain socket name # # @note StabilityLevel.STABLE # - # @deprecated Now available in the stable namespace at {OpenTelemetry::SemanticConventions::NETWORK::PEER_ADDRESS}. + # @deprecated Now available in the stable namespace at {OpenTelemetry::SemanticConventions::NETWORK::NETWORK_PEER_ADDRESS}. NETWORK_PEER_ADDRESS = 'network.peer.address' # Peer port number of the network connection # # @note StabilityLevel.STABLE # - # @deprecated Now available in the stable namespace at {OpenTelemetry::SemanticConventions::NETWORK::PEER_PORT}. + # @deprecated Now available in the stable namespace at {OpenTelemetry::SemanticConventions::NETWORK::NETWORK_PEER_PORT}. NETWORK_PEER_PORT = 'network.peer.port' # [OSI application layer](https://osi-model.com/application-layer/) or non-OSI equivalent @@ -92,7 +92,7 @@ module NETWORK # # @note StabilityLevel.STABLE # - # @deprecated Now available in the stable namespace at {OpenTelemetry::SemanticConventions::NETWORK::PROTOCOL_NAME}. + # @deprecated Now available in the stable namespace at {OpenTelemetry::SemanticConventions::NETWORK::NETWORK_PROTOCOL_NAME}. NETWORK_PROTOCOL_NAME = 'network.protocol.name' # The actual version of the protocol used for network communication @@ -101,7 +101,7 @@ module NETWORK # # @note StabilityLevel.STABLE # - # @deprecated Now available in the stable namespace at {OpenTelemetry::SemanticConventions::NETWORK::PROTOCOL_VERSION}. + # @deprecated Now available in the stable namespace at {OpenTelemetry::SemanticConventions::NETWORK::NETWORK_PROTOCOL_VERSION}. NETWORK_PROTOCOL_VERSION = 'network.protocol.version' # [OSI transport layer](https://osi-model.com/transport-layer/) or [inter-process communication method](https://wikipedia.org/wiki/Inter-process_communication) @@ -114,7 +114,7 @@ module NETWORK # # @note StabilityLevel.STABLE # - # @deprecated Now available in the stable namespace at {OpenTelemetry::SemanticConventions::NETWORK::TRANSPORT}. + # @deprecated Now available in the stable namespace at {OpenTelemetry::SemanticConventions::NETWORK::NETWORK_TRANSPORT}. NETWORK_TRANSPORT = 'network.transport' # [OSI network layer](https://osi-model.com/network-layer/) or non-OSI equivalent @@ -123,7 +123,7 @@ module NETWORK # # @note StabilityLevel.STABLE # - # @deprecated Now available in the stable namespace at {OpenTelemetry::SemanticConventions::NETWORK::TYPE}. + # @deprecated Now available in the stable namespace at {OpenTelemetry::SemanticConventions::NETWORK::NETWORK_TYPE}. NETWORK_TYPE = 'network.type' # @!endgroup diff --git a/semantic_conventions/lib/opentelemetry/semantic_candidates/attributes/otel.rb b/semantic_conventions/lib/opentelemetry/semantic_candidates/attributes/otel.rb index 2a72cf28d9..4ae29d3e97 100644 --- a/semantic_conventions/lib/opentelemetry/semantic_candidates/attributes/otel.rb +++ b/semantic_conventions/lib/opentelemetry/semantic_candidates/attributes/otel.rb @@ -41,28 +41,28 @@ module OTEL # # @note StabilityLevel.STABLE # - # @deprecated Now available in the stable namespace at {OpenTelemetry::SemanticConventions::OTEL::NAME}. + # @deprecated Now available in the stable namespace at {OpenTelemetry::SemanticConventions::OTEL::OTEL_SCOPE_NAME}. OTEL_SCOPE_NAME = 'otel.scope.name' # The version of the instrumentation scope - (`InstrumentationScope.Version` in OTLP) # # @note StabilityLevel.STABLE # - # @deprecated Now available in the stable namespace at {OpenTelemetry::SemanticConventions::OTEL::VERSION}. + # @deprecated Now available in the stable namespace at {OpenTelemetry::SemanticConventions::OTEL::OTEL_SCOPE_VERSION}. OTEL_SCOPE_VERSION = 'otel.scope.version' # Name of the code, either "OK" or "ERROR". MUST NOT be set if the status code is UNSET # # @note StabilityLevel.STABLE # - # @deprecated Now available in the stable namespace at {OpenTelemetry::SemanticConventions::OTEL::STATUS_CODE}. + # @deprecated Now available in the stable namespace at {OpenTelemetry::SemanticConventions::OTEL::OTEL_STATUS_CODE}. OTEL_STATUS_CODE = 'otel.status_code' # Description of the Status if it has a value, otherwise not set # # @note StabilityLevel.STABLE # - # @deprecated Now available in the stable namespace at {OpenTelemetry::SemanticConventions::OTEL::STATUS_DESCRIPTION}. + # @deprecated Now available in the stable namespace at {OpenTelemetry::SemanticConventions::OTEL::OTEL_STATUS_DESCRIPTION}. OTEL_STATUS_DESCRIPTION = 'otel.status_description' # @!endgroup diff --git a/semantic_conventions/lib/opentelemetry/semantic_candidates/attributes/server.rb b/semantic_conventions/lib/opentelemetry/semantic_candidates/attributes/server.rb index 273ca50d1d..8a72a02ec5 100644 --- a/semantic_conventions/lib/opentelemetry/semantic_candidates/attributes/server.rb +++ b/semantic_conventions/lib/opentelemetry/semantic_candidates/attributes/server.rb @@ -29,7 +29,7 @@ module SERVER # # @note StabilityLevel.STABLE # - # @deprecated Now available in the stable namespace at {OpenTelemetry::SemanticConventions::SERVER::ADDRESS}. + # @deprecated Now available in the stable namespace at {OpenTelemetry::SemanticConventions::SERVER::SERVER_ADDRESS}. SERVER_ADDRESS = 'server.address' # Server port number @@ -38,7 +38,7 @@ module SERVER # # @note StabilityLevel.STABLE # - # @deprecated Now available in the stable namespace at {OpenTelemetry::SemanticConventions::SERVER::PORT}. + # @deprecated Now available in the stable namespace at {OpenTelemetry::SemanticConventions::SERVER::SERVER_PORT}. SERVER_PORT = 'server.port' # @!endgroup diff --git a/semantic_conventions/lib/opentelemetry/semantic_candidates/attributes/service.rb b/semantic_conventions/lib/opentelemetry/semantic_candidates/attributes/service.rb index 5287007bb1..093e55ad6a 100644 --- a/semantic_conventions/lib/opentelemetry/semantic_candidates/attributes/service.rb +++ b/semantic_conventions/lib/opentelemetry/semantic_candidates/attributes/service.rb @@ -61,7 +61,7 @@ module SERVICE # # @note StabilityLevel.STABLE # - # @deprecated Now available in the stable namespace at {OpenTelemetry::SemanticConventions::SERVICE::NAME}. + # @deprecated Now available in the stable namespace at {OpenTelemetry::SemanticConventions::SERVICE::SERVICE_NAME}. SERVICE_NAME = 'service.name' # A namespace for `service.name` @@ -75,7 +75,7 @@ module SERVICE # # @note StabilityLevel.STABLE # - # @deprecated Now available in the stable namespace at {OpenTelemetry::SemanticConventions::SERVICE::VERSION}. + # @deprecated Now available in the stable namespace at {OpenTelemetry::SemanticConventions::SERVICE::SERVICE_VERSION}. SERVICE_VERSION = 'service.version' # @!endgroup diff --git a/semantic_conventions/lib/opentelemetry/semantic_candidates/attributes/signalr.rb b/semantic_conventions/lib/opentelemetry/semantic_candidates/attributes/signalr.rb index dac17b2969..226ead0157 100644 --- a/semantic_conventions/lib/opentelemetry/semantic_candidates/attributes/signalr.rb +++ b/semantic_conventions/lib/opentelemetry/semantic_candidates/attributes/signalr.rb @@ -27,14 +27,14 @@ module SIGNALR # # @note StabilityLevel.STABLE # - # @deprecated Now available in the stable namespace at {OpenTelemetry::SemanticConventions::SIGNALR::CONNECTION_STATUS}. + # @deprecated Now available in the stable namespace at {OpenTelemetry::SemanticConventions::SIGNALR::SIGNALR_CONNECTION_STATUS}. SIGNALR_CONNECTION_STATUS = 'signalr.connection.status' # [SignalR transport type](https://github.com/dotnet/aspnetcore/blob/main/src/SignalR/docs/specs/TransportProtocols.md) # # @note StabilityLevel.STABLE # - # @deprecated Now available in the stable namespace at {OpenTelemetry::SemanticConventions::SIGNALR::TRANSPORT}. + # @deprecated Now available in the stable namespace at {OpenTelemetry::SemanticConventions::SIGNALR::SIGNALR_TRANSPORT}. SIGNALR_TRANSPORT = 'signalr.transport' # @!endgroup diff --git a/semantic_conventions/lib/opentelemetry/semantic_candidates/attributes/telemetry.rb b/semantic_conventions/lib/opentelemetry/semantic_candidates/attributes/telemetry.rb index 23203e662c..079a2799b2 100644 --- a/semantic_conventions/lib/opentelemetry/semantic_candidates/attributes/telemetry.rb +++ b/semantic_conventions/lib/opentelemetry/semantic_candidates/attributes/telemetry.rb @@ -40,7 +40,7 @@ module TELEMETRY # # @note StabilityLevel.STABLE # - # @deprecated Now available in the stable namespace at {OpenTelemetry::SemanticConventions::TELEMETRY::SDK_LANGUAGE}. + # @deprecated Now available in the stable namespace at {OpenTelemetry::SemanticConventions::TELEMETRY::TELEMETRY_SDK_LANGUAGE}. TELEMETRY_SDK_LANGUAGE = 'telemetry.sdk.language' # The name of the telemetry SDK as defined above @@ -54,14 +54,14 @@ module TELEMETRY # # @note StabilityLevel.STABLE # - # @deprecated Now available in the stable namespace at {OpenTelemetry::SemanticConventions::TELEMETRY::SDK_NAME}. + # @deprecated Now available in the stable namespace at {OpenTelemetry::SemanticConventions::TELEMETRY::TELEMETRY_SDK_NAME}. TELEMETRY_SDK_NAME = 'telemetry.sdk.name' # The version string of the telemetry SDK # # @note StabilityLevel.STABLE # - # @deprecated Now available in the stable namespace at {OpenTelemetry::SemanticConventions::TELEMETRY::SDK_VERSION}. + # @deprecated Now available in the stable namespace at {OpenTelemetry::SemanticConventions::TELEMETRY::TELEMETRY_SDK_VERSION}. TELEMETRY_SDK_VERSION = 'telemetry.sdk.version' # @!endgroup diff --git a/semantic_conventions/lib/opentelemetry/semantic_candidates/attributes/url.rb b/semantic_conventions/lib/opentelemetry/semantic_candidates/attributes/url.rb index eb919de1da..a994db7266 100644 --- a/semantic_conventions/lib/opentelemetry/semantic_candidates/attributes/url.rb +++ b/semantic_conventions/lib/opentelemetry/semantic_candidates/attributes/url.rb @@ -41,7 +41,7 @@ module URL # # @note StabilityLevel.STABLE # - # @deprecated Now available in the stable namespace at {OpenTelemetry::SemanticConventions::URL::FRAGMENT}. + # @deprecated Now available in the stable namespace at {OpenTelemetry::SemanticConventions::URL::URL_FRAGMENT}. URL_FRAGMENT = 'url.fragment' # Absolute URL describing a network resource according to [RFC3986](https://www.rfc-editor.org/rfc/rfc3986) @@ -52,7 +52,7 @@ module URL # # @note StabilityLevel.STABLE # - # @deprecated Now available in the stable namespace at {OpenTelemetry::SemanticConventions::URL::FULL}. + # @deprecated Now available in the stable namespace at {OpenTelemetry::SemanticConventions::URL::URL_FULL}. URL_FULL = 'url.full' # Unmodified original URL as seen in the event source @@ -69,7 +69,7 @@ module URL # # @note StabilityLevel.STABLE # - # @deprecated Now available in the stable namespace at {OpenTelemetry::SemanticConventions::URL::PATH}. + # @deprecated Now available in the stable namespace at {OpenTelemetry::SemanticConventions::URL::URL_PATH}. URL_PATH = 'url.path' # Port extracted from the `url.full` @@ -83,7 +83,7 @@ module URL # # @note StabilityLevel.STABLE # - # @deprecated Now available in the stable namespace at {OpenTelemetry::SemanticConventions::URL::QUERY}. + # @deprecated Now available in the stable namespace at {OpenTelemetry::SemanticConventions::URL::URL_QUERY}. URL_QUERY = 'url.query' # The highest registered url domain, stripped of the subdomain @@ -97,7 +97,7 @@ module URL # # @note StabilityLevel.STABLE # - # @deprecated Now available in the stable namespace at {OpenTelemetry::SemanticConventions::URL::SCHEME}. + # @deprecated Now available in the stable namespace at {OpenTelemetry::SemanticConventions::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 diff --git a/semantic_conventions/lib/opentelemetry/semantic_candidates/attributes/user_agent.rb b/semantic_conventions/lib/opentelemetry/semantic_candidates/attributes/user_agent.rb index 84c9a25a90..1c8ca735e6 100644 --- a/semantic_conventions/lib/opentelemetry/semantic_candidates/attributes/user_agent.rb +++ b/semantic_conventions/lib/opentelemetry/semantic_candidates/attributes/user_agent.rb @@ -34,7 +34,7 @@ module USER_AGENT # # @note StabilityLevel.STABLE # - # @deprecated Now available in the stable namespace at {OpenTelemetry::SemanticConventions::USER_AGENT::ORIGINAL}. + # @deprecated Now available in the stable namespace at {OpenTelemetry::SemanticConventions::USER_AGENT::USER_AGENT_ORIGINAL}. USER_AGENT_ORIGINAL = 'user_agent.original' # Version of the user-agent extracted from original. Usually refers to the browser's version diff --git a/semantic_conventions/templates/attributes.j2 b/semantic_conventions/templates/attributes.j2 index ebb46b663c..b57c3097f3 100644 --- a/semantic_conventions/templates/attributes.j2 +++ b/semantic_conventions/templates/attributes.j2 @@ -40,7 +40,7 @@ module OpenTelemetry # @deprecated {{ common.to_docstring(attribute.deprecated) }} {%- elif attribute | is_stable and selector == 'any' %} # - # @deprecated Now available in the stable namespace at {OpenTelemetry::SemanticConventions::{{ root_namespace | to_const_name }}::{{ attribute.attr_id | to_const_name }}}. + # @deprecated Now available in the stable namespace at {OpenTelemetry::SemanticConventions::{{ root_namespace | to_const_name }}::{{ attribute.fqn | to_const_name }}}. {%- endif %} {%- if attribute.fqn in excluded_attributes %} # From 4343ffe2e8205fa0b80d216137089e41b7995b1a Mon Sep 17 00:00:00 2001 From: Robb Kidd Date: Wed, 10 Jul 2024 19:50:16 -0400 Subject: [PATCH 06/17] test that constants are available in candidates 277 runs, 500 assertions, 26 failures, 0 errors, 0 skips Apparently there are some kinks to work out. --- .../semantic_conventions/attributes_test.rb | 47 +++++++++++++++++++ semantic_conventions/test/test_helper.rb | 16 +++++++ 2 files changed, 63 insertions(+) create mode 100644 semantic_conventions/test/opentelemetry/semantic_conventions/attributes_test.rb create mode 100644 semantic_conventions/test/test_helper.rb diff --git a/semantic_conventions/test/opentelemetry/semantic_conventions/attributes_test.rb b/semantic_conventions/test/opentelemetry/semantic_conventions/attributes_test.rb new file mode 100644 index 0000000000..d1c1027153 --- /dev/null +++ b/semantic_conventions/test/opentelemetry/semantic_conventions/attributes_test.rb @@ -0,0 +1,47 @@ +# frozen_string_literal: true + +# Copyright The OpenTelemetry Authors +# +# SPDX-License-Identifier: Apache-2.0 + +require 'test_helper' + +OLD_SEMCONV_ROOTS = %i[Resource Trace].freeze + +describe OpenTelemetry::SemanticConventions do + OLD_SEMCONV_ROOTS + .each do |old_root| + describe "old root #{old_root} has a corresponding SemanticCandidates namespace and constant" do + OpenTelemetry::SemanticConventions + .const_get(old_root) + .constants + .each do |const| + it "(#{const})" do + root_namespace = const.to_s.split('_').first + assert OpenTelemetry::SemanticCandidates.constants.include?(root_namespace.to_sym), "Missing candidate namespace: #{root_namespace}" + + candidate_namespace = OpenTelemetry::SemanticCandidates.const_get(root_namespace.to_sym) + assert candidate_namespace.constants.include?(const), "Missing candidate constant: #{const}" + end + end + end + end + + OpenTelemetry::SemanticConventions + .constants + .reject { |const| const == :VERSION } + .reject { |root_namespace| OLD_SEMCONV_ROOTS.include?(root_namespace) } + .each do |root_namespace| + describe "stable root (#{root_namespace})" do + OpenTelemetry::SemanticConventions + .const_get(root_namespace) + .constants + .each do |stable_const| + it "(#{stable_const})" do + candidate_namespace = OpenTelemetry::SemanticCandidates.const_get(root_namespace) + assert candidate_namespace.constants.include?(stable_const), "Missing stable constant in candidates: #{stable_const}" + end + end + end + end +end diff --git a/semantic_conventions/test/test_helper.rb b/semantic_conventions/test/test_helper.rb new file mode 100644 index 0000000000..e53c8ef6e8 --- /dev/null +++ b/semantic_conventions/test/test_helper.rb @@ -0,0 +1,16 @@ +# frozen_string_literal: true + +# Copyright The OpenTelemetry Authors +# +# SPDX-License-Identifier: Apache-2.0 + +if RUBY_ENGINE == 'ruby' + require 'simplecov' + SimpleCov.start + SimpleCov.minimum_coverage 85 +end + +require 'minitest/autorun' +require 'pry' + +Dir[File.join(File.dirname(__FILE__), '..', 'lib', 'opentelemetry', '**', '*.rb')].sort.each { |file| require file } From a0798c72b472bfdf78b47ed1635b13db4d8babd7 Mon Sep 17 00:00:00 2001 From: Robb Kidd Date: Fri, 12 Jul 2024 11:31:00 -0400 Subject: [PATCH 07/17] generate v1.25 semconv There's naming hijinks in the db.* namespace I would like to avoid in this first effort to bring semconv up-to-recent-date. --- semantic_conventions/Rakefile | 4 +- .../semantic_candidates/attributes/android.rb | 2 +- .../attributes/container.rb | 2 +- .../semantic_candidates/attributes/db.rb | 105 ++++-------------- .../semantic_candidates/attributes/error.rb | 6 +- .../semantic_candidates/attributes/event.rb | 2 +- .../attributes/exception.rb | 2 +- .../semantic_candidates/attributes/gen_ai.rb | 95 ---------------- .../semantic_candidates/attributes/http.rb | 35 ------ .../semantic_candidates/attributes/ios.rb | 4 +- .../semantic_candidates/attributes/k8s.rb | 5 - .../semantic_candidates/attributes/message.rb | 18 +-- .../attributes/messaging.rb | 48 +------- .../semantic_candidates/attributes/net.rb | 14 --- .../semantic_candidates/attributes/other.rb | 4 +- .../semantic_candidates/attributes/pool.rb | 4 +- .../semantic_candidates/attributes/process.rb | 69 +----------- .../semantic_candidates/attributes/rpc.rb | 22 ---- .../semantic_candidates/attributes/service.rb | 2 +- .../semantic_candidates/attributes/system.rb | 2 +- .../semantic_candidates/attributes/url.rb | 5 - .../semantic_conventions/attributes/error.rb | 6 +- .../attributes/exception.rb | 2 +- .../attributes/service.rb | 2 +- .../semantic_conventions/version.rb | 2 +- 25 files changed, 51 insertions(+), 411 deletions(-) delete mode 100644 semantic_conventions/lib/opentelemetry/semantic_candidates/attributes/gen_ai.rb diff --git a/semantic_conventions/Rakefile b/semantic_conventions/Rakefile index bf22f05b09..c38761be5d 100644 --- a/semantic_conventions/Rakefile +++ b/semantic_conventions/Rakefile @@ -30,13 +30,13 @@ else task default: %i[generate test rubocop yard] end -SPEC_VERSION = '1.26.0' +SPEC_VERSION = '1.25.0' GENERATOR_VERSION = '0.24.0' semconv_source_dir = Pathname.new("./tmpsemconvrepo_v#{SPEC_VERSION}") conventions_output_dir = Pathname.new('./lib/opentelemetry/semantic_conventions') candidates_output_dir = Pathname.new('./lib/opentelemetry/semantic_candidates') -EXCLUDED_ATTRIBUTES = %w[messaging.client_id] +EXCLUDED_ATTRIBUTES = %w[] task generate: %i[update_gem_version generate_stable_attributes generate_candidate_attributes] diff --git a/semantic_conventions/lib/opentelemetry/semantic_candidates/attributes/android.rb b/semantic_conventions/lib/opentelemetry/semantic_candidates/attributes/android.rb index 71ed6dfabe..25d73105bc 100644 --- a/semantic_conventions/lib/opentelemetry/semantic_candidates/attributes/android.rb +++ b/semantic_conventions/lib/opentelemetry/semantic_candidates/attributes/android.rb @@ -28,7 +28,7 @@ module ANDROID # @note StabilityLevel.EXPERIMENTAL ANDROID_OS_API_LEVEL = 'android.os.api_level' - # Deprecated use the `device.app.lifecycle` event definition including `android.state` as a payload field instead + # This attribute represents the state the application has transitioned into at the occurrence of the event # # The Android lifecycle states are defined in [Activity lifecycle callbacks](https://developer.android.com/guide/components/activities/activity-lifecycle#lc), and from which the `OS identifiers` are derived # diff --git a/semantic_conventions/lib/opentelemetry/semantic_candidates/attributes/container.rb b/semantic_conventions/lib/opentelemetry/semantic_candidates/attributes/container.rb index 6bdf251cf9..cb9d78a3bb 100644 --- a/semantic_conventions/lib/opentelemetry/semantic_candidates/attributes/container.rb +++ b/semantic_conventions/lib/opentelemetry/semantic_candidates/attributes/container.rb @@ -54,7 +54,7 @@ module CONTAINER # # Docker defines a sha256 of the image id; `container.image.id` corresponds to the `Image` field from the Docker container inspect [API](https://docs.docker.com/engine/api/v1.43/#tag/Container/operation/ContainerInspect) endpoint. # K8s defines a link to the container registry repository with digest `"imageID": "registry.azurecr.io /namespace/service/dockerfile@sha256:bdeabd40c3a8a492eaf9e8e44d0ebbb84bac7ee25ac0cf8a7159d25f62555625"`. - # The ID is assigned by the container runtime and can vary in different environments. Consider using `oci.manifest.digest` if it is important to identify the same image in different environments/runtimes + # The ID is assinged by the container runtime and can vary in different environments. Consider using `oci.manifest.digest` if it is important to identify the same image in different environments/runtimes # # @note StabilityLevel.EXPERIMENTAL CONTAINER_IMAGE_ID = 'container.image.id' diff --git a/semantic_conventions/lib/opentelemetry/semantic_candidates/attributes/db.rb b/semantic_conventions/lib/opentelemetry/semantic_candidates/attributes/db.rb index d8efc88f79..a92fa5fbe6 100644 --- a/semantic_conventions/lib/opentelemetry/semantic_candidates/attributes/db.rb +++ b/semantic_conventions/lib/opentelemetry/semantic_candidates/attributes/db.rb @@ -53,30 +53,12 @@ module DB # @note StabilityLevel.EXPERIMENTAL DB_CASSANDRA_SPECULATIVE_EXECUTION_COUNT = 'db.cassandra.speculative_execution_count' - # Deprecated, use `db.collection.name` instead + # The name of the primary Cassandra table that the operation is acting upon, including the keyspace name (if applicable) # - # @note StabilityLevel.EXPERIMENTAL - # - # @deprecated Replaced by `db.collection.name` - DB_CASSANDRA_TABLE = 'db.cassandra.table' - - # The name of the connection pool; unique within the instrumented application. In case the connection pool implementation doesn't provide a name, instrumentation should use a combination of `server.address` and `server.port` attributes formatted as `server.address:server.port` - # - # @note StabilityLevel.EXPERIMENTAL - DB_CLIENT_CONNECTIONS_POOL_NAME = 'db.client.connections.pool.name' - - # The state of a connection in the pool - # - # @note StabilityLevel.EXPERIMENTAL - DB_CLIENT_CONNECTIONS_STATE = 'db.client.connections.state' - - # The name of a collection (table, container) within the database - # - # If the collection name is parsed from the query, it SHOULD match the value provided in the query and may be qualified with the schema and database name. - # It is RECOMMENDED to capture the value as provided by the application without attempting to do any case normalization + # 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 # # @note StabilityLevel.EXPERIMENTAL - DB_COLLECTION_NAME = 'db.collection.name' + DB_CASSANDRA_TABLE = 'db.cassandra.table' # Deprecated, use `server.address`, `server.port` attributes instead # @@ -95,11 +77,9 @@ module DB # @note StabilityLevel.EXPERIMENTAL DB_COSMOSDB_CONNECTION_MODE = 'db.cosmosdb.connection_mode' - # Deprecated, use `db.collection.name` instead + # Cosmos DB container name # # @note StabilityLevel.EXPERIMENTAL - # - # @deprecated Replaced by `db.collection.name` DB_COSMOSDB_CONTAINER = 'db.cosmosdb.container' # CosmosDB Operation Type @@ -132,9 +112,11 @@ module DB # @note StabilityLevel.EXPERIMENTAL DB_ELASTICSEARCH_CLUSTER_NAME = 'db.elasticsearch.cluster.name' - # Represents the human-readable identifier of the node/instance to which a request was routed + # Deprecated, use `db.instance.id` instead # # @note StabilityLevel.EXPERIMENTAL + # + # @deprecated Replaced by `db.instance.id` DB_ELASTICSEARCH_NODE_NAME = 'db.elasticsearch.node.name' # A dynamic value in the url path @@ -144,11 +126,9 @@ module DB # @note StabilityLevel.EXPERIMENTAL DB_ELASTICSEARCH_PATH_PARTS = 'db.elasticsearch.path_parts' - # Deprecated, no general replacement at this time. For Elasticsearch, use `db.elasticsearch.node.name` instead + # An identifier (address, unique name, or any other identifier) of the database instance that is executing queries or mutations on the current connection. This is useful in cases where the database is running in a clustered environment and the instrumentation is able to record the node executing the query. The client may obtain this value in databases like MySQL using queries like `select @@hostname` # # @note StabilityLevel.EXPERIMENTAL - # - # @deprecated Deprecated, no general replacement at this time. For Elasticsearch, use `db.elasticsearch.node.name` instead DB_INSTANCE_ID = 'db.instance.id' # Removed, no replacement at this time @@ -158,96 +138,57 @@ module DB # @deprecated Removed as not used DB_JDBC_DRIVER_CLASSNAME = 'db.jdbc.driver_classname' - # Deprecated, use `db.collection.name` instead + # The MongoDB collection being accessed within the database stated in `db.name` # # @note StabilityLevel.EXPERIMENTAL - # - # @deprecated Replaced by `db.collection.name` DB_MONGODB_COLLECTION = 'db.mongodb.collection' - # Deprecated, SQL Server instance is now populated as a part of `db.namespace` attribute + # The Microsoft SQL Server [instance name](https://docs.microsoft.com/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 # - # @note StabilityLevel.EXPERIMENTAL + # If setting a `db.mssql.instance_name`, `server.port` is no longer required (but still recommended if non-standard) # - # @deprecated Deprecated, no replacement at this time + # @note StabilityLevel.EXPERIMENTAL DB_MSSQL_INSTANCE_NAME = 'db.mssql.instance_name' - # Deprecated, use `db.namespace` instead + # 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) # - # @note StabilityLevel.EXPERIMENTAL + # In some SQL databases, the database name to be used is called "schema name". In case there are multiple layers that could be considered for database name (e.g. Oracle instance name and schema name), the database name to be used is the more specific layer (e.g. Oracle schema name) # - # @deprecated Replaced by `db.namespace` + # @note StabilityLevel.EXPERIMENTAL DB_NAME = 'db.name' - # The name of the database, fully qualified within the server address and port + # 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 # - # If a database system has multiple namespace components, they SHOULD be concatenated (potentially using database system specific conventions) from most general to most specific namespace component, and more specific namespaces SHOULD NOT be captured without the more general namespaces, to ensure that "startswith" queries for the more general namespaces will be valid. - # Semantic conventions for individual database systems SHOULD document what `db.namespace` means in the context of that system. - # It is RECOMMENDED to capture the value as provided by the application without attempting to do any case normalization + # 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 # # @note StabilityLevel.EXPERIMENTAL - DB_NAMESPACE = 'db.namespace' - - # Deprecated, use `db.operation.name` instead - # - # @note StabilityLevel.EXPERIMENTAL - # - # @deprecated Replaced by `db.operation.name` DB_OPERATION = 'db.operation' - # The name of the operation or command being executed - # - # It is RECOMMENDED to capture the value as provided by the application without attempting to do any case normalization - # - # @note StabilityLevel.EXPERIMENTAL - DB_OPERATION_NAME = 'db.operation.name' - - # The query parameters used in `db.query.text`, with `` being the parameter name, and the attribute value being the parameter value - # - # Query parameters should only be captured when `db.query.text` is parameterized with placeholders. - # If a parameter has no name and instead is referenced only by index, then `` SHOULD be the 0-based index - # - # @note StabilityLevel.EXPERIMENTAL - DB_QUERY_PARAMETER = 'db.query.parameter' - - # The database query being executed + # 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 # # @note StabilityLevel.EXPERIMENTAL - DB_QUERY_TEXT = 'db.query.text' - - # Deprecated, use `db.namespace` instead - # - # @note StabilityLevel.EXPERIMENTAL - # - # @deprecated Replaced by `db.namespace` DB_REDIS_DATABASE_INDEX = 'db.redis.database_index' - # Deprecated, use `db.collection.name` instead + # The name of the primary table that the operation is acting upon, including the database name (if applicable) # - # @note StabilityLevel.EXPERIMENTAL + # 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 # - # @deprecated Replaced by `db.collection.name` + # @note StabilityLevel.EXPERIMENTAL DB_SQL_TABLE = 'db.sql.table' # The database statement being executed # # @note StabilityLevel.EXPERIMENTAL - # - # @deprecated Replaced by `db.query.text` DB_STATEMENT = 'db.statement' - # The database management system (DBMS) product as identified by the client instrumentation - # - # The actual DBMS may differ from the one identified by the client. For example, when using PostgreSQL client libraries to connect to a CockroachDB, the `db.system` is set to `postgresql` based on the instrumentation's best knowledge + # An identifier for the database management system (DBMS) product being used. See below for a list of well-known identifiers # # @note StabilityLevel.EXPERIMENTAL DB_SYSTEM = 'db.system' - # Deprecated, no replacement at this time + # Username for accessing the database # # @note StabilityLevel.EXPERIMENTAL - # - # @deprecated No replacement at this time DB_USER = 'db.user' # @!endgroup diff --git a/semantic_conventions/lib/opentelemetry/semantic_candidates/attributes/error.rb b/semantic_conventions/lib/opentelemetry/semantic_candidates/attributes/error.rb index df326fa00b..0948527f8e 100644 --- a/semantic_conventions/lib/opentelemetry/semantic_candidates/attributes/error.rb +++ b/semantic_conventions/lib/opentelemetry/semantic_candidates/attributes/error.rb @@ -25,11 +25,7 @@ module ERROR # Describes a class of error the operation ended with # - # The `error.type` SHOULD be predictable, and SHOULD have low cardinality. - # - # When `error.type` is set to a type (e.g., an exception type), its - # canonical class name identifying the type within the artifact SHOULD be used. - # + # The `error.type` SHOULD be predictable and SHOULD have low cardinality. # Instrumentations SHOULD document the list of errors they report. # # The cardinality of `error.type` within one instrumentation library SHOULD be low. diff --git a/semantic_conventions/lib/opentelemetry/semantic_candidates/attributes/event.rb b/semantic_conventions/lib/opentelemetry/semantic_candidates/attributes/event.rb index 4b9174006c..f9af5780f8 100644 --- a/semantic_conventions/lib/opentelemetry/semantic_candidates/attributes/event.rb +++ b/semantic_conventions/lib/opentelemetry/semantic_candidates/attributes/event.rb @@ -25,7 +25,7 @@ module EVENT # Identifies the class / type of event # - # Event names are subject to the same rules as [attribute names](https://github.com/open-telemetry/opentelemetry-specification/tree/v1.33.0/specification/common/attribute-naming.md). Notably, event names are namespaced to avoid collisions and provide a clean separation of semantics for events in separate domains like browser, mobile, and kubernetes + # Event names are subject to the same rules as [attribute names](https://github.com/open-telemetry/opentelemetry-specification/tree/v1.31.0/specification/common/attribute-naming.md). Notably, event names are namespaced to avoid collisions and provide a clean separation of semantics for events in separate domains like browser, mobile, and kubernetes # # @note StabilityLevel.EXPERIMENTAL EVENT_NAME = 'event.name' diff --git a/semantic_conventions/lib/opentelemetry/semantic_candidates/attributes/exception.rb b/semantic_conventions/lib/opentelemetry/semantic_candidates/attributes/exception.rb index d3055ffcc3..4c412d1b26 100644 --- a/semantic_conventions/lib/opentelemetry/semantic_candidates/attributes/exception.rb +++ b/semantic_conventions/lib/opentelemetry/semantic_candidates/attributes/exception.rb @@ -35,7 +35,7 @@ module EXCEPTION # whether it will escape the scope of a span. # However, it is trivial to know that an exception # will escape, if one checks for an active exception just before ending the span, - # as done in the [example for recording span exceptions](https://opentelemetry.io/docs/specs/semconv/exceptions/exceptions-spans/#recording-an-exception). + # as done in the [example for recording span exceptions](#recording-an-exception). # # It follows that an exception may still escape the scope of the span # even if the `exception.escaped` attribute was not set or set to false, diff --git a/semantic_conventions/lib/opentelemetry/semantic_candidates/attributes/gen_ai.rb b/semantic_conventions/lib/opentelemetry/semantic_candidates/attributes/gen_ai.rb deleted file mode 100644 index 6e5018e357..0000000000 --- a/semantic_conventions/lib/opentelemetry/semantic_candidates/attributes/gen_ai.rb +++ /dev/null @@ -1,95 +0,0 @@ -# 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 SemanticCandidates - module GEN_AI - # @!group Attribute Names - - # The full response received from the LLM - # - # It's RECOMMENDED to format completions as JSON string matching [OpenAI messages format](https://platform.openai.com/docs/guides/text-generation) - # - # @note StabilityLevel.EXPERIMENTAL - GEN_AI_COMPLETION = 'gen_ai.completion' - - # The full prompt sent to an LLM - # - # It's RECOMMENDED to format prompts as JSON string matching [OpenAI messages format](https://platform.openai.com/docs/guides/text-generation) - # - # @note StabilityLevel.EXPERIMENTAL - GEN_AI_PROMPT = 'gen_ai.prompt' - - # The maximum number of tokens the LLM generates for a request - # - # @note StabilityLevel.EXPERIMENTAL - GEN_AI_REQUEST_MAX_TOKENS = 'gen_ai.request.max_tokens' - - # The name of the LLM a request is being made to - # - # @note StabilityLevel.EXPERIMENTAL - GEN_AI_REQUEST_MODEL = 'gen_ai.request.model' - - # The temperature setting for the LLM request - # - # @note StabilityLevel.EXPERIMENTAL - GEN_AI_REQUEST_TEMPERATURE = 'gen_ai.request.temperature' - - # The top_p sampling setting for the LLM request - # - # @note StabilityLevel.EXPERIMENTAL - GEN_AI_REQUEST_TOP_P = 'gen_ai.request.top_p' - - # Array of reasons the model stopped generating tokens, corresponding to each generation received - # - # @note StabilityLevel.EXPERIMENTAL - GEN_AI_RESPONSE_FINISH_REASONS = 'gen_ai.response.finish_reasons' - - # The unique identifier for the completion - # - # @note StabilityLevel.EXPERIMENTAL - GEN_AI_RESPONSE_ID = 'gen_ai.response.id' - - # The name of the LLM a response was generated from - # - # @note StabilityLevel.EXPERIMENTAL - GEN_AI_RESPONSE_MODEL = 'gen_ai.response.model' - - # The Generative AI product as identified by the client instrumentation - # - # The actual GenAI product may differ from the one identified by the client. For example, when using OpenAI client libraries to communicate with Mistral, the `gen_ai.system` is set to `openai` based on the instrumentation's best knowledge - # - # @note StabilityLevel.EXPERIMENTAL - GEN_AI_SYSTEM = 'gen_ai.system' - - # The number of tokens used in the LLM response (completion) - # - # @note StabilityLevel.EXPERIMENTAL - GEN_AI_USAGE_COMPLETION_TOKENS = 'gen_ai.usage.completion_tokens' - - # The number of tokens used in the LLM prompt - # - # @note StabilityLevel.EXPERIMENTAL - GEN_AI_USAGE_PROMPT_TOKENS = 'gen_ai.usage.prompt_tokens' - - # @!endgroup - end - end -end \ No newline at end of file diff --git a/semantic_conventions/lib/opentelemetry/semantic_candidates/attributes/http.rb b/semantic_conventions/lib/opentelemetry/semantic_candidates/attributes/http.rb index 13c7757147..03370e1370 100644 --- a/semantic_conventions/lib/opentelemetry/semantic_candidates/attributes/http.rb +++ b/semantic_conventions/lib/opentelemetry/semantic_candidates/attributes/http.rb @@ -23,13 +23,6 @@ module SemanticCandidates module HTTP # @!group Attribute Names - # Deprecated, use `client.address` instead - # - # @note StabilityLevel.EXPERIMENTAL - # - # @deprecated Replaced by `client.address` - HTTP_CLIENT_IP = 'http.client_ip' - # State of the HTTP connection in the HTTP connection pool # # @note StabilityLevel.EXPERIMENTAL @@ -42,13 +35,6 @@ module HTTP # @deprecated Replaced by `network.protocol.name` HTTP_FLAVOR = 'http.flavor' - # Deprecated, use one of `server.address`, `client.address` or `http.request.header.host` instead, depending on the usage - # - # @note StabilityLevel.EXPERIMENTAL - # - # @deprecated Replaced by one of `server.address`, `client.address` or `http.request.header.host`, depending on the usage - HTTP_HOST = 'http.host' - # Deprecated, use `http.request.method` instead # # @note StabilityLevel.EXPERIMENTAL @@ -122,13 +108,6 @@ module HTTP # @deprecated Replaced by `http.request.header.content-length` HTTP_REQUEST_CONTENT_LENGTH = 'http.request_content_length' - # Deprecated, use `http.request.body.size` instead - # - # @note StabilityLevel.EXPERIMENTAL - # - # @deprecated Replaced by `http.request.body.size` - HTTP_REQUEST_CONTENT_LENGTH_UNCOMPRESSED = 'http.request_content_length_uncompressed' - # The size of the response payload body in bytes. This is the number of bytes transferred excluding headers and is often, but not always, present as the [Content-Length](https://www.rfc-editor.org/rfc/rfc9110.html#field.content-length) header. For requests using transport encoding, this should be the compressed size # # @note StabilityLevel.EXPERIMENTAL @@ -164,13 +143,6 @@ module HTTP # @deprecated Replaced by `http.response.header.content-length` HTTP_RESPONSE_CONTENT_LENGTH = 'http.response_content_length' - # Deprecated, use `http.response.body.size` instead - # - # @note StabilityLevel.EXPERIMENTAL - # - # @deprecated Replace by `http.response.body.size` - HTTP_RESPONSE_CONTENT_LENGTH_UNCOMPRESSED = 'http.response_content_length_uncompressed' - # The matched route, that is, the path template in the format used by the respective server framework # # MUST NOT be populated when this is not supported by the HTTP server framework as the route attribute should have low-cardinality and the URI path can NOT substitute it. @@ -188,13 +160,6 @@ module HTTP # @deprecated Replaced by `url.scheme` instead HTTP_SCHEME = 'http.scheme' - # Deprecated, use `server.address` instead - # - # @note StabilityLevel.EXPERIMENTAL - # - # @deprecated Replaced by `server.address` - HTTP_SERVER_NAME = 'http.server_name' - # Deprecated, use `http.response.status_code` instead # # @note StabilityLevel.EXPERIMENTAL diff --git a/semantic_conventions/lib/opentelemetry/semantic_candidates/attributes/ios.rb b/semantic_conventions/lib/opentelemetry/semantic_candidates/attributes/ios.rb index 08a763198c..01e2519ddf 100644 --- a/semantic_conventions/lib/opentelemetry/semantic_candidates/attributes/ios.rb +++ b/semantic_conventions/lib/opentelemetry/semantic_candidates/attributes/ios.rb @@ -23,13 +23,11 @@ module SemanticCandidates module IOS # @!group Attribute Names - # Deprecated use the `device.app.lifecycle` event definition including `ios.state` as a payload field instead + # This attribute represents the state the application has transitioned into at the occurrence of the event # # The iOS lifecycle states are defined in the [UIApplicationDelegate documentation](https://developer.apple.com/documentation/uikit/uiapplicationdelegate#1656902), and from which the `OS terminology` column values are derived # # @note StabilityLevel.EXPERIMENTAL - # - # @deprecated Moved to a payload field of `device.app.lifecycle` IOS_STATE = 'ios.state' # @!endgroup diff --git a/semantic_conventions/lib/opentelemetry/semantic_candidates/attributes/k8s.rb b/semantic_conventions/lib/opentelemetry/semantic_candidates/attributes/k8s.rb index 22c8aa49c7..15734cebfd 100644 --- a/semantic_conventions/lib/opentelemetry/semantic_candidates/attributes/k8s.rb +++ b/semantic_conventions/lib/opentelemetry/semantic_candidates/attributes/k8s.rb @@ -66,11 +66,6 @@ module K8S # @note StabilityLevel.EXPERIMENTAL K8S_CONTAINER_RESTART_COUNT = 'k8s.container.restart_count' - # Last terminated reason of the Container - # - # @note StabilityLevel.EXPERIMENTAL - K8S_CONTAINER_STATUS_LAST_TERMINATED_REASON = 'k8s.container.status.last_terminated_reason' - # The name of the CronJob # # @note StabilityLevel.EXPERIMENTAL diff --git a/semantic_conventions/lib/opentelemetry/semantic_candidates/attributes/message.rb b/semantic_conventions/lib/opentelemetry/semantic_candidates/attributes/message.rb index c749d7e7a1..af6f9d0928 100644 --- a/semantic_conventions/lib/opentelemetry/semantic_candidates/attributes/message.rb +++ b/semantic_conventions/lib/opentelemetry/semantic_candidates/attributes/message.rb @@ -23,32 +23,26 @@ module SemanticCandidates module MESSAGE # @!group Attribute Names - # Deprecated, use `rpc.message.compressed_size` instead + # Compressed size of the message in bytes # # @note StabilityLevel.EXPERIMENTAL - # - # @deprecated Replaced by `rpc.message.compressed_size` MESSAGE_COMPRESSED_SIZE = 'message.compressed_size' - # Deprecated, use `rpc.message.id` instead + # MUST be calculated as two different counters starting from `1` one for sent messages and one for received message # - # @note StabilityLevel.EXPERIMENTAL + # This way we guarantee that the values will be consistent between different implementations # - # @deprecated Replaced by `rpc.message.id` + # @note StabilityLevel.EXPERIMENTAL MESSAGE_ID = 'message.id' - # Deprecated, use `rpc.message.type` instead + # Whether this is a received or sent message # # @note StabilityLevel.EXPERIMENTAL - # - # @deprecated Replaced by `rpc.message.type` MESSAGE_TYPE = 'message.type' - # Deprecated, use `rpc.message.uncompressed_size` instead + # Uncompressed size of the message in bytes # # @note StabilityLevel.EXPERIMENTAL - # - # @deprecated Replaced by `rpc.message.uncompressed_size` MESSAGE_UNCOMPRESSED_SIZE = 'message.uncompressed_size' # @!endgroup diff --git a/semantic_conventions/lib/opentelemetry/semantic_candidates/attributes/messaging.rb b/semantic_conventions/lib/opentelemetry/semantic_candidates/attributes/messaging.rb index 9a69a7b14c..d24304f80c 100644 --- a/semantic_conventions/lib/opentelemetry/semantic_candidates/attributes/messaging.rb +++ b/semantic_conventions/lib/opentelemetry/semantic_candidates/attributes/messaging.rb @@ -33,16 +33,7 @@ module MESSAGING # A unique identifier for the client that consumes or produces a message # # @note StabilityLevel.EXPERIMENTAL - MESSAGING_CLIENT_ID = 'messaging.client.id' - - # Deprecated, use `messaging.client.id` instead - # - # @note StabilityLevel.EXPERIMENTAL - # - # @deprecated Replaced by `messaging.client.id` - # - # @note This attribute has been excluded from code generation. - # MESSAGING_CLIENT_ID = 'messaging.client_id' + MESSAGING_CLIENT_ID = 'messaging.client_id' # A boolean that is true if the message destination is anonymous (could be unnamed or have auto-generated name) # @@ -97,21 +88,6 @@ module MESSAGING # @note StabilityLevel.EXPERIMENTAL MESSAGING_EVENTHUBS_MESSAGE_ENQUEUED_TIME = 'messaging.eventhubs.message.enqueued_time' - # The ack deadline in seconds set for the modify ack deadline request - # - # @note StabilityLevel.EXPERIMENTAL - MESSAGING_GCP_PUBSUB_MESSAGE_ACK_DEADLINE = 'messaging.gcp_pubsub.message.ack_deadline' - - # The ack id for a given message - # - # @note StabilityLevel.EXPERIMENTAL - MESSAGING_GCP_PUBSUB_MESSAGE_ACK_ID = 'messaging.gcp_pubsub.message.ack_id' - - # The delivery attempt for a given message - # - # @note StabilityLevel.EXPERIMENTAL - MESSAGING_GCP_PUBSUB_MESSAGE_DELIVERY_ATTEMPT = 'messaging.gcp_pubsub.message.delivery_attempt' - # The ordering key for a given message. If the attribute is not present, the message does not have an ordering key # # @note StabilityLevel.EXPERIMENTAL @@ -122,7 +98,7 @@ module MESSAGING # @note StabilityLevel.EXPERIMENTAL MESSAGING_KAFKA_CONSUMER_GROUP = 'messaging.kafka.consumer.group' - # Deprecated, use `messaging.destination.partition.id` instead + # "Deprecated, use `messaging.destination.partition.id` instead." # # @note StabilityLevel.EXPERIMENTAL # @@ -172,24 +148,12 @@ module MESSAGING # @note StabilityLevel.EXPERIMENTAL MESSAGING_MESSAGE_ID = 'messaging.message.id' - # Deprecated, use `messaging.operation.type` instead - # - # @note StabilityLevel.EXPERIMENTAL - # - # @deprecated Replaced by `messaging.operation.type` - MESSAGING_OPERATION = 'messaging.operation' - - # The system-specific name of the messaging operation - # - # @note StabilityLevel.EXPERIMENTAL - MESSAGING_OPERATION_NAME = 'messaging.operation.name' - - # A string identifying the type of the messaging operation + # A string identifying the kind of messaging operation # # If a custom value is used, it MUST be of low cardinality # # @note StabilityLevel.EXPERIMENTAL - MESSAGING_OPERATION_TYPE = 'messaging.operation.type' + MESSAGING_OPERATION = 'messaging.operation' # RabbitMQ message routing key # @@ -266,9 +230,7 @@ module MESSAGING # @note StabilityLevel.EXPERIMENTAL MESSAGING_SERVICEBUS_MESSAGE_ENQUEUED_TIME = 'messaging.servicebus.message.enqueued_time' - # The messaging system as identified by the client instrumentation - # - # The actual messaging system may differ from the one known by the client. For example, when using Kafka client libraries to communicate with Azure Event Hubs, the `messaging.system` is set to `kafka` based on the instrumentation's best knowledge + # An identifier for the messaging system being used. See below for a list of well-known identifiers # # @note StabilityLevel.EXPERIMENTAL MESSAGING_SYSTEM = 'messaging.system' diff --git a/semantic_conventions/lib/opentelemetry/semantic_candidates/attributes/net.rb b/semantic_conventions/lib/opentelemetry/semantic_candidates/attributes/net.rb index 11ebe26010..f0c8563fbb 100644 --- a/semantic_conventions/lib/opentelemetry/semantic_candidates/attributes/net.rb +++ b/semantic_conventions/lib/opentelemetry/semantic_candidates/attributes/net.rb @@ -23,13 +23,6 @@ module SemanticCandidates module NET # @!group Attribute Names - # Deprecated, use `network.local.address` - # - # @note StabilityLevel.EXPERIMENTAL - # - # @deprecated Replaced by `network.local.address` - NET_HOST_IP = 'net.host.ip' - # Deprecated, use `server.address` # # @note StabilityLevel.EXPERIMENTAL @@ -44,13 +37,6 @@ module NET # @deprecated Replaced by `server.port` NET_HOST_PORT = 'net.host.port' - # Deprecated, use `network.peer.address` - # - # @note StabilityLevel.EXPERIMENTAL - # - # @deprecated Replaced by `network.peer.address` - NET_PEER_IP = 'net.peer.ip' - # Deprecated, use `server.address` on client spans and `client.address` on server spans # # @note StabilityLevel.EXPERIMENTAL diff --git a/semantic_conventions/lib/opentelemetry/semantic_candidates/attributes/other.rb b/semantic_conventions/lib/opentelemetry/semantic_candidates/attributes/other.rb index d31a16a7e4..235764c7d8 100644 --- a/semantic_conventions/lib/opentelemetry/semantic_candidates/attributes/other.rb +++ b/semantic_conventions/lib/opentelemetry/semantic_candidates/attributes/other.rb @@ -23,11 +23,9 @@ module SemanticCandidates module OTHER # @!group Attribute Names - # Deprecated, use `db.client.connections.state` instead + # The state of a connection in the pool # # @note StabilityLevel.EXPERIMENTAL - # - # @deprecated Replaced by `db.client.connections.state` STATE = 'state' # @!endgroup diff --git a/semantic_conventions/lib/opentelemetry/semantic_candidates/attributes/pool.rb b/semantic_conventions/lib/opentelemetry/semantic_candidates/attributes/pool.rb index ad0fc9ed49..d1e3306983 100644 --- a/semantic_conventions/lib/opentelemetry/semantic_candidates/attributes/pool.rb +++ b/semantic_conventions/lib/opentelemetry/semantic_candidates/attributes/pool.rb @@ -23,11 +23,9 @@ module SemanticCandidates module POOL # @!group Attribute Names - # Deprecated, use `db.client.connections.pool.name` instead + # The name of the connection pool; unique within the instrumented application. In case the connection pool implementation doesn't provide a name, instrumentation should use a combination of `server.address` and `server.port` attributes formatted as `server.address:server.port` # # @note StabilityLevel.EXPERIMENTAL - # - # @deprecated Replaced by `db.client.connections.pool.name` POOL_NAME = 'pool.name' # @!endgroup diff --git a/semantic_conventions/lib/opentelemetry/semantic_candidates/attributes/process.rb b/semantic_conventions/lib/opentelemetry/semantic_candidates/attributes/process.rb index a1e7c21fbb..80227ed8e2 100644 --- a/semantic_conventions/lib/opentelemetry/semantic_candidates/attributes/process.rb +++ b/semantic_conventions/lib/opentelemetry/semantic_candidates/attributes/process.rb @@ -43,16 +43,11 @@ module PROCESS # @note StabilityLevel.EXPERIMENTAL PROCESS_CONTEXT_SWITCH_TYPE = 'process.context_switch_type' - # The CPU state of the process + # The CPU state for this data point. A process SHOULD be characterized _either_ by data points with no `state` labels, _or only_ data points with `state` labels # # @note StabilityLevel.EXPERIMENTAL PROCESS_CPU_STATE = 'process.cpu.state' - # The date and time the process was created, in ISO 8601 format - # - # @note StabilityLevel.EXPERIMENTAL - PROCESS_CREATION_TIME = 'process.creation.time' - # 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` # # @note StabilityLevel.EXPERIMENTAL @@ -63,26 +58,6 @@ module PROCESS # @note StabilityLevel.EXPERIMENTAL PROCESS_EXECUTABLE_PATH = 'process.executable.path' - # The exit code of the process - # - # @note StabilityLevel.EXPERIMENTAL - PROCESS_EXIT_CODE = 'process.exit.code' - - # The date and time the process exited, in ISO 8601 format - # - # @note StabilityLevel.EXPERIMENTAL - PROCESS_EXIT_TIME = 'process.exit.time' - - # The PID of the process's group leader. This is also the process group ID (PGID) of the process - # - # @note StabilityLevel.EXPERIMENTAL - PROCESS_GROUP_LEADER_PID = 'process.group_leader.pid' - - # Whether the process is connected to an interactive shell - # - # @note StabilityLevel.EXPERIMENTAL - PROCESS_INTERACTIVE = 'process.interactive' - # The username of the user that owns the process # # @note StabilityLevel.EXPERIMENTAL @@ -103,16 +78,6 @@ module PROCESS # @note StabilityLevel.EXPERIMENTAL PROCESS_PID = 'process.pid' - # The real user ID (RUID) of the process - # - # @note StabilityLevel.EXPERIMENTAL - PROCESS_REAL_USER_ID = 'process.real_user.id' - - # The username of the real user of the process - # - # @note StabilityLevel.EXPERIMENTAL - PROCESS_REAL_USER_NAME = 'process.real_user.name' - # An additional description about the runtime of the process, for example a specific vendor customization of the runtime environment # # @note StabilityLevel.EXPERIMENTAL @@ -128,38 +93,6 @@ module PROCESS # @note StabilityLevel.EXPERIMENTAL PROCESS_RUNTIME_VERSION = 'process.runtime.version' - # The saved user ID (SUID) of the process - # - # @note StabilityLevel.EXPERIMENTAL - PROCESS_SAVED_USER_ID = 'process.saved_user.id' - - # The username of the saved user - # - # @note StabilityLevel.EXPERIMENTAL - PROCESS_SAVED_USER_NAME = 'process.saved_user.name' - - # The PID of the process's session leader. This is also the session ID (SID) of the process - # - # @note StabilityLevel.EXPERIMENTAL - PROCESS_SESSION_LEADER_PID = 'process.session_leader.pid' - - # The effective user ID (EUID) of the process - # - # @note StabilityLevel.EXPERIMENTAL - PROCESS_USER_ID = 'process.user.id' - - # The username of the effective user of the process - # - # @note StabilityLevel.EXPERIMENTAL - PROCESS_USER_NAME = 'process.user.name' - - # Virtual process identifier - # - # The process ID within a PID namespace. This is not necessarily unique across all processes on the host but it is unique within the process namespace that the process exists within - # - # @note StabilityLevel.EXPERIMENTAL - PROCESS_VPID = 'process.vpid' - # @!endgroup end end diff --git a/semantic_conventions/lib/opentelemetry/semantic_candidates/attributes/rpc.rb b/semantic_conventions/lib/opentelemetry/semantic_candidates/attributes/rpc.rb index 9436ba19ed..d53959fd47 100644 --- a/semantic_conventions/lib/opentelemetry/semantic_candidates/attributes/rpc.rb +++ b/semantic_conventions/lib/opentelemetry/semantic_candidates/attributes/rpc.rb @@ -81,28 +81,6 @@ module RPC # @note StabilityLevel.EXPERIMENTAL RPC_JSONRPC_VERSION = 'rpc.jsonrpc.version' - # Compressed size of the message in bytes - # - # @note StabilityLevel.EXPERIMENTAL - RPC_MESSAGE_COMPRESSED_SIZE = 'rpc.message.compressed_size' - - # MUST be calculated as two different counters starting from `1` one for sent messages and one for received message - # - # This way we guarantee that the values will be consistent between different implementations - # - # @note StabilityLevel.EXPERIMENTAL - RPC_MESSAGE_ID = 'rpc.message.id' - - # Whether this is a received or sent message - # - # @note StabilityLevel.EXPERIMENTAL - RPC_MESSAGE_TYPE = 'rpc.message.type' - - # Uncompressed size of the message in bytes - # - # @note StabilityLevel.EXPERIMENTAL - RPC_MESSAGE_UNCOMPRESSED_SIZE = 'rpc.message.uncompressed_size' - # The name of the (logical) method being called, must be equal to the $method part in the span name # # This is the logical name of the method from the RPC interface perspective, which can be different from the name of any implementing method/function. The `code.function` attribute may be used to store the latter (e.g., method actually executing the call on the server side, RPC client stub method on the client side) diff --git a/semantic_conventions/lib/opentelemetry/semantic_candidates/attributes/service.rb b/semantic_conventions/lib/opentelemetry/semantic_candidates/attributes/service.rb index 093e55ad6a..4ea0ee2f69 100644 --- a/semantic_conventions/lib/opentelemetry/semantic_candidates/attributes/service.rb +++ b/semantic_conventions/lib/opentelemetry/semantic_candidates/attributes/service.rb @@ -57,7 +57,7 @@ module SERVICE # Logical name of the service # - # MUST be the same for all instances of horizontally scaled services. If the value was not specified, SDKs MUST fallback to `unknown_service:` concatenated with [`process.executable.name`](process.md), e.g. `unknown_service:bash`. If `process.executable.name` is not available, the value MUST be set to `unknown_service` + # 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` # # @note StabilityLevel.STABLE # diff --git a/semantic_conventions/lib/opentelemetry/semantic_candidates/attributes/system.rb b/semantic_conventions/lib/opentelemetry/semantic_candidates/attributes/system.rb index 1fd29db5c0..c8dc6d1789 100644 --- a/semantic_conventions/lib/opentelemetry/semantic_candidates/attributes/system.rb +++ b/semantic_conventions/lib/opentelemetry/semantic_candidates/attributes/system.rb @@ -28,7 +28,7 @@ module SYSTEM # @note StabilityLevel.EXPERIMENTAL SYSTEM_CPU_LOGICAL_NUMBER = 'system.cpu.logical_number' - # The state of the CPU + # The CPU state for this data point. A system's CPU SHOULD be characterized *either* by data points with no `state` labels, *or only* data points with `state` labels # # @note StabilityLevel.EXPERIMENTAL SYSTEM_CPU_STATE = 'system.cpu.state' diff --git a/semantic_conventions/lib/opentelemetry/semantic_candidates/attributes/url.rb b/semantic_conventions/lib/opentelemetry/semantic_candidates/attributes/url.rb index a994db7266..f87dd62874 100644 --- a/semantic_conventions/lib/opentelemetry/semantic_candidates/attributes/url.rb +++ b/semantic_conventions/lib/opentelemetry/semantic_candidates/attributes/url.rb @@ -107,11 +107,6 @@ module URL # @note StabilityLevel.EXPERIMENTAL URL_SUBDOMAIN = 'url.subdomain' - # The low-cardinality template of an [absolute path reference](https://www.rfc-editor.org/rfc/rfc3986#section-4.2) - # - # @note StabilityLevel.EXPERIMENTAL - 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](http://publicsuffix.org) diff --git a/semantic_conventions/lib/opentelemetry/semantic_conventions/attributes/error.rb b/semantic_conventions/lib/opentelemetry/semantic_conventions/attributes/error.rb index acdb5bc119..62ed6042ae 100644 --- a/semantic_conventions/lib/opentelemetry/semantic_conventions/attributes/error.rb +++ b/semantic_conventions/lib/opentelemetry/semantic_conventions/attributes/error.rb @@ -25,11 +25,7 @@ module ERROR # Describes a class of error the operation ended with # - # The `error.type` SHOULD be predictable, and SHOULD have low cardinality. - # - # When `error.type` is set to a type (e.g., an exception type), its - # canonical class name identifying the type within the artifact SHOULD be used. - # + # The `error.type` SHOULD be predictable and SHOULD have low cardinality. # Instrumentations SHOULD document the list of errors they report. # # The cardinality of `error.type` within one instrumentation library SHOULD be low. diff --git a/semantic_conventions/lib/opentelemetry/semantic_conventions/attributes/exception.rb b/semantic_conventions/lib/opentelemetry/semantic_conventions/attributes/exception.rb index 436d6f0694..91638a547b 100644 --- a/semantic_conventions/lib/opentelemetry/semantic_conventions/attributes/exception.rb +++ b/semantic_conventions/lib/opentelemetry/semantic_conventions/attributes/exception.rb @@ -35,7 +35,7 @@ module EXCEPTION # whether it will escape the scope of a span. # However, it is trivial to know that an exception # will escape, if one checks for an active exception just before ending the span, - # as done in the [example for recording span exceptions](https://opentelemetry.io/docs/specs/semconv/exceptions/exceptions-spans/#recording-an-exception). + # as done in the [example for recording span exceptions](#recording-an-exception). # # It follows that an exception may still escape the scope of the span # even if the `exception.escaped` attribute was not set or set to false, diff --git a/semantic_conventions/lib/opentelemetry/semantic_conventions/attributes/service.rb b/semantic_conventions/lib/opentelemetry/semantic_conventions/attributes/service.rb index 5a679dc08c..d4aa987a9d 100644 --- a/semantic_conventions/lib/opentelemetry/semantic_conventions/attributes/service.rb +++ b/semantic_conventions/lib/opentelemetry/semantic_conventions/attributes/service.rb @@ -25,7 +25,7 @@ module SERVICE # Logical name of the service # - # MUST be the same for all instances of horizontally scaled services. If the value was not specified, SDKs MUST fallback to `unknown_service:` concatenated with [`process.executable.name`](process.md), e.g. `unknown_service:bash`. If `process.executable.name` is not available, the value MUST be set to `unknown_service` + # 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` # # @note StabilityLevel.STABLE SERVICE_NAME = 'service.name' diff --git a/semantic_conventions/lib/opentelemetry/semantic_conventions/version.rb b/semantic_conventions/lib/opentelemetry/semantic_conventions/version.rb index 47751f20d0..4f00687755 100644 --- a/semantic_conventions/lib/opentelemetry/semantic_conventions/version.rb +++ b/semantic_conventions/lib/opentelemetry/semantic_conventions/version.rb @@ -6,6 +6,6 @@ module OpenTelemetry module SemanticConventions - VERSION = '1.26.0' + VERSION = '1.25.0' end end From b9825400f70822073d1590d34d403c747ef1c8ab Mon Sep 17 00:00:00 2001 From: Robb Kidd Date: Fri, 12 Jul 2024 11:57:54 -0400 Subject: [PATCH 08/17] add/expand doc comments on top-level modules Explain the auto-generated situation. --- .../lib/opentelemetry/semantic_candidates.rb | 19 +++++++++++++++++++ .../lib/opentelemetry/semantic_conventions.rb | 10 +++++++++- 2 files changed, 28 insertions(+), 1 deletion(-) create mode 100644 semantic_conventions/lib/opentelemetry/semantic_candidates.rb diff --git a/semantic_conventions/lib/opentelemetry/semantic_candidates.rb b/semantic_conventions/lib/opentelemetry/semantic_candidates.rb new file mode 100644 index 0000000000..a57863c083 --- /dev/null +++ b/semantic_conventions/lib/opentelemetry/semantic_candidates.rb @@ -0,0 +1,19 @@ +# frozen_string_literal: true + +# Copyright The OpenTelemetry Authors +# +# SPDX-License-Identifier: Apache-2.0 + +module OpenTelemetry + # OpenTelemetry semantic convention attribute names as constants. + # These are auto-generated from source YAML in {https://github.com/open-telemetry/semantic-conventions the semantic-conventions repository}. + # + # The constants in this namespace are all of the attribute names at all stability levels present in the OpenTelemetry semantic conventions as of {SemanticConventions::VERSION}. + # + # @note The constants here ought to remain within major versions of this library. + # However, there risk with auto-generated code. + # The maintainers try to prevent constants disappearing, but we cannot gaurantee this. + # We strongly recommend that any constants you use in your code are exercised in your test suite to catch missing constants before release or production runtime. + module SemanticCandidates + end +end diff --git a/semantic_conventions/lib/opentelemetry/semantic_conventions.rb b/semantic_conventions/lib/opentelemetry/semantic_conventions.rb index 0cd4a6cdec..29de270572 100644 --- a/semantic_conventions/lib/opentelemetry/semantic_conventions.rb +++ b/semantic_conventions/lib/opentelemetry/semantic_conventions.rb @@ -5,7 +5,15 @@ # SPDX-License-Identifier: Apache-2.0 module OpenTelemetry - # Auto-generated semantic convention constants. + # OpenTelemetry semantic convention attribute names as constants. + # These are auto-generated from source YAML in {https://github.com/open-telemetry/semantic-conventions the semantic-conventions repository}. + # + # Except for the {Resource} and {Trace} modules, constants in this namespace have been declared stable by the OpenTelemetry semantic conventions working group. + # + # @note The constants here ought to remain within major versions of this library. + # However, there risk with auto-generated code. + # The maintainers try to prevent constants disappearing, but we cannot gaurantee this. + # We strongly recommend that any constants you use in your code are exercised in your test suite to catch missing constants before release or production runtime. module SemanticConventions end end From dc42bf59e86b8ef767ab435a92d19646a04ceab6 Mon Sep 17 00:00:00 2001 From: Robb Kidd Date: Fri, 12 Jul 2024 12:04:51 -0400 Subject: [PATCH 09/17] correct deprecation notices for several old names The v1.10 names whose comments were updated in this commit were renamed or removed in version 1.11-1.25. Made note of their replacements or that their use should be dropped. Removed test for one-to-one matching of 1.10 constants to 1.25 "all" constants. That will never pass without updating the source semconv YAML to add back the missing names with dep notices. I believe our dep notes will suffice and we won't auto-generate Resource or Trace again. --- .../semantic_conventions/resource.rb | 8 ++- .../semantic_conventions/trace.rb | 64 ++++++++++--------- .../semantic_conventions/attributes_test.rb | 22 +------ 3 files changed, 41 insertions(+), 53 deletions(-) diff --git a/semantic_conventions/lib/opentelemetry/semantic_conventions/resource.rb b/semantic_conventions/lib/opentelemetry/semantic_conventions/resource.rb index 2e2db40d1d..04a2bc43c5 100644 --- a/semantic_conventions/lib/opentelemetry/semantic_conventions/resource.rb +++ b/semantic_conventions/lib/opentelemetry/semantic_conventions/resource.rb @@ -6,6 +6,8 @@ module OpenTelemetry module SemanticConventions + # OpenTelemetry semantic conventions from v1.10. + # # @deprecated This module is deprecated in favor of the namespaced modules under # {OpenTelemetry::SemanticCandidates} (all experimental and stable) and # {OpenTelemetry::SemanticConventions} (stable) @@ -139,7 +141,7 @@ module Resource # Container image tag # # @deprecated The \{OpenTelemetry::SemanticConventions::Resource\} module is deprecated. - # See {OpenTelemetry::SemanticCandidates::CONTAINER::CONTAINER_IMAGE_TAG} for its replacement. + # See {OpenTelemetry::SemanticCandidates::CONTAINER::CONTAINER_IMAGE_TAGS} for its replacement. CONTAINER_IMAGE_TAG = 'container.image.tag' # Name of the [deployment environment](https://en.wikipedia.org/wiki/Deployment_environment) (aka deployment tier) @@ -200,7 +202,7 @@ module Resource # As an alternative, consider setting `faas.id` as a span attribute instead # # @deprecated The \{OpenTelemetry::SemanticConventions::Resource\} module is deprecated. - # See {OpenTelemetry::SemanticCandidates::FAAS::FAAS_ID} for its replacement. + # See {OpenTelemetry::SemanticCandidates::CLOUD::CLOUD_RESOURCE_ID} for its replacement. FAAS_ID = 'faas.id' # The immutable version of the function being executed @@ -526,7 +528,7 @@ module Resource # The version string of the auto instrumentation agent, if used # # @deprecated The \{OpenTelemetry::SemanticConventions::Resource\} module is deprecated. - # See {OpenTelemetry::SemanticCandidates::TELEMETRY::TELEMETRY_AUTO_VERSION} for its replacement. + # See {OpenTelemetry::SemanticCandidates::TELEMETRY::TELEMETRY_DISTRO_VERSION} for its replacement. TELEMETRY_AUTO_VERSION = 'telemetry.auto.version' # The name of the web engine diff --git a/semantic_conventions/lib/opentelemetry/semantic_conventions/trace.rb b/semantic_conventions/lib/opentelemetry/semantic_conventions/trace.rb index 788a53c6e4..0f72ce4223 100644 --- a/semantic_conventions/lib/opentelemetry/semantic_conventions/trace.rb +++ b/semantic_conventions/lib/opentelemetry/semantic_conventions/trace.rb @@ -6,6 +6,8 @@ module OpenTelemetry module SemanticConventions + # OpenTelemetry semantic conventions from v1.10. + # # @deprecated This module is deprecated in favor of the namespaced modules under # {OpenTelemetry::SemanticCandidates} (all experimental and stable) and # {OpenTelemetry::SemanticConventions} (stable) @@ -108,7 +110,7 @@ module Trace # Remote address of the peer (dotted decimal for IPv4 or [RFC5952](https://tools.ietf.org/html/rfc5952) for IPv6) # # @deprecated The \{OpenTelemetry::SemanticConventions::Trace\} module is deprecated. - # See {OpenTelemetry::SemanticCandidates::NET::NET_PEER_IP} for its replacement. + # See {OpenTelemetry::SemanticCandidates::NET::NET_SOCK_PEER_ADDR} for its replacement. NET_PEER_IP = 'net.peer.ip' # Remote port number @@ -250,7 +252,7 @@ module Trace # The execution ID of the current function execution # # @deprecated The \{OpenTelemetry::SemanticConventions::Trace\} module is deprecated. - # See {OpenTelemetry::SemanticCandidates::FAAS::FAAS_EXECUTION} for its replacement. + # See {OpenTelemetry::SemanticCandidates::FAAS::FAAS_INVOCATION_ID} for its replacement. FAAS_EXECUTION = 'faas.execution' # 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 @@ -300,7 +302,7 @@ module Trace # @note When the header is present but empty the attribute SHOULD be set to the empty string. Note that this is a valid situation that is expected in certain cases, according the aforementioned [section of RFC 7230](https://tools.ietf.org/html/rfc7230#section-5.4). When the header is not set the attribute MUST NOT be set # # @deprecated The \{OpenTelemetry::SemanticConventions::Trace\} module is deprecated. - # See {OpenTelemetry::SemanticCandidates::HTTP::HTTP_HOST} for its replacement. + # See {OpenTelemetry::SemanticCandidates::HTTP::HTTP_REQUEST_HEADER} for its replacement. HTTP_HOST = 'http.host' # The URI scheme identifying the used protocol @@ -337,7 +339,8 @@ module Trace # The size of the uncompressed request payload body after transport decoding. Not set if transport encoding not used # # @deprecated The \{OpenTelemetry::SemanticConventions::Trace\} module is deprecated. - # See {OpenTelemetry::SemanticCandidates::HTTP::HTTP_REQUEST_CONTENT_LENGTH_UNCOMPRESSED} for its replacement. + # There is no replacement. + # Consider using the bare content length with {OpenTelemetry::SemanticCandidates::HTTP::HTTP_REQUEST_CONTENT_LENGTH} instead. HTTP_REQUEST_CONTENT_LENGTH_UNCOMPRESSED = 'http.request_content_length_uncompressed' # 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 @@ -349,20 +352,21 @@ module Trace # The size of the uncompressed response payload body after transport decoding. Not set if transport encoding not used # # @deprecated The \{OpenTelemetry::SemanticConventions::Trace\} module is deprecated. - # See {OpenTelemetry::SemanticCandidates::HTTP::HTTP_RESPONSE_CONTENT_LENGTH_UNCOMPRESSED} for its replacement. + # There is no replacement. + # Consider using the bare content length with {OpenTelemetry::SemanticCandidates::HTTP::HTTP_RESPONSE_CONTENT_LENGTH} instead. HTTP_RESPONSE_CONTENT_LENGTH_UNCOMPRESSED = 'http.response_content_length_uncompressed' # The ordinal number of request re-sending attempt # # @deprecated The \{OpenTelemetry::SemanticConventions::Trace\} module is deprecated. - # See {OpenTelemetry::SemanticCandidates::HTTP::HTTP_RETRY_COUNT} for its replacement. + # See {OpenTelemetry::SemanticCandidates::HTTP::HTTP_REQUEST_RESEND_COUNT} for its replacement. HTTP_RETRY_COUNT = 'http.retry_count' # 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) # @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 # # @deprecated The \{OpenTelemetry::SemanticConventions::Trace\} module is deprecated. - # See {OpenTelemetry::SemanticCandidates::HTTP::HTTP_SERVER_NAME} for its replacement. + # See {OpenTelemetry::SemanticCandidates::NET::NET_HOST_NAME} for its replacement. HTTP_SERVER_NAME = 'http.server_name' # The matched route (path template) @@ -385,13 +389,13 @@ module Trace # the closest proxy # # @deprecated The \{OpenTelemetry::SemanticConventions::Trace\} module is deprecated. - # See {OpenTelemetry::SemanticCandidates::HTTP::HTTP_CLIENT_IP} for its replacement. + # See {OpenTelemetry::SemanticCandidates::CLIENT::CLIENT_ADDRESS} for its replacement. HTTP_CLIENT_IP = 'http.client_ip' # Like `net.peer.ip` but for the host IP. Useful in case of a multi-IP host # # @deprecated The \{OpenTelemetry::SemanticConventions::Trace\} module is deprecated. - # See {OpenTelemetry::SemanticCandidates::NET::NET_HOST_IP} for its replacement. + # See {OpenTelemetry::SemanticCandidates::NET::NET_SOCK_HOST_ADDR} for its replacement. NET_HOST_IP = 'net.host.ip' # Like `net.peer.port` but for the host port @@ -409,37 +413,37 @@ module Trace # The internet connection type currently being used by the host # # @deprecated The \{OpenTelemetry::SemanticConventions::Trace\} module is deprecated. - # See {OpenTelemetry::SemanticCandidates::NET::NET_HOST_CONNECTION_TYPE} for its replacement. + # See {OpenTelemetry::SemanticCandidates::NETWORK::NETWORK_CONNECTION_TYPE} for its replacement. NET_HOST_CONNECTION_TYPE = 'net.host.connection.type' # This describes more details regarding the connection.type. It may be the type of cell technology connection, but it could be used for describing details about a wifi connection # # @deprecated The \{OpenTelemetry::SemanticConventions::Trace\} module is deprecated. - # See {OpenTelemetry::SemanticCandidates::NET::NET_HOST_CONNECTION_SUBTYPE} for its replacement. + # See {OpenTelemetry::SemanticCandidates::NETWORK::NETWORK_CONNECTION_SUBTYPE} for its replacement. NET_HOST_CONNECTION_SUBTYPE = 'net.host.connection.subtype' # The name of the mobile carrier # # @deprecated The \{OpenTelemetry::SemanticConventions::Trace\} module is deprecated. - # See {OpenTelemetry::SemanticCandidates::NET::NET_HOST_CARRIER_NAME} for its replacement. + # See {OpenTelemetry::SemanticCandidates::NETWORK::NETWORK_CARRIER_NAME} for its replacement. NET_HOST_CARRIER_NAME = 'net.host.carrier.name' # The mobile carrier country code # # @deprecated The \{OpenTelemetry::SemanticConventions::Trace\} module is deprecated. - # See {OpenTelemetry::SemanticCandidates::NET::NET_HOST_CARRIER_MCC} for its replacement. + # See {OpenTelemetry::SemanticCandidates::NETWORK::NETWORK_CARRIER_MCC} for its replacement. NET_HOST_CARRIER_MCC = 'net.host.carrier.mcc' # The mobile carrier network code # # @deprecated The \{OpenTelemetry::SemanticConventions::Trace\} module is deprecated. - # See {OpenTelemetry::SemanticCandidates::NET::NET_HOST_CARRIER_MNC} for its replacement. + # See {OpenTelemetry::SemanticCandidates::NETWORK::NETWORK_CARRIER_MNC} for its replacement. NET_HOST_CARRIER_MNC = 'net.host.carrier.mnc' # The ISO 3166-1 alpha-2 2-character country code associated with the mobile carrier network # # @deprecated The \{OpenTelemetry::SemanticConventions::Trace\} module is deprecated. - # See {OpenTelemetry::SemanticCandidates::NET::NET_HOST_CARRIER_ICC} for its replacement. + # See {OpenTelemetry::SemanticCandidates::NETWORK::NETWORK_CARRIER_ICC} for its replacement. NET_HOST_CARRIER_ICC = 'net.host.carrier.icc' # A string identifying the messaging system @@ -451,37 +455,37 @@ module Trace # The message destination name. This might be equal to the span name but is required nevertheless # # @deprecated The \{OpenTelemetry::SemanticConventions::Trace\} module is deprecated. - # See {OpenTelemetry::SemanticCandidates::MESSAGING::MESSAGING_DESTINATION} for its replacement. + # See {OpenTelemetry::SemanticCandidates::MESSAGING::MESSAGING_DESTINATION_NAME} for its replacement. MESSAGING_DESTINATION = 'messaging.destination' # The kind of message destination # # @deprecated The \{OpenTelemetry::SemanticConventions::Trace\} module is deprecated. - # See {OpenTelemetry::SemanticCandidates::MESSAGING::MESSAGING_DESTINATION_KIND} for its replacement. + # This attribute was renamed in v1.17.0 and its replacement was removed in v1.20.0. MESSAGING_DESTINATION_KIND = 'messaging.destination_kind' # A boolean that is true if the message destination is temporary # # @deprecated The \{OpenTelemetry::SemanticConventions::Trace\} module is deprecated. - # See {OpenTelemetry::SemanticCandidates::MESSAGING::MESSAGING_TEMP_DESTINATION} for its replacement. + # See {OpenTelemetry::SemanticCandidates::MESSAGING::MESSAGING_DESTINATION_TEMPORARY} for its replacement. MESSAGING_TEMP_DESTINATION = 'messaging.temp_destination' # The name of the transport protocol # # @deprecated The \{OpenTelemetry::SemanticConventions::Trace\} module is deprecated. - # See {OpenTelemetry::SemanticCandidates::MESSAGING::MESSAGING_PROTOCOL} for its replacement. + # See {OpenTelemetry::SemanticCandidates::NET::NET_PROTOCOL_NAME} for its replacement. MESSAGING_PROTOCOL = 'messaging.protocol' # The version of the transport protocol # # @deprecated The \{OpenTelemetry::SemanticConventions::Trace\} module is deprecated. - # See {OpenTelemetry::SemanticCandidates::MESSAGING::MESSAGING_PROTOCOL_VERSION} for its replacement. + # See {OpenTelemetry::SemanticCandidates::NET::NET_PROTOCOL_VERSION} for its replacement. MESSAGING_PROTOCOL_VERSION = 'messaging.protocol_version' # Connection string # # @deprecated The \{OpenTelemetry::SemanticConventions::Trace\} module is deprecated. - # See {OpenTelemetry::SemanticCandidates::MESSAGING::MESSAGING_URL} for its replacement. + # This attribute was removed in v1.17.0. MESSAGING_URL = 'messaging.url' # A value used by the messaging system as an identifier for the message, represented as a string @@ -493,19 +497,19 @@ module Trace # The [conversation ID](#conversations) identifying the conversation to which the message belongs, represented as a string. Sometimes called "Correlation ID" # # @deprecated The \{OpenTelemetry::SemanticConventions::Trace\} module is deprecated. - # See {OpenTelemetry::SemanticCandidates::MESSAGING::MESSAGING_CONVERSATION_ID} for its replacement. + # See {OpenTelemetry::SemanticCandidates::MESSAGING::MESSAGING_MESSAGE_CONVERSATION_ID} for its replacement. MESSAGING_CONVERSATION_ID = 'messaging.conversation_id' # 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 # # @deprecated The \{OpenTelemetry::SemanticConventions::Trace\} module is deprecated. - # See {OpenTelemetry::SemanticCandidates::MESSAGING::MESSAGING_MESSAGE_PAYLOAD_SIZE_BYTES} for its replacement. + # See {OpenTelemetry::SemanticCandidates::MESSAGING::MESSAGING_MESSAGE_BODY_SIZE} for its replacement. MESSAGING_MESSAGE_PAYLOAD_SIZE_BYTES = 'messaging.message_payload_size_bytes' # The compressed size of the message payload in bytes # # @deprecated The \{OpenTelemetry::SemanticConventions::Trace\} module is deprecated. - # See {OpenTelemetry::SemanticCandidates::MESSAGING::MESSAGING_MESSAGE_PAYLOAD_COMPRESSED_SIZE_BYTES} for its replacement. + # This attribute was removed in v1.22.0. MESSAGING_MESSAGE_PAYLOAD_COMPRESSED_SIZE_BYTES = 'messaging.message_payload_compressed_size_bytes' # 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) @@ -768,13 +772,13 @@ module Trace # The identifier for the consumer receiving a message. For Kafka, set it to `{messaging.kafka.consumer_group} - {messaging.kafka.client_id}`, if both are present, or only `messaging.kafka.consumer_group`. For brokers, such as RabbitMQ and Artemis, set it to the `client_id` of the client consuming the message # # @deprecated The \{OpenTelemetry::SemanticConventions::Trace\} module is deprecated. - # See {OpenTelemetry::SemanticCandidates::MESSAGING::MESSAGING_CONSUMER_ID} for its replacement. + # See {OpenTelemetry::SemanticCandidates::MESSAGING::MESSAGING_CLIENT_ID} for its replacement. MESSAGING_CONSUMER_ID = 'messaging.consumer_id' # RabbitMQ message routing key # # @deprecated The \{OpenTelemetry::SemanticConventions::Trace\} module is deprecated. - # See {OpenTelemetry::SemanticCandidates::MESSAGING::MESSAGING_RABBITMQ_ROUTING_KEY} for its replacement. + # See {OpenTelemetry::SemanticCandidates::MESSAGING::MESSAGING_RABBITMQ_DESTINATION_ROUTING_KEY} for its replacement. MESSAGING_RABBITMQ_ROUTING_KEY = 'messaging.rabbitmq.routing_key' # 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 @@ -793,19 +797,19 @@ module Trace # Client Id for the Consumer or Producer that is handling the message # # @deprecated The \{OpenTelemetry::SemanticConventions::Trace\} module is deprecated. - # See {OpenTelemetry::SemanticCandidates::MESSAGING::MESSAGING_KAFKA_CLIENT_ID} for its replacement. + # See {OpenTelemetry::SemanticCandidates::MESSAGING::MESSAGING_CLIENT_ID} for its replacement. MESSAGING_KAFKA_CLIENT_ID = 'messaging.kafka.client_id' # Partition the message is sent to # # @deprecated The \{OpenTelemetry::SemanticConventions::Trace\} module is deprecated. - # See {OpenTelemetry::SemanticCandidates::MESSAGING::MESSAGING_KAFKA_PARTITION} for its replacement. + # See {OpenTelemetry::SemanticCandidates::MESSAGING::MESSAGING_KAFKA_DESTINATION_PARTITION} for its replacement. MESSAGING_KAFKA_PARTITION = 'messaging.kafka.partition' # A boolean that is true if the message is a tombstone # # @deprecated The \{OpenTelemetry::SemanticConventions::Trace\} module is deprecated. - # See {OpenTelemetry::SemanticCandidates::MESSAGING::MESSAGING_KAFKA_TOMBSTONE} for its replacement. + # See {OpenTelemetry::SemanticCandidates::MESSAGING::MESSAGING_KAFKA_MESSAGE_TOMBSTONE} for its replacement. MESSAGING_KAFKA_TOMBSTONE = 'messaging.kafka.tombstone' # Namespace of RocketMQ resources, resources in different namespaces are individual @@ -823,7 +827,7 @@ module Trace # The unique identifier for each client # # @deprecated The \{OpenTelemetry::SemanticConventions::Trace\} module is deprecated. - # See {OpenTelemetry::SemanticCandidates::MESSAGING::MESSAGING_ROCKETMQ_CLIENT_ID} for its replacement. + # See {OpenTelemetry::SemanticCandidates::MESSAGING::MESSAGING_CLIENT_ID} for its replacement. MESSAGING_ROCKETMQ_CLIENT_ID = 'messaging.rocketmq.client_id' # Type of message diff --git a/semantic_conventions/test/opentelemetry/semantic_conventions/attributes_test.rb b/semantic_conventions/test/opentelemetry/semantic_conventions/attributes_test.rb index d1c1027153..bfaed15a1e 100644 --- a/semantic_conventions/test/opentelemetry/semantic_conventions/attributes_test.rb +++ b/semantic_conventions/test/opentelemetry/semantic_conventions/attributes_test.rb @@ -9,35 +9,17 @@ OLD_SEMCONV_ROOTS = %i[Resource Trace].freeze describe OpenTelemetry::SemanticConventions do - OLD_SEMCONV_ROOTS - .each do |old_root| - describe "old root #{old_root} has a corresponding SemanticCandidates namespace and constant" do - OpenTelemetry::SemanticConventions - .const_get(old_root) - .constants - .each do |const| - it "(#{const})" do - root_namespace = const.to_s.split('_').first - assert OpenTelemetry::SemanticCandidates.constants.include?(root_namespace.to_sym), "Missing candidate namespace: #{root_namespace}" - - candidate_namespace = OpenTelemetry::SemanticCandidates.const_get(root_namespace.to_sym) - assert candidate_namespace.constants.include?(const), "Missing candidate constant: #{const}" - end - end - end - end - OpenTelemetry::SemanticConventions .constants .reject { |const| const == :VERSION } .reject { |root_namespace| OLD_SEMCONV_ROOTS.include?(root_namespace) } .each do |root_namespace| - describe "stable root (#{root_namespace})" do + describe "#{root_namespace} stable constants still exist in SemanticCandidates" do OpenTelemetry::SemanticConventions .const_get(root_namespace) .constants .each do |stable_const| - it "(#{stable_const})" do + it "#{stable_const}" do candidate_namespace = OpenTelemetry::SemanticCandidates.const_get(root_namespace) assert candidate_namespace.constants.include?(stable_const), "Missing stable constant in candidates: #{stable_const}" end From 9b268d1273bde35146dc29a3ea62907af3f3bee7 Mon Sep 17 00:00:00 2001 From: Robb Kidd Date: Fri, 12 Jul 2024 12:36:54 -0400 Subject: [PATCH 10/17] gitignore semconv repo clone; rake improvements * Move to a tmp/ dir and ignore that. * Update the git commands to be able to reuse one directory for the repo working copy, just update what's needed for a different tag between iterations. (Generally only an improvement for dev envs.) * Use sh() for shell commands so that tasks fail if their commands fail. * Appease Rubocop. --- semantic_conventions/.gitignore | 1 + semantic_conventions/Rakefile | 16 ++++++++-------- .../semantic_conventions/attributes_test.rb | 2 +- semantic_conventions/test/test_helper.rb | 2 +- 4 files changed, 11 insertions(+), 10 deletions(-) create mode 100644 semantic_conventions/.gitignore diff --git a/semantic_conventions/.gitignore b/semantic_conventions/.gitignore new file mode 100644 index 0000000000..3fec32c842 --- /dev/null +++ b/semantic_conventions/.gitignore @@ -0,0 +1 @@ +tmp/ diff --git a/semantic_conventions/Rakefile b/semantic_conventions/Rakefile index c38761be5d..12658b9f36 100644 --- a/semantic_conventions/Rakefile +++ b/semantic_conventions/Rakefile @@ -32,22 +32,22 @@ end SPEC_VERSION = '1.25.0' GENERATOR_VERSION = '0.24.0' -semconv_source_dir = Pathname.new("./tmpsemconvrepo_v#{SPEC_VERSION}") +semconv_source_dir = Pathname.new('./tmp/semconvrepo') conventions_output_dir = Pathname.new('./lib/opentelemetry/semantic_conventions') candidates_output_dir = Pathname.new('./lib/opentelemetry/semantic_candidates') -EXCLUDED_ATTRIBUTES = %w[] +EXCLUDED_ATTRIBUTES = %w[].freeze task generate: %i[update_gem_version generate_stable_attributes generate_candidate_attributes] directory semconv_source_dir do - `git clone --depth=1 --branch v#{SPEC_VERSION} https://github.com/open-telemetry/semantic-conventions.git #{semconv_source_dir}` + sh "git clone --tags --depth=1 --branch v#{SPEC_VERSION} https://github.com/open-telemetry/semantic-conventions.git #{semconv_source_dir}" end task check_out_semconv_version: [semconv_source_dir] do Dir.chdir(semconv_source_dir) do - `git fetch` - `git checkout "v#{SPEC_VERSION}"` + sh "git fetch --depth 1 origin tag v#{SPEC_VERSION}" + sh "git checkout 'v#{SPEC_VERSION}'" end end @@ -88,10 +88,10 @@ def semconvgen(semconv_source, output_root:, kind:, selector:) ] puts "Running: #{cmd.join(' ')}" - `#{cmd.join(' ')}` + sh cmd.join(' ') end task :update_gem_version do - `sed -i.bak "s/VERSION = '.*'/VERSION = '#{SPEC_VERSION}'/g" lib/opentelemetry/semantic_conventions/version.rb` - `rm lib/opentelemetry/semantic_conventions/version.rb.bak` + sh %(sed -i.bak "s/VERSION = '.*'/VERSION = '#{SPEC_VERSION}'/g" lib/opentelemetry/semantic_conventions/version.rb) + sh 'rm lib/opentelemetry/semantic_conventions/version.rb.bak' end diff --git a/semantic_conventions/test/opentelemetry/semantic_conventions/attributes_test.rb b/semantic_conventions/test/opentelemetry/semantic_conventions/attributes_test.rb index bfaed15a1e..58e153b303 100644 --- a/semantic_conventions/test/opentelemetry/semantic_conventions/attributes_test.rb +++ b/semantic_conventions/test/opentelemetry/semantic_conventions/attributes_test.rb @@ -19,7 +19,7 @@ .const_get(root_namespace) .constants .each do |stable_const| - it "#{stable_const}" do + it stable_const.to_s do candidate_namespace = OpenTelemetry::SemanticCandidates.const_get(root_namespace) assert candidate_namespace.constants.include?(stable_const), "Missing stable constant in candidates: #{stable_const}" end diff --git a/semantic_conventions/test/test_helper.rb b/semantic_conventions/test/test_helper.rb index e53c8ef6e8..43bd7417f3 100644 --- a/semantic_conventions/test/test_helper.rb +++ b/semantic_conventions/test/test_helper.rb @@ -13,4 +13,4 @@ require 'minitest/autorun' require 'pry' -Dir[File.join(File.dirname(__FILE__), '..', 'lib', 'opentelemetry', '**', '*.rb')].sort.each { |file| require file } +Dir[File.join(File.dirname(__FILE__), '..', 'lib', 'opentelemetry', '**', '*.rb')].each { |file| require file } From a64173454c00d2c5636c242827aba742e9279f4d Mon Sep 17 00:00:00 2001 From: Robb Kidd Date: Fri, 19 Jul 2024 13:58:27 -0400 Subject: [PATCH 11/17] typo/grammar corrections Co-authored-by: Kayla Reopelle <87386821+kaylareopelle@users.noreply.github.com> --- .../lib/opentelemetry/semantic_candidates.rb | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/semantic_conventions/lib/opentelemetry/semantic_candidates.rb b/semantic_conventions/lib/opentelemetry/semantic_candidates.rb index a57863c083..d314730e44 100644 --- a/semantic_conventions/lib/opentelemetry/semantic_candidates.rb +++ b/semantic_conventions/lib/opentelemetry/semantic_candidates.rb @@ -5,14 +5,14 @@ # SPDX-License-Identifier: Apache-2.0 module OpenTelemetry - # OpenTelemetry semantic convention attribute names as constants. + # OpenTelemetry Semantic Conventions attribute names as constants. # These are auto-generated from source YAML in {https://github.com/open-telemetry/semantic-conventions the semantic-conventions repository}. # # The constants in this namespace are all of the attribute names at all stability levels present in the OpenTelemetry semantic conventions as of {SemanticConventions::VERSION}. # # @note The constants here ought to remain within major versions of this library. - # However, there risk with auto-generated code. - # The maintainers try to prevent constants disappearing, but we cannot gaurantee this. + # However, there are risks with auto-generated code. + # The maintainers try to prevent constants disappearing, but we cannot guarantee this. # We strongly recommend that any constants you use in your code are exercised in your test suite to catch missing constants before release or production runtime. module SemanticCandidates end From 04466766d41c431ee4096b0aebed33a23f79bddd Mon Sep 17 00:00:00 2001 From: Robb Kidd Date: Thu, 11 Jul 2024 17:34:54 -0400 Subject: [PATCH 12/17] adds kramdown to dev dependencies Yard's default use of the rdoc markdown provider was choking on links containing codeblocks, for example: [`ENV`](link/to/somewhere). These style links are pretty popular in the text details provided with semconv attributes. Let's switch to kramdown which is a markdown parser and renderer that: * can handle inline code blocks inside a link anchor * is pure Ruby (no C extensions) so works with JRuby --- semantic_conventions/.yardopts | 1 + semantic_conventions/opentelemetry-semantic_conventions.gemspec | 1 + 2 files changed, 2 insertions(+) diff --git a/semantic_conventions/.yardopts b/semantic_conventions/.yardopts index fd17675afe..9f334b2d10 100644 --- a/semantic_conventions/.yardopts +++ b/semantic_conventions/.yardopts @@ -1,6 +1,7 @@ --no-private --title=OpenTelemetry Semantic Conventions --markup=markdown +--markup-provider=kramdown --main=README.md ./lib/opentelemetry/**/*.rb - diff --git a/semantic_conventions/opentelemetry-semantic_conventions.gemspec b/semantic_conventions/opentelemetry-semantic_conventions.gemspec index e09b108c86..09732536e0 100644 --- a/semantic_conventions/opentelemetry-semantic_conventions.gemspec +++ b/semantic_conventions/opentelemetry-semantic_conventions.gemspec @@ -28,6 +28,7 @@ Gem::Specification.new do |spec| spec.add_dependency 'opentelemetry-api', '~> 1.0' spec.add_development_dependency 'bundler', '>= 1.17' + spec.add_development_dependency 'kramdown', '~> 2.3' spec.add_development_dependency 'minitest', '~> 5.0' spec.add_development_dependency 'rake', '~> 12.0' spec.add_development_dependency 'rubocop', '~> 1.3' From 99788de48046177207675c19e3f2adf0bce86f81 Mon Sep 17 00:00:00 2001 From: Robb Kidd Date: Tue, 10 Sep 2024 17:20:15 -0400 Subject: [PATCH 13/17] reorg module namespaces * out with Candidates, we're using Incubating like most other SIGs * shorten the namespace to SemConv * do not provide an all-in-one rollup require for all namespaces; downstream users must directly require the namespaces that they use * attributes that are templates (prefixes, really, for the moment) are generated as lambdas with _LAMBDA appended to their name; users must call that lambda with a key for the template to return the attribute name string --- semantic_conventions/Rakefile | 26 +++--- .../lib/opentelemetry/semantic_candidates.rb | 19 ---- .../lib/opentelemetry/semantic_conventions.rb | 4 +- .../attributes => semconv}/aspnetcore.rb | 21 +++-- .../attributes => semconv}/client.rb | 11 ++- .../attributes => semconv}/error.rb | 9 +- .../attributes => semconv}/exception.rb | 15 +-- .../attributes => semconv}/http.rb | 25 ++--- .../incubating}/android.rb | 13 ++- .../incubating}/aspnetcore.rb | 37 ++++---- .../attributes => semconv/incubating}/aws.rb | 93 ++++++++++--------- .../incubating}/browser.rb | 17 ++-- .../incubating}/client.rb | 17 ++-- .../incubating}/cloud.rb | 21 +++-- .../incubating}/cloudevents.rb | 19 ++-- .../attributes => semconv/incubating}/code.rb | 21 +++-- .../incubating}/container.rb | 39 ++++---- .../attributes => semconv/incubating}/db.rb | 71 +++++++------- .../incubating}/deployment.rb | 11 ++- .../incubating}/destination.rb | 13 ++- .../incubating}/device.rb | 17 ++-- .../attributes => semconv/incubating}/disk.rb | 11 ++- .../attributes => semconv/incubating}/dns.rb | 11 ++- .../incubating}/enduser.rb | 15 ++- .../incubating}/error.rb | 13 ++- .../incubating}/event.rb | 11 ++- .../incubating}/exception.rb | 25 +++-- .../attributes => semconv/incubating}/faas.rb | 41 ++++---- .../incubating}/feature_flag.rb | 15 ++- .../attributes => semconv/incubating}/file.rb | 19 ++-- .../attributes => semconv/incubating}/gcp.rb | 17 ++-- .../incubating}/graphql.rb | 15 ++- .../incubating}/heroku.rb | 15 ++- .../attributes => semconv/incubating}/host.rb | 39 ++++---- .../attributes => semconv/incubating}/http.rb | 69 +++++++------- .../attributes => semconv/incubating}/ios.rb | 11 ++- .../attributes => semconv/incubating}/jvm.rb | 35 ++++--- .../attributes => semconv/incubating}/k8s.rb | 63 +++++++------ .../attributes => semconv/incubating}/log.rb | 21 +++-- .../incubating}/message.rb | 17 ++-- .../incubating}/messaging.rb | 85 +++++++++-------- .../attributes => semconv/incubating}/net.rb | 35 ++++--- .../incubating}/network.rb | 55 ++++++----- .../attributes => semconv/incubating}/oci.rb | 11 ++- .../incubating}/opentracing.rb | 11 ++- .../attributes => semconv/incubating}/os.rb | 19 ++-- .../attributes => semconv/incubating}/otel.rb | 29 +++--- .../incubating}/other.rb | 11 ++- .../attributes => semconv/incubating}/peer.rb | 11 ++- .../attributes => semconv/incubating}/pool.rb | 11 ++- .../incubating}/process.rb | 37 ++++---- .../attributes => semconv/incubating}/rpc.rb | 43 +++++---- .../incubating}/server.rb | 17 ++-- .../incubating}/service.rb | 21 +++-- .../incubating}/session.rb | 13 ++- .../incubating}/signalr.rb | 17 ++-- .../incubating}/source.rb | 13 ++- .../incubating}/system.rb | 37 ++++---- .../incubating}/telemetry.rb | 25 +++-- .../incubating}/thread.rb | 13 ++- .../attributes => semconv/incubating}/tls.rb | 67 ++++++------- .../attributes => semconv/incubating}/url.rb | 43 +++++---- .../incubating}/user_agent.rb | 17 ++-- .../incubating}/webengine.rb | 15 ++- .../attributes => semconv}/jvm.rb | 19 ++-- .../attributes => semconv}/network.rb | 23 +++-- .../attributes => semconv}/otel.rb | 15 +-- .../attributes => semconv}/server.rb | 11 ++- .../attributes => semconv}/service.rb | 11 ++- .../attributes => semconv}/signalr.rb | 11 ++- .../attributes => semconv}/telemetry.rb | 13 ++- .../attributes => semconv}/url.rb | 17 ++-- .../attributes => semconv}/user_agent.rb | 9 +- semantic_conventions/templates/attributes.j2 | 38 +++++--- 74 files changed, 1057 insertions(+), 748 deletions(-) delete mode 100644 semantic_conventions/lib/opentelemetry/semantic_candidates.rb rename semantic_conventions/lib/opentelemetry/{semantic_conventions/attributes => semconv}/aspnetcore.rb (95%) rename semantic_conventions/lib/opentelemetry/{semantic_conventions/attributes => semconv}/client.rb (94%) rename semantic_conventions/lib/opentelemetry/{semantic_conventions/attributes => semconv}/error.rb (95%) rename semantic_conventions/lib/opentelemetry/{semantic_conventions/attributes => semconv}/exception.rb (96%) rename semantic_conventions/lib/opentelemetry/{semantic_conventions/attributes => semconv}/http.rb (95%) rename semantic_conventions/lib/opentelemetry/{semantic_candidates/attributes => semconv/incubating}/android.rb (91%) rename semantic_conventions/lib/opentelemetry/{semantic_candidates/attributes => semconv/incubating}/aspnetcore.rb (80%) rename semantic_conventions/lib/opentelemetry/{semantic_candidates/attributes => semconv/incubating}/aws.rb (98%) rename semantic_conventions/lib/opentelemetry/{semantic_candidates/attributes => semconv/incubating}/browser.rb (94%) rename semantic_conventions/lib/opentelemetry/{semantic_candidates/attributes => semconv/incubating}/client.rb (88%) rename semantic_conventions/lib/opentelemetry/{semantic_candidates/attributes => semconv/incubating}/cloud.rb (96%) rename semantic_conventions/lib/opentelemetry/{semantic_candidates/attributes => semconv/incubating}/cloudevents.rb (93%) rename semantic_conventions/lib/opentelemetry/{semantic_candidates/attributes => semconv/incubating}/code.rb (93%) rename semantic_conventions/lib/opentelemetry/{semantic_candidates/attributes => semconv/incubating}/container.rb (93%) rename semantic_conventions/lib/opentelemetry/{semantic_candidates/attributes => semconv/incubating}/db.rb (96%) rename semantic_conventions/lib/opentelemetry/{semantic_candidates/attributes => semconv/incubating}/deployment.rb (91%) rename semantic_conventions/lib/opentelemetry/{semantic_candidates/attributes => semconv/incubating}/destination.rb (90%) rename semantic_conventions/lib/opentelemetry/{semantic_candidates/attributes => semconv/incubating}/device.rb (94%) rename semantic_conventions/lib/opentelemetry/{semantic_candidates/attributes => semconv/incubating}/disk.rb (87%) rename semantic_conventions/lib/opentelemetry/{semantic_candidates/attributes => semconv/incubating}/dns.rb (90%) rename semantic_conventions/lib/opentelemetry/{semantic_candidates/attributes => semconv/incubating}/enduser.rb (92%) rename semantic_conventions/lib/opentelemetry/{semantic_candidates/attributes => semconv/incubating}/error.rb (91%) rename semantic_conventions/lib/opentelemetry/{semantic_candidates/attributes => semconv/incubating}/event.rb (90%) rename semantic_conventions/lib/opentelemetry/{semantic_candidates/attributes => semconv/incubating}/exception.rb (89%) rename semantic_conventions/lib/opentelemetry/{semantic_candidates/attributes => semconv/incubating}/faas.rb (97%) rename semantic_conventions/lib/opentelemetry/{semantic_candidates/attributes => semconv/incubating}/feature_flag.rb (92%) rename semantic_conventions/lib/opentelemetry/{semantic_candidates/attributes => semconv/incubating}/file.rb (92%) rename semantic_conventions/lib/opentelemetry/{semantic_candidates/attributes => semconv/incubating}/gcp.rb (94%) rename semantic_conventions/lib/opentelemetry/{semantic_candidates/attributes => semconv/incubating}/graphql.rb (90%) rename semantic_conventions/lib/opentelemetry/{semantic_candidates/attributes => semconv/incubating}/heroku.rb (90%) rename semantic_conventions/lib/opentelemetry/{semantic_candidates/attributes => semconv/incubating}/host.rb (96%) rename semantic_conventions/lib/opentelemetry/{semantic_candidates/attributes => semconv/incubating}/http.rb (92%) rename semantic_conventions/lib/opentelemetry/{semantic_candidates/attributes => semconv/incubating}/ios.rb (90%) rename semantic_conventions/lib/opentelemetry/{semantic_candidates/attributes => semconv/incubating}/jvm.rb (87%) rename semantic_conventions/lib/opentelemetry/{semantic_candidates/attributes => semconv/incubating}/k8s.rb (93%) rename semantic_conventions/lib/opentelemetry/{semantic_candidates/attributes => semconv/incubating}/log.rb (93%) rename semantic_conventions/lib/opentelemetry/{semantic_candidates/attributes => semconv/incubating}/message.rb (91%) rename semantic_conventions/lib/opentelemetry/{semantic_candidates/attributes => semconv/incubating}/messaging.rb (97%) rename semantic_conventions/lib/opentelemetry/{semantic_candidates/attributes => semconv/incubating}/net.rb (95%) rename semantic_conventions/lib/opentelemetry/{semantic_candidates/attributes => semconv/incubating}/network.rb (88%) rename semantic_conventions/lib/opentelemetry/{semantic_candidates/attributes => semconv/incubating}/oci.rb (91%) rename semantic_conventions/lib/opentelemetry/{semantic_candidates/attributes => semconv/incubating}/opentracing.rb (88%) rename semantic_conventions/lib/opentelemetry/{semantic_candidates/attributes => semconv/incubating}/os.rb (92%) rename semantic_conventions/lib/opentelemetry/{semantic_candidates/attributes => semconv/incubating}/otel.rb (86%) rename semantic_conventions/lib/opentelemetry/{semantic_candidates/attributes => semconv/incubating}/other.rb (87%) rename semantic_conventions/lib/opentelemetry/{semantic_candidates/attributes => semconv/incubating}/peer.rb (89%) rename semantic_conventions/lib/opentelemetry/{semantic_candidates/attributes => semconv/incubating}/pool.rb (89%) rename semantic_conventions/lib/opentelemetry/{semantic_candidates/attributes => semconv/incubating}/process.rb (96%) rename semantic_conventions/lib/opentelemetry/{semantic_candidates/attributes => semconv/incubating}/rpc.rb (90%) rename semantic_conventions/lib/opentelemetry/{semantic_candidates/attributes => semconv/incubating}/server.rb (88%) rename semantic_conventions/lib/opentelemetry/{semantic_candidates/attributes => semconv/incubating}/service.rb (95%) rename semantic_conventions/lib/opentelemetry/{semantic_candidates/attributes => semconv/incubating}/session.rb (88%) rename semantic_conventions/lib/opentelemetry/{semantic_candidates/attributes => semconv/incubating}/signalr.rb (84%) rename semantic_conventions/lib/opentelemetry/{semantic_candidates/attributes => semconv/incubating}/source.rb (90%) rename semantic_conventions/lib/opentelemetry/{semantic_candidates/attributes => semconv/incubating}/system.rb (94%) rename semantic_conventions/lib/opentelemetry/{semantic_candidates/attributes => semconv/incubating}/telemetry.rb (89%) rename semantic_conventions/lib/opentelemetry/{semantic_candidates/attributes => semconv/incubating}/thread.rb (88%) rename semantic_conventions/lib/opentelemetry/{semantic_candidates/attributes => semconv/incubating}/tls.rb (97%) rename semantic_conventions/lib/opentelemetry/{semantic_candidates/attributes => semconv/incubating}/url.rb (94%) rename semantic_conventions/lib/opentelemetry/{semantic_candidates/attributes => semconv/incubating}/user_agent.rb (91%) rename semantic_conventions/lib/opentelemetry/{semantic_candidates/attributes => semconv/incubating}/webengine.rb (89%) rename semantic_conventions/lib/opentelemetry/{semantic_conventions/attributes => semconv}/jvm.rb (95%) rename semantic_conventions/lib/opentelemetry/{semantic_conventions/attributes => semconv}/network.rb (96%) rename semantic_conventions/lib/opentelemetry/{semantic_conventions/attributes => semconv}/otel.rb (94%) rename semantic_conventions/lib/opentelemetry/{semantic_conventions/attributes => semconv}/server.rb (94%) rename semantic_conventions/lib/opentelemetry/{semantic_conventions/attributes => semconv}/service.rb (94%) rename semantic_conventions/lib/opentelemetry/{semantic_conventions/attributes => semconv}/signalr.rb (92%) rename semantic_conventions/lib/opentelemetry/{semantic_conventions/attributes => semconv}/telemetry.rb (94%) rename semantic_conventions/lib/opentelemetry/{semantic_conventions/attributes => semconv}/url.rb (96%) rename semantic_conventions/lib/opentelemetry/{semantic_conventions/attributes => semconv}/user_agent.rb (91%) diff --git a/semantic_conventions/Rakefile b/semantic_conventions/Rakefile index 12658b9f36..d9d19a6929 100644 --- a/semantic_conventions/Rakefile +++ b/semantic_conventions/Rakefile @@ -33,12 +33,12 @@ end SPEC_VERSION = '1.25.0' GENERATOR_VERSION = '0.24.0' semconv_source_dir = Pathname.new('./tmp/semconvrepo') -conventions_output_dir = Pathname.new('./lib/opentelemetry/semantic_conventions') -candidates_output_dir = Pathname.new('./lib/opentelemetry/semantic_candidates') +conventions_output_dir = Pathname.new('./lib/opentelemetry/semconv') +incubating_output_dir = Pathname.new('./lib/opentelemetry/semconv/incubating') EXCLUDED_ATTRIBUTES = %w[].freeze -task generate: %i[update_gem_version generate_stable_attributes generate_candidate_attributes] +task generate: %i[update_gem_version generate_stable generate_incubating] directory semconv_source_dir do sh "git clone --tags --depth=1 --branch v#{SPEC_VERSION} https://github.com/open-telemetry/semantic-conventions.git #{semconv_source_dir}" @@ -51,26 +51,24 @@ task check_out_semconv_version: [semconv_source_dir] do end end -task generate_stable_attributes: [:check_out_semconv_version] do +task generate_stable: [:check_out_semconv_version] do conventions_output_dir - .join('attributes') .glob('*.rb') .then { |files| FileUtils.rm(files) } - semconvgen(semconv_source_dir, output_root: conventions_output_dir, kind: 'attributes', selector: 'is_stable') + semconvgen(semconv_source_dir, output_root: conventions_output_dir, selector: 'is_stable') end -task generate_candidate_attributes: [:check_out_semconv_version] do - candidates_output_dir - .join('attributes') +task generate_incubating: [:check_out_semconv_version] do + incubating_output_dir .glob('*.rb') .then { |files| FileUtils.rm(files) } - semconvgen(semconv_source_dir, output_root: candidates_output_dir, kind: 'attributes', selector: 'any') + semconvgen(semconv_source_dir, output_root: incubating_output_dir, selector: 'any') end -def semconvgen(semconv_source, output_root:, kind:, selector:) - mkdir_p output_root + kind +def semconvgen(semconv_source, output_root:, selector:) + FileUtils.mkdir_p(output_root) cwd = Dir.pwd - output_filenames_template = Pathname.new('/output').join(output_root, kind, '{{snake_prefix}}.rb') + output_filenames_template = Pathname.new('/output').join(output_root, '{{snake_prefix}}.rb') cmd = %W[ docker run --rm -v "#{semconv_source}/model":/source @@ -81,7 +79,7 @@ def semconvgen(semconv_source, output_root:, kind:, selector:) --continue-on-validation-errors code --file-per-group root_namespace - --template /templates/#{kind}.j2 + --template /templates/attributes.j2 --output "#{output_filenames_template}" -Dselector=#{selector} -Dexcluded_attributes="#{EXCLUDED_ATTRIBUTES.join(' ')}" diff --git a/semantic_conventions/lib/opentelemetry/semantic_candidates.rb b/semantic_conventions/lib/opentelemetry/semantic_candidates.rb deleted file mode 100644 index d314730e44..0000000000 --- a/semantic_conventions/lib/opentelemetry/semantic_candidates.rb +++ /dev/null @@ -1,19 +0,0 @@ -# frozen_string_literal: true - -# Copyright The OpenTelemetry Authors -# -# SPDX-License-Identifier: Apache-2.0 - -module OpenTelemetry - # OpenTelemetry Semantic Conventions attribute names as constants. - # These are auto-generated from source YAML in {https://github.com/open-telemetry/semantic-conventions the semantic-conventions repository}. - # - # The constants in this namespace are all of the attribute names at all stability levels present in the OpenTelemetry semantic conventions as of {SemanticConventions::VERSION}. - # - # @note The constants here ought to remain within major versions of this library. - # However, there are risks with auto-generated code. - # The maintainers try to prevent constants disappearing, but we cannot guarantee this. - # We strongly recommend that any constants you use in your code are exercised in your test suite to catch missing constants before release or production runtime. - module SemanticCandidates - end -end diff --git a/semantic_conventions/lib/opentelemetry/semantic_conventions.rb b/semantic_conventions/lib/opentelemetry/semantic_conventions.rb index 29de270572..d98743d580 100644 --- a/semantic_conventions/lib/opentelemetry/semantic_conventions.rb +++ b/semantic_conventions/lib/opentelemetry/semantic_conventions.rb @@ -18,8 +18,8 @@ module SemanticConventions end end -# TODO: test to make sure the trace and resource constants are present in SemanticCandidates -# TODO: test to make sure the SemanticConventions (stable) constants are all still present in the SemanticCandidates constants +# TODO: test to make sure the trace and resource constants are present in SemConv::Incubating +# TODO: test to make sure the SemConv (stable) constants are all still present in the SemConv::Incubating constants # TODO: remove these convenience requires in the next major version require_relative 'semantic_conventions/trace' require_relative 'semantic_conventions/resource' diff --git a/semantic_conventions/lib/opentelemetry/semantic_conventions/attributes/aspnetcore.rb b/semantic_conventions/lib/opentelemetry/semconv/aspnetcore.rb similarity index 95% rename from semantic_conventions/lib/opentelemetry/semantic_conventions/attributes/aspnetcore.rb rename to semantic_conventions/lib/opentelemetry/semconv/aspnetcore.rb index a95ae588f7..d594ebe75b 100644 --- a/semantic_conventions/lib/opentelemetry/semantic_conventions/attributes/aspnetcore.rb +++ b/semantic_conventions/lib/opentelemetry/semconv/aspnetcore.rb @@ -19,45 +19,48 @@ # This file was autogenerated. Do not edit it by hand. module OpenTelemetry - module SemanticConventions - module ASPNETCORE + module SemConv + module ASPNETCORE # @!group Attribute Names # ASP.NET Core exception middleware handling result # # @note StabilityLevel.STABLE ASPNETCORE_DIAGNOSTICS_EXCEPTION_RESULT = 'aspnetcore.diagnostics.exception.result' - + # Full type name of the [`IExceptionHandler`](https://learn.microsoft.com/dotnet/api/microsoft.aspnetcore.diagnostics.iexceptionhandler) implementation that handled the exception # # @note StabilityLevel.STABLE ASPNETCORE_DIAGNOSTICS_HANDLER_TYPE = 'aspnetcore.diagnostics.handler.type' - + # Rate limiting policy name # # @note StabilityLevel.STABLE ASPNETCORE_RATE_LIMITING_POLICY = 'aspnetcore.rate_limiting.policy' - + # Rate-limiting result, shows whether the lease was acquired or contains a rejection reason # # @note StabilityLevel.STABLE ASPNETCORE_RATE_LIMITING_RESULT = 'aspnetcore.rate_limiting.result' - + # Flag indicating if request was handled by the application pipeline # # @note StabilityLevel.STABLE ASPNETCORE_REQUEST_IS_UNHANDLED = 'aspnetcore.request.is_unhandled' - + # A value that indicates whether the matched route is a fallback route # # @note StabilityLevel.STABLE ASPNETCORE_ROUTING_IS_FALLBACK = 'aspnetcore.routing.is_fallback' - + # Match result - success or failure # # @note StabilityLevel.STABLE ASPNETCORE_ROUTING_MATCH_STATUS = 'aspnetcore.routing.match_status' - + + # @!endgroup + + # @!group Metric Names # @!endgroup end end diff --git a/semantic_conventions/lib/opentelemetry/semantic_conventions/attributes/client.rb b/semantic_conventions/lib/opentelemetry/semconv/client.rb similarity index 94% rename from semantic_conventions/lib/opentelemetry/semantic_conventions/attributes/client.rb rename to semantic_conventions/lib/opentelemetry/semconv/client.rb index 56e86d09da..31fe53b916 100644 --- a/semantic_conventions/lib/opentelemetry/semantic_conventions/attributes/client.rb +++ b/semantic_conventions/lib/opentelemetry/semconv/client.rb @@ -19,8 +19,8 @@ # This file was autogenerated. Do not edit it by hand. module OpenTelemetry - module SemanticConventions - module CLIENT + module SemConv + module CLIENT # @!group Attribute Names # Client address - domain name if available without reverse DNS lookup; otherwise, IP address or Unix domain socket name @@ -29,14 +29,17 @@ module CLIENT # # @note StabilityLevel.STABLE CLIENT_ADDRESS = 'client.address' - + # Client port number # # When observed from the server side, and when communicating through an intermediary, `client.port` SHOULD represent the client port behind any intermediaries, for example proxies, if it's available # # @note StabilityLevel.STABLE CLIENT_PORT = 'client.port' - + + # @!endgroup + + # @!group Metric Names # @!endgroup end end diff --git a/semantic_conventions/lib/opentelemetry/semantic_conventions/attributes/error.rb b/semantic_conventions/lib/opentelemetry/semconv/error.rb similarity index 95% rename from semantic_conventions/lib/opentelemetry/semantic_conventions/attributes/error.rb rename to semantic_conventions/lib/opentelemetry/semconv/error.rb index 62ed6042ae..63268e8f83 100644 --- a/semantic_conventions/lib/opentelemetry/semantic_conventions/attributes/error.rb +++ b/semantic_conventions/lib/opentelemetry/semconv/error.rb @@ -19,8 +19,8 @@ # This file was autogenerated. Do not edit it by hand. module OpenTelemetry - module SemanticConventions - module ERROR + module SemConv + module ERROR # @!group Attribute Names # Describes a class of error the operation ended with @@ -43,7 +43,10 @@ module ERROR # # @note StabilityLevel.STABLE ERROR_TYPE = 'error.type' - + + # @!endgroup + + # @!group Metric Names # @!endgroup end end diff --git a/semantic_conventions/lib/opentelemetry/semantic_conventions/attributes/exception.rb b/semantic_conventions/lib/opentelemetry/semconv/exception.rb similarity index 96% rename from semantic_conventions/lib/opentelemetry/semantic_conventions/attributes/exception.rb rename to semantic_conventions/lib/opentelemetry/semconv/exception.rb index 91638a547b..8dcd50e3bf 100644 --- a/semantic_conventions/lib/opentelemetry/semantic_conventions/attributes/exception.rb +++ b/semantic_conventions/lib/opentelemetry/semconv/exception.rb @@ -19,8 +19,8 @@ # This file was autogenerated. Do not edit it by hand. module OpenTelemetry - module SemanticConventions - module EXCEPTION + module SemConv + module EXCEPTION # @!group Attribute Names # 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 @@ -44,22 +44,25 @@ module EXCEPTION # # @note StabilityLevel.STABLE EXCEPTION_ESCAPED = 'exception.escaped' - + # The exception message # # @note StabilityLevel.STABLE 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 StabilityLevel.STABLE 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 StabilityLevel.STABLE EXCEPTION_TYPE = 'exception.type' - + + # @!endgroup + + # @!group Metric Names # @!endgroup end end diff --git a/semantic_conventions/lib/opentelemetry/semantic_conventions/attributes/http.rb b/semantic_conventions/lib/opentelemetry/semconv/http.rb similarity index 95% rename from semantic_conventions/lib/opentelemetry/semantic_conventions/attributes/http.rb rename to semantic_conventions/lib/opentelemetry/semconv/http.rb index 898f477f07..2b30875093 100644 --- a/semantic_conventions/lib/opentelemetry/semantic_conventions/attributes/http.rb +++ b/semantic_conventions/lib/opentelemetry/semconv/http.rb @@ -19,8 +19,8 @@ # This file was autogenerated. Do not edit it by hand. module OpenTelemetry - module SemanticConventions - module HTTP + module SemConv + module HTTP # @!group Attribute Names # HTTP request headers, `` being the normalized HTTP Header name (lowercase), the value being the header values @@ -30,8 +30,8 @@ module HTTP # The attribute value MUST consist of either multiple header values as an array of strings or a single-item array containing a possibly comma-concatenated string, depending on the way the HTTP library provides access to headers # # @note StabilityLevel.STABLE - HTTP_REQUEST_HEADER = 'http.request.header' - + HTTP_REQUEST_HEADER_LAMBDA = -> (key) { "http.request.header.#{key}" } + # HTTP request method # # HTTP request method value SHOULD be "known" to the instrumentation. @@ -51,19 +51,19 @@ module HTTP # # @note StabilityLevel.STABLE HTTP_REQUEST_METHOD = 'http.request.method' - + # Original HTTP method sent by the client in the request line # # @note StabilityLevel.STABLE HTTP_REQUEST_METHOD_ORIGINAL = 'http.request.method_original' - + # The ordinal number of request resending attempt (for any reason, including redirects) # # The resend count SHOULD be updated each time an HTTP request gets resent by the client, regardless of what was the cause of the resending (e.g. redirection, authorization failure, 503 Server Unavailable, network issues, or any other) # # @note StabilityLevel.STABLE HTTP_REQUEST_RESEND_COUNT = 'http.request.resend_count' - + # HTTP response headers, `` being the normalized HTTP Header name (lowercase), the value being the header values # # Instrumentations SHOULD require an explicit configuration of which headers are to be captured. Including all response headers can be a security risk - explicit configuration helps avoid leaking sensitive information. @@ -71,13 +71,13 @@ module HTTP # The attribute value MUST consist of either multiple header values as an array of strings or a single-item array containing a possibly comma-concatenated string, depending on the way the HTTP library provides access to headers # # @note StabilityLevel.STABLE - HTTP_RESPONSE_HEADER = 'http.response.header' - + HTTP_RESPONSE_HEADER_LAMBDA = -> (key) { "http.response.header.#{key}" } + # [HTTP response status code](https://tools.ietf.org/html/rfc7231#section-6) # # @note StabilityLevel.STABLE HTTP_RESPONSE_STATUS_CODE = 'http.response.status_code' - + # The matched route, that is, the path template in the format used by the respective server framework # # MUST NOT be populated when this is not supported by the HTTP server framework as the route attribute should have low-cardinality and the URI path can NOT substitute it. @@ -85,7 +85,10 @@ module HTTP # # @note StabilityLevel.STABLE HTTP_ROUTE = 'http.route' - + + # @!endgroup + + # @!group Metric Names # @!endgroup end end diff --git a/semantic_conventions/lib/opentelemetry/semantic_candidates/attributes/android.rb b/semantic_conventions/lib/opentelemetry/semconv/incubating/android.rb similarity index 91% rename from semantic_conventions/lib/opentelemetry/semantic_candidates/attributes/android.rb rename to semantic_conventions/lib/opentelemetry/semconv/incubating/android.rb index 25d73105bc..7020e9eb63 100644 --- a/semantic_conventions/lib/opentelemetry/semantic_candidates/attributes/android.rb +++ b/semantic_conventions/lib/opentelemetry/semconv/incubating/android.rb @@ -19,23 +19,28 @@ # This file was autogenerated. Do not edit it by hand. module OpenTelemetry - module SemanticCandidates - module ANDROID + module SemConv + module Incubating + module ANDROID # @!group Attribute Names # Uniquely identifies the framework API revision offered by a version (`os.version`) of the android operating system. More information can be found [here](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels) # # @note StabilityLevel.EXPERIMENTAL ANDROID_OS_API_LEVEL = 'android.os.api_level' - + # This attribute represents the state the application has transitioned into at the occurrence of the event # # The Android lifecycle states are defined in [Activity lifecycle callbacks](https://developer.android.com/guide/components/activities/activity-lifecycle#lc), and from which the `OS identifiers` are derived # # @note StabilityLevel.EXPERIMENTAL ANDROID_STATE = 'android.state' - + + # @!endgroup + + # @!group Metric Names # @!endgroup end + end # module Incubating end end \ No newline at end of file diff --git a/semantic_conventions/lib/opentelemetry/semantic_candidates/attributes/aspnetcore.rb b/semantic_conventions/lib/opentelemetry/semconv/incubating/aspnetcore.rb similarity index 80% rename from semantic_conventions/lib/opentelemetry/semantic_candidates/attributes/aspnetcore.rb rename to semantic_conventions/lib/opentelemetry/semconv/incubating/aspnetcore.rb index 5e35b95fa1..5e8454d95f 100644 --- a/semantic_conventions/lib/opentelemetry/semantic_candidates/attributes/aspnetcore.rb +++ b/semantic_conventions/lib/opentelemetry/semconv/incubating/aspnetcore.rb @@ -19,60 +19,65 @@ # This file was autogenerated. Do not edit it by hand. module OpenTelemetry - module SemanticCandidates - module ASPNETCORE + module SemConv + module Incubating + module ASPNETCORE # @!group Attribute Names # ASP.NET Core exception middleware handling result # # @note StabilityLevel.STABLE # - # @deprecated Now available in the stable namespace at {OpenTelemetry::SemanticConventions::ASPNETCORE::ASPNETCORE_DIAGNOSTICS_EXCEPTION_RESULT}. + # @deprecated Now available in the stable namespace at {OpenTelemetry::SemConv::ASPNETCORE::ASPNETCORE_DIAGNOSTICS_EXCEPTION_RESULT}. ASPNETCORE_DIAGNOSTICS_EXCEPTION_RESULT = 'aspnetcore.diagnostics.exception.result' - + # Full type name of the [`IExceptionHandler`](https://learn.microsoft.com/dotnet/api/microsoft.aspnetcore.diagnostics.iexceptionhandler) implementation that handled the exception # # @note StabilityLevel.STABLE # - # @deprecated Now available in the stable namespace at {OpenTelemetry::SemanticConventions::ASPNETCORE::ASPNETCORE_DIAGNOSTICS_HANDLER_TYPE}. + # @deprecated Now available in the stable namespace at {OpenTelemetry::SemConv::ASPNETCORE::ASPNETCORE_DIAGNOSTICS_HANDLER_TYPE}. ASPNETCORE_DIAGNOSTICS_HANDLER_TYPE = 'aspnetcore.diagnostics.handler.type' - + # Rate limiting policy name # # @note StabilityLevel.STABLE # - # @deprecated Now available in the stable namespace at {OpenTelemetry::SemanticConventions::ASPNETCORE::ASPNETCORE_RATE_LIMITING_POLICY}. + # @deprecated Now available in the stable namespace at {OpenTelemetry::SemConv::ASPNETCORE::ASPNETCORE_RATE_LIMITING_POLICY}. ASPNETCORE_RATE_LIMITING_POLICY = 'aspnetcore.rate_limiting.policy' - + # Rate-limiting result, shows whether the lease was acquired or contains a rejection reason # # @note StabilityLevel.STABLE # - # @deprecated Now available in the stable namespace at {OpenTelemetry::SemanticConventions::ASPNETCORE::ASPNETCORE_RATE_LIMITING_RESULT}. + # @deprecated Now available in the stable namespace at {OpenTelemetry::SemConv::ASPNETCORE::ASPNETCORE_RATE_LIMITING_RESULT}. ASPNETCORE_RATE_LIMITING_RESULT = 'aspnetcore.rate_limiting.result' - + # Flag indicating if request was handled by the application pipeline # # @note StabilityLevel.STABLE # - # @deprecated Now available in the stable namespace at {OpenTelemetry::SemanticConventions::ASPNETCORE::ASPNETCORE_REQUEST_IS_UNHANDLED}. + # @deprecated Now available in the stable namespace at {OpenTelemetry::SemConv::ASPNETCORE::ASPNETCORE_REQUEST_IS_UNHANDLED}. ASPNETCORE_REQUEST_IS_UNHANDLED = 'aspnetcore.request.is_unhandled' - + # A value that indicates whether the matched route is a fallback route # # @note StabilityLevel.STABLE # - # @deprecated Now available in the stable namespace at {OpenTelemetry::SemanticConventions::ASPNETCORE::ASPNETCORE_ROUTING_IS_FALLBACK}. + # @deprecated Now available in the stable namespace at {OpenTelemetry::SemConv::ASPNETCORE::ASPNETCORE_ROUTING_IS_FALLBACK}. ASPNETCORE_ROUTING_IS_FALLBACK = 'aspnetcore.routing.is_fallback' - + # Match result - success or failure # # @note StabilityLevel.STABLE # - # @deprecated Now available in the stable namespace at {OpenTelemetry::SemanticConventions::ASPNETCORE::ASPNETCORE_ROUTING_MATCH_STATUS}. + # @deprecated Now available in the stable namespace at {OpenTelemetry::SemConv::ASPNETCORE::ASPNETCORE_ROUTING_MATCH_STATUS}. ASPNETCORE_ROUTING_MATCH_STATUS = 'aspnetcore.routing.match_status' - + + # @!endgroup + + # @!group Metric Names # @!endgroup end + end # module Incubating end end \ No newline at end of file diff --git a/semantic_conventions/lib/opentelemetry/semantic_candidates/attributes/aws.rb b/semantic_conventions/lib/opentelemetry/semconv/incubating/aws.rb similarity index 98% rename from semantic_conventions/lib/opentelemetry/semantic_candidates/attributes/aws.rb rename to semantic_conventions/lib/opentelemetry/semconv/incubating/aws.rb index 99098466b9..e7222308c7 100644 --- a/semantic_conventions/lib/opentelemetry/semantic_candidates/attributes/aws.rb +++ b/semantic_conventions/lib/opentelemetry/semconv/incubating/aws.rb @@ -19,198 +19,199 @@ # This file was autogenerated. Do not edit it by hand. module OpenTelemetry - module SemanticCandidates - module AWS + module SemConv + module Incubating + module AWS # @!group Attribute Names # The JSON-serialized value of each item in the `AttributeDefinitions` request field # # @note StabilityLevel.EXPERIMENTAL AWS_DYNAMODB_ATTRIBUTE_DEFINITIONS = 'aws.dynamodb.attribute_definitions' - + # The value of the `AttributesToGet` request parameter # # @note StabilityLevel.EXPERIMENTAL AWS_DYNAMODB_ATTRIBUTES_TO_GET = 'aws.dynamodb.attributes_to_get' - + # The value of the `ConsistentRead` request parameter # # @note StabilityLevel.EXPERIMENTAL AWS_DYNAMODB_CONSISTENT_READ = 'aws.dynamodb.consistent_read' - + # The JSON-serialized value of each item in the `ConsumedCapacity` response field # # @note StabilityLevel.EXPERIMENTAL AWS_DYNAMODB_CONSUMED_CAPACITY = 'aws.dynamodb.consumed_capacity' - + # The value of the `Count` response parameter # # @note StabilityLevel.EXPERIMENTAL AWS_DYNAMODB_COUNT = 'aws.dynamodb.count' - + # The value of the `ExclusiveStartTableName` request parameter # # @note StabilityLevel.EXPERIMENTAL AWS_DYNAMODB_EXCLUSIVE_START_TABLE = 'aws.dynamodb.exclusive_start_table' - + # The JSON-serialized value of each item in the `GlobalSecondaryIndexUpdates` request field # # @note StabilityLevel.EXPERIMENTAL AWS_DYNAMODB_GLOBAL_SECONDARY_INDEX_UPDATES = 'aws.dynamodb.global_secondary_index_updates' - + # The JSON-serialized value of each item of the `GlobalSecondaryIndexes` request field # # @note StabilityLevel.EXPERIMENTAL AWS_DYNAMODB_GLOBAL_SECONDARY_INDEXES = 'aws.dynamodb.global_secondary_indexes' - + # The value of the `IndexName` request parameter # # @note StabilityLevel.EXPERIMENTAL AWS_DYNAMODB_INDEX_NAME = 'aws.dynamodb.index_name' - + # The JSON-serialized value of the `ItemCollectionMetrics` response field # # @note StabilityLevel.EXPERIMENTAL AWS_DYNAMODB_ITEM_COLLECTION_METRICS = 'aws.dynamodb.item_collection_metrics' - + # The value of the `Limit` request parameter # # @note StabilityLevel.EXPERIMENTAL AWS_DYNAMODB_LIMIT = 'aws.dynamodb.limit' - + # The JSON-serialized value of each item of the `LocalSecondaryIndexes` request field # # @note StabilityLevel.EXPERIMENTAL AWS_DYNAMODB_LOCAL_SECONDARY_INDEXES = 'aws.dynamodb.local_secondary_indexes' - + # The value of the `ProjectionExpression` request parameter # # @note StabilityLevel.EXPERIMENTAL AWS_DYNAMODB_PROJECTION = 'aws.dynamodb.projection' - + # The value of the `ProvisionedThroughput.ReadCapacityUnits` request parameter # # @note StabilityLevel.EXPERIMENTAL AWS_DYNAMODB_PROVISIONED_READ_CAPACITY = 'aws.dynamodb.provisioned_read_capacity' - + # The value of the `ProvisionedThroughput.WriteCapacityUnits` request parameter # # @note StabilityLevel.EXPERIMENTAL AWS_DYNAMODB_PROVISIONED_WRITE_CAPACITY = 'aws.dynamodb.provisioned_write_capacity' - + # The value of the `ScanIndexForward` request parameter # # @note StabilityLevel.EXPERIMENTAL AWS_DYNAMODB_SCAN_FORWARD = 'aws.dynamodb.scan_forward' - + # The value of the `ScannedCount` response parameter # # @note StabilityLevel.EXPERIMENTAL AWS_DYNAMODB_SCANNED_COUNT = 'aws.dynamodb.scanned_count' - + # The value of the `Segment` request parameter # # @note StabilityLevel.EXPERIMENTAL AWS_DYNAMODB_SEGMENT = 'aws.dynamodb.segment' - + # The value of the `Select` request parameter # # @note StabilityLevel.EXPERIMENTAL AWS_DYNAMODB_SELECT = 'aws.dynamodb.select' - + # The number of items in the `TableNames` response parameter # # @note StabilityLevel.EXPERIMENTAL AWS_DYNAMODB_TABLE_COUNT = 'aws.dynamodb.table_count' - + # The keys in the `RequestItems` object field # # @note StabilityLevel.EXPERIMENTAL AWS_DYNAMODB_TABLE_NAMES = 'aws.dynamodb.table_names' - + # The value of the `TotalSegments` request parameter # # @note StabilityLevel.EXPERIMENTAL AWS_DYNAMODB_TOTAL_SEGMENTS = 'aws.dynamodb.total_segments' - + # The ARN of an [ECS cluster](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/clusters.html) # # @note StabilityLevel.EXPERIMENTAL AWS_ECS_CLUSTER_ARN = 'aws.ecs.cluster.arn' - + # The Amazon Resource Name (ARN) of an [ECS container instance](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ECS_instances.html) # # @note StabilityLevel.EXPERIMENTAL AWS_ECS_CONTAINER_ARN = 'aws.ecs.container.arn' - + # The [launch type](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/launch_types.html) for an ECS task # # @note StabilityLevel.EXPERIMENTAL AWS_ECS_LAUNCHTYPE = 'aws.ecs.launchtype' - + # The ARN of a running [ECS task](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-account-settings.html#ecs-resource-ids) # # @note StabilityLevel.EXPERIMENTAL AWS_ECS_TASK_ARN = 'aws.ecs.task.arn' - + # The family name of the [ECS task definition](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task_definitions.html) used to create the ECS task # # @note StabilityLevel.EXPERIMENTAL AWS_ECS_TASK_FAMILY = 'aws.ecs.task.family' - + # The ID of a running ECS task. The ID MUST be extracted from `task.arn` # # @note StabilityLevel.EXPERIMENTAL AWS_ECS_TASK_ID = 'aws.ecs.task.id' - + # The revision for the task definition used to create the ECS task # # @note StabilityLevel.EXPERIMENTAL AWS_ECS_TASK_REVISION = 'aws.ecs.task.revision' - + # The ARN of an EKS cluster # # @note StabilityLevel.EXPERIMENTAL AWS_EKS_CLUSTER_ARN = 'aws.eks.cluster.arn' - + # The full invoked ARN as provided on the `Context` passed to the function (`Lambda-Runtime-Invoked-Function-Arn` header on the `/runtime/invocation/next` applicable) # # This may be different from `cloud.resource_id` if an alias is involved # # @note StabilityLevel.EXPERIMENTAL AWS_LAMBDA_INVOKED_ARN = 'aws.lambda.invoked_arn' - + # The Amazon Resource Name(s) (ARN) of the AWS log group(s) # # See the [log group ARN format documentation](https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/iam-access-control-overview-cwl.html#CWL_ARN_Format) # # @note StabilityLevel.EXPERIMENTAL AWS_LOG_GROUP_ARNS = 'aws.log.group.arns' - + # The name(s) of the AWS log group(s) an application is writing to # # 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 # # @note StabilityLevel.EXPERIMENTAL AWS_LOG_GROUP_NAMES = 'aws.log.group.names' - + # The ARN(s) of the AWS log stream(s) # # 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 # # @note StabilityLevel.EXPERIMENTAL AWS_LOG_STREAM_ARNS = 'aws.log.stream.arns' - + # The name(s) of the AWS log stream(s) an application is writing to # # @note StabilityLevel.EXPERIMENTAL AWS_LOG_STREAM_NAMES = 'aws.log.stream.names' - + # The AWS request ID as returned in the response headers `x-amz-request-id` or `x-amz-requestid` # # @note StabilityLevel.EXPERIMENTAL AWS_REQUEST_ID = 'aws.request_id' - + # The S3 bucket name the request refers to. Corresponds to the `--bucket` parameter of the [S3 API](https://docs.aws.amazon.com/cli/latest/reference/s3api/index.html) operations # # The `bucket` attribute is applicable to all S3 operations that reference a bucket, i.e. that require the bucket name as a mandatory parameter. @@ -218,7 +219,7 @@ module AWS # # @note StabilityLevel.EXPERIMENTAL AWS_S3_BUCKET = 'aws.s3.bucket' - + # The source object (in the form `bucket`/`key`) for the copy operation # # The `copy_source` attribute applies to S3 copy operations and corresponds to the `--copy-source` parameter @@ -230,7 +231,7 @@ module AWS # # @note StabilityLevel.EXPERIMENTAL AWS_S3_COPY_SOURCE = 'aws.s3.copy_source' - + # The delete request container that specifies the objects to be deleted # # The `delete` attribute is only applicable to the [delete-object](https://docs.aws.amazon.com/cli/latest/reference/s3api/delete-object.html) operation. @@ -239,7 +240,7 @@ module AWS # # @note StabilityLevel.EXPERIMENTAL AWS_S3_DELETE = 'aws.s3.delete' - + # The S3 object key the request refers to. Corresponds to the `--key` parameter of the [S3 API](https://docs.aws.amazon.com/cli/latest/reference/s3api/index.html) operations # # The `key` attribute is applicable to all object-related S3 operations, i.e. that require the object key as a mandatory parameter. @@ -261,7 +262,7 @@ module AWS # # @note StabilityLevel.EXPERIMENTAL AWS_S3_KEY = 'aws.s3.key' - + # The part number of the part being uploaded in a multipart-upload operation. This is a positive integer between 1 and 10,000 # # The `part_number` attribute is only applicable to the [upload-part](https://docs.aws.amazon.com/cli/latest/reference/s3api/upload-part.html) @@ -271,7 +272,7 @@ module AWS # # @note StabilityLevel.EXPERIMENTAL AWS_S3_PART_NUMBER = 'aws.s3.part_number' - + # Upload ID that identifies the multipart upload # # The `upload_id` attribute applies to S3 multipart-upload operations and corresponds to the `--upload-id` parameter @@ -286,8 +287,12 @@ module AWS # # @note StabilityLevel.EXPERIMENTAL AWS_S3_UPLOAD_ID = 'aws.s3.upload_id' - + + # @!endgroup + + # @!group Metric Names # @!endgroup end + end # module Incubating end end \ No newline at end of file diff --git a/semantic_conventions/lib/opentelemetry/semantic_candidates/attributes/browser.rb b/semantic_conventions/lib/opentelemetry/semconv/incubating/browser.rb similarity index 94% rename from semantic_conventions/lib/opentelemetry/semantic_candidates/attributes/browser.rb rename to semantic_conventions/lib/opentelemetry/semconv/incubating/browser.rb index 954d50f3a3..220d6db4a0 100644 --- a/semantic_conventions/lib/opentelemetry/semantic_candidates/attributes/browser.rb +++ b/semantic_conventions/lib/opentelemetry/semconv/incubating/browser.rb @@ -19,8 +19,9 @@ # This file was autogenerated. Do not edit it by hand. module OpenTelemetry - module SemanticCandidates - module BROWSER + module SemConv + module Incubating + module BROWSER # @!group Attribute Names # Array of brand name and version separated by a space @@ -29,21 +30,21 @@ module BROWSER # # @note StabilityLevel.EXPERIMENTAL BROWSER_BRANDS = 'browser.brands' - + # Preferred language of the user using the browser # # This value is intended to be taken from the Navigator API `navigator.language` # # @note StabilityLevel.EXPERIMENTAL BROWSER_LANGUAGE = 'browser.language' - + # A boolean that is true if the browser is running on a mobile device # # This value is intended to be taken from the [UA client hints API](https://wicg.github.io/ua-client-hints/#interface) (`navigator.userAgentData.mobile`). If unavailable, this attribute SHOULD be left unset # # @note StabilityLevel.EXPERIMENTAL BROWSER_MOBILE = 'browser.mobile' - + # The platform on which the browser is running # # This value is intended to be taken from the [UA client hints API](https://wicg.github.io/ua-client-hints/#interface) (`navigator.userAgentData.platform`). If unavailable, the legacy `navigator.platform` API SHOULD NOT be used instead and this attribute SHOULD be left unset in order for the values to be consistent. @@ -51,8 +52,12 @@ module BROWSER # # @note StabilityLevel.EXPERIMENTAL BROWSER_PLATFORM = 'browser.platform' - + + # @!endgroup + + # @!group Metric Names # @!endgroup end + end # module Incubating end end \ No newline at end of file diff --git a/semantic_conventions/lib/opentelemetry/semantic_candidates/attributes/client.rb b/semantic_conventions/lib/opentelemetry/semconv/incubating/client.rb similarity index 88% rename from semantic_conventions/lib/opentelemetry/semantic_candidates/attributes/client.rb rename to semantic_conventions/lib/opentelemetry/semconv/incubating/client.rb index 98e6e9443d..09db54112f 100644 --- a/semantic_conventions/lib/opentelemetry/semantic_candidates/attributes/client.rb +++ b/semantic_conventions/lib/opentelemetry/semconv/incubating/client.rb @@ -19,8 +19,9 @@ # This file was autogenerated. Do not edit it by hand. module OpenTelemetry - module SemanticCandidates - module CLIENT + module SemConv + module Incubating + module CLIENT # @!group Attribute Names # Client address - domain name if available without reverse DNS lookup; otherwise, IP address or Unix domain socket name @@ -29,19 +30,23 @@ module CLIENT # # @note StabilityLevel.STABLE # - # @deprecated Now available in the stable namespace at {OpenTelemetry::SemanticConventions::CLIENT::CLIENT_ADDRESS}. + # @deprecated Now available in the stable namespace at {OpenTelemetry::SemConv::CLIENT::CLIENT_ADDRESS}. CLIENT_ADDRESS = 'client.address' - + # Client port number # # When observed from the server side, and when communicating through an intermediary, `client.port` SHOULD represent the client port behind any intermediaries, for example proxies, if it's available # # @note StabilityLevel.STABLE # - # @deprecated Now available in the stable namespace at {OpenTelemetry::SemanticConventions::CLIENT::CLIENT_PORT}. + # @deprecated Now available in the stable namespace at {OpenTelemetry::SemConv::CLIENT::CLIENT_PORT}. CLIENT_PORT = 'client.port' - + + # @!endgroup + + # @!group Metric Names # @!endgroup end + end # module Incubating end end \ No newline at end of file diff --git a/semantic_conventions/lib/opentelemetry/semantic_candidates/attributes/cloud.rb b/semantic_conventions/lib/opentelemetry/semconv/incubating/cloud.rb similarity index 96% rename from semantic_conventions/lib/opentelemetry/semantic_candidates/attributes/cloud.rb rename to semantic_conventions/lib/opentelemetry/semconv/incubating/cloud.rb index a3defbf358..e450c6e78a 100644 --- a/semantic_conventions/lib/opentelemetry/semantic_candidates/attributes/cloud.rb +++ b/semantic_conventions/lib/opentelemetry/semconv/incubating/cloud.rb @@ -19,41 +19,42 @@ # This file was autogenerated. Do not edit it by hand. module OpenTelemetry - module SemanticCandidates - module CLOUD + module SemConv + module Incubating + module CLOUD # @!group Attribute Names # The cloud account ID the resource is assigned to # # @note StabilityLevel.EXPERIMENTAL CLOUD_ACCOUNT_ID = 'cloud.account.id' - + # Cloud regions often have multiple, isolated locations known as zones to increase availability. Availability zone represents the zone where the resource is running # # Availability zones are called "zones" on Alibaba Cloud and Google Cloud # # @note StabilityLevel.EXPERIMENTAL CLOUD_AVAILABILITY_ZONE = 'cloud.availability_zone' - + # The cloud platform in use # # The prefix of the service SHOULD match the one specified in `cloud.provider` # # @note StabilityLevel.EXPERIMENTAL CLOUD_PLATFORM = 'cloud.platform' - + # Name of the cloud provider # # @note StabilityLevel.EXPERIMENTAL CLOUD_PROVIDER = 'cloud.provider' - + # The geographical region the resource is running # # Refer to your provider's docs to see the available regions, for example [Alibaba Cloud regions](https://www.alibabacloud.com/help/doc-detail/40654.htm), [AWS regions](https://aws.amazon.com/about-aws/global-infrastructure/regions_az/), [Azure regions](https://azure.microsoft.com/global-infrastructure/geographies/), [Google Cloud regions](https://cloud.google.com/about/locations), or [Tencent Cloud regions](https://www.tencentcloud.com/document/product/213/6091) # # @note StabilityLevel.EXPERIMENTAL CLOUD_REGION = 'cloud.region' - + # Cloud provider-specific native identifier of the monitored cloud resource (e.g. an [ARN](https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) on AWS, a [fully qualified resource ID](https://learn.microsoft.com/rest/api/resources/resources/get-by-id) on Azure, a [full resource name](https://cloud.google.com/apis/design/resource_names#full_resource_name) on GCP) # # On some cloud providers, it may not be possible to determine the full ID at startup, @@ -76,8 +77,12 @@ module CLOUD # # @note StabilityLevel.EXPERIMENTAL CLOUD_RESOURCE_ID = 'cloud.resource_id' - + + # @!endgroup + + # @!group Metric Names # @!endgroup end + end # module Incubating end end \ No newline at end of file diff --git a/semantic_conventions/lib/opentelemetry/semantic_candidates/attributes/cloudevents.rb b/semantic_conventions/lib/opentelemetry/semconv/incubating/cloudevents.rb similarity index 93% rename from semantic_conventions/lib/opentelemetry/semantic_candidates/attributes/cloudevents.rb rename to semantic_conventions/lib/opentelemetry/semconv/incubating/cloudevents.rb index f57284343e..83dc8f4097 100644 --- a/semantic_conventions/lib/opentelemetry/semantic_candidates/attributes/cloudevents.rb +++ b/semantic_conventions/lib/opentelemetry/semconv/incubating/cloudevents.rb @@ -19,36 +19,41 @@ # This file was autogenerated. Do not edit it by hand. module OpenTelemetry - module SemanticCandidates - module CLOUDEVENTS + module SemConv + module Incubating + module CLOUDEVENTS # @!group Attribute Names # The [event_id](https://github.com/cloudevents/spec/blob/v1.0.2/cloudevents/spec.md#id) uniquely identifies the event # # @note StabilityLevel.EXPERIMENTAL CLOUDEVENTS_EVENT_ID = 'cloudevents.event_id' - + # The [source](https://github.com/cloudevents/spec/blob/v1.0.2/cloudevents/spec.md#source-1) identifies the context in which an event happened # # @note StabilityLevel.EXPERIMENTAL CLOUDEVENTS_EVENT_SOURCE = 'cloudevents.event_source' - + # The [version of the CloudEvents specification](https://github.com/cloudevents/spec/blob/v1.0.2/cloudevents/spec.md#specversion) which the event uses # # @note StabilityLevel.EXPERIMENTAL CLOUDEVENTS_EVENT_SPEC_VERSION = 'cloudevents.event_spec_version' - + # The [subject](https://github.com/cloudevents/spec/blob/v1.0.2/cloudevents/spec.md#subject) of the event in the context of the event producer (identified by source) # # @note StabilityLevel.EXPERIMENTAL CLOUDEVENTS_EVENT_SUBJECT = 'cloudevents.event_subject' - + # The [event_type](https://github.com/cloudevents/spec/blob/v1.0.2/cloudevents/spec.md#type) contains a value describing the type of event related to the originating occurrence # # @note StabilityLevel.EXPERIMENTAL CLOUDEVENTS_EVENT_TYPE = 'cloudevents.event_type' - + + # @!endgroup + + # @!group Metric Names # @!endgroup end + end # module Incubating end end \ No newline at end of file diff --git a/semantic_conventions/lib/opentelemetry/semantic_candidates/attributes/code.rb b/semantic_conventions/lib/opentelemetry/semconv/incubating/code.rb similarity index 93% rename from semantic_conventions/lib/opentelemetry/semantic_candidates/attributes/code.rb rename to semantic_conventions/lib/opentelemetry/semconv/incubating/code.rb index 5e42ce29b8..30c7fd58bc 100644 --- a/semantic_conventions/lib/opentelemetry/semantic_candidates/attributes/code.rb +++ b/semantic_conventions/lib/opentelemetry/semconv/incubating/code.rb @@ -19,41 +19,46 @@ # This file was autogenerated. Do not edit it by hand. module OpenTelemetry - module SemanticCandidates - module CODE + module SemConv + module Incubating + module CODE # @!group Attribute Names # The column number in `code.filepath` best representing the operation. It SHOULD point within the code unit named in `code.function` # # @note StabilityLevel.EXPERIMENTAL CODE_COLUMN = 'code.column' - + # The source code file name that identifies the code unit as uniquely as possible (preferably an absolute file path) # # @note StabilityLevel.EXPERIMENTAL CODE_FILEPATH = 'code.filepath' - + # The method or function name, or equivalent (usually rightmost part of the code unit's name) # # @note StabilityLevel.EXPERIMENTAL CODE_FUNCTION = 'code.function' - + # The line number in `code.filepath` best representing the operation. It SHOULD point within the code unit named in `code.function` # # @note StabilityLevel.EXPERIMENTAL CODE_LINENO = 'code.lineno' - + # 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 # # @note StabilityLevel.EXPERIMENTAL CODE_NAMESPACE = 'code.namespace' - + # 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 StabilityLevel.EXPERIMENTAL CODE_STACKTRACE = 'code.stacktrace' - + + # @!endgroup + + # @!group Metric Names # @!endgroup end + end # module Incubating end end \ No newline at end of file diff --git a/semantic_conventions/lib/opentelemetry/semantic_candidates/attributes/container.rb b/semantic_conventions/lib/opentelemetry/semconv/incubating/container.rb similarity index 93% rename from semantic_conventions/lib/opentelemetry/semantic_candidates/attributes/container.rb rename to semantic_conventions/lib/opentelemetry/semconv/incubating/container.rb index cb9d78a3bb..3e01848701 100644 --- a/semantic_conventions/lib/opentelemetry/semantic_candidates/attributes/container.rb +++ b/semantic_conventions/lib/opentelemetry/semconv/incubating/container.rb @@ -19,8 +19,9 @@ # This file was autogenerated. Do not edit it by hand. module OpenTelemetry - module SemanticCandidates - module CONTAINER + module SemConv + module Incubating + module CONTAINER # @!group Attribute Names # The command used to run the container (i.e. the command name) @@ -29,27 +30,27 @@ module CONTAINER # # @note StabilityLevel.EXPERIMENTAL CONTAINER_COMMAND = 'container.command' - + # All the command arguments (including the command/executable itself) run by the container. [2] # # @note StabilityLevel.EXPERIMENTAL CONTAINER_COMMAND_ARGS = 'container.command_args' - + # The full command run by the container as a single string representing the full command. [2] # # @note StabilityLevel.EXPERIMENTAL CONTAINER_COMMAND_LINE = 'container.command_line' - + # The CPU state for this data point # # @note StabilityLevel.EXPERIMENTAL CONTAINER_CPU_STATE = 'container.cpu.state' - + # 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 # # @note StabilityLevel.EXPERIMENTAL CONTAINER_ID = 'container.id' - + # Runtime specific image identifier. Usually a hash algorithm followed by a UUID # # Docker defines a sha256 of the image id; `container.image.id` corresponds to the `Image` field from the Docker container inspect [API](https://docs.docker.com/engine/api/v1.43/#tag/Container/operation/ContainerInspect) endpoint. @@ -58,47 +59,51 @@ module CONTAINER # # @note StabilityLevel.EXPERIMENTAL CONTAINER_IMAGE_ID = 'container.image.id' - + # Name of the image the container was built on # # @note StabilityLevel.EXPERIMENTAL CONTAINER_IMAGE_NAME = 'container.image.name' - + # Repo digests of the container image as provided by the container runtime # # [Docker](https://docs.docker.com/engine/api/v1.43/#tag/Image/operation/ImageInspect) and [CRI](https://github.com/kubernetes/cri-api/blob/c75ef5b473bbe2d0a4fc92f82235efd665ea8e9f/pkg/apis/runtime/v1/api.proto#L1237-L1238) report those under the `RepoDigests` field # # @note StabilityLevel.EXPERIMENTAL CONTAINER_IMAGE_REPO_DIGESTS = 'container.image.repo_digests' - + # Container image tags. An example can be found in [Docker Image Inspect](https://docs.docker.com/engine/api/v1.43/#tag/Image/operation/ImageInspect). Should be only the `` section of the full name for example from `registry.example.com/my-org/my-image:` # # @note StabilityLevel.EXPERIMENTAL CONTAINER_IMAGE_TAGS = 'container.image.tags' - + # Container labels, `` being the label name, the value being the label value # # @note StabilityLevel.EXPERIMENTAL - CONTAINER_LABEL = 'container.label' - + CONTAINER_LABEL_LAMBDA = -> (key) { "container.label.#{key}" } + # Deprecated, use `container.label` instead # # @note StabilityLevel.EXPERIMENTAL # # @deprecated Replaced by `container.label` - CONTAINER_LABELS = 'container.labels' - + CONTAINER_LABELS_LAMBDA = -> (key) { "container.labels.#{key}" } + # Container name used by container runtime # # @note StabilityLevel.EXPERIMENTAL CONTAINER_NAME = 'container.name' - + # The container runtime managing this container # # @note StabilityLevel.EXPERIMENTAL CONTAINER_RUNTIME = 'container.runtime' - + + # @!endgroup + + # @!group Metric Names # @!endgroup end + end # module Incubating end end \ No newline at end of file diff --git a/semantic_conventions/lib/opentelemetry/semantic_candidates/attributes/db.rb b/semantic_conventions/lib/opentelemetry/semconv/incubating/db.rb similarity index 96% rename from semantic_conventions/lib/opentelemetry/semantic_candidates/attributes/db.rb rename to semantic_conventions/lib/opentelemetry/semconv/incubating/db.rb index a92fa5fbe6..4953c4e476 100644 --- a/semantic_conventions/lib/opentelemetry/semantic_candidates/attributes/db.rb +++ b/semantic_conventions/lib/opentelemetry/semconv/incubating/db.rb @@ -19,179 +19,184 @@ # This file was autogenerated. Do not edit it by hand. module OpenTelemetry - module SemanticCandidates - module DB + module SemConv + module Incubating + module DB # @!group Attribute Names # 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) # # @note StabilityLevel.EXPERIMENTAL DB_CASSANDRA_CONSISTENCY_LEVEL = 'db.cassandra.consistency_level' - + # The data center of the coordinating node for a query # # @note StabilityLevel.EXPERIMENTAL DB_CASSANDRA_COORDINATOR_DC = 'db.cassandra.coordinator.dc' - + # The ID of the coordinating node for a query # # @note StabilityLevel.EXPERIMENTAL DB_CASSANDRA_COORDINATOR_ID = 'db.cassandra.coordinator.id' - + # Whether or not the query is idempotent # # @note StabilityLevel.EXPERIMENTAL DB_CASSANDRA_IDEMPOTENCE = 'db.cassandra.idempotence' - + # The fetch size used for paging, i.e. how many rows will be returned at once # # @note StabilityLevel.EXPERIMENTAL DB_CASSANDRA_PAGE_SIZE = 'db.cassandra.page_size' - + # The number of times a query was speculatively executed. Not set or `0` if the query was not executed speculatively # # @note StabilityLevel.EXPERIMENTAL DB_CASSANDRA_SPECULATIVE_EXECUTION_COUNT = 'db.cassandra.speculative_execution_count' - + # The name of the primary Cassandra table that the operation is acting upon, including the keyspace name (if applicable) # # 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 # # @note StabilityLevel.EXPERIMENTAL DB_CASSANDRA_TABLE = 'db.cassandra.table' - + # Deprecated, use `server.address`, `server.port` attributes instead # # @note StabilityLevel.EXPERIMENTAL # # @deprecated "Replaced by `server.address` and `server.port`." DB_CONNECTION_STRING = 'db.connection_string' - + # Unique Cosmos client instance id # # @note StabilityLevel.EXPERIMENTAL DB_COSMOSDB_CLIENT_ID = 'db.cosmosdb.client_id' - + # Cosmos client connection mode # # @note StabilityLevel.EXPERIMENTAL DB_COSMOSDB_CONNECTION_MODE = 'db.cosmosdb.connection_mode' - + # Cosmos DB container name # # @note StabilityLevel.EXPERIMENTAL DB_COSMOSDB_CONTAINER = 'db.cosmosdb.container' - + # CosmosDB Operation Type # # @note StabilityLevel.EXPERIMENTAL DB_COSMOSDB_OPERATION_TYPE = 'db.cosmosdb.operation_type' - + # RU consumed for that operation # # @note StabilityLevel.EXPERIMENTAL DB_COSMOSDB_REQUEST_CHARGE = 'db.cosmosdb.request_charge' - + # Request payload size in bytes # # @note StabilityLevel.EXPERIMENTAL DB_COSMOSDB_REQUEST_CONTENT_LENGTH = 'db.cosmosdb.request_content_length' - + # Cosmos DB status code # # @note StabilityLevel.EXPERIMENTAL DB_COSMOSDB_STATUS_CODE = 'db.cosmosdb.status_code' - + # Cosmos DB sub status code # # @note StabilityLevel.EXPERIMENTAL DB_COSMOSDB_SUB_STATUS_CODE = 'db.cosmosdb.sub_status_code' - + # Represents the identifier of an Elasticsearch cluster # # @note StabilityLevel.EXPERIMENTAL DB_ELASTICSEARCH_CLUSTER_NAME = 'db.elasticsearch.cluster.name' - + # Deprecated, use `db.instance.id` instead # # @note StabilityLevel.EXPERIMENTAL # # @deprecated Replaced by `db.instance.id` DB_ELASTICSEARCH_NODE_NAME = 'db.elasticsearch.node.name' - + # A dynamic value in the url path # # Many Elasticsearch url paths allow dynamic values. These SHOULD be recorded in span attributes in the format `db.elasticsearch.path_parts.`, where `` is the url path part name. The implementation SHOULD reference the [elasticsearch schema](https://raw.githubusercontent.com/elastic/elasticsearch-specification/main/output/schema/schema.json) in order to map the path part values to their names # # @note StabilityLevel.EXPERIMENTAL - DB_ELASTICSEARCH_PATH_PARTS = 'db.elasticsearch.path_parts' - + DB_ELASTICSEARCH_PATH_PARTS_LAMBDA = -> (key) { "db.elasticsearch.path_parts.#{key}" } + # An identifier (address, unique name, or any other identifier) of the database instance that is executing queries or mutations on the current connection. This is useful in cases where the database is running in a clustered environment and the instrumentation is able to record the node executing the query. The client may obtain this value in databases like MySQL using queries like `select @@hostname` # # @note StabilityLevel.EXPERIMENTAL DB_INSTANCE_ID = 'db.instance.id' - + # Removed, no replacement at this time # # @note StabilityLevel.EXPERIMENTAL # # @deprecated Removed as not used DB_JDBC_DRIVER_CLASSNAME = 'db.jdbc.driver_classname' - + # The MongoDB collection being accessed within the database stated in `db.name` # # @note StabilityLevel.EXPERIMENTAL DB_MONGODB_COLLECTION = 'db.mongodb.collection' - + # The Microsoft SQL Server [instance name](https://docs.microsoft.com/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 # # If setting a `db.mssql.instance_name`, `server.port` is no longer required (but still recommended if non-standard) # # @note StabilityLevel.EXPERIMENTAL DB_MSSQL_INSTANCE_NAME = 'db.mssql.instance_name' - + # 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) # # In some SQL databases, the database name to be used is called "schema name". In case there are multiple layers that could be considered for database name (e.g. Oracle instance name and schema name), the database name to be used is the more specific layer (e.g. Oracle schema name) # # @note StabilityLevel.EXPERIMENTAL DB_NAME = 'db.name' - + # 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 # # 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 # # @note StabilityLevel.EXPERIMENTAL DB_OPERATION = 'db.operation' - + # 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 # # @note StabilityLevel.EXPERIMENTAL DB_REDIS_DATABASE_INDEX = 'db.redis.database_index' - + # The name of the primary table that the operation is acting upon, including the database name (if applicable) # # 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 # # @note StabilityLevel.EXPERIMENTAL DB_SQL_TABLE = 'db.sql.table' - + # The database statement being executed # # @note StabilityLevel.EXPERIMENTAL DB_STATEMENT = 'db.statement' - + # An identifier for the database management system (DBMS) product being used. See below for a list of well-known identifiers # # @note StabilityLevel.EXPERIMENTAL DB_SYSTEM = 'db.system' - + # Username for accessing the database # # @note StabilityLevel.EXPERIMENTAL DB_USER = 'db.user' - + + # @!endgroup + + # @!group Metric Names # @!endgroup end + end # module Incubating end end \ No newline at end of file diff --git a/semantic_conventions/lib/opentelemetry/semantic_candidates/attributes/deployment.rb b/semantic_conventions/lib/opentelemetry/semconv/incubating/deployment.rb similarity index 91% rename from semantic_conventions/lib/opentelemetry/semantic_candidates/attributes/deployment.rb rename to semantic_conventions/lib/opentelemetry/semconv/incubating/deployment.rb index a70fc2396f..0390fce977 100644 --- a/semantic_conventions/lib/opentelemetry/semantic_candidates/attributes/deployment.rb +++ b/semantic_conventions/lib/opentelemetry/semconv/incubating/deployment.rb @@ -19,8 +19,9 @@ # This file was autogenerated. Do not edit it by hand. module OpenTelemetry - module SemanticCandidates - module DEPLOYMENT + module SemConv + module Incubating + module DEPLOYMENT # @!group Attribute Names # Name of the [deployment environment](https://wikipedia.org/wiki/Deployment_environment) (aka deployment tier) @@ -35,8 +36,12 @@ module DEPLOYMENT # # @note StabilityLevel.EXPERIMENTAL DEPLOYMENT_ENVIRONMENT = 'deployment.environment' - + + # @!endgroup + + # @!group Metric Names # @!endgroup end + end # module Incubating end end \ No newline at end of file diff --git a/semantic_conventions/lib/opentelemetry/semantic_candidates/attributes/destination.rb b/semantic_conventions/lib/opentelemetry/semconv/incubating/destination.rb similarity index 90% rename from semantic_conventions/lib/opentelemetry/semantic_candidates/attributes/destination.rb rename to semantic_conventions/lib/opentelemetry/semconv/incubating/destination.rb index 5a5a9b8e47..151861b4dc 100644 --- a/semantic_conventions/lib/opentelemetry/semantic_candidates/attributes/destination.rb +++ b/semantic_conventions/lib/opentelemetry/semconv/incubating/destination.rb @@ -19,8 +19,9 @@ # This file was autogenerated. Do not edit it by hand. module OpenTelemetry - module SemanticCandidates - module DESTINATION + module SemConv + module Incubating + module DESTINATION # @!group Attribute Names # Destination address - domain name if available without reverse DNS lookup; otherwise, IP address or Unix domain socket name @@ -29,13 +30,17 @@ module DESTINATION # # @note StabilityLevel.EXPERIMENTAL DESTINATION_ADDRESS = 'destination.address' - + # Destination port number # # @note StabilityLevel.EXPERIMENTAL DESTINATION_PORT = 'destination.port' - + + # @!endgroup + + # @!group Metric Names # @!endgroup end + end # module Incubating end end \ No newline at end of file diff --git a/semantic_conventions/lib/opentelemetry/semantic_candidates/attributes/device.rb b/semantic_conventions/lib/opentelemetry/semconv/incubating/device.rb similarity index 94% rename from semantic_conventions/lib/opentelemetry/semantic_candidates/attributes/device.rb rename to semantic_conventions/lib/opentelemetry/semconv/incubating/device.rb index ca6a99b9d2..1d486ed63d 100644 --- a/semantic_conventions/lib/opentelemetry/semantic_candidates/attributes/device.rb +++ b/semantic_conventions/lib/opentelemetry/semconv/incubating/device.rb @@ -19,8 +19,9 @@ # This file was autogenerated. Do not edit it by hand. module OpenTelemetry - module SemanticCandidates - module DEVICE + module SemConv + module Incubating + module DEVICE # @!group Attribute Names # A unique identifier representing the device @@ -29,29 +30,33 @@ module DEVICE # # @note StabilityLevel.EXPERIMENTAL DEVICE_ID = 'device.id' - + # The name of the device manufacturer # # The Android OS provides this field via [Build](https://developer.android.com/reference/android/os/Build#MANUFACTURER). iOS apps SHOULD hardcode the value `Apple` # # @note StabilityLevel.EXPERIMENTAL DEVICE_MANUFACTURER = 'device.manufacturer' - + # The model identifier for the device # # 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 # # @note StabilityLevel.EXPERIMENTAL DEVICE_MODEL_IDENTIFIER = 'device.model.identifier' - + # The marketing name for the device model # # It's recommended this value represents a human-readable version of the device model rather than a machine-readable alternative # # @note StabilityLevel.EXPERIMENTAL DEVICE_MODEL_NAME = 'device.model.name' - + + # @!endgroup + + # @!group Metric Names # @!endgroup end + end # module Incubating end end \ No newline at end of file diff --git a/semantic_conventions/lib/opentelemetry/semantic_candidates/attributes/disk.rb b/semantic_conventions/lib/opentelemetry/semconv/incubating/disk.rb similarity index 87% rename from semantic_conventions/lib/opentelemetry/semantic_candidates/attributes/disk.rb rename to semantic_conventions/lib/opentelemetry/semconv/incubating/disk.rb index 22010f1f40..09c4bf85e6 100644 --- a/semantic_conventions/lib/opentelemetry/semantic_candidates/attributes/disk.rb +++ b/semantic_conventions/lib/opentelemetry/semconv/incubating/disk.rb @@ -19,16 +19,21 @@ # This file was autogenerated. Do not edit it by hand. module OpenTelemetry - module SemanticCandidates - module DISK + module SemConv + module Incubating + module DISK # @!group Attribute Names # The disk IO operation direction # # @note StabilityLevel.EXPERIMENTAL DISK_IO_DIRECTION = 'disk.io.direction' - + + # @!endgroup + + # @!group Metric Names # @!endgroup end + end # module Incubating end end \ No newline at end of file diff --git a/semantic_conventions/lib/opentelemetry/semantic_candidates/attributes/dns.rb b/semantic_conventions/lib/opentelemetry/semconv/incubating/dns.rb similarity index 90% rename from semantic_conventions/lib/opentelemetry/semantic_candidates/attributes/dns.rb rename to semantic_conventions/lib/opentelemetry/semconv/incubating/dns.rb index a176c2c635..ba85696b10 100644 --- a/semantic_conventions/lib/opentelemetry/semantic_candidates/attributes/dns.rb +++ b/semantic_conventions/lib/opentelemetry/semconv/incubating/dns.rb @@ -19,8 +19,9 @@ # This file was autogenerated. Do not edit it by hand. module OpenTelemetry - module SemanticCandidates - module DNS + module SemConv + module Incubating + module DNS # @!group Attribute Names # The name being queried @@ -29,8 +30,12 @@ module DNS # # @note StabilityLevel.EXPERIMENTAL DNS_QUESTION_NAME = 'dns.question.name' - + + # @!endgroup + + # @!group Metric Names # @!endgroup end + end # module Incubating end end \ No newline at end of file diff --git a/semantic_conventions/lib/opentelemetry/semantic_candidates/attributes/enduser.rb b/semantic_conventions/lib/opentelemetry/semconv/incubating/enduser.rb similarity index 92% rename from semantic_conventions/lib/opentelemetry/semantic_candidates/attributes/enduser.rb rename to semantic_conventions/lib/opentelemetry/semconv/incubating/enduser.rb index 1b2a42d435..f82da215c8 100644 --- a/semantic_conventions/lib/opentelemetry/semantic_candidates/attributes/enduser.rb +++ b/semantic_conventions/lib/opentelemetry/semconv/incubating/enduser.rb @@ -19,26 +19,31 @@ # This file was autogenerated. Do not edit it by hand. module OpenTelemetry - module SemanticCandidates - module ENDUSER + module SemConv + module Incubating + module ENDUSER # @!group Attribute Names # 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 # # @note StabilityLevel.EXPERIMENTAL ENDUSER_ID = 'enduser.id' - + # Actual/assumed role the client is making the request under extracted from token or application security context # # @note StabilityLevel.EXPERIMENTAL ENDUSER_ROLE = 'enduser.role' - + # 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) # # @note StabilityLevel.EXPERIMENTAL ENDUSER_SCOPE = 'enduser.scope' - + + # @!endgroup + + # @!group Metric Names # @!endgroup end + end # module Incubating end end \ No newline at end of file diff --git a/semantic_conventions/lib/opentelemetry/semantic_candidates/attributes/error.rb b/semantic_conventions/lib/opentelemetry/semconv/incubating/error.rb similarity index 91% rename from semantic_conventions/lib/opentelemetry/semantic_candidates/attributes/error.rb rename to semantic_conventions/lib/opentelemetry/semconv/incubating/error.rb index 0948527f8e..9ea0e28e01 100644 --- a/semantic_conventions/lib/opentelemetry/semantic_candidates/attributes/error.rb +++ b/semantic_conventions/lib/opentelemetry/semconv/incubating/error.rb @@ -19,8 +19,9 @@ # This file was autogenerated. Do not edit it by hand. module OpenTelemetry - module SemanticCandidates - module ERROR + module SemConv + module Incubating + module ERROR # @!group Attribute Names # Describes a class of error the operation ended with @@ -43,10 +44,14 @@ module ERROR # # @note StabilityLevel.STABLE # - # @deprecated Now available in the stable namespace at {OpenTelemetry::SemanticConventions::ERROR::ERROR_TYPE}. + # @deprecated Now available in the stable namespace at {OpenTelemetry::SemConv::ERROR::ERROR_TYPE}. ERROR_TYPE = 'error.type' - + + # @!endgroup + + # @!group Metric Names # @!endgroup end + end # module Incubating end end \ No newline at end of file diff --git a/semantic_conventions/lib/opentelemetry/semantic_candidates/attributes/event.rb b/semantic_conventions/lib/opentelemetry/semconv/incubating/event.rb similarity index 90% rename from semantic_conventions/lib/opentelemetry/semantic_candidates/attributes/event.rb rename to semantic_conventions/lib/opentelemetry/semconv/incubating/event.rb index f9af5780f8..9610d20c23 100644 --- a/semantic_conventions/lib/opentelemetry/semantic_candidates/attributes/event.rb +++ b/semantic_conventions/lib/opentelemetry/semconv/incubating/event.rb @@ -19,8 +19,9 @@ # This file was autogenerated. Do not edit it by hand. module OpenTelemetry - module SemanticCandidates - module EVENT + module SemConv + module Incubating + module EVENT # @!group Attribute Names # Identifies the class / type of event @@ -29,8 +30,12 @@ module EVENT # # @note StabilityLevel.EXPERIMENTAL EVENT_NAME = 'event.name' - + + # @!endgroup + + # @!group Metric Names # @!endgroup end + end # module Incubating end end \ No newline at end of file diff --git a/semantic_conventions/lib/opentelemetry/semantic_candidates/attributes/exception.rb b/semantic_conventions/lib/opentelemetry/semconv/incubating/exception.rb similarity index 89% rename from semantic_conventions/lib/opentelemetry/semantic_candidates/attributes/exception.rb rename to semantic_conventions/lib/opentelemetry/semconv/incubating/exception.rb index 4c412d1b26..e289c834a5 100644 --- a/semantic_conventions/lib/opentelemetry/semantic_candidates/attributes/exception.rb +++ b/semantic_conventions/lib/opentelemetry/semconv/incubating/exception.rb @@ -19,8 +19,9 @@ # This file was autogenerated. Do not edit it by hand. module OpenTelemetry - module SemanticCandidates - module EXCEPTION + module SemConv + module Incubating + module EXCEPTION # @!group Attribute Names # 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 @@ -44,31 +45,35 @@ module EXCEPTION # # @note StabilityLevel.STABLE # - # @deprecated Now available in the stable namespace at {OpenTelemetry::SemanticConventions::EXCEPTION::EXCEPTION_ESCAPED}. + # @deprecated Now available in the stable namespace at {OpenTelemetry::SemConv::EXCEPTION::EXCEPTION_ESCAPED}. EXCEPTION_ESCAPED = 'exception.escaped' - + # The exception message # # @note StabilityLevel.STABLE # - # @deprecated Now available in the stable namespace at {OpenTelemetry::SemanticConventions::EXCEPTION::EXCEPTION_MESSAGE}. + # @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 StabilityLevel.STABLE # - # @deprecated Now available in the stable namespace at {OpenTelemetry::SemanticConventions::EXCEPTION::EXCEPTION_STACKTRACE}. + # @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 StabilityLevel.STABLE # - # @deprecated Now available in the stable namespace at {OpenTelemetry::SemanticConventions::EXCEPTION::EXCEPTION_TYPE}. + # @deprecated Now available in the stable namespace at {OpenTelemetry::SemConv::EXCEPTION::EXCEPTION_TYPE}. EXCEPTION_TYPE = 'exception.type' - + + # @!endgroup + + # @!group Metric Names # @!endgroup end + end # module Incubating end end \ No newline at end of file diff --git a/semantic_conventions/lib/opentelemetry/semantic_candidates/attributes/faas.rb b/semantic_conventions/lib/opentelemetry/semconv/incubating/faas.rb similarity index 97% rename from semantic_conventions/lib/opentelemetry/semantic_candidates/attributes/faas.rb rename to semantic_conventions/lib/opentelemetry/semconv/incubating/faas.rb index 1f97b8b95a..4dd6f11789 100644 --- a/semantic_conventions/lib/opentelemetry/semantic_candidates/attributes/faas.rb +++ b/semantic_conventions/lib/opentelemetry/semconv/incubating/faas.rb @@ -19,80 +19,81 @@ # This file was autogenerated. Do not edit it by hand. module OpenTelemetry - module SemanticCandidates - module FAAS + 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 StabilityLevel.EXPERIMENTAL 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 StabilityLevel.EXPERIMENTAL 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 StabilityLevel.EXPERIMENTAL 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 StabilityLevel.EXPERIMENTAL FAAS_DOCUMENT_NAME = 'faas.document.name' - + # Describes the type of the operation that was performed on the data # # @note StabilityLevel.EXPERIMENTAL 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 StabilityLevel.EXPERIMENTAL 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 StabilityLevel.EXPERIMENTAL FAAS_INSTANCE = 'faas.instance' - + # The invocation ID of the current function invocation # # @note StabilityLevel.EXPERIMENTAL 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 StabilityLevel.EXPERIMENTAL 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 StabilityLevel.EXPERIMENTAL 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 StabilityLevel.EXPERIMENTAL 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 StabilityLevel.EXPERIMENTAL 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 @@ -114,17 +115,17 @@ module FAAS # # @note StabilityLevel.EXPERIMENTAL 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 StabilityLevel.EXPERIMENTAL FAAS_TIME = 'faas.time' - + # Type of the trigger which caused this function invocation # # @note StabilityLevel.EXPERIMENTAL FAAS_TRIGGER = 'faas.trigger' - + # The immutable version of the function being executed # # Depending on the cloud provider and platform, use: @@ -139,8 +140,12 @@ module FAAS # # @note StabilityLevel.EXPERIMENTAL FAAS_VERSION = 'faas.version' - + + # @!endgroup + + # @!group Metric Names # @!endgroup end + end # module Incubating end end \ No newline at end of file diff --git a/semantic_conventions/lib/opentelemetry/semantic_candidates/attributes/feature_flag.rb b/semantic_conventions/lib/opentelemetry/semconv/incubating/feature_flag.rb similarity index 92% rename from semantic_conventions/lib/opentelemetry/semantic_candidates/attributes/feature_flag.rb rename to semantic_conventions/lib/opentelemetry/semconv/incubating/feature_flag.rb index b0f33d0440..d2db2c0fe6 100644 --- a/semantic_conventions/lib/opentelemetry/semantic_candidates/attributes/feature_flag.rb +++ b/semantic_conventions/lib/opentelemetry/semconv/incubating/feature_flag.rb @@ -19,20 +19,21 @@ # This file was autogenerated. Do not edit it by hand. module OpenTelemetry - module SemanticCandidates - module FEATURE_FLAG + module SemConv + module Incubating + module FEATURE_FLAG # @!group Attribute Names # The unique identifier of the feature flag # # @note StabilityLevel.EXPERIMENTAL FEATURE_FLAG_KEY = 'feature_flag.key' - + # The name of the service provider that performs the flag evaluation # # @note StabilityLevel.EXPERIMENTAL FEATURE_FLAG_PROVIDER_NAME = 'feature_flag.provider_name' - + # SHOULD be a semantic identifier for a value. If one is unavailable, a stringified version of the value can be used # # A semantic identifier, commonly referred to as a variant, provides a means @@ -46,8 +47,12 @@ module FEATURE_FLAG # # @note StabilityLevel.EXPERIMENTAL FEATURE_FLAG_VARIANT = 'feature_flag.variant' - + + # @!endgroup + + # @!group Metric Names # @!endgroup end + end # module Incubating end end \ No newline at end of file diff --git a/semantic_conventions/lib/opentelemetry/semantic_candidates/attributes/file.rb b/semantic_conventions/lib/opentelemetry/semconv/incubating/file.rb similarity index 92% rename from semantic_conventions/lib/opentelemetry/semantic_candidates/attributes/file.rb rename to semantic_conventions/lib/opentelemetry/semconv/incubating/file.rb index b9be01690f..369b9e8e5a 100644 --- a/semantic_conventions/lib/opentelemetry/semantic_candidates/attributes/file.rb +++ b/semantic_conventions/lib/opentelemetry/semconv/incubating/file.rb @@ -19,38 +19,43 @@ # This file was autogenerated. Do not edit it by hand. module OpenTelemetry - module SemanticCandidates - module FILE + module SemConv + module Incubating + module FILE # @!group Attribute Names # Directory where the file is located. It should include the drive letter, when appropriate # # @note StabilityLevel.EXPERIMENTAL FILE_DIRECTORY = 'file.directory' - + # File extension, excluding the leading dot # # When the file name has multiple extensions (example.tar.gz), only the last one should be captured ("gz", not "tar.gz") # # @note StabilityLevel.EXPERIMENTAL FILE_EXTENSION = 'file.extension' - + # Name of the file including the extension, without the directory # # @note StabilityLevel.EXPERIMENTAL FILE_NAME = 'file.name' - + # Full path to the file, including the file name. It should include the drive letter, when appropriate # # @note StabilityLevel.EXPERIMENTAL FILE_PATH = 'file.path' - + # File size in bytes # # @note StabilityLevel.EXPERIMENTAL FILE_SIZE = 'file.size' - + + # @!endgroup + + # @!group Metric Names # @!endgroup end + end # module Incubating end end \ No newline at end of file diff --git a/semantic_conventions/lib/opentelemetry/semantic_candidates/attributes/gcp.rb b/semantic_conventions/lib/opentelemetry/semconv/incubating/gcp.rb similarity index 94% rename from semantic_conventions/lib/opentelemetry/semantic_candidates/attributes/gcp.rb rename to semantic_conventions/lib/opentelemetry/semconv/incubating/gcp.rb index 64bf21b688..58f1f18c7a 100644 --- a/semantic_conventions/lib/opentelemetry/semantic_candidates/attributes/gcp.rb +++ b/semantic_conventions/lib/opentelemetry/semconv/incubating/gcp.rb @@ -19,31 +19,36 @@ # This file was autogenerated. Do not edit it by hand. module OpenTelemetry - module SemanticCandidates - module GCP + module SemConv + module Incubating + module GCP # @!group Attribute Names # The name of the Cloud Run [execution](https://cloud.google.com/run/docs/managing/job-executions) being run for the Job, as set by the [`CLOUD_RUN_EXECUTION`](https://cloud.google.com/run/docs/container-contract#jobs-env-vars) environment variable # # @note StabilityLevel.EXPERIMENTAL GCP_CLOUD_RUN_JOB_EXECUTION = 'gcp.cloud_run.job.execution' - + # The index for a task within an execution as provided by the [`CLOUD_RUN_TASK_INDEX`](https://cloud.google.com/run/docs/container-contract#jobs-env-vars) environment variable # # @note StabilityLevel.EXPERIMENTAL GCP_CLOUD_RUN_JOB_TASK_INDEX = 'gcp.cloud_run.job.task_index' - + # The hostname of a GCE instance. This is the full value of the default or [custom hostname](https://cloud.google.com/compute/docs/instances/custom-hostname-vm) # # @note StabilityLevel.EXPERIMENTAL GCP_GCE_INSTANCE_HOSTNAME = 'gcp.gce.instance.hostname' - + # The instance name of a GCE instance. This is the value provided by `host.name`, the visible name of the instance in the Cloud Console UI, and the prefix for the default hostname of the instance as defined by the [default internal DNS name](https://cloud.google.com/compute/docs/internal-dns#instance-fully-qualified-domain-names) # # @note StabilityLevel.EXPERIMENTAL GCP_GCE_INSTANCE_NAME = 'gcp.gce.instance.name' - + + # @!endgroup + + # @!group Metric Names # @!endgroup end + end # module Incubating end end \ No newline at end of file diff --git a/semantic_conventions/lib/opentelemetry/semantic_candidates/attributes/graphql.rb b/semantic_conventions/lib/opentelemetry/semconv/incubating/graphql.rb similarity index 90% rename from semantic_conventions/lib/opentelemetry/semantic_candidates/attributes/graphql.rb rename to semantic_conventions/lib/opentelemetry/semconv/incubating/graphql.rb index 4ed58c6152..3f391e2a21 100644 --- a/semantic_conventions/lib/opentelemetry/semantic_candidates/attributes/graphql.rb +++ b/semantic_conventions/lib/opentelemetry/semconv/incubating/graphql.rb @@ -19,8 +19,9 @@ # This file was autogenerated. Do not edit it by hand. module OpenTelemetry - module SemanticCandidates - module GRAPHQL + module SemConv + module Incubating + module GRAPHQL # @!group Attribute Names # The GraphQL document being executed @@ -29,18 +30,22 @@ module GRAPHQL # # @note StabilityLevel.EXPERIMENTAL GRAPHQL_DOCUMENT = 'graphql.document' - + # The name of the operation being executed # # @note StabilityLevel.EXPERIMENTAL GRAPHQL_OPERATION_NAME = 'graphql.operation.name' - + # The type of the operation being executed # # @note StabilityLevel.EXPERIMENTAL GRAPHQL_OPERATION_TYPE = 'graphql.operation.type' - + + # @!endgroup + + # @!group Metric Names # @!endgroup end + end # module Incubating end end \ No newline at end of file diff --git a/semantic_conventions/lib/opentelemetry/semantic_candidates/attributes/heroku.rb b/semantic_conventions/lib/opentelemetry/semconv/incubating/heroku.rb similarity index 90% rename from semantic_conventions/lib/opentelemetry/semantic_candidates/attributes/heroku.rb rename to semantic_conventions/lib/opentelemetry/semconv/incubating/heroku.rb index 172cda73c4..5cce49da4a 100644 --- a/semantic_conventions/lib/opentelemetry/semantic_candidates/attributes/heroku.rb +++ b/semantic_conventions/lib/opentelemetry/semconv/incubating/heroku.rb @@ -19,26 +19,31 @@ # This file was autogenerated. Do not edit it by hand. module OpenTelemetry - module SemanticCandidates - module HEROKU + module SemConv + module Incubating + module HEROKU # @!group Attribute Names # Unique identifier for the application # # @note StabilityLevel.EXPERIMENTAL HEROKU_APP_ID = 'heroku.app.id' - + # Commit hash for the current release # # @note StabilityLevel.EXPERIMENTAL HEROKU_RELEASE_COMMIT = 'heroku.release.commit' - + # Time and date the release was created # # @note StabilityLevel.EXPERIMENTAL HEROKU_RELEASE_CREATION_TIMESTAMP = 'heroku.release.creation_timestamp' - + + # @!endgroup + + # @!group Metric Names # @!endgroup end + end # module Incubating end end \ No newline at end of file diff --git a/semantic_conventions/lib/opentelemetry/semantic_candidates/attributes/host.rb b/semantic_conventions/lib/opentelemetry/semconv/incubating/host.rb similarity index 96% rename from semantic_conventions/lib/opentelemetry/semantic_candidates/attributes/host.rb rename to semantic_conventions/lib/opentelemetry/semconv/incubating/host.rb index 1abd7a9c42..28cca6c82a 100644 --- a/semantic_conventions/lib/opentelemetry/semantic_candidates/attributes/host.rb +++ b/semantic_conventions/lib/opentelemetry/semconv/incubating/host.rb @@ -19,92 +19,97 @@ # This file was autogenerated. Do not edit it by hand. module OpenTelemetry - module SemanticCandidates - module HOST + module SemConv + module Incubating + module HOST # @!group Attribute Names # The CPU architecture the host system is running on # # @note StabilityLevel.EXPERIMENTAL HOST_ARCH = 'host.arch' - + # The amount of level 2 memory cache available to the processor (in Bytes) # # @note StabilityLevel.EXPERIMENTAL HOST_CPU_CACHE_L2_SIZE = 'host.cpu.cache.l2.size' - + # Family or generation of the CPU # # @note StabilityLevel.EXPERIMENTAL HOST_CPU_FAMILY = 'host.cpu.family' - + # Model identifier. It provides more granular information about the CPU, distinguishing it from other CPUs within the same family # # @note StabilityLevel.EXPERIMENTAL HOST_CPU_MODEL_ID = 'host.cpu.model.id' - + # Model designation of the processor # # @note StabilityLevel.EXPERIMENTAL HOST_CPU_MODEL_NAME = 'host.cpu.model.name' - + # Stepping or core revisions # # @note StabilityLevel.EXPERIMENTAL HOST_CPU_STEPPING = 'host.cpu.stepping' - + # Processor manufacturer identifier. A maximum 12-character string # # [CPUID](https://wiki.osdev.org/CPUID) command returns the vendor ID string in EBX, EDX and ECX registers. Writing these to memory in this order results in a 12-character string # # @note StabilityLevel.EXPERIMENTAL HOST_CPU_VENDOR_ID = 'host.cpu.vendor.id' - + # Unique host ID. For Cloud, this must be the instance_id assigned by the cloud provider. For non-containerized systems, this should be the `machine-id`. See the table below for the sources to use to determine the `machine-id` based on operating system # # @note StabilityLevel.EXPERIMENTAL HOST_ID = 'host.id' - + # VM image ID or host OS image ID. For Cloud, this value is from the provider # # @note StabilityLevel.EXPERIMENTAL HOST_IMAGE_ID = 'host.image.id' - + # Name of the VM image or OS install the host was instantiated from # # @note StabilityLevel.EXPERIMENTAL HOST_IMAGE_NAME = 'host.image.name' - + # The version string of the VM image or host OS as defined in [Version Attributes](/docs/resource/README.md#version-attributes) # # @note StabilityLevel.EXPERIMENTAL HOST_IMAGE_VERSION = 'host.image.version' - + # Available IP addresses of the host, excluding loopback interfaces # # IPv4 Addresses MUST be specified in dotted-quad notation. IPv6 addresses MUST be specified in the [RFC 5952](https://www.rfc-editor.org/rfc/rfc5952.html) format # # @note StabilityLevel.EXPERIMENTAL HOST_IP = 'host.ip' - + # Available MAC addresses of the host, excluding loopback interfaces # # MAC Addresses MUST be represented in [IEEE RA hexadecimal form](https://standards.ieee.org/wp-content/uploads/import/documents/tutorials/eui.pdf): as hyphen-separated octets in uppercase hexadecimal form from most to least significant # # @note StabilityLevel.EXPERIMENTAL HOST_MAC = 'host.mac' - + # 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 # # @note StabilityLevel.EXPERIMENTAL HOST_NAME = 'host.name' - + # Type of host. For Cloud, this must be the machine type # # @note StabilityLevel.EXPERIMENTAL HOST_TYPE = 'host.type' - + + # @!endgroup + + # @!group Metric Names # @!endgroup end + end # module Incubating end end \ No newline at end of file diff --git a/semantic_conventions/lib/opentelemetry/semantic_candidates/attributes/http.rb b/semantic_conventions/lib/opentelemetry/semconv/incubating/http.rb similarity index 92% rename from semantic_conventions/lib/opentelemetry/semantic_candidates/attributes/http.rb rename to semantic_conventions/lib/opentelemetry/semconv/incubating/http.rb index 03370e1370..dd2fd2c336 100644 --- a/semantic_conventions/lib/opentelemetry/semantic_candidates/attributes/http.rb +++ b/semantic_conventions/lib/opentelemetry/semconv/incubating/http.rb @@ -19,34 +19,35 @@ # This file was autogenerated. Do not edit it by hand. module OpenTelemetry - module SemanticCandidates - module HTTP + module SemConv + module Incubating + module HTTP # @!group Attribute Names # State of the HTTP connection in the HTTP connection pool # # @note StabilityLevel.EXPERIMENTAL HTTP_CONNECTION_STATE = 'http.connection.state' - + # Deprecated, use `network.protocol.name` instead # # @note StabilityLevel.EXPERIMENTAL # # @deprecated Replaced by `network.protocol.name` HTTP_FLAVOR = 'http.flavor' - + # Deprecated, use `http.request.method` instead # # @note StabilityLevel.EXPERIMENTAL # # @deprecated Replaced by `http.request.method` HTTP_METHOD = 'http.method' - + # The size of the request payload body in bytes. This is the number of bytes transferred excluding headers and is often, but not always, present as the [Content-Length](https://www.rfc-editor.org/rfc/rfc9110.html#field.content-length) header. For requests using transport encoding, this should be the compressed size # # @note StabilityLevel.EXPERIMENTAL HTTP_REQUEST_BODY_SIZE = 'http.request.body.size' - + # HTTP request headers, `` being the normalized HTTP Header name (lowercase), the value being the header values # # Instrumentations SHOULD require an explicit configuration of which headers are to be captured. Including all request headers can be a security risk - explicit configuration helps avoid leaking sensitive information. @@ -55,9 +56,9 @@ module HTTP # # @note StabilityLevel.STABLE # - # @deprecated Now available in the stable namespace at {OpenTelemetry::SemanticConventions::HTTP::HTTP_REQUEST_HEADER}. - HTTP_REQUEST_HEADER = 'http.request.header' - + # @deprecated Now available in the stable namespace at {OpenTelemetry::SemConv::HTTP::HTTP_REQUEST_HEADER}. + HTTP_REQUEST_HEADER_LAMBDA = -> (key) { "http.request.header.#{key}" } + # HTTP request method # # HTTP request method value SHOULD be "known" to the instrumentation. @@ -77,42 +78,42 @@ module HTTP # # @note StabilityLevel.STABLE # - # @deprecated Now available in the stable namespace at {OpenTelemetry::SemanticConventions::HTTP::HTTP_REQUEST_METHOD}. + # @deprecated Now available in the stable namespace at {OpenTelemetry::SemConv::HTTP::HTTP_REQUEST_METHOD}. HTTP_REQUEST_METHOD = 'http.request.method' - + # Original HTTP method sent by the client in the request line # # @note StabilityLevel.STABLE # - # @deprecated Now available in the stable namespace at {OpenTelemetry::SemanticConventions::HTTP::HTTP_REQUEST_METHOD_ORIGINAL}. + # @deprecated Now available in the stable namespace at {OpenTelemetry::SemConv::HTTP::HTTP_REQUEST_METHOD_ORIGINAL}. HTTP_REQUEST_METHOD_ORIGINAL = 'http.request.method_original' - + # The ordinal number of request resending attempt (for any reason, including redirects) # # The resend count SHOULD be updated each time an HTTP request gets resent by the client, regardless of what was the cause of the resending (e.g. redirection, authorization failure, 503 Server Unavailable, network issues, or any other) # # @note StabilityLevel.STABLE # - # @deprecated Now available in the stable namespace at {OpenTelemetry::SemanticConventions::HTTP::HTTP_REQUEST_RESEND_COUNT}. + # @deprecated Now available in the stable namespace at {OpenTelemetry::SemConv::HTTP::HTTP_REQUEST_RESEND_COUNT}. HTTP_REQUEST_RESEND_COUNT = 'http.request.resend_count' - + # The total size of the request in bytes. This should be the total number of bytes sent over the wire, including the request line (HTTP/1.1), framing (HTTP/2 and HTTP/3), headers, and request body if any # # @note StabilityLevel.EXPERIMENTAL HTTP_REQUEST_SIZE = 'http.request.size' - + # Deprecated, use `http.request.header.content-length` instead # # @note StabilityLevel.EXPERIMENTAL # # @deprecated Replaced by `http.request.header.content-length` HTTP_REQUEST_CONTENT_LENGTH = 'http.request_content_length' - + # The size of the response payload body in bytes. This is the number of bytes transferred excluding headers and is often, but not always, present as the [Content-Length](https://www.rfc-editor.org/rfc/rfc9110.html#field.content-length) header. For requests using transport encoding, this should be the compressed size # # @note StabilityLevel.EXPERIMENTAL HTTP_RESPONSE_BODY_SIZE = 'http.response.body.size' - + # HTTP response headers, `` being the normalized HTTP Header name (lowercase), the value being the header values # # Instrumentations SHOULD require an explicit configuration of which headers are to be captured. Including all response headers can be a security risk - explicit configuration helps avoid leaking sensitive information. @@ -121,28 +122,28 @@ module HTTP # # @note StabilityLevel.STABLE # - # @deprecated Now available in the stable namespace at {OpenTelemetry::SemanticConventions::HTTP::HTTP_RESPONSE_HEADER}. - HTTP_RESPONSE_HEADER = 'http.response.header' - + # @deprecated Now available in the stable namespace at {OpenTelemetry::SemConv::HTTP::HTTP_RESPONSE_HEADER}. + HTTP_RESPONSE_HEADER_LAMBDA = -> (key) { "http.response.header.#{key}" } + # The total size of the response in bytes. This should be the total number of bytes sent over the wire, including the status line (HTTP/1.1), framing (HTTP/2 and HTTP/3), headers, and response body and trailers if any # # @note StabilityLevel.EXPERIMENTAL HTTP_RESPONSE_SIZE = 'http.response.size' - + # [HTTP response status code](https://tools.ietf.org/html/rfc7231#section-6) # # @note StabilityLevel.STABLE # - # @deprecated Now available in the stable namespace at {OpenTelemetry::SemanticConventions::HTTP::HTTP_RESPONSE_STATUS_CODE}. + # @deprecated Now available in the stable namespace at {OpenTelemetry::SemConv::HTTP::HTTP_RESPONSE_STATUS_CODE}. HTTP_RESPONSE_STATUS_CODE = 'http.response.status_code' - + # Deprecated, use `http.response.header.content-length` instead # # @note StabilityLevel.EXPERIMENTAL # # @deprecated Replaced by `http.response.header.content-length` HTTP_RESPONSE_CONTENT_LENGTH = 'http.response_content_length' - + # The matched route, that is, the path template in the format used by the respective server framework # # MUST NOT be populated when this is not supported by the HTTP server framework as the route attribute should have low-cardinality and the URI path can NOT substitute it. @@ -150,45 +151,49 @@ module HTTP # # @note StabilityLevel.STABLE # - # @deprecated Now available in the stable namespace at {OpenTelemetry::SemanticConventions::HTTP::HTTP_ROUTE}. + # @deprecated Now available in the stable namespace at {OpenTelemetry::SemConv::HTTP::HTTP_ROUTE}. HTTP_ROUTE = 'http.route' - + # Deprecated, use `url.scheme` instead # # @note StabilityLevel.EXPERIMENTAL # # @deprecated Replaced by `url.scheme` instead HTTP_SCHEME = 'http.scheme' - + # Deprecated, use `http.response.status_code` instead # # @note StabilityLevel.EXPERIMENTAL # # @deprecated Replaced by `http.response.status_code` HTTP_STATUS_CODE = 'http.status_code' - + # Deprecated, use `url.path` and `url.query` instead # # @note StabilityLevel.EXPERIMENTAL # # @deprecated Split to `url.path` and `url.query HTTP_TARGET = 'http.target' - + # Deprecated, use `url.full` instead # # @note StabilityLevel.EXPERIMENTAL # # @deprecated Replaced by `url.full` HTTP_URL = 'http.url' - + # Deprecated, use `user_agent.original` instead # # @note StabilityLevel.EXPERIMENTAL # # @deprecated Replaced by `user_agent.original` HTTP_USER_AGENT = 'http.user_agent' - + + # @!endgroup + + # @!group Metric Names # @!endgroup end + end # module Incubating end end \ No newline at end of file diff --git a/semantic_conventions/lib/opentelemetry/semantic_candidates/attributes/ios.rb b/semantic_conventions/lib/opentelemetry/semconv/incubating/ios.rb similarity index 90% rename from semantic_conventions/lib/opentelemetry/semantic_candidates/attributes/ios.rb rename to semantic_conventions/lib/opentelemetry/semconv/incubating/ios.rb index 01e2519ddf..a94f6fa165 100644 --- a/semantic_conventions/lib/opentelemetry/semantic_candidates/attributes/ios.rb +++ b/semantic_conventions/lib/opentelemetry/semconv/incubating/ios.rb @@ -19,8 +19,9 @@ # This file was autogenerated. Do not edit it by hand. module OpenTelemetry - module SemanticCandidates - module IOS + module SemConv + module Incubating + module IOS # @!group Attribute Names # This attribute represents the state the application has transitioned into at the occurrence of the event @@ -29,8 +30,12 @@ module IOS # # @note StabilityLevel.EXPERIMENTAL IOS_STATE = 'ios.state' - + + # @!endgroup + + # @!group Metric Names # @!endgroup end + end # module Incubating end end \ No newline at end of file diff --git a/semantic_conventions/lib/opentelemetry/semantic_candidates/attributes/jvm.rb b/semantic_conventions/lib/opentelemetry/semconv/incubating/jvm.rb similarity index 87% rename from semantic_conventions/lib/opentelemetry/semantic_candidates/attributes/jvm.rb rename to semantic_conventions/lib/opentelemetry/semconv/incubating/jvm.rb index de6c0d7112..517776ce82 100644 --- a/semantic_conventions/lib/opentelemetry/semantic_candidates/attributes/jvm.rb +++ b/semantic_conventions/lib/opentelemetry/semconv/incubating/jvm.rb @@ -19,8 +19,9 @@ # This file was autogenerated. Do not edit it by hand. module OpenTelemetry - module SemanticCandidates - module JVM + module SemConv + module Incubating + module JVM # @!group Attribute Names # Name of the buffer pool @@ -29,56 +30,60 @@ module JVM # # @note StabilityLevel.EXPERIMENTAL JVM_BUFFER_POOL_NAME = 'jvm.buffer.pool.name' - + # Name of the garbage collector action # # Garbage collector action is generally obtained via [GarbageCollectionNotificationInfo#getGcAction()](https://docs.oracle.com/en/java/javase/11/docs/api/jdk.management/com/sun/management/GarbageCollectionNotificationInfo.html#getGcAction()) # # @note StabilityLevel.STABLE # - # @deprecated Now available in the stable namespace at {OpenTelemetry::SemanticConventions::JVM::JVM_GC_ACTION}. + # @deprecated Now available in the stable namespace at {OpenTelemetry::SemConv::JVM::JVM_GC_ACTION}. JVM_GC_ACTION = 'jvm.gc.action' - + # Name of the garbage collector # # Garbage collector name is generally obtained via [GarbageCollectionNotificationInfo#getGcName()](https://docs.oracle.com/en/java/javase/11/docs/api/jdk.management/com/sun/management/GarbageCollectionNotificationInfo.html#getGcName()) # # @note StabilityLevel.STABLE # - # @deprecated Now available in the stable namespace at {OpenTelemetry::SemanticConventions::JVM::JVM_GC_NAME}. + # @deprecated Now available in the stable namespace at {OpenTelemetry::SemConv::JVM::JVM_GC_NAME}. JVM_GC_NAME = 'jvm.gc.name' - + # Name of the memory pool # # Pool names are generally obtained via [MemoryPoolMXBean#getName()](https://docs.oracle.com/en/java/javase/11/docs/api/java.management/java/lang/management/MemoryPoolMXBean.html#getName()) # # @note StabilityLevel.STABLE # - # @deprecated Now available in the stable namespace at {OpenTelemetry::SemanticConventions::JVM::JVM_MEMORY_POOL_NAME}. + # @deprecated Now available in the stable namespace at {OpenTelemetry::SemConv::JVM::JVM_MEMORY_POOL_NAME}. JVM_MEMORY_POOL_NAME = 'jvm.memory.pool.name' - + # The type of memory # # @note StabilityLevel.STABLE # - # @deprecated Now available in the stable namespace at {OpenTelemetry::SemanticConventions::JVM::JVM_MEMORY_TYPE}. + # @deprecated Now available in the stable namespace at {OpenTelemetry::SemConv::JVM::JVM_MEMORY_TYPE}. JVM_MEMORY_TYPE = 'jvm.memory.type' - + # Whether the thread is daemon or not # # @note StabilityLevel.STABLE # - # @deprecated Now available in the stable namespace at {OpenTelemetry::SemanticConventions::JVM::JVM_THREAD_DAEMON}. + # @deprecated Now available in the stable namespace at {OpenTelemetry::SemConv::JVM::JVM_THREAD_DAEMON}. JVM_THREAD_DAEMON = 'jvm.thread.daemon' - + # State of the thread # # @note StabilityLevel.STABLE # - # @deprecated Now available in the stable namespace at {OpenTelemetry::SemanticConventions::JVM::JVM_THREAD_STATE}. + # @deprecated Now available in the stable namespace at {OpenTelemetry::SemConv::JVM::JVM_THREAD_STATE}. JVM_THREAD_STATE = 'jvm.thread.state' - + + # @!endgroup + + # @!group Metric Names # @!endgroup end + end # module Incubating end end \ No newline at end of file diff --git a/semantic_conventions/lib/opentelemetry/semantic_candidates/attributes/k8s.rb b/semantic_conventions/lib/opentelemetry/semconv/incubating/k8s.rb similarity index 93% rename from semantic_conventions/lib/opentelemetry/semantic_candidates/attributes/k8s.rb rename to semantic_conventions/lib/opentelemetry/semconv/incubating/k8s.rb index 15734cebfd..e996345d4c 100644 --- a/semantic_conventions/lib/opentelemetry/semantic_candidates/attributes/k8s.rb +++ b/semantic_conventions/lib/opentelemetry/semconv/incubating/k8s.rb @@ -19,15 +19,16 @@ # This file was autogenerated. Do not edit it by hand. module OpenTelemetry - module SemanticCandidates - module K8S + module SemConv + module Incubating + module K8S # @!group Attribute Names # The name of the cluster # # @note StabilityLevel.EXPERIMENTAL K8S_CLUSTER_NAME = 'k8s.cluster.name' - + # A pseudo-ID for the cluster, set to the UID of the `kube-system` namespace # # K8s doesn't have support for obtaining a cluster ID. If this is ever @@ -55,120 +56,124 @@ module K8S # # @note StabilityLevel.EXPERIMENTAL K8S_CLUSTER_UID = 'k8s.cluster.uid' - + # The name of the Container from Pod specification, must be unique within a Pod. Container runtime usually uses different globally unique name (`container.name`) # # @note StabilityLevel.EXPERIMENTAL K8S_CONTAINER_NAME = 'k8s.container.name' - + # Number of times the container was restarted. This attribute can be used to identify a particular container (running or stopped) within a container spec # # @note StabilityLevel.EXPERIMENTAL K8S_CONTAINER_RESTART_COUNT = 'k8s.container.restart_count' - + # The name of the CronJob # # @note StabilityLevel.EXPERIMENTAL K8S_CRONJOB_NAME = 'k8s.cronjob.name' - + # The UID of the CronJob # # @note StabilityLevel.EXPERIMENTAL K8S_CRONJOB_UID = 'k8s.cronjob.uid' - + # The name of the DaemonSet # # @note StabilityLevel.EXPERIMENTAL K8S_DAEMONSET_NAME = 'k8s.daemonset.name' - + # The UID of the DaemonSet # # @note StabilityLevel.EXPERIMENTAL K8S_DAEMONSET_UID = 'k8s.daemonset.uid' - + # The name of the Deployment # # @note StabilityLevel.EXPERIMENTAL K8S_DEPLOYMENT_NAME = 'k8s.deployment.name' - + # The UID of the Deployment # # @note StabilityLevel.EXPERIMENTAL K8S_DEPLOYMENT_UID = 'k8s.deployment.uid' - + # The name of the Job # # @note StabilityLevel.EXPERIMENTAL K8S_JOB_NAME = 'k8s.job.name' - + # The UID of the Job # # @note StabilityLevel.EXPERIMENTAL K8S_JOB_UID = 'k8s.job.uid' - + # The name of the namespace that the pod is running in # # @note StabilityLevel.EXPERIMENTAL K8S_NAMESPACE_NAME = 'k8s.namespace.name' - + # The name of the Node # # @note StabilityLevel.EXPERIMENTAL K8S_NODE_NAME = 'k8s.node.name' - + # The UID of the Node # # @note StabilityLevel.EXPERIMENTAL K8S_NODE_UID = 'k8s.node.uid' - + # The annotation key-value pairs placed on the Pod, the `` being the annotation name, the value being the annotation value # # @note StabilityLevel.EXPERIMENTAL - K8S_POD_ANNOTATION = 'k8s.pod.annotation' - + K8S_POD_ANNOTATION_LAMBDA = -> (key) { "k8s.pod.annotation.#{key}" } + # The label key-value pairs placed on the Pod, the `` being the label name, the value being the label value # # @note StabilityLevel.EXPERIMENTAL - K8S_POD_LABEL = 'k8s.pod.label' - + K8S_POD_LABEL_LAMBDA = -> (key) { "k8s.pod.label.#{key}" } + # Deprecated, use `k8s.pod.label` instead # # @note StabilityLevel.EXPERIMENTAL # # @deprecated Replaced by `k8s.pod.label` - K8S_POD_LABELS = 'k8s.pod.labels' - + K8S_POD_LABELS_LAMBDA = -> (key) { "k8s.pod.labels.#{key}" } + # The name of the Pod # # @note StabilityLevel.EXPERIMENTAL K8S_POD_NAME = 'k8s.pod.name' - + # The UID of the Pod # # @note StabilityLevel.EXPERIMENTAL K8S_POD_UID = 'k8s.pod.uid' - + # The name of the ReplicaSet # # @note StabilityLevel.EXPERIMENTAL K8S_REPLICASET_NAME = 'k8s.replicaset.name' - + # The UID of the ReplicaSet # # @note StabilityLevel.EXPERIMENTAL K8S_REPLICASET_UID = 'k8s.replicaset.uid' - + # The name of the StatefulSet # # @note StabilityLevel.EXPERIMENTAL K8S_STATEFULSET_NAME = 'k8s.statefulset.name' - + # The UID of the StatefulSet # # @note StabilityLevel.EXPERIMENTAL K8S_STATEFULSET_UID = 'k8s.statefulset.uid' - + + # @!endgroup + + # @!group Metric Names # @!endgroup end + end # module Incubating end end \ No newline at end of file diff --git a/semantic_conventions/lib/opentelemetry/semantic_candidates/attributes/log.rb b/semantic_conventions/lib/opentelemetry/semconv/incubating/log.rb similarity index 93% rename from semantic_conventions/lib/opentelemetry/semantic_candidates/attributes/log.rb rename to semantic_conventions/lib/opentelemetry/semconv/incubating/log.rb index 74659a3534..f297f94677 100644 --- a/semantic_conventions/lib/opentelemetry/semantic_candidates/attributes/log.rb +++ b/semantic_conventions/lib/opentelemetry/semconv/incubating/log.rb @@ -19,35 +19,36 @@ # This file was autogenerated. Do not edit it by hand. module OpenTelemetry - module SemanticCandidates - module LOG + module SemConv + module Incubating + module LOG # @!group Attribute Names # The basename of the file # # @note StabilityLevel.EXPERIMENTAL LOG_FILE_NAME = 'log.file.name' - + # The basename of the file, with symlinks resolved # # @note StabilityLevel.EXPERIMENTAL LOG_FILE_NAME_RESOLVED = 'log.file.name_resolved' - + # The full path to the file # # @note StabilityLevel.EXPERIMENTAL LOG_FILE_PATH = 'log.file.path' - + # The full path to the file, with symlinks resolved # # @note StabilityLevel.EXPERIMENTAL LOG_FILE_PATH_RESOLVED = 'log.file.path_resolved' - + # The stream associated with the log. See below for a list of well-known values # # @note StabilityLevel.EXPERIMENTAL LOG_IOSTREAM = 'log.iostream' - + # A unique identifier for the Log Record # # If an id is provided, other log records with the same id will be considered duplicates and can be removed safely. This means, that two distinguishable log records MUST have different values. @@ -55,8 +56,12 @@ module LOG # # @note StabilityLevel.EXPERIMENTAL LOG_RECORD_UID = 'log.record.uid' - + + # @!endgroup + + # @!group Metric Names # @!endgroup end + end # module Incubating end end \ No newline at end of file diff --git a/semantic_conventions/lib/opentelemetry/semantic_candidates/attributes/message.rb b/semantic_conventions/lib/opentelemetry/semconv/incubating/message.rb similarity index 91% rename from semantic_conventions/lib/opentelemetry/semantic_candidates/attributes/message.rb rename to semantic_conventions/lib/opentelemetry/semconv/incubating/message.rb index af6f9d0928..eaa20b90bd 100644 --- a/semantic_conventions/lib/opentelemetry/semantic_candidates/attributes/message.rb +++ b/semantic_conventions/lib/opentelemetry/semconv/incubating/message.rb @@ -19,33 +19,38 @@ # This file was autogenerated. Do not edit it by hand. module OpenTelemetry - module SemanticCandidates - module MESSAGE + module SemConv + module Incubating + module MESSAGE # @!group Attribute Names # Compressed size of the message in bytes # # @note StabilityLevel.EXPERIMENTAL MESSAGE_COMPRESSED_SIZE = 'message.compressed_size' - + # MUST be calculated as two different counters starting from `1` one for sent messages and one for received message # # This way we guarantee that the values will be consistent between different implementations # # @note StabilityLevel.EXPERIMENTAL MESSAGE_ID = 'message.id' - + # Whether this is a received or sent message # # @note StabilityLevel.EXPERIMENTAL MESSAGE_TYPE = 'message.type' - + # Uncompressed size of the message in bytes # # @note StabilityLevel.EXPERIMENTAL MESSAGE_UNCOMPRESSED_SIZE = 'message.uncompressed_size' - + + # @!endgroup + + # @!group Metric Names # @!endgroup end + end # module Incubating end end \ No newline at end of file diff --git a/semantic_conventions/lib/opentelemetry/semantic_candidates/attributes/messaging.rb b/semantic_conventions/lib/opentelemetry/semconv/incubating/messaging.rb similarity index 97% rename from semantic_conventions/lib/opentelemetry/semantic_candidates/attributes/messaging.rb rename to semantic_conventions/lib/opentelemetry/semconv/incubating/messaging.rb index d24304f80c..16c63e070c 100644 --- a/semantic_conventions/lib/opentelemetry/semantic_candidates/attributes/messaging.rb +++ b/semantic_conventions/lib/opentelemetry/semconv/incubating/messaging.rb @@ -19,8 +19,9 @@ # This file was autogenerated. Do not edit it by hand. module OpenTelemetry - module SemanticCandidates - module MESSAGING + module SemConv + module Incubating + module MESSAGING # @!group Attribute Names # The number of messages sent, received, or processed in the scope of the batching operation @@ -29,17 +30,17 @@ module MESSAGING # # @note StabilityLevel.EXPERIMENTAL MESSAGING_BATCH_MESSAGE_COUNT = 'messaging.batch.message_count' - + # A unique identifier for the client that consumes or produces a message # # @note StabilityLevel.EXPERIMENTAL MESSAGING_CLIENT_ID = 'messaging.client_id' - + # A boolean that is true if the message destination is anonymous (could be unnamed or have auto-generated name) # # @note StabilityLevel.EXPERIMENTAL MESSAGING_DESTINATION_ANONYMOUS = 'messaging.destination.anonymous' - + # The message destination name # # Destination name SHOULD uniquely identify a specific queue, topic or other entity within the broker. If @@ -47,29 +48,29 @@ module MESSAGING # # @note StabilityLevel.EXPERIMENTAL MESSAGING_DESTINATION_NAME = 'messaging.destination.name' - + # The identifier of the partition messages are sent to or received from, unique within the `messaging.destination.name` # # @note StabilityLevel.EXPERIMENTAL MESSAGING_DESTINATION_PARTITION_ID = 'messaging.destination.partition.id' - + # Low cardinality representation of the messaging destination name # # Destination names could be constructed from templates. An example would be a destination name involving a user name or product id. Although the destination name in this case is of high cardinality, the underlying template is of low cardinality and can be effectively used for grouping and aggregation # # @note StabilityLevel.EXPERIMENTAL MESSAGING_DESTINATION_TEMPLATE = 'messaging.destination.template' - + # A boolean that is true if the message destination is temporary and might not exist anymore after messages are processed # # @note StabilityLevel.EXPERIMENTAL MESSAGING_DESTINATION_TEMPORARY = 'messaging.destination.temporary' - + # A boolean that is true if the publish message destination is anonymous (could be unnamed or have auto-generated name) # # @note StabilityLevel.EXPERIMENTAL MESSAGING_DESTINATION_PUBLISH_ANONYMOUS = 'messaging.destination_publish.anonymous' - + # The name of the original destination the message was published to # # The name SHOULD uniquely identify a specific queue, topic, or other entity within the broker. If @@ -77,51 +78,51 @@ module MESSAGING # # @note StabilityLevel.EXPERIMENTAL MESSAGING_DESTINATION_PUBLISH_NAME = 'messaging.destination_publish.name' - + # The name of the consumer group the event consumer is associated with # # @note StabilityLevel.EXPERIMENTAL MESSAGING_EVENTHUBS_CONSUMER_GROUP = 'messaging.eventhubs.consumer.group' - + # The UTC epoch seconds at which the message has been accepted and stored in the entity # # @note StabilityLevel.EXPERIMENTAL MESSAGING_EVENTHUBS_MESSAGE_ENQUEUED_TIME = 'messaging.eventhubs.message.enqueued_time' - + # The ordering key for a given message. If the attribute is not present, the message does not have an ordering key # # @note StabilityLevel.EXPERIMENTAL MESSAGING_GCP_PUBSUB_MESSAGE_ORDERING_KEY = 'messaging.gcp_pubsub.message.ordering_key' - + # Name of the Kafka Consumer Group that is handling the message. Only applies to consumers, not producers # # @note StabilityLevel.EXPERIMENTAL MESSAGING_KAFKA_CONSUMER_GROUP = 'messaging.kafka.consumer.group' - + # "Deprecated, use `messaging.destination.partition.id` instead." # # @note StabilityLevel.EXPERIMENTAL # # @deprecated Replaced by `messaging.destination.partition.id` MESSAGING_KAFKA_DESTINATION_PARTITION = 'messaging.kafka.destination.partition' - + # 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 # # 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 # # @note StabilityLevel.EXPERIMENTAL MESSAGING_KAFKA_MESSAGE_KEY = 'messaging.kafka.message.key' - + # The offset of a record in the corresponding Kafka partition # # @note StabilityLevel.EXPERIMENTAL MESSAGING_KAFKA_MESSAGE_OFFSET = 'messaging.kafka.message.offset' - + # A boolean that is true if the message is a tombstone # # @note StabilityLevel.EXPERIMENTAL MESSAGING_KAFKA_MESSAGE_TOMBSTONE = 'messaging.kafka.message.tombstone' - + # The size of the message body in bytes # # This can refer to both the compressed or uncompressed body size. If both sizes are known, the uncompressed @@ -129,12 +130,12 @@ module MESSAGING # # @note StabilityLevel.EXPERIMENTAL MESSAGING_MESSAGE_BODY_SIZE = 'messaging.message.body.size' - + # The conversation ID identifying the conversation to which the message belongs, represented as a string. Sometimes called "Correlation ID" # # @note StabilityLevel.EXPERIMENTAL MESSAGING_MESSAGE_CONVERSATION_ID = 'messaging.message.conversation_id' - + # The size of the message body and metadata in bytes # # This can refer to both the compressed or uncompressed size. If both sizes are known, the uncompressed @@ -142,100 +143,104 @@ module MESSAGING # # @note StabilityLevel.EXPERIMENTAL MESSAGING_MESSAGE_ENVELOPE_SIZE = 'messaging.message.envelope.size' - + # A value used by the messaging system as an identifier for the message, represented as a string # # @note StabilityLevel.EXPERIMENTAL MESSAGING_MESSAGE_ID = 'messaging.message.id' - + # A string identifying the kind of messaging operation # # If a custom value is used, it MUST be of low cardinality # # @note StabilityLevel.EXPERIMENTAL MESSAGING_OPERATION = 'messaging.operation' - + # RabbitMQ message routing key # # @note StabilityLevel.EXPERIMENTAL MESSAGING_RABBITMQ_DESTINATION_ROUTING_KEY = 'messaging.rabbitmq.destination.routing_key' - + # RabbitMQ message delivery tag # # @note StabilityLevel.EXPERIMENTAL MESSAGING_RABBITMQ_MESSAGE_DELIVERY_TAG = 'messaging.rabbitmq.message.delivery_tag' - + # Name of the RocketMQ producer/consumer group that is handling the message. The client type is identified by the SpanKind # # @note StabilityLevel.EXPERIMENTAL MESSAGING_ROCKETMQ_CLIENT_GROUP = 'messaging.rocketmq.client_group' - + # Model of message consumption. This only applies to consumer spans # # @note StabilityLevel.EXPERIMENTAL MESSAGING_ROCKETMQ_CONSUMPTION_MODEL = 'messaging.rocketmq.consumption_model' - + # The delay time level for delay message, which determines the message delay time # # @note StabilityLevel.EXPERIMENTAL MESSAGING_ROCKETMQ_MESSAGE_DELAY_TIME_LEVEL = 'messaging.rocketmq.message.delay_time_level' - + # The timestamp in milliseconds that the delay message is expected to be delivered to consumer # # @note StabilityLevel.EXPERIMENTAL MESSAGING_ROCKETMQ_MESSAGE_DELIVERY_TIMESTAMP = 'messaging.rocketmq.message.delivery_timestamp' - + # It is essential for FIFO message. Messages that belong to the same message group are always processed one by one within the same consumer group # # @note StabilityLevel.EXPERIMENTAL MESSAGING_ROCKETMQ_MESSAGE_GROUP = 'messaging.rocketmq.message.group' - + # Key(s) of message, another way to mark message besides message id # # @note StabilityLevel.EXPERIMENTAL MESSAGING_ROCKETMQ_MESSAGE_KEYS = 'messaging.rocketmq.message.keys' - + # The secondary classifier of message besides topic # # @note StabilityLevel.EXPERIMENTAL MESSAGING_ROCKETMQ_MESSAGE_TAG = 'messaging.rocketmq.message.tag' - + # Type of message # # @note StabilityLevel.EXPERIMENTAL MESSAGING_ROCKETMQ_MESSAGE_TYPE = 'messaging.rocketmq.message.type' - + # Namespace of RocketMQ resources, resources in different namespaces are individual # # @note StabilityLevel.EXPERIMENTAL MESSAGING_ROCKETMQ_NAMESPACE = 'messaging.rocketmq.namespace' - + # The name of the subscription in the topic messages are received from # # @note StabilityLevel.EXPERIMENTAL MESSAGING_SERVICEBUS_DESTINATION_SUBSCRIPTION_NAME = 'messaging.servicebus.destination.subscription_name' - + # Describes the [settlement type](https://learn.microsoft.com/azure/service-bus-messaging/message-transfers-locks-settlement#peeklock) # # @note StabilityLevel.EXPERIMENTAL MESSAGING_SERVICEBUS_DISPOSITION_STATUS = 'messaging.servicebus.disposition_status' - + # Number of deliveries that have been attempted for this message # # @note StabilityLevel.EXPERIMENTAL MESSAGING_SERVICEBUS_MESSAGE_DELIVERY_COUNT = 'messaging.servicebus.message.delivery_count' - + # The UTC epoch seconds at which the message has been accepted and stored in the entity # # @note StabilityLevel.EXPERIMENTAL MESSAGING_SERVICEBUS_MESSAGE_ENQUEUED_TIME = 'messaging.servicebus.message.enqueued_time' - + # An identifier for the messaging system being used. See below for a list of well-known identifiers # # @note StabilityLevel.EXPERIMENTAL MESSAGING_SYSTEM = 'messaging.system' - + + # @!endgroup + + # @!group Metric Names # @!endgroup end + end # module Incubating end end \ No newline at end of file diff --git a/semantic_conventions/lib/opentelemetry/semantic_candidates/attributes/net.rb b/semantic_conventions/lib/opentelemetry/semconv/incubating/net.rb similarity index 95% rename from semantic_conventions/lib/opentelemetry/semantic_candidates/attributes/net.rb rename to semantic_conventions/lib/opentelemetry/semconv/incubating/net.rb index f0c8563fbb..f5611134df 100644 --- a/semantic_conventions/lib/opentelemetry/semantic_candidates/attributes/net.rb +++ b/semantic_conventions/lib/opentelemetry/semconv/incubating/net.rb @@ -19,8 +19,9 @@ # This file was autogenerated. Do not edit it by hand. module OpenTelemetry - module SemanticCandidates - module NET + module SemConv + module Incubating + module NET # @!group Attribute Names # Deprecated, use `server.address` @@ -29,92 +30,96 @@ module NET # # @deprecated Replaced by `server.address` NET_HOST_NAME = 'net.host.name' - + # Deprecated, use `server.port` # # @note StabilityLevel.EXPERIMENTAL # # @deprecated Replaced by `server.port` NET_HOST_PORT = 'net.host.port' - + # Deprecated, use `server.address` on client spans and `client.address` on server spans # # @note StabilityLevel.EXPERIMENTAL # # @deprecated Replaced by `server.address` on client spans and `client.address` on server spans NET_PEER_NAME = 'net.peer.name' - + # Deprecated, use `server.port` on client spans and `client.port` on server spans # # @note StabilityLevel.EXPERIMENTAL # # @deprecated Replaced by `server.port` on client spans and `client.port` on server spans NET_PEER_PORT = 'net.peer.port' - + # Deprecated, use `network.protocol.name` # # @note StabilityLevel.EXPERIMENTAL # # @deprecated Replaced by `network.protocol.name` NET_PROTOCOL_NAME = 'net.protocol.name' - + # Deprecated, use `network.protocol.version` # # @note StabilityLevel.EXPERIMENTAL # # @deprecated Replaced by `network.protocol.version` NET_PROTOCOL_VERSION = 'net.protocol.version' - + # Deprecated, use `network.transport` and `network.type` # # @note StabilityLevel.EXPERIMENTAL # # @deprecated Split to `network.transport` and `network.type` NET_SOCK_FAMILY = 'net.sock.family' - + # Deprecated, use `network.local.address` # # @note StabilityLevel.EXPERIMENTAL # # @deprecated Replaced by `network.local.address` NET_SOCK_HOST_ADDR = 'net.sock.host.addr' - + # Deprecated, use `network.local.port` # # @note StabilityLevel.EXPERIMENTAL # # @deprecated Replaced by `network.local.port` NET_SOCK_HOST_PORT = 'net.sock.host.port' - + # Deprecated, use `network.peer.address` # # @note StabilityLevel.EXPERIMENTAL # # @deprecated Replaced by `network.peer.address` NET_SOCK_PEER_ADDR = 'net.sock.peer.addr' - + # Deprecated, no replacement at this time # # @note StabilityLevel.EXPERIMENTAL # # @deprecated Removed NET_SOCK_PEER_NAME = 'net.sock.peer.name' - + # Deprecated, use `network.peer.port` # # @note StabilityLevel.EXPERIMENTAL # # @deprecated Replaced by `network.peer.port` NET_SOCK_PEER_PORT = 'net.sock.peer.port' - + # Deprecated, use `network.transport` # # @note StabilityLevel.EXPERIMENTAL # # @deprecated Replaced by `network.transport` NET_TRANSPORT = 'net.transport' - + + # @!endgroup + + # @!group Metric Names # @!endgroup end + end # module Incubating end end \ No newline at end of file diff --git a/semantic_conventions/lib/opentelemetry/semantic_candidates/attributes/network.rb b/semantic_conventions/lib/opentelemetry/semconv/incubating/network.rb similarity index 88% rename from semantic_conventions/lib/opentelemetry/semantic_candidates/attributes/network.rb rename to semantic_conventions/lib/opentelemetry/semconv/incubating/network.rb index ba7c46a305..681ae8594c 100644 --- a/semantic_conventions/lib/opentelemetry/semantic_candidates/attributes/network.rb +++ b/semantic_conventions/lib/opentelemetry/semconv/incubating/network.rb @@ -19,91 +19,92 @@ # This file was autogenerated. Do not edit it by hand. module OpenTelemetry - module SemanticCandidates - module NETWORK + module SemConv + module Incubating + module NETWORK # @!group Attribute Names # The ISO 3166-1 alpha-2 2-character country code associated with the mobile carrier network # # @note StabilityLevel.EXPERIMENTAL NETWORK_CARRIER_ICC = 'network.carrier.icc' - + # The mobile carrier country code # # @note StabilityLevel.EXPERIMENTAL NETWORK_CARRIER_MCC = 'network.carrier.mcc' - + # The mobile carrier network code # # @note StabilityLevel.EXPERIMENTAL NETWORK_CARRIER_MNC = 'network.carrier.mnc' - + # The name of the mobile carrier # # @note StabilityLevel.EXPERIMENTAL NETWORK_CARRIER_NAME = 'network.carrier.name' - + # This describes more details regarding the connection.type. It may be the type of cell technology connection, but it could be used for describing details about a wifi connection # # @note StabilityLevel.EXPERIMENTAL NETWORK_CONNECTION_SUBTYPE = 'network.connection.subtype' - + # The internet connection type # # @note StabilityLevel.EXPERIMENTAL NETWORK_CONNECTION_TYPE = 'network.connection.type' - + # The network IO operation direction # # @note StabilityLevel.EXPERIMENTAL NETWORK_IO_DIRECTION = 'network.io.direction' - + # Local address of the network connection - IP address or Unix domain socket name # # @note StabilityLevel.STABLE # - # @deprecated Now available in the stable namespace at {OpenTelemetry::SemanticConventions::NETWORK::NETWORK_LOCAL_ADDRESS}. + # @deprecated Now available in the stable namespace at {OpenTelemetry::SemConv::NETWORK::NETWORK_LOCAL_ADDRESS}. NETWORK_LOCAL_ADDRESS = 'network.local.address' - + # Local port number of the network connection # # @note StabilityLevel.STABLE # - # @deprecated Now available in the stable namespace at {OpenTelemetry::SemanticConventions::NETWORK::NETWORK_LOCAL_PORT}. + # @deprecated Now available in the stable namespace at {OpenTelemetry::SemConv::NETWORK::NETWORK_LOCAL_PORT}. NETWORK_LOCAL_PORT = 'network.local.port' - + # Peer address of the network connection - IP address or Unix domain socket name # # @note StabilityLevel.STABLE # - # @deprecated Now available in the stable namespace at {OpenTelemetry::SemanticConventions::NETWORK::NETWORK_PEER_ADDRESS}. + # @deprecated Now available in the stable namespace at {OpenTelemetry::SemConv::NETWORK::NETWORK_PEER_ADDRESS}. NETWORK_PEER_ADDRESS = 'network.peer.address' - + # Peer port number of the network connection # # @note StabilityLevel.STABLE # - # @deprecated Now available in the stable namespace at {OpenTelemetry::SemanticConventions::NETWORK::NETWORK_PEER_PORT}. + # @deprecated Now available in the stable namespace at {OpenTelemetry::SemConv::NETWORK::NETWORK_PEER_PORT}. NETWORK_PEER_PORT = 'network.peer.port' - + # [OSI application layer](https://osi-model.com/application-layer/) or non-OSI equivalent # # The value SHOULD be normalized to lowercase # # @note StabilityLevel.STABLE # - # @deprecated Now available in the stable namespace at {OpenTelemetry::SemanticConventions::NETWORK::NETWORK_PROTOCOL_NAME}. + # @deprecated Now available in the stable namespace at {OpenTelemetry::SemConv::NETWORK::NETWORK_PROTOCOL_NAME}. NETWORK_PROTOCOL_NAME = 'network.protocol.name' - + # The actual version of the protocol used for network communication # # If protocol version is subject to negotiation (for example using [ALPN](https://www.rfc-editor.org/rfc/rfc7301.html)), this attribute SHOULD be set to the negotiated version. If the actual protocol version is not known, this attribute SHOULD NOT be set # # @note StabilityLevel.STABLE # - # @deprecated Now available in the stable namespace at {OpenTelemetry::SemanticConventions::NETWORK::NETWORK_PROTOCOL_VERSION}. + # @deprecated Now available in the stable namespace at {OpenTelemetry::SemConv::NETWORK::NETWORK_PROTOCOL_VERSION}. NETWORK_PROTOCOL_VERSION = 'network.protocol.version' - + # [OSI transport layer](https://osi-model.com/transport-layer/) or [inter-process communication method](https://wikipedia.org/wiki/Inter-process_communication) # # The value SHOULD be normalized to lowercase. @@ -114,19 +115,23 @@ module NETWORK # # @note StabilityLevel.STABLE # - # @deprecated Now available in the stable namespace at {OpenTelemetry::SemanticConventions::NETWORK::NETWORK_TRANSPORT}. + # @deprecated Now available in the stable namespace at {OpenTelemetry::SemConv::NETWORK::NETWORK_TRANSPORT}. NETWORK_TRANSPORT = 'network.transport' - + # [OSI network layer](https://osi-model.com/network-layer/) or non-OSI equivalent # # The value SHOULD be normalized to lowercase # # @note StabilityLevel.STABLE # - # @deprecated Now available in the stable namespace at {OpenTelemetry::SemanticConventions::NETWORK::NETWORK_TYPE}. + # @deprecated Now available in the stable namespace at {OpenTelemetry::SemConv::NETWORK::NETWORK_TYPE}. NETWORK_TYPE = 'network.type' - + + # @!endgroup + + # @!group Metric Names # @!endgroup end + end # module Incubating end end \ No newline at end of file diff --git a/semantic_conventions/lib/opentelemetry/semantic_candidates/attributes/oci.rb b/semantic_conventions/lib/opentelemetry/semconv/incubating/oci.rb similarity index 91% rename from semantic_conventions/lib/opentelemetry/semantic_candidates/attributes/oci.rb rename to semantic_conventions/lib/opentelemetry/semconv/incubating/oci.rb index 65a716bd29..4129ed1f16 100644 --- a/semantic_conventions/lib/opentelemetry/semantic_candidates/attributes/oci.rb +++ b/semantic_conventions/lib/opentelemetry/semconv/incubating/oci.rb @@ -19,8 +19,9 @@ # This file was autogenerated. Do not edit it by hand. module OpenTelemetry - module SemanticCandidates - module OCI + module SemConv + module Incubating + module OCI # @!group Attribute Names # The digest of the OCI image manifest. For container images specifically is the digest by which the container image is known @@ -30,8 +31,12 @@ module OCI # # @note StabilityLevel.EXPERIMENTAL OCI_MANIFEST_DIGEST = 'oci.manifest.digest' - + + # @!endgroup + + # @!group Metric Names # @!endgroup end + end # module Incubating end end \ No newline at end of file diff --git a/semantic_conventions/lib/opentelemetry/semantic_candidates/attributes/opentracing.rb b/semantic_conventions/lib/opentelemetry/semconv/incubating/opentracing.rb similarity index 88% rename from semantic_conventions/lib/opentelemetry/semantic_candidates/attributes/opentracing.rb rename to semantic_conventions/lib/opentelemetry/semconv/incubating/opentracing.rb index 237ea71396..cfbb426e48 100644 --- a/semantic_conventions/lib/opentelemetry/semantic_candidates/attributes/opentracing.rb +++ b/semantic_conventions/lib/opentelemetry/semconv/incubating/opentracing.rb @@ -19,8 +19,9 @@ # This file was autogenerated. Do not edit it by hand. module OpenTelemetry - module SemanticCandidates - module OPENTRACING + module SemConv + module Incubating + module OPENTRACING # @!group Attribute Names # Parent-child Reference type @@ -29,8 +30,12 @@ module OPENTRACING # # @note StabilityLevel.EXPERIMENTAL OPENTRACING_REF_TYPE = 'opentracing.ref_type' - + + # @!endgroup + + # @!group Metric Names # @!endgroup end + end # module Incubating end end \ No newline at end of file diff --git a/semantic_conventions/lib/opentelemetry/semantic_candidates/attributes/os.rb b/semantic_conventions/lib/opentelemetry/semconv/incubating/os.rb similarity index 92% rename from semantic_conventions/lib/opentelemetry/semantic_candidates/attributes/os.rb rename to semantic_conventions/lib/opentelemetry/semconv/incubating/os.rb index 8e241d4f9b..8f2664afee 100644 --- a/semantic_conventions/lib/opentelemetry/semantic_candidates/attributes/os.rb +++ b/semantic_conventions/lib/opentelemetry/semconv/incubating/os.rb @@ -19,36 +19,41 @@ # This file was autogenerated. Do not edit it by hand. module OpenTelemetry - module SemanticCandidates - module OS + module SemConv + module Incubating + module OS # @!group Attribute Names # Unique identifier for a particular build or compilation of the operating system # # @note StabilityLevel.EXPERIMENTAL OS_BUILD_ID = 'os.build_id' - + # Human readable (not intended to be parsed) OS version information, like e.g. reported by `ver` or `lsb_release -a` commands # # @note StabilityLevel.EXPERIMENTAL OS_DESCRIPTION = 'os.description' - + # Human readable operating system name # # @note StabilityLevel.EXPERIMENTAL OS_NAME = 'os.name' - + # The operating system type # # @note StabilityLevel.EXPERIMENTAL OS_TYPE = 'os.type' - + # The version string of the operating system as defined in [Version Attributes](/docs/resource/README.md#version-attributes) # # @note StabilityLevel.EXPERIMENTAL OS_VERSION = 'os.version' - + + # @!endgroup + + # @!group Metric Names # @!endgroup end + end # module Incubating end end \ No newline at end of file diff --git a/semantic_conventions/lib/opentelemetry/semantic_candidates/attributes/otel.rb b/semantic_conventions/lib/opentelemetry/semconv/incubating/otel.rb similarity index 86% rename from semantic_conventions/lib/opentelemetry/semantic_candidates/attributes/otel.rb rename to semantic_conventions/lib/opentelemetry/semconv/incubating/otel.rb index 4ae29d3e97..2fecf8972d 100644 --- a/semantic_conventions/lib/opentelemetry/semantic_candidates/attributes/otel.rb +++ b/semantic_conventions/lib/opentelemetry/semconv/incubating/otel.rb @@ -19,8 +19,9 @@ # This file was autogenerated. Do not edit it by hand. module OpenTelemetry - module SemanticCandidates - module OTEL + module SemConv + module Incubating + module OTEL # @!group Attribute Names # None @@ -29,43 +30,47 @@ module OTEL # # @deprecated use the `otel.scope.name` attribute OTEL_LIBRARY_NAME = 'otel.library.name' - + # None # # @note StabilityLevel.EXPERIMENTAL # # @deprecated use the `otel.scope.version` attribute OTEL_LIBRARY_VERSION = 'otel.library.version' - + # The name of the instrumentation scope - (`InstrumentationScope.Name` in OTLP) # # @note StabilityLevel.STABLE # - # @deprecated Now available in the stable namespace at {OpenTelemetry::SemanticConventions::OTEL::OTEL_SCOPE_NAME}. + # @deprecated Now available in the stable namespace at {OpenTelemetry::SemConv::OTEL::OTEL_SCOPE_NAME}. OTEL_SCOPE_NAME = 'otel.scope.name' - + # The version of the instrumentation scope - (`InstrumentationScope.Version` in OTLP) # # @note StabilityLevel.STABLE # - # @deprecated Now available in the stable namespace at {OpenTelemetry::SemanticConventions::OTEL::OTEL_SCOPE_VERSION}. + # @deprecated Now available in the stable namespace at {OpenTelemetry::SemConv::OTEL::OTEL_SCOPE_VERSION}. OTEL_SCOPE_VERSION = 'otel.scope.version' - + # Name of the code, either "OK" or "ERROR". MUST NOT be set if the status code is UNSET # # @note StabilityLevel.STABLE # - # @deprecated Now available in the stable namespace at {OpenTelemetry::SemanticConventions::OTEL::OTEL_STATUS_CODE}. + # @deprecated Now available in the stable namespace at {OpenTelemetry::SemConv::OTEL::OTEL_STATUS_CODE}. OTEL_STATUS_CODE = 'otel.status_code' - + # Description of the Status if it has a value, otherwise not set # # @note StabilityLevel.STABLE # - # @deprecated Now available in the stable namespace at {OpenTelemetry::SemanticConventions::OTEL::OTEL_STATUS_DESCRIPTION}. + # @deprecated Now available in the stable namespace at {OpenTelemetry::SemConv::OTEL::OTEL_STATUS_DESCRIPTION}. OTEL_STATUS_DESCRIPTION = 'otel.status_description' - + + # @!endgroup + + # @!group Metric Names # @!endgroup end + end # module Incubating end end \ No newline at end of file diff --git a/semantic_conventions/lib/opentelemetry/semantic_candidates/attributes/other.rb b/semantic_conventions/lib/opentelemetry/semconv/incubating/other.rb similarity index 87% rename from semantic_conventions/lib/opentelemetry/semantic_candidates/attributes/other.rb rename to semantic_conventions/lib/opentelemetry/semconv/incubating/other.rb index 235764c7d8..752d9d3840 100644 --- a/semantic_conventions/lib/opentelemetry/semantic_candidates/attributes/other.rb +++ b/semantic_conventions/lib/opentelemetry/semconv/incubating/other.rb @@ -19,16 +19,21 @@ # This file was autogenerated. Do not edit it by hand. module OpenTelemetry - module SemanticCandidates - module OTHER + module SemConv + module Incubating + module OTHER # @!group Attribute Names # The state of a connection in the pool # # @note StabilityLevel.EXPERIMENTAL STATE = 'state' - + + # @!endgroup + + # @!group Metric Names # @!endgroup end + end # module Incubating end end \ No newline at end of file diff --git a/semantic_conventions/lib/opentelemetry/semantic_candidates/attributes/peer.rb b/semantic_conventions/lib/opentelemetry/semconv/incubating/peer.rb similarity index 89% rename from semantic_conventions/lib/opentelemetry/semantic_candidates/attributes/peer.rb rename to semantic_conventions/lib/opentelemetry/semconv/incubating/peer.rb index 6303345eff..2d3c6aded0 100644 --- a/semantic_conventions/lib/opentelemetry/semantic_candidates/attributes/peer.rb +++ b/semantic_conventions/lib/opentelemetry/semconv/incubating/peer.rb @@ -19,16 +19,21 @@ # This file was autogenerated. Do not edit it by hand. module OpenTelemetry - module SemanticCandidates - module PEER + module SemConv + module Incubating + module PEER # @!group Attribute Names # The [`service.name`](/docs/resource/README.md#service) of the remote service. SHOULD be equal to the actual `service.name` resource attribute of the remote service if any # # @note StabilityLevel.EXPERIMENTAL PEER_SERVICE = 'peer.service' - + + # @!endgroup + + # @!group Metric Names # @!endgroup end + end # module Incubating end end \ No newline at end of file diff --git a/semantic_conventions/lib/opentelemetry/semantic_candidates/attributes/pool.rb b/semantic_conventions/lib/opentelemetry/semconv/incubating/pool.rb similarity index 89% rename from semantic_conventions/lib/opentelemetry/semantic_candidates/attributes/pool.rb rename to semantic_conventions/lib/opentelemetry/semconv/incubating/pool.rb index d1e3306983..867a6b5e43 100644 --- a/semantic_conventions/lib/opentelemetry/semantic_candidates/attributes/pool.rb +++ b/semantic_conventions/lib/opentelemetry/semconv/incubating/pool.rb @@ -19,16 +19,21 @@ # This file was autogenerated. Do not edit it by hand. module OpenTelemetry - module SemanticCandidates - module POOL + module SemConv + module Incubating + module POOL # @!group Attribute Names # The name of the connection pool; unique within the instrumented application. In case the connection pool implementation doesn't provide a name, instrumentation should use a combination of `server.address` and `server.port` attributes formatted as `server.address:server.port` # # @note StabilityLevel.EXPERIMENTAL POOL_NAME = 'pool.name' - + + # @!endgroup + + # @!group Metric Names # @!endgroup end + end # module Incubating end end \ No newline at end of file diff --git a/semantic_conventions/lib/opentelemetry/semantic_candidates/attributes/process.rb b/semantic_conventions/lib/opentelemetry/semconv/incubating/process.rb similarity index 96% rename from semantic_conventions/lib/opentelemetry/semantic_candidates/attributes/process.rb rename to semantic_conventions/lib/opentelemetry/semconv/incubating/process.rb index 80227ed8e2..de570e4fa4 100644 --- a/semantic_conventions/lib/opentelemetry/semantic_candidates/attributes/process.rb +++ b/semantic_conventions/lib/opentelemetry/semconv/incubating/process.rb @@ -19,81 +19,86 @@ # This file was autogenerated. Do not edit it by hand. module OpenTelemetry - module SemanticCandidates - module PROCESS + module SemConv + module Incubating + module PROCESS # @!group Attribute Names # 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` # # @note StabilityLevel.EXPERIMENTAL PROCESS_COMMAND = 'process.command' - + # 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` # # @note StabilityLevel.EXPERIMENTAL PROCESS_COMMAND_ARGS = 'process.command_args' - + # 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 # # @note StabilityLevel.EXPERIMENTAL PROCESS_COMMAND_LINE = 'process.command_line' - + # Specifies whether the context switches for this data point were voluntary or involuntary # # @note StabilityLevel.EXPERIMENTAL PROCESS_CONTEXT_SWITCH_TYPE = 'process.context_switch_type' - + # The CPU state for this data point. A process SHOULD be characterized _either_ by data points with no `state` labels, _or only_ data points with `state` labels # # @note StabilityLevel.EXPERIMENTAL PROCESS_CPU_STATE = 'process.cpu.state' - + # 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` # # @note StabilityLevel.EXPERIMENTAL PROCESS_EXECUTABLE_NAME = 'process.executable.name' - + # 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` # # @note StabilityLevel.EXPERIMENTAL PROCESS_EXECUTABLE_PATH = 'process.executable.path' - + # The username of the user that owns the process # # @note StabilityLevel.EXPERIMENTAL PROCESS_OWNER = 'process.owner' - + # The type of page fault for this data point. Type `major` is for major/hard page faults, and `minor` is for minor/soft page faults # # @note StabilityLevel.EXPERIMENTAL PROCESS_PAGING_FAULT_TYPE = 'process.paging.fault_type' - + # Parent Process identifier (PPID) # # @note StabilityLevel.EXPERIMENTAL PROCESS_PARENT_PID = 'process.parent_pid' - + # Process identifier (PID) # # @note StabilityLevel.EXPERIMENTAL PROCESS_PID = 'process.pid' - + # An additional description about the runtime of the process, for example a specific vendor customization of the runtime environment # # @note StabilityLevel.EXPERIMENTAL PROCESS_RUNTIME_DESCRIPTION = 'process.runtime.description' - + # The name of the runtime of this process. For compiled native binaries, this SHOULD be the name of the compiler # # @note StabilityLevel.EXPERIMENTAL PROCESS_RUNTIME_NAME = 'process.runtime.name' - + # The version of the runtime of this process, as returned by the runtime without modification # # @note StabilityLevel.EXPERIMENTAL PROCESS_RUNTIME_VERSION = 'process.runtime.version' - + + # @!endgroup + + # @!group Metric Names # @!endgroup end + end # module Incubating end end \ No newline at end of file diff --git a/semantic_conventions/lib/opentelemetry/semantic_candidates/attributes/rpc.rb b/semantic_conventions/lib/opentelemetry/semconv/incubating/rpc.rb similarity index 90% rename from semantic_conventions/lib/opentelemetry/semantic_candidates/attributes/rpc.rb rename to semantic_conventions/lib/opentelemetry/semconv/incubating/rpc.rb index d53959fd47..a0fef031c3 100644 --- a/semantic_conventions/lib/opentelemetry/semantic_candidates/attributes/rpc.rb +++ b/semantic_conventions/lib/opentelemetry/semconv/incubating/rpc.rb @@ -19,88 +19,93 @@ # This file was autogenerated. Do not edit it by hand. module OpenTelemetry - module SemanticCandidates - module RPC + module SemConv + module Incubating + module RPC # @!group Attribute Names # The [error codes](https://connect.build/docs/protocol/#error-codes) of the Connect request. Error codes are always string values # # @note StabilityLevel.EXPERIMENTAL RPC_CONNECT_RPC_ERROR_CODE = 'rpc.connect_rpc.error_code' - + # Connect request metadata, `` being the normalized Connect Metadata key (lowercase), the value being the metadata values # # Instrumentations SHOULD require an explicit configuration of which metadata values are to be captured. Including all request metadata values can be a security risk - explicit configuration helps avoid leaking sensitive information # # @note StabilityLevel.EXPERIMENTAL - RPC_CONNECT_RPC_REQUEST_METADATA = 'rpc.connect_rpc.request.metadata' - + RPC_CONNECT_RPC_REQUEST_METADATA_LAMBDA = -> (key) { "rpc.connect_rpc.request.metadata.#{key}" } + # Connect response metadata, `` being the normalized Connect Metadata key (lowercase), the value being the metadata values # # Instrumentations SHOULD require an explicit configuration of which metadata values are to be captured. Including all response metadata values can be a security risk - explicit configuration helps avoid leaking sensitive information # # @note StabilityLevel.EXPERIMENTAL - RPC_CONNECT_RPC_RESPONSE_METADATA = 'rpc.connect_rpc.response.metadata' - + RPC_CONNECT_RPC_RESPONSE_METADATA_LAMBDA = -> (key) { "rpc.connect_rpc.response.metadata.#{key}" } + # gRPC request metadata, `` being the normalized gRPC Metadata key (lowercase), the value being the metadata values # # Instrumentations SHOULD require an explicit configuration of which metadata values are to be captured. Including all request metadata values can be a security risk - explicit configuration helps avoid leaking sensitive information # # @note StabilityLevel.EXPERIMENTAL - RPC_GRPC_REQUEST_METADATA = 'rpc.grpc.request.metadata' - + RPC_GRPC_REQUEST_METADATA_LAMBDA = -> (key) { "rpc.grpc.request.metadata.#{key}" } + # gRPC response metadata, `` being the normalized gRPC Metadata key (lowercase), the value being the metadata values # # Instrumentations SHOULD require an explicit configuration of which metadata values are to be captured. Including all response metadata values can be a security risk - explicit configuration helps avoid leaking sensitive information # # @note StabilityLevel.EXPERIMENTAL - RPC_GRPC_RESPONSE_METADATA = 'rpc.grpc.response.metadata' - + RPC_GRPC_RESPONSE_METADATA_LAMBDA = -> (key) { "rpc.grpc.response.metadata.#{key}" } + # The [numeric status code](https://github.com/grpc/grpc/blob/v1.33.2/doc/statuscodes.md) of the gRPC request # # @note StabilityLevel.EXPERIMENTAL RPC_GRPC_STATUS_CODE = 'rpc.grpc.status_code' - + # `error.code` property of response if it is an error response # # @note StabilityLevel.EXPERIMENTAL RPC_JSONRPC_ERROR_CODE = 'rpc.jsonrpc.error_code' - + # `error.message` property of response if it is an error response # # @note StabilityLevel.EXPERIMENTAL RPC_JSONRPC_ERROR_MESSAGE = 'rpc.jsonrpc.error_message' - + # `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 # # @note StabilityLevel.EXPERIMENTAL RPC_JSONRPC_REQUEST_ID = 'rpc.jsonrpc.request_id' - + # Protocol version as in `jsonrpc` property of request/response. Since JSON-RPC 1.0 doesn't specify this, the value can be omitted # # @note StabilityLevel.EXPERIMENTAL RPC_JSONRPC_VERSION = 'rpc.jsonrpc.version' - + # The name of the (logical) method being called, must be equal to the $method part in the span name # # This is the logical name of the method from the RPC interface perspective, which can be different from the name of any implementing method/function. The `code.function` attribute may be used to store the latter (e.g., method actually executing the call on the server side, RPC client stub method on the client side) # # @note StabilityLevel.EXPERIMENTAL RPC_METHOD = 'rpc.method' - + # The full (logical) name of the service being called, including its package name, if applicable # # This is the logical name of the service from the RPC interface perspective, which can be different from the name of any implementing class. The `code.namespace` attribute may be used to store the latter (despite the attribute name, it may include a class name; e.g., class with method actually executing the call on the server side, RPC client stub class on the client side) # # @note StabilityLevel.EXPERIMENTAL RPC_SERVICE = 'rpc.service' - + # A string identifying the remoting system. See below for a list of well-known identifiers # # @note StabilityLevel.EXPERIMENTAL RPC_SYSTEM = 'rpc.system' - + + # @!endgroup + + # @!group Metric Names # @!endgroup end + end # module Incubating end end \ No newline at end of file diff --git a/semantic_conventions/lib/opentelemetry/semantic_candidates/attributes/server.rb b/semantic_conventions/lib/opentelemetry/semconv/incubating/server.rb similarity index 88% rename from semantic_conventions/lib/opentelemetry/semantic_candidates/attributes/server.rb rename to semantic_conventions/lib/opentelemetry/semconv/incubating/server.rb index 8a72a02ec5..ed2d08fb29 100644 --- a/semantic_conventions/lib/opentelemetry/semantic_candidates/attributes/server.rb +++ b/semantic_conventions/lib/opentelemetry/semconv/incubating/server.rb @@ -19,8 +19,9 @@ # This file was autogenerated. Do not edit it by hand. module OpenTelemetry - module SemanticCandidates - module SERVER + module SemConv + module Incubating + module SERVER # @!group Attribute Names # Server domain name if available without reverse DNS lookup; otherwise, IP address or Unix domain socket name @@ -29,19 +30,23 @@ module SERVER # # @note StabilityLevel.STABLE # - # @deprecated Now available in the stable namespace at {OpenTelemetry::SemanticConventions::SERVER::SERVER_ADDRESS}. + # @deprecated Now available in the stable namespace at {OpenTelemetry::SemConv::SERVER::SERVER_ADDRESS}. SERVER_ADDRESS = 'server.address' - + # Server port number # # When observed from the client side, and when communicating through an intermediary, `server.port` SHOULD represent the server port behind any intermediaries, for example proxies, if it's available # # @note StabilityLevel.STABLE # - # @deprecated Now available in the stable namespace at {OpenTelemetry::SemanticConventions::SERVER::SERVER_PORT}. + # @deprecated Now available in the stable namespace at {OpenTelemetry::SemConv::SERVER::SERVER_PORT}. SERVER_PORT = 'server.port' - + + # @!endgroup + + # @!group Metric Names # @!endgroup end + end # module Incubating end end \ No newline at end of file diff --git a/semantic_conventions/lib/opentelemetry/semantic_candidates/attributes/service.rb b/semantic_conventions/lib/opentelemetry/semconv/incubating/service.rb similarity index 95% rename from semantic_conventions/lib/opentelemetry/semantic_candidates/attributes/service.rb rename to semantic_conventions/lib/opentelemetry/semconv/incubating/service.rb index 4ea0ee2f69..bbaf151902 100644 --- a/semantic_conventions/lib/opentelemetry/semantic_candidates/attributes/service.rb +++ b/semantic_conventions/lib/opentelemetry/semconv/incubating/service.rb @@ -19,8 +19,9 @@ # This file was autogenerated. Do not edit it by hand. module OpenTelemetry - module SemanticCandidates - module SERVICE + module SemConv + module Incubating + module SERVICE # @!group Attribute Names # The string ID of the service instance @@ -54,31 +55,35 @@ module SERVICE # # @note StabilityLevel.EXPERIMENTAL SERVICE_INSTANCE_ID = 'service.instance.id' - + # Logical name of the service # # 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` # # @note StabilityLevel.STABLE # - # @deprecated Now available in the stable namespace at {OpenTelemetry::SemanticConventions::SERVICE::SERVICE_NAME}. + # @deprecated Now available in the stable namespace at {OpenTelemetry::SemConv::SERVICE::SERVICE_NAME}. SERVICE_NAME = 'service.name' - + # A namespace for `service.name` # # 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 # # @note StabilityLevel.EXPERIMENTAL SERVICE_NAMESPACE = 'service.namespace' - + # The version string of the service API or implementation. The format is not defined by these conventions # # @note StabilityLevel.STABLE # - # @deprecated Now available in the stable namespace at {OpenTelemetry::SemanticConventions::SERVICE::SERVICE_VERSION}. + # @deprecated Now available in the stable namespace at {OpenTelemetry::SemConv::SERVICE::SERVICE_VERSION}. SERVICE_VERSION = 'service.version' - + + # @!endgroup + + # @!group Metric Names # @!endgroup end + end # module Incubating end end \ No newline at end of file diff --git a/semantic_conventions/lib/opentelemetry/semantic_candidates/attributes/session.rb b/semantic_conventions/lib/opentelemetry/semconv/incubating/session.rb similarity index 88% rename from semantic_conventions/lib/opentelemetry/semantic_candidates/attributes/session.rb rename to semantic_conventions/lib/opentelemetry/semconv/incubating/session.rb index b673e43794..47cf0f3e93 100644 --- a/semantic_conventions/lib/opentelemetry/semantic_candidates/attributes/session.rb +++ b/semantic_conventions/lib/opentelemetry/semconv/incubating/session.rb @@ -19,21 +19,26 @@ # This file was autogenerated. Do not edit it by hand. module OpenTelemetry - module SemanticCandidates - module SESSION + module SemConv + module Incubating + module SESSION # @!group Attribute Names # A unique id to identify a session # # @note StabilityLevel.EXPERIMENTAL SESSION_ID = 'session.id' - + # The previous `session.id` for this user, when known # # @note StabilityLevel.EXPERIMENTAL SESSION_PREVIOUS_ID = 'session.previous_id' - + + # @!endgroup + + # @!group Metric Names # @!endgroup end + end # module Incubating end end \ No newline at end of file diff --git a/semantic_conventions/lib/opentelemetry/semantic_candidates/attributes/signalr.rb b/semantic_conventions/lib/opentelemetry/semconv/incubating/signalr.rb similarity index 84% rename from semantic_conventions/lib/opentelemetry/semantic_candidates/attributes/signalr.rb rename to semantic_conventions/lib/opentelemetry/semconv/incubating/signalr.rb index 226ead0157..24ad444cbd 100644 --- a/semantic_conventions/lib/opentelemetry/semantic_candidates/attributes/signalr.rb +++ b/semantic_conventions/lib/opentelemetry/semconv/incubating/signalr.rb @@ -19,25 +19,30 @@ # This file was autogenerated. Do not edit it by hand. module OpenTelemetry - module SemanticCandidates - module SIGNALR + module SemConv + module Incubating + module SIGNALR # @!group Attribute Names # SignalR HTTP connection closure status # # @note StabilityLevel.STABLE # - # @deprecated Now available in the stable namespace at {OpenTelemetry::SemanticConventions::SIGNALR::SIGNALR_CONNECTION_STATUS}. + # @deprecated Now available in the stable namespace at {OpenTelemetry::SemConv::SIGNALR::SIGNALR_CONNECTION_STATUS}. SIGNALR_CONNECTION_STATUS = 'signalr.connection.status' - + # [SignalR transport type](https://github.com/dotnet/aspnetcore/blob/main/src/SignalR/docs/specs/TransportProtocols.md) # # @note StabilityLevel.STABLE # - # @deprecated Now available in the stable namespace at {OpenTelemetry::SemanticConventions::SIGNALR::SIGNALR_TRANSPORT}. + # @deprecated Now available in the stable namespace at {OpenTelemetry::SemConv::SIGNALR::SIGNALR_TRANSPORT}. SIGNALR_TRANSPORT = 'signalr.transport' - + + # @!endgroup + + # @!group Metric Names # @!endgroup end + end # module Incubating end end \ No newline at end of file diff --git a/semantic_conventions/lib/opentelemetry/semantic_candidates/attributes/source.rb b/semantic_conventions/lib/opentelemetry/semconv/incubating/source.rb similarity index 90% rename from semantic_conventions/lib/opentelemetry/semantic_candidates/attributes/source.rb rename to semantic_conventions/lib/opentelemetry/semconv/incubating/source.rb index 3309bfcd06..cc1b5322a4 100644 --- a/semantic_conventions/lib/opentelemetry/semantic_candidates/attributes/source.rb +++ b/semantic_conventions/lib/opentelemetry/semconv/incubating/source.rb @@ -19,8 +19,9 @@ # This file was autogenerated. Do not edit it by hand. module OpenTelemetry - module SemanticCandidates - module SOURCE + module SemConv + module Incubating + module SOURCE # @!group Attribute Names # Source address - domain name if available without reverse DNS lookup; otherwise, IP address or Unix domain socket name @@ -29,13 +30,17 @@ module SOURCE # # @note StabilityLevel.EXPERIMENTAL SOURCE_ADDRESS = 'source.address' - + # Source port number # # @note StabilityLevel.EXPERIMENTAL SOURCE_PORT = 'source.port' - + + # @!endgroup + + # @!group Metric Names # @!endgroup end + end # module Incubating end end \ No newline at end of file diff --git a/semantic_conventions/lib/opentelemetry/semantic_candidates/attributes/system.rb b/semantic_conventions/lib/opentelemetry/semconv/incubating/system.rb similarity index 94% rename from semantic_conventions/lib/opentelemetry/semantic_candidates/attributes/system.rb rename to semantic_conventions/lib/opentelemetry/semconv/incubating/system.rb index c8dc6d1789..65ec43b2ce 100644 --- a/semantic_conventions/lib/opentelemetry/semantic_candidates/attributes/system.rb +++ b/semantic_conventions/lib/opentelemetry/semconv/incubating/system.rb @@ -19,83 +19,88 @@ # This file was autogenerated. Do not edit it by hand. module OpenTelemetry - module SemanticCandidates - module SYSTEM + module SemConv + module Incubating + module SYSTEM # @!group Attribute Names # The logical CPU number [0..n-1] # # @note StabilityLevel.EXPERIMENTAL SYSTEM_CPU_LOGICAL_NUMBER = 'system.cpu.logical_number' - + # The CPU state for this data point. A system's CPU SHOULD be characterized *either* by data points with no `state` labels, *or only* data points with `state` labels # # @note StabilityLevel.EXPERIMENTAL SYSTEM_CPU_STATE = 'system.cpu.state' - + # The device identifier # # @note StabilityLevel.EXPERIMENTAL SYSTEM_DEVICE = 'system.device' - + # The filesystem mode # # @note StabilityLevel.EXPERIMENTAL SYSTEM_FILESYSTEM_MODE = 'system.filesystem.mode' - + # The filesystem mount path # # @note StabilityLevel.EXPERIMENTAL SYSTEM_FILESYSTEM_MOUNTPOINT = 'system.filesystem.mountpoint' - + # The filesystem state # # @note StabilityLevel.EXPERIMENTAL SYSTEM_FILESYSTEM_STATE = 'system.filesystem.state' - + # The filesystem type # # @note StabilityLevel.EXPERIMENTAL SYSTEM_FILESYSTEM_TYPE = 'system.filesystem.type' - + # The memory state # # @note StabilityLevel.EXPERIMENTAL SYSTEM_MEMORY_STATE = 'system.memory.state' - + # A stateless protocol MUST NOT set this attribute # # @note StabilityLevel.EXPERIMENTAL SYSTEM_NETWORK_STATE = 'system.network.state' - + # The paging access direction # # @note StabilityLevel.EXPERIMENTAL SYSTEM_PAGING_DIRECTION = 'system.paging.direction' - + # The memory paging state # # @note StabilityLevel.EXPERIMENTAL SYSTEM_PAGING_STATE = 'system.paging.state' - + # The memory paging type # # @note StabilityLevel.EXPERIMENTAL SYSTEM_PAGING_TYPE = 'system.paging.type' - + # The process state, e.g., [Linux Process State Codes](https://man7.org/linux/man-pages/man1/ps.1.html#PROCESS_STATE_CODES) # # @note StabilityLevel.EXPERIMENTAL SYSTEM_PROCESS_STATUS = 'system.process.status' - + # Deprecated, use `system.process.status` instead # # @note StabilityLevel.EXPERIMENTAL # # @deprecated Replaced by `system.process.status` SYSTEM_PROCESSES_STATUS = 'system.processes.status' - + + # @!endgroup + + # @!group Metric Names # @!endgroup end + end # module Incubating end end \ No newline at end of file diff --git a/semantic_conventions/lib/opentelemetry/semantic_candidates/attributes/telemetry.rb b/semantic_conventions/lib/opentelemetry/semconv/incubating/telemetry.rb similarity index 89% rename from semantic_conventions/lib/opentelemetry/semantic_candidates/attributes/telemetry.rb rename to semantic_conventions/lib/opentelemetry/semconv/incubating/telemetry.rb index 079a2799b2..0fa6358180 100644 --- a/semantic_conventions/lib/opentelemetry/semantic_candidates/attributes/telemetry.rb +++ b/semantic_conventions/lib/opentelemetry/semconv/incubating/telemetry.rb @@ -19,8 +19,9 @@ # This file was autogenerated. Do not edit it by hand. module OpenTelemetry - module SemanticCandidates - module TELEMETRY + module SemConv + module Incubating + module TELEMETRY # @!group Attribute Names # The name of the auto instrumentation agent or distribution, if used @@ -30,19 +31,19 @@ module TELEMETRY # # @note StabilityLevel.EXPERIMENTAL TELEMETRY_DISTRO_NAME = 'telemetry.distro.name' - + # The version string of the auto instrumentation agent or distribution, if used # # @note StabilityLevel.EXPERIMENTAL TELEMETRY_DISTRO_VERSION = 'telemetry.distro.version' - + # The language of the telemetry SDK # # @note StabilityLevel.STABLE # - # @deprecated Now available in the stable namespace at {OpenTelemetry::SemanticConventions::TELEMETRY::TELEMETRY_SDK_LANGUAGE}. + # @deprecated Now available in the stable namespace at {OpenTelemetry::SemConv::TELEMETRY::TELEMETRY_SDK_LANGUAGE}. TELEMETRY_SDK_LANGUAGE = 'telemetry.sdk.language' - + # The name of the telemetry SDK as defined above # # The OpenTelemetry SDK MUST set the `telemetry.sdk.name` attribute to `opentelemetry`. @@ -54,17 +55,21 @@ module TELEMETRY # # @note StabilityLevel.STABLE # - # @deprecated Now available in the stable namespace at {OpenTelemetry::SemanticConventions::TELEMETRY::TELEMETRY_SDK_NAME}. + # @deprecated Now available in the stable namespace at {OpenTelemetry::SemConv::TELEMETRY::TELEMETRY_SDK_NAME}. TELEMETRY_SDK_NAME = 'telemetry.sdk.name' - + # The version string of the telemetry SDK # # @note StabilityLevel.STABLE # - # @deprecated Now available in the stable namespace at {OpenTelemetry::SemanticConventions::TELEMETRY::TELEMETRY_SDK_VERSION}. + # @deprecated Now available in the stable namespace at {OpenTelemetry::SemConv::TELEMETRY::TELEMETRY_SDK_VERSION}. TELEMETRY_SDK_VERSION = 'telemetry.sdk.version' - + + # @!endgroup + + # @!group Metric Names # @!endgroup end + end # module Incubating end end \ No newline at end of file diff --git a/semantic_conventions/lib/opentelemetry/semantic_candidates/attributes/thread.rb b/semantic_conventions/lib/opentelemetry/semconv/incubating/thread.rb similarity index 88% rename from semantic_conventions/lib/opentelemetry/semantic_candidates/attributes/thread.rb rename to semantic_conventions/lib/opentelemetry/semconv/incubating/thread.rb index 05776d00a0..e2cf4bea33 100644 --- a/semantic_conventions/lib/opentelemetry/semantic_candidates/attributes/thread.rb +++ b/semantic_conventions/lib/opentelemetry/semconv/incubating/thread.rb @@ -19,21 +19,26 @@ # This file was autogenerated. Do not edit it by hand. module OpenTelemetry - module SemanticCandidates - module THREAD + module SemConv + module Incubating + module THREAD # @!group Attribute Names # Current "managed" thread ID (as opposed to OS thread ID) # # @note StabilityLevel.EXPERIMENTAL THREAD_ID = 'thread.id' - + # Current thread name # # @note StabilityLevel.EXPERIMENTAL THREAD_NAME = 'thread.name' - + + # @!endgroup + + # @!group Metric Names # @!endgroup end + end # module Incubating end end \ No newline at end of file diff --git a/semantic_conventions/lib/opentelemetry/semantic_candidates/attributes/tls.rb b/semantic_conventions/lib/opentelemetry/semconv/incubating/tls.rb similarity index 97% rename from semantic_conventions/lib/opentelemetry/semantic_candidates/attributes/tls.rb rename to semantic_conventions/lib/opentelemetry/semconv/incubating/tls.rb index c36bc8238b..b37554e48a 100644 --- a/semantic_conventions/lib/opentelemetry/semantic_candidates/attributes/tls.rb +++ b/semantic_conventions/lib/opentelemetry/semconv/incubating/tls.rb @@ -19,8 +19,9 @@ # This file was autogenerated. Do not edit it by hand. module OpenTelemetry - module SemanticCandidates - module TLS + module SemConv + module Incubating + module TLS # @!group Attribute Names # String indicating the [cipher](https://datatracker.ietf.org/doc/html/rfc5246#appendix-A.5) used during the current connection @@ -29,148 +30,152 @@ module TLS # # @note StabilityLevel.EXPERIMENTAL TLS_CIPHER = 'tls.cipher' - + # PEM-encoded stand-alone certificate offered by the client. This is usually mutually-exclusive of `client.certificate_chain` since this value also exists in that list # # @note StabilityLevel.EXPERIMENTAL TLS_CLIENT_CERTIFICATE = 'tls.client.certificate' - + # Array of PEM-encoded certificates that make up the certificate chain offered by the client. This is usually mutually-exclusive of `client.certificate` since that value should be the first certificate in the chain # # @note StabilityLevel.EXPERIMENTAL TLS_CLIENT_CERTIFICATE_CHAIN = 'tls.client.certificate_chain' - + # Certificate fingerprint using the MD5 digest of DER-encoded version of certificate offered by the client. For consistency with other hash values, this value should be formatted as an uppercase hash # # @note StabilityLevel.EXPERIMENTAL TLS_CLIENT_HASH_MD5 = 'tls.client.hash.md5' - + # Certificate fingerprint using the SHA1 digest of DER-encoded version of certificate offered by the client. For consistency with other hash values, this value should be formatted as an uppercase hash # # @note StabilityLevel.EXPERIMENTAL TLS_CLIENT_HASH_SHA1 = 'tls.client.hash.sha1' - + # Certificate fingerprint using the SHA256 digest of DER-encoded version of certificate offered by the client. For consistency with other hash values, this value should be formatted as an uppercase hash # # @note StabilityLevel.EXPERIMENTAL TLS_CLIENT_HASH_SHA256 = 'tls.client.hash.sha256' - + # Distinguished name of [subject](https://datatracker.ietf.org/doc/html/rfc5280#section-4.1.2.6) of the issuer of the x.509 certificate presented by the client # # @note StabilityLevel.EXPERIMENTAL TLS_CLIENT_ISSUER = 'tls.client.issuer' - + # A hash that identifies clients based on how they perform an SSL/TLS handshake # # @note StabilityLevel.EXPERIMENTAL TLS_CLIENT_JA3 = 'tls.client.ja3' - + # Date/Time indicating when client certificate is no longer considered valid # # @note StabilityLevel.EXPERIMENTAL TLS_CLIENT_NOT_AFTER = 'tls.client.not_after' - + # Date/Time indicating when client certificate is first considered valid # # @note StabilityLevel.EXPERIMENTAL TLS_CLIENT_NOT_BEFORE = 'tls.client.not_before' - + # Also called an SNI, this tells the server which hostname to which the client is attempting to connect to # # @note StabilityLevel.EXPERIMENTAL TLS_CLIENT_SERVER_NAME = 'tls.client.server_name' - + # Distinguished name of subject of the x.509 certificate presented by the client # # @note StabilityLevel.EXPERIMENTAL TLS_CLIENT_SUBJECT = 'tls.client.subject' - + # Array of ciphers offered by the client during the client hello # # @note StabilityLevel.EXPERIMENTAL TLS_CLIENT_SUPPORTED_CIPHERS = 'tls.client.supported_ciphers' - + # String indicating the curve used for the given cipher, when applicable # # @note StabilityLevel.EXPERIMENTAL TLS_CURVE = 'tls.curve' - + # Boolean flag indicating if the TLS negotiation was successful and transitioned to an encrypted tunnel # # @note StabilityLevel.EXPERIMENTAL TLS_ESTABLISHED = 'tls.established' - + # String indicating the protocol being tunneled. Per the values in the [IANA registry](https://www.iana.org/assignments/tls-extensiontype-values/tls-extensiontype-values.xhtml#alpn-protocol-ids), this string should be lower case # # @note StabilityLevel.EXPERIMENTAL TLS_NEXT_PROTOCOL = 'tls.next_protocol' - + # Normalized lowercase protocol name parsed from original string of the negotiated [SSL/TLS protocol version](https://www.openssl.org/docs/man1.1.1/man3/SSL_get_version.html#RETURN-VALUES) # # @note StabilityLevel.EXPERIMENTAL TLS_PROTOCOL_NAME = 'tls.protocol.name' - + # Numeric part of the version parsed from the original string of the negotiated [SSL/TLS protocol version](https://www.openssl.org/docs/man1.1.1/man3/SSL_get_version.html#RETURN-VALUES) # # @note StabilityLevel.EXPERIMENTAL TLS_PROTOCOL_VERSION = 'tls.protocol.version' - + # Boolean flag indicating if this TLS connection was resumed from an existing TLS negotiation # # @note StabilityLevel.EXPERIMENTAL TLS_RESUMED = 'tls.resumed' - + # PEM-encoded stand-alone certificate offered by the server. This is usually mutually-exclusive of `server.certificate_chain` since this value also exists in that list # # @note StabilityLevel.EXPERIMENTAL TLS_SERVER_CERTIFICATE = 'tls.server.certificate' - + # Array of PEM-encoded certificates that make up the certificate chain offered by the server. This is usually mutually-exclusive of `server.certificate` since that value should be the first certificate in the chain # # @note StabilityLevel.EXPERIMENTAL TLS_SERVER_CERTIFICATE_CHAIN = 'tls.server.certificate_chain' - + # Certificate fingerprint using the MD5 digest of DER-encoded version of certificate offered by the server. For consistency with other hash values, this value should be formatted as an uppercase hash # # @note StabilityLevel.EXPERIMENTAL TLS_SERVER_HASH_MD5 = 'tls.server.hash.md5' - + # Certificate fingerprint using the SHA1 digest of DER-encoded version of certificate offered by the server. For consistency with other hash values, this value should be formatted as an uppercase hash # # @note StabilityLevel.EXPERIMENTAL TLS_SERVER_HASH_SHA1 = 'tls.server.hash.sha1' - + # Certificate fingerprint using the SHA256 digest of DER-encoded version of certificate offered by the server. For consistency with other hash values, this value should be formatted as an uppercase hash # # @note StabilityLevel.EXPERIMENTAL TLS_SERVER_HASH_SHA256 = 'tls.server.hash.sha256' - + # Distinguished name of [subject](https://datatracker.ietf.org/doc/html/rfc5280#section-4.1.2.6) of the issuer of the x.509 certificate presented by the client # # @note StabilityLevel.EXPERIMENTAL TLS_SERVER_ISSUER = 'tls.server.issuer' - + # A hash that identifies servers based on how they perform an SSL/TLS handshake # # @note StabilityLevel.EXPERIMENTAL TLS_SERVER_JA3S = 'tls.server.ja3s' - + # Date/Time indicating when server certificate is no longer considered valid # # @note StabilityLevel.EXPERIMENTAL TLS_SERVER_NOT_AFTER = 'tls.server.not_after' - + # Date/Time indicating when server certificate is first considered valid # # @note StabilityLevel.EXPERIMENTAL TLS_SERVER_NOT_BEFORE = 'tls.server.not_before' - + # Distinguished name of subject of the x.509 certificate presented by the server # # @note StabilityLevel.EXPERIMENTAL TLS_SERVER_SUBJECT = 'tls.server.subject' - + + # @!endgroup + + # @!group Metric Names # @!endgroup end + end # module Incubating end end \ No newline at end of file diff --git a/semantic_conventions/lib/opentelemetry/semantic_candidates/attributes/url.rb b/semantic_conventions/lib/opentelemetry/semconv/incubating/url.rb similarity index 94% rename from semantic_conventions/lib/opentelemetry/semantic_candidates/attributes/url.rb rename to semantic_conventions/lib/opentelemetry/semconv/incubating/url.rb index f87dd62874..cc7862f49a 100644 --- a/semantic_conventions/lib/opentelemetry/semantic_candidates/attributes/url.rb +++ b/semantic_conventions/lib/opentelemetry/semconv/incubating/url.rb @@ -19,8 +19,9 @@ # This file was autogenerated. Do not edit it by hand. module OpenTelemetry - module SemanticCandidates - module URL + module SemConv + module Incubating + module URL # @!group Attribute Names # Domain extracted from the `url.full`, such as "opentelemetry.io" @@ -29,21 +30,21 @@ module URL # # @note StabilityLevel.EXPERIMENTAL 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 StabilityLevel.EXPERIMENTAL URL_EXTENSION = 'url.extension' - + # The [URI fragment](https://www.rfc-editor.org/rfc/rfc3986#section-3.5) component # # @note StabilityLevel.STABLE # - # @deprecated Now available in the stable namespace at {OpenTelemetry::SemanticConventions::URL::URL_FRAGMENT}. + # @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. @@ -52,9 +53,9 @@ module URL # # @note StabilityLevel.STABLE # - # @deprecated Now available in the stable namespace at {OpenTelemetry::SemanticConventions::URL::URL_FULL}. + # @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. @@ -62,59 +63,63 @@ module URL # # @note StabilityLevel.EXPERIMENTAL 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 StabilityLevel.STABLE # - # @deprecated Now available in the stable namespace at {OpenTelemetry::SemanticConventions::URL::URL_PATH}. + # @deprecated Now available in the stable namespace at {OpenTelemetry::SemConv::URL::URL_PATH}. URL_PATH = 'url.path' - + # Port extracted from the `url.full` # # @note StabilityLevel.EXPERIMENTAL 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 # # @note StabilityLevel.STABLE # - # @deprecated Now available in the stable namespace at {OpenTelemetry::SemanticConventions::URL::URL_QUERY}. + # @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](http://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 StabilityLevel.EXPERIMENTAL 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 StabilityLevel.STABLE # - # @deprecated Now available in the stable namespace at {OpenTelemetry::SemanticConventions::URL::URL_SCHEME}. + # @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 StabilityLevel.EXPERIMENTAL URL_SUBDOMAIN = 'url.subdomain' - + # 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](http://publicsuffix.org) # # @note StabilityLevel.EXPERIMENTAL URL_TOP_LEVEL_DOMAIN = 'url.top_level_domain' - + + # @!endgroup + + # @!group Metric Names # @!endgroup end + end # module Incubating end end \ No newline at end of file diff --git a/semantic_conventions/lib/opentelemetry/semantic_candidates/attributes/user_agent.rb b/semantic_conventions/lib/opentelemetry/semconv/incubating/user_agent.rb similarity index 91% rename from semantic_conventions/lib/opentelemetry/semantic_candidates/attributes/user_agent.rb rename to semantic_conventions/lib/opentelemetry/semconv/incubating/user_agent.rb index 1c8ca735e6..7c37cc6247 100644 --- a/semantic_conventions/lib/opentelemetry/semantic_candidates/attributes/user_agent.rb +++ b/semantic_conventions/lib/opentelemetry/semconv/incubating/user_agent.rb @@ -19,8 +19,9 @@ # This file was autogenerated. Do not edit it by hand. module OpenTelemetry - module SemanticCandidates - module USER_AGENT + 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 @@ -29,22 +30,26 @@ module USER_AGENT # # @note StabilityLevel.EXPERIMENTAL 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 StabilityLevel.STABLE # - # @deprecated Now available in the stable namespace at {OpenTelemetry::SemanticConventions::USER_AGENT::USER_AGENT_ORIGINAL}. + # @deprecated Now available in the stable namespace at {OpenTelemetry::SemConv::USER_AGENT::USER_AGENT_ORIGINAL}. USER_AGENT_ORIGINAL = 'user_agent.original' - + # 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 StabilityLevel.EXPERIMENTAL USER_AGENT_VERSION = 'user_agent.version' - + + # @!endgroup + + # @!group Metric Names # @!endgroup end + end # module Incubating end end \ No newline at end of file diff --git a/semantic_conventions/lib/opentelemetry/semantic_candidates/attributes/webengine.rb b/semantic_conventions/lib/opentelemetry/semconv/incubating/webengine.rb similarity index 89% rename from semantic_conventions/lib/opentelemetry/semantic_candidates/attributes/webengine.rb rename to semantic_conventions/lib/opentelemetry/semconv/incubating/webengine.rb index d62e02ff41..56448fe3ea 100644 --- a/semantic_conventions/lib/opentelemetry/semantic_candidates/attributes/webengine.rb +++ b/semantic_conventions/lib/opentelemetry/semconv/incubating/webengine.rb @@ -19,26 +19,31 @@ # This file was autogenerated. Do not edit it by hand. module OpenTelemetry - module SemanticCandidates - module WEBENGINE + module SemConv + module Incubating + module WEBENGINE # @!group Attribute Names # Additional description of the web engine (e.g. detailed version and edition information) # # @note StabilityLevel.EXPERIMENTAL WEBENGINE_DESCRIPTION = 'webengine.description' - + # The name of the web engine # # @note StabilityLevel.EXPERIMENTAL WEBENGINE_NAME = 'webengine.name' - + # The version of the web engine # # @note StabilityLevel.EXPERIMENTAL WEBENGINE_VERSION = 'webengine.version' - + + # @!endgroup + + # @!group Metric Names # @!endgroup end + end # module Incubating end end \ No newline at end of file diff --git a/semantic_conventions/lib/opentelemetry/semantic_conventions/attributes/jvm.rb b/semantic_conventions/lib/opentelemetry/semconv/jvm.rb similarity index 95% rename from semantic_conventions/lib/opentelemetry/semantic_conventions/attributes/jvm.rb rename to semantic_conventions/lib/opentelemetry/semconv/jvm.rb index 4de8fa7a51..abbd3e2d37 100644 --- a/semantic_conventions/lib/opentelemetry/semantic_conventions/attributes/jvm.rb +++ b/semantic_conventions/lib/opentelemetry/semconv/jvm.rb @@ -19,8 +19,8 @@ # This file was autogenerated. Do not edit it by hand. module OpenTelemetry - module SemanticConventions - module JVM + module SemConv + module JVM # @!group Attribute Names # Name of the garbage collector action @@ -29,36 +29,39 @@ module JVM # # @note StabilityLevel.STABLE JVM_GC_ACTION = 'jvm.gc.action' - + # Name of the garbage collector # # Garbage collector name is generally obtained via [GarbageCollectionNotificationInfo#getGcName()](https://docs.oracle.com/en/java/javase/11/docs/api/jdk.management/com/sun/management/GarbageCollectionNotificationInfo.html#getGcName()) # # @note StabilityLevel.STABLE JVM_GC_NAME = 'jvm.gc.name' - + # Name of the memory pool # # Pool names are generally obtained via [MemoryPoolMXBean#getName()](https://docs.oracle.com/en/java/javase/11/docs/api/java.management/java/lang/management/MemoryPoolMXBean.html#getName()) # # @note StabilityLevel.STABLE JVM_MEMORY_POOL_NAME = 'jvm.memory.pool.name' - + # The type of memory # # @note StabilityLevel.STABLE JVM_MEMORY_TYPE = 'jvm.memory.type' - + # Whether the thread is daemon or not # # @note StabilityLevel.STABLE JVM_THREAD_DAEMON = 'jvm.thread.daemon' - + # State of the thread # # @note StabilityLevel.STABLE JVM_THREAD_STATE = 'jvm.thread.state' - + + # @!endgroup + + # @!group Metric Names # @!endgroup end end diff --git a/semantic_conventions/lib/opentelemetry/semantic_conventions/attributes/network.rb b/semantic_conventions/lib/opentelemetry/semconv/network.rb similarity index 96% rename from semantic_conventions/lib/opentelemetry/semantic_conventions/attributes/network.rb rename to semantic_conventions/lib/opentelemetry/semconv/network.rb index 14a33a8819..15bdf963a7 100644 --- a/semantic_conventions/lib/opentelemetry/semantic_conventions/attributes/network.rb +++ b/semantic_conventions/lib/opentelemetry/semconv/network.rb @@ -19,44 +19,44 @@ # This file was autogenerated. Do not edit it by hand. module OpenTelemetry - module SemanticConventions - module NETWORK + module SemConv + module NETWORK # @!group Attribute Names # Local address of the network connection - IP address or Unix domain socket name # # @note StabilityLevel.STABLE NETWORK_LOCAL_ADDRESS = 'network.local.address' - + # Local port number of the network connection # # @note StabilityLevel.STABLE NETWORK_LOCAL_PORT = 'network.local.port' - + # Peer address of the network connection - IP address or Unix domain socket name # # @note StabilityLevel.STABLE NETWORK_PEER_ADDRESS = 'network.peer.address' - + # Peer port number of the network connection # # @note StabilityLevel.STABLE NETWORK_PEER_PORT = 'network.peer.port' - + # [OSI application layer](https://osi-model.com/application-layer/) or non-OSI equivalent # # The value SHOULD be normalized to lowercase # # @note StabilityLevel.STABLE NETWORK_PROTOCOL_NAME = 'network.protocol.name' - + # The actual version of the protocol used for network communication # # If protocol version is subject to negotiation (for example using [ALPN](https://www.rfc-editor.org/rfc/rfc7301.html)), this attribute SHOULD be set to the negotiated version. If the actual protocol version is not known, this attribute SHOULD NOT be set # # @note StabilityLevel.STABLE NETWORK_PROTOCOL_VERSION = 'network.protocol.version' - + # [OSI transport layer](https://osi-model.com/transport-layer/) or [inter-process communication method](https://wikipedia.org/wiki/Inter-process_communication) # # The value SHOULD be normalized to lowercase. @@ -67,14 +67,17 @@ module NETWORK # # @note StabilityLevel.STABLE NETWORK_TRANSPORT = 'network.transport' - + # [OSI network layer](https://osi-model.com/network-layer/) or non-OSI equivalent # # The value SHOULD be normalized to lowercase # # @note StabilityLevel.STABLE NETWORK_TYPE = 'network.type' - + + # @!endgroup + + # @!group Metric Names # @!endgroup end end diff --git a/semantic_conventions/lib/opentelemetry/semantic_conventions/attributes/otel.rb b/semantic_conventions/lib/opentelemetry/semconv/otel.rb similarity index 94% rename from semantic_conventions/lib/opentelemetry/semantic_conventions/attributes/otel.rb rename to semantic_conventions/lib/opentelemetry/semconv/otel.rb index 254e005cfc..699a11d7ce 100644 --- a/semantic_conventions/lib/opentelemetry/semantic_conventions/attributes/otel.rb +++ b/semantic_conventions/lib/opentelemetry/semconv/otel.rb @@ -19,30 +19,33 @@ # This file was autogenerated. Do not edit it by hand. module OpenTelemetry - module SemanticConventions - module OTEL + module SemConv + module OTEL # @!group Attribute Names # The name of the instrumentation scope - (`InstrumentationScope.Name` in OTLP) # # @note StabilityLevel.STABLE OTEL_SCOPE_NAME = 'otel.scope.name' - + # The version of the instrumentation scope - (`InstrumentationScope.Version` in OTLP) # # @note StabilityLevel.STABLE OTEL_SCOPE_VERSION = 'otel.scope.version' - + # Name of the code, either "OK" or "ERROR". MUST NOT be set if the status code is UNSET # # @note StabilityLevel.STABLE OTEL_STATUS_CODE = 'otel.status_code' - + # Description of the Status if it has a value, otherwise not set # # @note StabilityLevel.STABLE OTEL_STATUS_DESCRIPTION = 'otel.status_description' - + + # @!endgroup + + # @!group Metric Names # @!endgroup end end diff --git a/semantic_conventions/lib/opentelemetry/semantic_conventions/attributes/server.rb b/semantic_conventions/lib/opentelemetry/semconv/server.rb similarity index 94% rename from semantic_conventions/lib/opentelemetry/semantic_conventions/attributes/server.rb rename to semantic_conventions/lib/opentelemetry/semconv/server.rb index 68816e4f96..1b5132e3da 100644 --- a/semantic_conventions/lib/opentelemetry/semantic_conventions/attributes/server.rb +++ b/semantic_conventions/lib/opentelemetry/semconv/server.rb @@ -19,8 +19,8 @@ # This file was autogenerated. Do not edit it by hand. module OpenTelemetry - module SemanticConventions - module SERVER + module SemConv + module SERVER # @!group Attribute Names # Server domain name if available without reverse DNS lookup; otherwise, IP address or Unix domain socket name @@ -29,14 +29,17 @@ module SERVER # # @note StabilityLevel.STABLE SERVER_ADDRESS = 'server.address' - + # Server port number # # When observed from the client side, and when communicating through an intermediary, `server.port` SHOULD represent the server port behind any intermediaries, for example proxies, if it's available # # @note StabilityLevel.STABLE SERVER_PORT = 'server.port' - + + # @!endgroup + + # @!group Metric Names # @!endgroup end end diff --git a/semantic_conventions/lib/opentelemetry/semantic_conventions/attributes/service.rb b/semantic_conventions/lib/opentelemetry/semconv/service.rb similarity index 94% rename from semantic_conventions/lib/opentelemetry/semantic_conventions/attributes/service.rb rename to semantic_conventions/lib/opentelemetry/semconv/service.rb index d4aa987a9d..d3ae0a44d8 100644 --- a/semantic_conventions/lib/opentelemetry/semantic_conventions/attributes/service.rb +++ b/semantic_conventions/lib/opentelemetry/semconv/service.rb @@ -19,8 +19,8 @@ # This file was autogenerated. Do not edit it by hand. module OpenTelemetry - module SemanticConventions - module SERVICE + module SemConv + module SERVICE # @!group Attribute Names # Logical name of the service @@ -29,12 +29,15 @@ module SERVICE # # @note StabilityLevel.STABLE SERVICE_NAME = 'service.name' - + # The version string of the service API or implementation. The format is not defined by these conventions # # @note StabilityLevel.STABLE SERVICE_VERSION = 'service.version' - + + # @!endgroup + + # @!group Metric Names # @!endgroup end end diff --git a/semantic_conventions/lib/opentelemetry/semantic_conventions/attributes/signalr.rb b/semantic_conventions/lib/opentelemetry/semconv/signalr.rb similarity index 92% rename from semantic_conventions/lib/opentelemetry/semantic_conventions/attributes/signalr.rb rename to semantic_conventions/lib/opentelemetry/semconv/signalr.rb index 0a7a189eaf..1fc16ebfbd 100644 --- a/semantic_conventions/lib/opentelemetry/semantic_conventions/attributes/signalr.rb +++ b/semantic_conventions/lib/opentelemetry/semconv/signalr.rb @@ -19,20 +19,23 @@ # This file was autogenerated. Do not edit it by hand. module OpenTelemetry - module SemanticConventions - module SIGNALR + module SemConv + module SIGNALR # @!group Attribute Names # SignalR HTTP connection closure status # # @note StabilityLevel.STABLE SIGNALR_CONNECTION_STATUS = 'signalr.connection.status' - + # [SignalR transport type](https://github.com/dotnet/aspnetcore/blob/main/src/SignalR/docs/specs/TransportProtocols.md) # # @note StabilityLevel.STABLE SIGNALR_TRANSPORT = 'signalr.transport' - + + # @!endgroup + + # @!group Metric Names # @!endgroup end end diff --git a/semantic_conventions/lib/opentelemetry/semantic_conventions/attributes/telemetry.rb b/semantic_conventions/lib/opentelemetry/semconv/telemetry.rb similarity index 94% rename from semantic_conventions/lib/opentelemetry/semantic_conventions/attributes/telemetry.rb rename to semantic_conventions/lib/opentelemetry/semconv/telemetry.rb index ffd1dc27f8..47c5fe043c 100644 --- a/semantic_conventions/lib/opentelemetry/semantic_conventions/attributes/telemetry.rb +++ b/semantic_conventions/lib/opentelemetry/semconv/telemetry.rb @@ -19,15 +19,15 @@ # This file was autogenerated. Do not edit it by hand. module OpenTelemetry - module SemanticConventions - module TELEMETRY + module SemConv + module TELEMETRY # @!group Attribute Names # The language of the telemetry SDK # # @note StabilityLevel.STABLE TELEMETRY_SDK_LANGUAGE = 'telemetry.sdk.language' - + # The name of the telemetry SDK as defined above # # The OpenTelemetry SDK MUST set the `telemetry.sdk.name` attribute to `opentelemetry`. @@ -39,12 +39,15 @@ module TELEMETRY # # @note StabilityLevel.STABLE TELEMETRY_SDK_NAME = 'telemetry.sdk.name' - + # The version string of the telemetry SDK # # @note StabilityLevel.STABLE TELEMETRY_SDK_VERSION = 'telemetry.sdk.version' - + + # @!endgroup + + # @!group Metric Names # @!endgroup end end diff --git a/semantic_conventions/lib/opentelemetry/semantic_conventions/attributes/url.rb b/semantic_conventions/lib/opentelemetry/semconv/url.rb similarity index 96% rename from semantic_conventions/lib/opentelemetry/semantic_conventions/attributes/url.rb rename to semantic_conventions/lib/opentelemetry/semconv/url.rb index 9adb90ebb2..00ee7831ef 100644 --- a/semantic_conventions/lib/opentelemetry/semantic_conventions/attributes/url.rb +++ b/semantic_conventions/lib/opentelemetry/semconv/url.rb @@ -19,15 +19,15 @@ # This file was autogenerated. Do not edit it by hand. module OpenTelemetry - module SemanticConventions - module URL + module SemConv + module URL # @!group Attribute Names # The [URI fragment](https://www.rfc-editor.org/rfc/rfc3986#section-3.5) component # # @note StabilityLevel.STABLE 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. @@ -36,26 +36,29 @@ module URL # # @note StabilityLevel.STABLE URL_FULL = 'url.full' - + # 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 StabilityLevel.STABLE URL_PATH = 'url.path' - + # 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 # # @note StabilityLevel.STABLE URL_QUERY = 'url.query' - + # The [URI scheme](https://www.rfc-editor.org/rfc/rfc3986#section-3.1) component identifying the used protocol # # @note StabilityLevel.STABLE URL_SCHEME = 'url.scheme' - + + # @!endgroup + + # @!group Metric Names # @!endgroup end end diff --git a/semantic_conventions/lib/opentelemetry/semantic_conventions/attributes/user_agent.rb b/semantic_conventions/lib/opentelemetry/semconv/user_agent.rb similarity index 91% rename from semantic_conventions/lib/opentelemetry/semantic_conventions/attributes/user_agent.rb rename to semantic_conventions/lib/opentelemetry/semconv/user_agent.rb index 27db46d4cc..64c43de9c4 100644 --- a/semantic_conventions/lib/opentelemetry/semantic_conventions/attributes/user_agent.rb +++ b/semantic_conventions/lib/opentelemetry/semconv/user_agent.rb @@ -19,15 +19,18 @@ # This file was autogenerated. Do not edit it by hand. module OpenTelemetry - module SemanticConventions - module USER_AGENT + module SemConv + module USER_AGENT # @!group Attribute Names # Value of the [HTTP User-Agent](https://www.rfc-editor.org/rfc/rfc9110.html#field.user-agent) header sent by the client # # @note StabilityLevel.STABLE USER_AGENT_ORIGINAL = 'user_agent.original' - + + # @!endgroup + + # @!group Metric Names # @!endgroup end end diff --git a/semantic_conventions/templates/attributes.j2 b/semantic_conventions/templates/attributes.j2 index b57c3097f3..4cb04ba905 100644 --- a/semantic_conventions/templates/attributes.j2 +++ b/semantic_conventions/templates/attributes.j2 @@ -14,18 +14,21 @@ #} {%- import 'common.j2' as common -%} {%- if selector == 'any' -%} -{%- set filtered_attributes = attributes_and_templates | list -%} -{%- set module_name = 'SemanticCandidates' -%} +{%- set filtered_attributes = attributes_and_templates | list -%} +{%- set gen_incubating = true -%} {%- elif selector == 'is_stable' -%} -{%- set filtered_attributes = attributes_and_templates | select(selector) | list -%} -{%- set module_name = 'SemanticConventions' -%} +{%- set filtered_attributes = attributes_and_templates | select(selector) | list -%} +{%- set gen_incubating = false -%} {%- endif -%} {%- if filtered_attributes | count > 0 -%} {# only produce code if there are attributes #} {{- common.file_header() }} module OpenTelemetry - module {{ module_name }} - module {{ root_namespace | to_const_name }} {# TODO: macro to PascalCase with exceptions for AspNetCore, HTTP, etc? #} + module SemConv + {%- if gen_incubating %} + module Incubating + {%- endif %} + module {{ root_namespace | to_const_name }} # @!group Attribute Names {% for attribute in filtered_attributes %} # {{ common.to_docstring(attribute.brief) }} @@ -38,21 +41,26 @@ module OpenTelemetry {%- if attribute | is_deprecated %} # # @deprecated {{ common.to_docstring(attribute.deprecated) }} - {%- elif attribute | is_stable and selector == 'any' %} + {%- elif attribute | is_stable and gen_incubating %} # - # @deprecated Now available in the stable namespace at {OpenTelemetry::SemanticConventions::{{ root_namespace | to_const_name }}::{{ attribute.fqn | to_const_name }}}. + # @deprecated Now available in the stable namespace at {OpenTelemetry::SemConv::{{ root_namespace | to_const_name }}::{{ attribute.fqn | to_const_name }}}. {%- endif %} - {%- if attribute.fqn in excluded_attributes %} - # - # @note This attribute has been excluded from code generation. - # {{ attribute.fqn | to_const_name }} = '{{ attribute.fqn }}' - {%- else %} + {%- if attribute.fqn not in excluded_attributes %} + {%- if attribute | is_template %} + {{ attribute.fqn | to_const_name }}_LAMBDA = -> (key) { "{{ attribute.fqn }}.#{key}" } + {%- else %} {{ attribute.fqn | to_const_name }} = '{{ attribute.fqn }}' + {%- endif %} {%- endif %} - {% endfor %} + {% endfor %} + # @!endgroup + + # @!group Metric Names # @!endgroup end + {%- if gen_incubating %} + end # module Incubating + {%- endif %} end end - {%- endif -%} {# only produce code if there are attributes #} From 90975a80a58f5064583695d7af325ecf83943c7b Mon Sep 17 00:00:00 2001 From: Robb Kidd Date: Wed, 11 Sep 2024 18:01:02 -0400 Subject: [PATCH 14/17] semconv 1.26 with weaver With multiple template entries in weaver.yaml, code generation for stable and incubating can be performed in one invocation of the docker image. Rakefile targets trimmed down in light of that. --- semantic_conventions/Rakefile | 63 ++-- .../semantic_conventions/version.rb | 2 +- .../lib/opentelemetry/semconv/aspnetcore.rb | 36 +- .../lib/opentelemetry/semconv/client.rb | 20 +- .../lib/opentelemetry/semconv/error.rb | 42 ++- .../lib/opentelemetry/semconv/exception.rb | 56 +-- .../lib/opentelemetry/semconv/http.rb | 94 ++--- .../semconv/incubating/android.rb | 18 +- .../semconv/incubating/aspnetcore.rb | 52 +-- .../opentelemetry/semconv/incubating/aws.rb | 348 +++++++++--------- .../semconv/incubating/browser.rb | 34 +- .../semconv/incubating/client.rb | 26 +- .../opentelemetry/semconv/incubating/cloud.rb | 82 ++--- .../semconv/incubating/cloudevents.rb | 32 +- .../opentelemetry/semconv/incubating/code.rb | 38 +- .../semconv/incubating/container.rb | 97 +++-- .../opentelemetry/semconv/incubating/db.rb | 262 +++++++------ .../semconv/incubating/deployment.rb | 22 +- .../semconv/incubating/destination.rb | 16 +- .../semconv/incubating/device.rb | 34 +- .../opentelemetry/semconv/incubating/disk.rb | 8 +- .../opentelemetry/semconv/incubating/dns.rb | 12 +- .../semconv/incubating/enduser.rb | 20 +- .../opentelemetry/semconv/incubating/error.rb | 46 +-- .../opentelemetry/semconv/incubating/event.rb | 12 +- .../semconv/incubating/exception.rb | 66 ++-- .../opentelemetry/semconv/incubating/faas.rb | 168 ++++----- .../semconv/incubating/feature_flag.rb | 36 +- .../opentelemetry/semconv/incubating/file.rb | 36 +- .../opentelemetry/semconv/incubating/gcp.rb | 26 +- .../semconv/incubating/gen_ai.rb | 100 +++++ .../semconv/incubating/graphql.rb | 24 +- .../semconv/incubating/heroku.rb | 14 +- .../opentelemetry/semconv/incubating/host.rb | 104 +++--- .../opentelemetry/semconv/incubating/http.rb | 253 +++++++------ .../opentelemetry/semconv/incubating/ios.rb | 13 +- .../opentelemetry/semconv/incubating/jvm.rb | 72 ++-- .../opentelemetry/semconv/incubating/k8s.rb | 210 +++++------ .../opentelemetry/semconv/incubating/log.rb | 42 +-- .../semconv/incubating/message.rb | 32 +- .../semconv/incubating/messaging.rb | 287 ++++++++------- .../opentelemetry/semconv/incubating/net.rb | 131 ++++--- .../semconv/incubating/network.rb | 132 +++---- .../opentelemetry/semconv/incubating/oci.rb | 12 +- .../semconv/incubating/opentracing.rb | 10 +- .../opentelemetry/semconv/incubating/os.rb | 32 +- .../opentelemetry/semconv/incubating/otel.rb | 48 ++- .../opentelemetry/semconv/incubating/other.rb | 9 +- .../opentelemetry/semconv/incubating/peer.rb | 8 +- .../opentelemetry/semconv/incubating/pool.rb | 9 +- .../semconv/incubating/process.rb | 153 +++++--- .../opentelemetry/semconv/incubating/rpc.rb | 142 ++++--- .../semconv/incubating/server.rb | 26 +- .../semconv/incubating/service.rb | 90 ++--- .../semconv/incubating/session.rb | 14 +- .../semconv/incubating/signalr.rb | 16 +- .../semconv/incubating/source.rb | 16 +- .../semconv/incubating/system.rb | 65 ++-- .../semconv/incubating/telemetry.rb | 54 +-- .../semconv/incubating/thread.rb | 14 +- .../opentelemetry/semconv/incubating/tls.rb | 174 ++++----- .../opentelemetry/semconv/incubating/url.rb | 117 +++--- .../semconv/incubating/user_agent.rb | 24 +- .../semconv/incubating/webengine.rb | 20 +- .../lib/opentelemetry/semconv/jvm.rb | 48 +-- .../lib/opentelemetry/semconv/network.rb | 70 ++-- .../lib/opentelemetry/semconv/otel.rb | 24 +- .../lib/opentelemetry/semconv/server.rb | 20 +- .../lib/opentelemetry/semconv/service.rb | 16 +- .../lib/opentelemetry/semconv/signalr.rb | 10 +- .../lib/opentelemetry/semconv/telemetry.rb | 30 +- .../lib/opentelemetry/semconv/url.rb | 36 +- .../lib/opentelemetry/semconv/user_agent.rb | 6 +- semantic_conventions/templates/attributes.j2 | 66 ---- .../templates/registry/ruby/attributes.j2 | 57 +++ .../templates/{ => registry/ruby}/common.j2 | 2 +- .../templates/registry/ruby/weaver.yaml | 34 ++ 77 files changed, 2496 insertions(+), 2194 deletions(-) create mode 100644 semantic_conventions/lib/opentelemetry/semconv/incubating/gen_ai.rb delete mode 100644 semantic_conventions/templates/attributes.j2 create mode 100644 semantic_conventions/templates/registry/ruby/attributes.j2 rename semantic_conventions/templates/{ => registry/ruby}/common.j2 (91%) create mode 100644 semantic_conventions/templates/registry/ruby/weaver.yaml diff --git a/semantic_conventions/Rakefile b/semantic_conventions/Rakefile index d9d19a6929..263e0e5676 100644 --- a/semantic_conventions/Rakefile +++ b/semantic_conventions/Rakefile @@ -30,66 +30,47 @@ else task default: %i[generate test rubocop yard] end -SPEC_VERSION = '1.25.0' -GENERATOR_VERSION = '0.24.0' +SPEC_VERSION = '1.26.0' +OTEL_WEAVER_VERSION = 'v0.9.2' semconv_source_dir = Pathname.new('./tmp/semconvrepo') -conventions_output_dir = Pathname.new('./lib/opentelemetry/semconv') -incubating_output_dir = Pathname.new('./lib/opentelemetry/semconv/incubating') - -EXCLUDED_ATTRIBUTES = %w[].freeze - -task generate: %i[update_gem_version generate_stable generate_incubating] +semconv_output_dir = Pathname.new('./lib/opentelemetry/semconv') directory semconv_source_dir do + puts "\n+++ Cloning semantic conventions repository\n" sh "git clone --tags --depth=1 --branch v#{SPEC_VERSION} https://github.com/open-telemetry/semantic-conventions.git #{semconv_source_dir}" end task check_out_semconv_version: [semconv_source_dir] do + puts "\n+++ Checking out semantic conventions version #{SPEC_VERSION}\n" Dir.chdir(semconv_source_dir) do sh "git fetch --depth 1 origin tag v#{SPEC_VERSION}" sh "git checkout 'v#{SPEC_VERSION}'" end end -task generate_stable: [:check_out_semconv_version] do - conventions_output_dir - .glob('*.rb') - .then { |files| FileUtils.rm(files) } - semconvgen(semconv_source_dir, output_root: conventions_output_dir, selector: 'is_stable') -end - -task generate_incubating: [:check_out_semconv_version] do - incubating_output_dir +task generate: %i[update_gem_version check_out_semconv_version] do + puts "\n+++ Removing previously generated semantic conventions code.\n" + semconv_output_dir .glob('*.rb') .then { |files| FileUtils.rm(files) } - semconvgen(semconv_source_dir, output_root: incubating_output_dir, selector: 'any') -end - -def semconvgen(semconv_source, output_root:, selector:) - FileUtils.mkdir_p(output_root) - cwd = Dir.pwd - output_filenames_template = Pathname.new('/output').join(output_root, '{{snake_prefix}}.rb') - cmd = %W[ - docker run --rm - -v "#{semconv_source}/model":/source - -v "#{cwd}/templates":/templates - -v "#{cwd}":/output - otel/semconvgen:#{GENERATOR_VERSION} - --yaml-root /source - --continue-on-validation-errors - code - --file-per-group root_namespace - --template /templates/attributes.j2 - --output "#{output_filenames_template}" - -Dselector=#{selector} - -Dexcluded_attributes="#{EXCLUDED_ATTRIBUTES.join(' ')}" - ] - puts "Running: #{cmd.join(' ')}" - sh cmd.join(' ') + puts "\n+++ Generating semantic conventions code.\n" + sh <<~DOCKER_COMMAND + docker run --rm \ + -v "#{semconv_source_dir}/model":/source \ + -v ./templates:/templates \ + -v ./:/output \ + otel/weaver:#{OTEL_WEAVER_VERSION} \ + registry generate \ + --registry=/source \ + --templates=/templates \ + ruby \ + /output/#{semconv_output_dir} + DOCKER_COMMAND end task :update_gem_version do + puts "\n+++ Updating gem version to #{SPEC_VERSION}\n" sh %(sed -i.bak "s/VERSION = '.*'/VERSION = '#{SPEC_VERSION}'/g" lib/opentelemetry/semantic_conventions/version.rb) sh 'rm lib/opentelemetry/semantic_conventions/version.rb.bak' end diff --git a/semantic_conventions/lib/opentelemetry/semantic_conventions/version.rb b/semantic_conventions/lib/opentelemetry/semantic_conventions/version.rb index 4f00687755..47751f20d0 100644 --- a/semantic_conventions/lib/opentelemetry/semantic_conventions/version.rb +++ b/semantic_conventions/lib/opentelemetry/semantic_conventions/version.rb @@ -6,6 +6,6 @@ module OpenTelemetry module SemanticConventions - VERSION = '1.25.0' + VERSION = '1.26.0' end end diff --git a/semantic_conventions/lib/opentelemetry/semconv/aspnetcore.rb b/semantic_conventions/lib/opentelemetry/semconv/aspnetcore.rb index d594ebe75b..c28700955c 100644 --- a/semantic_conventions/lib/opentelemetry/semconv/aspnetcore.rb +++ b/semantic_conventions/lib/opentelemetry/semconv/aspnetcore.rb @@ -24,38 +24,38 @@ module ASPNETCORE # @!group Attribute Names # ASP.NET Core exception middleware handling result - # - # @note StabilityLevel.STABLE + # + # @note Stability Level: stable ASPNETCORE_DIAGNOSTICS_EXCEPTION_RESULT = 'aspnetcore.diagnostics.exception.result' - # Full type name of the [`IExceptionHandler`](https://learn.microsoft.com/dotnet/api/microsoft.aspnetcore.diagnostics.iexceptionhandler) implementation that handled the exception - # - # @note StabilityLevel.STABLE + # Full type name of the [`IExceptionHandler`](https://learn.microsoft.com/dotnet/api/microsoft.aspnetcore.diagnostics.iexceptionhandler) implementation that handled the exception. + # + # @note Stability Level: stable ASPNETCORE_DIAGNOSTICS_HANDLER_TYPE = 'aspnetcore.diagnostics.handler.type' - # Rate limiting policy name - # - # @note StabilityLevel.STABLE + # Rate limiting policy name. + # + # @note Stability Level: stable ASPNETCORE_RATE_LIMITING_POLICY = 'aspnetcore.rate_limiting.policy' # Rate-limiting result, shows whether the lease was acquired or contains a rejection reason - # - # @note StabilityLevel.STABLE + # + # @note Stability Level: stable ASPNETCORE_RATE_LIMITING_RESULT = 'aspnetcore.rate_limiting.result' - # Flag indicating if request was handled by the application pipeline - # - # @note StabilityLevel.STABLE + # Flag indicating if request was handled by the application pipeline. + # + # @note Stability Level: stable ASPNETCORE_REQUEST_IS_UNHANDLED = 'aspnetcore.request.is_unhandled' - # A value that indicates whether the matched route is a fallback route - # - # @note StabilityLevel.STABLE + # A value that indicates whether the matched route is a fallback route. + # + # @note Stability Level: stable ASPNETCORE_ROUTING_IS_FALLBACK = 'aspnetcore.routing.is_fallback' # Match result - success or failure - # - # @note StabilityLevel.STABLE + # + # @note Stability Level: stable ASPNETCORE_ROUTING_MATCH_STATUS = 'aspnetcore.routing.match_status' # @!endgroup diff --git a/semantic_conventions/lib/opentelemetry/semconv/client.rb b/semantic_conventions/lib/opentelemetry/semconv/client.rb index 31fe53b916..049db89201 100644 --- a/semantic_conventions/lib/opentelemetry/semconv/client.rb +++ b/semantic_conventions/lib/opentelemetry/semconv/client.rb @@ -23,18 +23,18 @@ module SemConv module CLIENT # @!group Attribute Names - # Client address - domain name if available without reverse DNS lookup; otherwise, IP address or Unix domain socket name - # - # When observed from the server side, and when communicating through an intermediary, `client.address` SHOULD represent the client address behind any intermediaries, for example proxies, if it's available - # - # @note StabilityLevel.STABLE + # Client address - domain name if available without reverse DNS lookup; otherwise, IP address or Unix domain socket name. + # + # When observed from the server side, and when communicating through an intermediary, `client.address` SHOULD represent the client address behind any intermediaries, for example proxies, if it's available. + # + # @note Stability Level: stable CLIENT_ADDRESS = 'client.address' - # Client port number - # - # When observed from the server side, and when communicating through an intermediary, `client.port` SHOULD represent the client port behind any intermediaries, for example proxies, if it's available - # - # @note StabilityLevel.STABLE + # Client port number. + # + # When observed from the server side, and when communicating through an intermediary, `client.port` SHOULD represent the client port behind any intermediaries, for example proxies, if it's available. + # + # @note Stability Level: stable CLIENT_PORT = 'client.port' # @!endgroup diff --git a/semantic_conventions/lib/opentelemetry/semconv/error.rb b/semantic_conventions/lib/opentelemetry/semconv/error.rb index 63268e8f83..35075439ba 100644 --- a/semantic_conventions/lib/opentelemetry/semconv/error.rb +++ b/semantic_conventions/lib/opentelemetry/semconv/error.rb @@ -23,25 +23,29 @@ module SemConv module ERROR # @!group Attribute Names - # Describes a class of error the operation ended with - # - # The `error.type` SHOULD be predictable and SHOULD have low cardinality. - # Instrumentations SHOULD document the list of errors they report. - # - # The cardinality of `error.type` within one instrumentation library SHOULD be low. - # Telemetry consumers that aggregate data from multiple instrumentation libraries and applications - # should be prepared for `error.type` to have high cardinality at query time when no - # additional filters are applied. - # - # If the operation has completed successfully, instrumentations SHOULD NOT set `error.type`. - # - # If a specific domain defines its own set of error identifiers (such as HTTP or gRPC status codes), - # it's RECOMMENDED to: - # - # * Use a domain-specific attribute - # * Set `error.type` to capture all errors, regardless of whether they are defined within the domain-specific set or not - # - # @note StabilityLevel.STABLE + # Describes a class of error the operation ended with. + # + # The `error.type` SHOULD be predictable, and SHOULD have low cardinality. + # + # When `error.type` is set to a type (e.g., an exception type), its + # canonical class name identifying the type within the artifact SHOULD be used. + # + # Instrumentations SHOULD document the list of errors they report. + # + # The cardinality of `error.type` within one instrumentation library SHOULD be low. + # Telemetry consumers that aggregate data from multiple instrumentation libraries and applications + # should be prepared for `error.type` to have high cardinality at query time when no + # additional filters are applied. + # + # If the operation has completed successfully, instrumentations SHOULD NOT set `error.type`. + # + # If a specific domain defines its own set of error identifiers (such as HTTP or gRPC status codes), + # it's RECOMMENDED to: + # + # - Use a domain-specific attribute + # - Set `error.type` to capture all errors, regardless of whether they are defined within the domain-specific set or not. + # + # @note Stability Level: stable ERROR_TYPE = 'error.type' # @!endgroup diff --git a/semantic_conventions/lib/opentelemetry/semconv/exception.rb b/semantic_conventions/lib/opentelemetry/semconv/exception.rb index 8dcd50e3bf..7f52ed152e 100644 --- a/semantic_conventions/lib/opentelemetry/semconv/exception.rb +++ b/semantic_conventions/lib/opentelemetry/semconv/exception.rb @@ -23,41 +23,41 @@ module SemConv module EXCEPTION # @!group Attribute Names - # 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 - # + # 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. + # # An exception is considered to have escaped (or left) the scope of a span, - # if that span is ended while the exception is still logically "in flight". - # This may be actually "in flight" in some languages (e.g. if the exception - # is passed to a Context manager's `__exit__` method in Python) but will - # usually be caught at the point of recording the exception in most languages. - # - # It is usually not possible to determine at the point where an exception is thrown - # whether it will escape the scope of a span. - # However, it is trivial to know that an exception - # will escape, if one checks for an active exception just before ending the span, - # as done in the [example for recording span exceptions](#recording-an-exception). - # - # It follows that an exception may still escape the scope of the span - # even if the `exception.escaped` attribute was not set or set to false, - # since the event might have been recorded at a time where it was not - # clear whether the exception will escape - # - # @note StabilityLevel.STABLE + # if that span is ended while the exception is still logically "in flight". + # This may be actually "in flight" in some languages (e.g. if the exception + # is passed to a Context manager's `__exit__` method in Python) but will + # usually be caught at the point of recording the exception in most languages. + # + # It is usually not possible to determine at the point where an exception is thrown + # whether it will escape the scope of a span. + # However, it is trivial to know that an exception + # will escape, if one checks for an active exception just before ending the span, + # as done in the [example for recording span exceptions](https://opentelemetry.io/docs/specs/semconv/exceptions/exceptions-spans/#recording-an-exception). + # + # It follows that an exception may still escape the scope of the span + # even if the `exception.escaped` attribute was not set or set to false, + # since the event might have been recorded at a time where it was not + # clear whether the exception will escape. + # + # @note Stability Level: stable EXCEPTION_ESCAPED = 'exception.escaped' - # The exception message - # - # @note StabilityLevel.STABLE + # The exception message. + # + # @note Stability Level: stable 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 StabilityLevel.STABLE + # 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 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 StabilityLevel.STABLE + # 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 EXCEPTION_TYPE = 'exception.type' # @!endgroup diff --git a/semantic_conventions/lib/opentelemetry/semconv/http.rb b/semantic_conventions/lib/opentelemetry/semconv/http.rb index 2b30875093..19d26ecf90 100644 --- a/semantic_conventions/lib/opentelemetry/semconv/http.rb +++ b/semantic_conventions/lib/opentelemetry/semconv/http.rb @@ -23,67 +23,67 @@ module SemConv module HTTP # @!group Attribute Names - # HTTP request headers, `` being the normalized HTTP Header name (lowercase), the value being the header values - # + # HTTP request headers, `` being the normalized HTTP Header name (lowercase), the value being the header values. + # # Instrumentations SHOULD require an explicit configuration of which headers are to be captured. Including all request headers can be a security risk - explicit configuration helps avoid leaking sensitive information. - # The `User-Agent` header is already captured in the `user_agent.original` attribute. Users MAY explicitly configure instrumentations to capture them even though it is not recommended. - # The attribute value MUST consist of either multiple header values as an array of strings or a single-item array containing a possibly comma-concatenated string, depending on the way the HTTP library provides access to headers - # - # @note StabilityLevel.STABLE - HTTP_REQUEST_HEADER_LAMBDA = -> (key) { "http.request.header.#{key}" } + # The `User-Agent` header is already captured in the `user_agent.original` attribute. Users MAY explicitly configure instrumentations to capture them even though it is not recommended. + # The attribute value MUST consist of either multiple header values as an array of strings or a single-item array containing a possibly comma-concatenated string, depending on the way the HTTP library provides access to headers. + # + # @note Stability Level: stable + HTTP_REQUEST_HEADER_LAMBDA = ->(key) { "http.request.header.#{key}" } - # HTTP request method - # + # HTTP request method. + # # HTTP request method value SHOULD be "known" to the instrumentation. - # By default, this convention defines "known" methods as the ones listed in [RFC9110](https://www.rfc-editor.org/rfc/rfc9110.html#name-methods) - # and the PATCH method defined in [RFC5789](https://www.rfc-editor.org/rfc/rfc5789.html). - # - # If the HTTP request method is not known to instrumentation, it MUST set the `http.request.method` attribute to `_OTHER`. - # - # If the HTTP instrumentation could end up converting valid HTTP request methods to `_OTHER`, then it MUST provide a way to override - # the list of known HTTP methods. If this override is done via environment variable, then the environment variable MUST be named - # OTEL_INSTRUMENTATION_HTTP_KNOWN_METHODS and support a comma-separated list of case-sensitive known HTTP methods - # (this list MUST be a full override of the default known method, it is not a list of known methods in addition to the defaults). - # - # HTTP method names are case-sensitive and `http.request.method` attribute value MUST match a known HTTP method name exactly. - # Instrumentations for specific web frameworks that consider HTTP methods to be case insensitive, SHOULD populate a canonical equivalent. - # Tracing instrumentations that do so, MUST also set `http.request.method_original` to the original value - # - # @note StabilityLevel.STABLE + # By default, this convention defines "known" methods as the ones listed in [RFC9110](https://www.rfc-editor.org/rfc/rfc9110.html#name-methods) + # and the PATCH method defined in [RFC5789](https://www.rfc-editor.org/rfc/rfc5789.html). + # + # If the HTTP request method is not known to instrumentation, it MUST set the `http.request.method` attribute to `_OTHER`. + # + # If the HTTP instrumentation could end up converting valid HTTP request methods to `_OTHER`, then it MUST provide a way to override + # the list of known HTTP methods. If this override is done via environment variable, then the environment variable MUST be named + # OTEL_INSTRUMENTATION_HTTP_KNOWN_METHODS and support a comma-separated list of case-sensitive known HTTP methods + # (this list MUST be a full override of the default known method, it is not a list of known methods in addition to the defaults). + # + # HTTP method names are case-sensitive and `http.request.method` attribute value MUST match a known HTTP method name exactly. + # Instrumentations for specific web frameworks that consider HTTP methods to be case insensitive, SHOULD populate a canonical equivalent. + # Tracing instrumentations that do so, MUST also set `http.request.method_original` to the original value. + # + # @note Stability Level: stable HTTP_REQUEST_METHOD = 'http.request.method' - # Original HTTP method sent by the client in the request line - # - # @note StabilityLevel.STABLE + # Original HTTP method sent by the client in the request line. + # + # @note Stability Level: stable HTTP_REQUEST_METHOD_ORIGINAL = 'http.request.method_original' - # The ordinal number of request resending attempt (for any reason, including redirects) - # - # The resend count SHOULD be updated each time an HTTP request gets resent by the client, regardless of what was the cause of the resending (e.g. redirection, authorization failure, 503 Server Unavailable, network issues, or any other) - # - # @note StabilityLevel.STABLE + # The ordinal number of request resending attempt (for any reason, including redirects). + # + # The resend count SHOULD be updated each time an HTTP request gets resent by the client, regardless of what was the cause of the resending (e.g. redirection, authorization failure, 503 Server Unavailable, network issues, or any other). + # + # @note Stability Level: stable HTTP_REQUEST_RESEND_COUNT = 'http.request.resend_count' - # HTTP response headers, `` being the normalized HTTP Header name (lowercase), the value being the header values - # + # HTTP response headers, `` being the normalized HTTP Header name (lowercase), the value being the header values. + # # Instrumentations SHOULD require an explicit configuration of which headers are to be captured. Including all response headers can be a security risk - explicit configuration helps avoid leaking sensitive information. - # Users MAY explicitly configure instrumentations to capture them even though it is not recommended. - # The attribute value MUST consist of either multiple header values as an array of strings or a single-item array containing a possibly comma-concatenated string, depending on the way the HTTP library provides access to headers - # - # @note StabilityLevel.STABLE - HTTP_RESPONSE_HEADER_LAMBDA = -> (key) { "http.response.header.#{key}" } + # Users MAY explicitly configure instrumentations to capture them even though it is not recommended. + # The attribute value MUST consist of either multiple header values as an array of strings or a single-item array containing a possibly comma-concatenated string, depending on the way the HTTP library provides access to headers. + # + # @note Stability Level: stable + HTTP_RESPONSE_HEADER_LAMBDA = ->(key) { "http.response.header.#{key}" } - # [HTTP response status code](https://tools.ietf.org/html/rfc7231#section-6) - # - # @note StabilityLevel.STABLE + # [HTTP response status code](https://tools.ietf.org/html/rfc7231#section-6). + # + # @note Stability Level: stable HTTP_RESPONSE_STATUS_CODE = 'http.response.status_code' - # The matched route, that is, the path template in the format used by the respective server framework - # + # The matched route, that is, the path template in the format used by the respective server framework. + # # MUST NOT be populated when this is not supported by the HTTP server framework as the route attribute should have low-cardinality and the URI path can NOT substitute it. - # SHOULD include the [application root](/docs/http/http-spans.md#http-server-definitions) if there is one - # - # @note StabilityLevel.STABLE + # SHOULD include the [application root](/docs/http/http-spans.md#http-server-definitions) if there is one. + # + # @note Stability Level: stable HTTP_ROUTE = 'http.route' # @!endgroup diff --git a/semantic_conventions/lib/opentelemetry/semconv/incubating/android.rb b/semantic_conventions/lib/opentelemetry/semconv/incubating/android.rb index 7020e9eb63..129ed23cc1 100644 --- a/semantic_conventions/lib/opentelemetry/semconv/incubating/android.rb +++ b/semantic_conventions/lib/opentelemetry/semconv/incubating/android.rb @@ -24,16 +24,16 @@ module Incubating module ANDROID # @!group Attribute Names - # Uniquely identifies the framework API revision offered by a version (`os.version`) of the android operating system. More information can be found [here](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels) - # - # @note StabilityLevel.EXPERIMENTAL + # Uniquely identifies the framework API revision offered by a version (`os.version`) of the android operating system. More information can be found [here](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels). + # + # @note Stability Level: experimental ANDROID_OS_API_LEVEL = 'android.os.api_level' - # This attribute represents the state the application has transitioned into at the occurrence of the event - # - # The Android lifecycle states are defined in [Activity lifecycle callbacks](https://developer.android.com/guide/components/activities/activity-lifecycle#lc), and from which the `OS identifiers` are derived - # - # @note StabilityLevel.EXPERIMENTAL + # Deprecated use the `device.app.lifecycle` event definition including `android.state` as a payload field instead. + # + # The Android lifecycle states are defined in [Activity lifecycle callbacks](https://developer.android.com/guide/components/activities/activity-lifecycle#lc), and from which the `OS identifiers` are derived. + # + # @note Stability Level: experimental ANDROID_STATE = 'android.state' # @!endgroup @@ -41,6 +41,6 @@ module ANDROID # @!group Metric Names # @!endgroup end - end # module Incubating + end end end \ No newline at end of file diff --git a/semantic_conventions/lib/opentelemetry/semconv/incubating/aspnetcore.rb b/semantic_conventions/lib/opentelemetry/semconv/incubating/aspnetcore.rb index 5e8454d95f..c5a26895bd 100644 --- a/semantic_conventions/lib/opentelemetry/semconv/incubating/aspnetcore.rb +++ b/semantic_conventions/lib/opentelemetry/semconv/incubating/aspnetcore.rb @@ -25,52 +25,52 @@ module ASPNETCORE # @!group Attribute Names # ASP.NET Core exception middleware handling result + # + # @note Stability Level: stable # - # @note StabilityLevel.STABLE - # - # @deprecated Now available in the stable namespace at {OpenTelemetry::SemConv::ASPNETCORE::ASPNETCORE_DIAGNOSTICS_EXCEPTION_RESULT}. + # @deprecated Now available in the stable namespace at {OpenTelemetry::SemConv::Aspnetcore::ASPNETCORE_DIAGNOSTICS_EXCEPTION_RESULT}. ASPNETCORE_DIAGNOSTICS_EXCEPTION_RESULT = 'aspnetcore.diagnostics.exception.result' - # Full type name of the [`IExceptionHandler`](https://learn.microsoft.com/dotnet/api/microsoft.aspnetcore.diagnostics.iexceptionhandler) implementation that handled the exception - # - # @note StabilityLevel.STABLE + # Full type name of the [`IExceptionHandler`](https://learn.microsoft.com/dotnet/api/microsoft.aspnetcore.diagnostics.iexceptionhandler) implementation that handled the exception. + # + # @note Stability Level: stable # - # @deprecated Now available in the stable namespace at {OpenTelemetry::SemConv::ASPNETCORE::ASPNETCORE_DIAGNOSTICS_HANDLER_TYPE}. + # @deprecated Now available in the stable namespace at {OpenTelemetry::SemConv::Aspnetcore::ASPNETCORE_DIAGNOSTICS_HANDLER_TYPE}. ASPNETCORE_DIAGNOSTICS_HANDLER_TYPE = 'aspnetcore.diagnostics.handler.type' - # Rate limiting policy name + # Rate limiting policy name. + # + # @note Stability Level: stable # - # @note StabilityLevel.STABLE - # - # @deprecated Now available in the stable namespace at {OpenTelemetry::SemConv::ASPNETCORE::ASPNETCORE_RATE_LIMITING_POLICY}. + # @deprecated Now available in the stable namespace at {OpenTelemetry::SemConv::Aspnetcore::ASPNETCORE_RATE_LIMITING_POLICY}. ASPNETCORE_RATE_LIMITING_POLICY = 'aspnetcore.rate_limiting.policy' # Rate-limiting result, shows whether the lease was acquired or contains a rejection reason + # + # @note Stability Level: stable # - # @note StabilityLevel.STABLE - # - # @deprecated Now available in the stable namespace at {OpenTelemetry::SemConv::ASPNETCORE::ASPNETCORE_RATE_LIMITING_RESULT}. + # @deprecated Now available in the stable namespace at {OpenTelemetry::SemConv::Aspnetcore::ASPNETCORE_RATE_LIMITING_RESULT}. ASPNETCORE_RATE_LIMITING_RESULT = 'aspnetcore.rate_limiting.result' - # Flag indicating if request was handled by the application pipeline + # Flag indicating if request was handled by the application pipeline. + # + # @note Stability Level: stable # - # @note StabilityLevel.STABLE - # - # @deprecated Now available in the stable namespace at {OpenTelemetry::SemConv::ASPNETCORE::ASPNETCORE_REQUEST_IS_UNHANDLED}. + # @deprecated Now available in the stable namespace at {OpenTelemetry::SemConv::Aspnetcore::ASPNETCORE_REQUEST_IS_UNHANDLED}. ASPNETCORE_REQUEST_IS_UNHANDLED = 'aspnetcore.request.is_unhandled' - # A value that indicates whether the matched route is a fallback route - # - # @note StabilityLevel.STABLE + # A value that indicates whether the matched route is a fallback route. + # + # @note Stability Level: stable # - # @deprecated Now available in the stable namespace at {OpenTelemetry::SemConv::ASPNETCORE::ASPNETCORE_ROUTING_IS_FALLBACK}. + # @deprecated Now available in the stable namespace at {OpenTelemetry::SemConv::Aspnetcore::ASPNETCORE_ROUTING_IS_FALLBACK}. ASPNETCORE_ROUTING_IS_FALLBACK = 'aspnetcore.routing.is_fallback' # Match result - success or failure + # + # @note Stability Level: stable # - # @note StabilityLevel.STABLE - # - # @deprecated Now available in the stable namespace at {OpenTelemetry::SemConv::ASPNETCORE::ASPNETCORE_ROUTING_MATCH_STATUS}. + # @deprecated Now available in the stable namespace at {OpenTelemetry::SemConv::Aspnetcore::ASPNETCORE_ROUTING_MATCH_STATUS}. ASPNETCORE_ROUTING_MATCH_STATUS = 'aspnetcore.routing.match_status' # @!endgroup @@ -78,6 +78,6 @@ module ASPNETCORE # @!group Metric Names # @!endgroup end - end # module Incubating + end end end \ No newline at end of file diff --git a/semantic_conventions/lib/opentelemetry/semconv/incubating/aws.rb b/semantic_conventions/lib/opentelemetry/semconv/incubating/aws.rb index e7222308c7..e66977dcdd 100644 --- a/semantic_conventions/lib/opentelemetry/semconv/incubating/aws.rb +++ b/semantic_conventions/lib/opentelemetry/semconv/incubating/aws.rb @@ -24,268 +24,268 @@ module Incubating module AWS # @!group Attribute Names - # The JSON-serialized value of each item in the `AttributeDefinitions` request field - # - # @note StabilityLevel.EXPERIMENTAL + # The JSON-serialized value of each item in the `AttributeDefinitions` request field. + # + # @note Stability Level: experimental AWS_DYNAMODB_ATTRIBUTE_DEFINITIONS = 'aws.dynamodb.attribute_definitions' - # The value of the `AttributesToGet` request parameter - # - # @note StabilityLevel.EXPERIMENTAL + # The value of the `AttributesToGet` request parameter. + # + # @note Stability Level: experimental AWS_DYNAMODB_ATTRIBUTES_TO_GET = 'aws.dynamodb.attributes_to_get' - # The value of the `ConsistentRead` request parameter - # - # @note StabilityLevel.EXPERIMENTAL + # The value of the `ConsistentRead` request parameter. + # + # @note Stability Level: experimental AWS_DYNAMODB_CONSISTENT_READ = 'aws.dynamodb.consistent_read' - # The JSON-serialized value of each item in the `ConsumedCapacity` response field - # - # @note StabilityLevel.EXPERIMENTAL + # The JSON-serialized value of each item in the `ConsumedCapacity` response field. + # + # @note Stability Level: experimental AWS_DYNAMODB_CONSUMED_CAPACITY = 'aws.dynamodb.consumed_capacity' - # The value of the `Count` response parameter - # - # @note StabilityLevel.EXPERIMENTAL + # The value of the `Count` response parameter. + # + # @note Stability Level: experimental AWS_DYNAMODB_COUNT = 'aws.dynamodb.count' - # The value of the `ExclusiveStartTableName` request parameter - # - # @note StabilityLevel.EXPERIMENTAL + # The value of the `ExclusiveStartTableName` request parameter. + # + # @note Stability Level: experimental AWS_DYNAMODB_EXCLUSIVE_START_TABLE = 'aws.dynamodb.exclusive_start_table' - # The JSON-serialized value of each item in the `GlobalSecondaryIndexUpdates` request field - # - # @note StabilityLevel.EXPERIMENTAL + # The JSON-serialized value of each item in the `GlobalSecondaryIndexUpdates` request field. + # + # @note Stability Level: experimental AWS_DYNAMODB_GLOBAL_SECONDARY_INDEX_UPDATES = 'aws.dynamodb.global_secondary_index_updates' # The JSON-serialized value of each item of the `GlobalSecondaryIndexes` request field - # - # @note StabilityLevel.EXPERIMENTAL + # + # @note Stability Level: experimental AWS_DYNAMODB_GLOBAL_SECONDARY_INDEXES = 'aws.dynamodb.global_secondary_indexes' - # The value of the `IndexName` request parameter - # - # @note StabilityLevel.EXPERIMENTAL + # The value of the `IndexName` request parameter. + # + # @note Stability Level: experimental AWS_DYNAMODB_INDEX_NAME = 'aws.dynamodb.index_name' - # The JSON-serialized value of the `ItemCollectionMetrics` response field - # - # @note StabilityLevel.EXPERIMENTAL + # The JSON-serialized value of the `ItemCollectionMetrics` response field. + # + # @note Stability Level: experimental AWS_DYNAMODB_ITEM_COLLECTION_METRICS = 'aws.dynamodb.item_collection_metrics' - # The value of the `Limit` request parameter - # - # @note StabilityLevel.EXPERIMENTAL + # The value of the `Limit` request parameter. + # + # @note Stability Level: experimental AWS_DYNAMODB_LIMIT = 'aws.dynamodb.limit' - # The JSON-serialized value of each item of the `LocalSecondaryIndexes` request field - # - # @note StabilityLevel.EXPERIMENTAL + # The JSON-serialized value of each item of the `LocalSecondaryIndexes` request field. + # + # @note Stability Level: experimental AWS_DYNAMODB_LOCAL_SECONDARY_INDEXES = 'aws.dynamodb.local_secondary_indexes' - # The value of the `ProjectionExpression` request parameter - # - # @note StabilityLevel.EXPERIMENTAL + # The value of the `ProjectionExpression` request parameter. + # + # @note Stability Level: experimental AWS_DYNAMODB_PROJECTION = 'aws.dynamodb.projection' - # The value of the `ProvisionedThroughput.ReadCapacityUnits` request parameter - # - # @note StabilityLevel.EXPERIMENTAL + # The value of the `ProvisionedThroughput.ReadCapacityUnits` request parameter. + # + # @note Stability Level: experimental AWS_DYNAMODB_PROVISIONED_READ_CAPACITY = 'aws.dynamodb.provisioned_read_capacity' - # The value of the `ProvisionedThroughput.WriteCapacityUnits` request parameter - # - # @note StabilityLevel.EXPERIMENTAL + # The value of the `ProvisionedThroughput.WriteCapacityUnits` request parameter. + # + # @note Stability Level: experimental AWS_DYNAMODB_PROVISIONED_WRITE_CAPACITY = 'aws.dynamodb.provisioned_write_capacity' - # The value of the `ScanIndexForward` request parameter - # - # @note StabilityLevel.EXPERIMENTAL + # The value of the `ScanIndexForward` request parameter. + # + # @note Stability Level: experimental AWS_DYNAMODB_SCAN_FORWARD = 'aws.dynamodb.scan_forward' - # The value of the `ScannedCount` response parameter - # - # @note StabilityLevel.EXPERIMENTAL + # The value of the `ScannedCount` response parameter. + # + # @note Stability Level: experimental AWS_DYNAMODB_SCANNED_COUNT = 'aws.dynamodb.scanned_count' - # The value of the `Segment` request parameter - # - # @note StabilityLevel.EXPERIMENTAL + # The value of the `Segment` request parameter. + # + # @note Stability Level: experimental AWS_DYNAMODB_SEGMENT = 'aws.dynamodb.segment' - # The value of the `Select` request parameter - # - # @note StabilityLevel.EXPERIMENTAL + # The value of the `Select` request parameter. + # + # @note Stability Level: experimental AWS_DYNAMODB_SELECT = 'aws.dynamodb.select' - # The number of items in the `TableNames` response parameter - # - # @note StabilityLevel.EXPERIMENTAL + # The number of items in the `TableNames` response parameter. + # + # @note Stability Level: experimental AWS_DYNAMODB_TABLE_COUNT = 'aws.dynamodb.table_count' - # The keys in the `RequestItems` object field - # - # @note StabilityLevel.EXPERIMENTAL + # The keys in the `RequestItems` object field. + # + # @note Stability Level: experimental AWS_DYNAMODB_TABLE_NAMES = 'aws.dynamodb.table_names' - # The value of the `TotalSegments` request parameter - # - # @note StabilityLevel.EXPERIMENTAL + # The value of the `TotalSegments` request parameter. + # + # @note Stability Level: experimental AWS_DYNAMODB_TOTAL_SEGMENTS = 'aws.dynamodb.total_segments' - # The ARN of an [ECS cluster](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/clusters.html) - # - # @note StabilityLevel.EXPERIMENTAL + # The ARN of an [ECS cluster](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/clusters.html). + # + # @note Stability Level: experimental AWS_ECS_CLUSTER_ARN = 'aws.ecs.cluster.arn' - # The Amazon Resource Name (ARN) of an [ECS container instance](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ECS_instances.html) - # - # @note StabilityLevel.EXPERIMENTAL + # The Amazon Resource Name (ARN) of an [ECS container instance](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ECS_instances.html). + # + # @note Stability Level: experimental AWS_ECS_CONTAINER_ARN = 'aws.ecs.container.arn' - # The [launch type](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/launch_types.html) for an ECS task - # - # @note StabilityLevel.EXPERIMENTAL + # The [launch type](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/launch_types.html) for an ECS task. + # + # @note Stability Level: experimental AWS_ECS_LAUNCHTYPE = 'aws.ecs.launchtype' - # The ARN of a running [ECS task](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-account-settings.html#ecs-resource-ids) - # - # @note StabilityLevel.EXPERIMENTAL + # The ARN of a running [ECS task](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-account-settings.html#ecs-resource-ids). + # + # @note Stability Level: experimental AWS_ECS_TASK_ARN = 'aws.ecs.task.arn' - # The family name of the [ECS task definition](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task_definitions.html) used to create the ECS task - # - # @note StabilityLevel.EXPERIMENTAL + # The family name of the [ECS task definition](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task_definitions.html) used to create the ECS task. + # + # @note Stability Level: experimental AWS_ECS_TASK_FAMILY = 'aws.ecs.task.family' - # The ID of a running ECS task. The ID MUST be extracted from `task.arn` - # - # @note StabilityLevel.EXPERIMENTAL + # The ID of a running ECS task. The ID MUST be extracted from `task.arn`. + # + # @note Stability Level: experimental AWS_ECS_TASK_ID = 'aws.ecs.task.id' - # The revision for the task definition used to create the ECS task - # - # @note StabilityLevel.EXPERIMENTAL + # The revision for the task definition used to create the ECS task. + # + # @note Stability Level: experimental AWS_ECS_TASK_REVISION = 'aws.ecs.task.revision' - # The ARN of an EKS cluster - # - # @note StabilityLevel.EXPERIMENTAL + # The ARN of an EKS cluster. + # + # @note Stability Level: experimental AWS_EKS_CLUSTER_ARN = 'aws.eks.cluster.arn' - # The full invoked ARN as provided on the `Context` passed to the function (`Lambda-Runtime-Invoked-Function-Arn` header on the `/runtime/invocation/next` applicable) - # - # This may be different from `cloud.resource_id` if an alias is involved - # - # @note StabilityLevel.EXPERIMENTAL + # The full invoked ARN as provided on the `Context` passed to the function (`Lambda-Runtime-Invoked-Function-Arn` header on the `/runtime/invocation/next` applicable). + # + # This may be different from `cloud.resource_id` if an alias is involved. + # + # @note Stability Level: experimental AWS_LAMBDA_INVOKED_ARN = 'aws.lambda.invoked_arn' - # The Amazon Resource Name(s) (ARN) of the AWS log group(s) - # - # See the [log group ARN format documentation](https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/iam-access-control-overview-cwl.html#CWL_ARN_Format) - # - # @note StabilityLevel.EXPERIMENTAL + # The Amazon Resource Name(s) (ARN) of the AWS log group(s). + # + # See the [log group ARN format documentation](https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/iam-access-control-overview-cwl.html#CWL_ARN_Format). + # + # @note Stability Level: experimental AWS_LOG_GROUP_ARNS = 'aws.log.group.arns' - # The name(s) of the AWS log group(s) an application is writing to - # - # 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 - # - # @note StabilityLevel.EXPERIMENTAL + # The name(s) of the AWS log group(s) an application is writing to. + # + # 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. + # + # @note Stability Level: experimental AWS_LOG_GROUP_NAMES = 'aws.log.group.names' - # The ARN(s) of the AWS log stream(s) - # - # 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 - # - # @note StabilityLevel.EXPERIMENTAL + # The ARN(s) of the AWS log stream(s). + # + # 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. + # + # @note Stability Level: experimental AWS_LOG_STREAM_ARNS = 'aws.log.stream.arns' - # The name(s) of the AWS log stream(s) an application is writing to - # - # @note StabilityLevel.EXPERIMENTAL + # The name(s) of the AWS log stream(s) an application is writing to. + # + # @note Stability Level: experimental AWS_LOG_STREAM_NAMES = 'aws.log.stream.names' - # The AWS request ID as returned in the response headers `x-amz-request-id` or `x-amz-requestid` - # - # @note StabilityLevel.EXPERIMENTAL + # The AWS request ID as returned in the response headers `x-amz-request-id` or `x-amz-requestid`. + # + # @note Stability Level: experimental AWS_REQUEST_ID = 'aws.request_id' - # The S3 bucket name the request refers to. Corresponds to the `--bucket` parameter of the [S3 API](https://docs.aws.amazon.com/cli/latest/reference/s3api/index.html) operations - # + # The S3 bucket name the request refers to. Corresponds to the `--bucket` parameter of the [S3 API](https://docs.aws.amazon.com/cli/latest/reference/s3api/index.html) operations. + # # The `bucket` attribute is applicable to all S3 operations that reference a bucket, i.e. that require the bucket name as a mandatory parameter. - # This applies to almost all S3 operations except `list-buckets` - # - # @note StabilityLevel.EXPERIMENTAL + # This applies to almost all S3 operations except `list-buckets`. + # + # @note Stability Level: experimental AWS_S3_BUCKET = 'aws.s3.bucket' - # The source object (in the form `bucket`/`key`) for the copy operation - # + # The source object (in the form `bucket`/`key`) for the copy operation. + # # The `copy_source` attribute applies to S3 copy operations and corresponds to the `--copy-source` parameter - # of the [copy-object operation within the S3 API](https://docs.aws.amazon.com/cli/latest/reference/s3api/copy-object.html). - # This applies in particular to the following operations: - # - # - [copy-object](https://docs.aws.amazon.com/cli/latest/reference/s3api/copy-object.html) - # - [upload-part-copy](https://docs.aws.amazon.com/cli/latest/reference/s3api/upload-part-copy.html) - # - # @note StabilityLevel.EXPERIMENTAL + # of the [copy-object operation within the S3 API](https://docs.aws.amazon.com/cli/latest/reference/s3api/copy-object.html). + # This applies in particular to the following operations: + # + # - [copy-object](https://docs.aws.amazon.com/cli/latest/reference/s3api/copy-object.html) + # - [upload-part-copy](https://docs.aws.amazon.com/cli/latest/reference/s3api/upload-part-copy.html) + # + # @note Stability Level: experimental AWS_S3_COPY_SOURCE = 'aws.s3.copy_source' - # The delete request container that specifies the objects to be deleted - # + # The delete request container that specifies the objects to be deleted. + # # The `delete` attribute is only applicable to the [delete-object](https://docs.aws.amazon.com/cli/latest/reference/s3api/delete-object.html) operation. - # The `delete` attribute corresponds to the `--delete` parameter of the - # [delete-objects operation within the S3 API](https://docs.aws.amazon.com/cli/latest/reference/s3api/delete-objects.html) - # - # @note StabilityLevel.EXPERIMENTAL + # The `delete` attribute corresponds to the `--delete` parameter of the + # [delete-objects operation within the S3 API](https://docs.aws.amazon.com/cli/latest/reference/s3api/delete-objects.html). + # + # @note Stability Level: experimental AWS_S3_DELETE = 'aws.s3.delete' - # The S3 object key the request refers to. Corresponds to the `--key` parameter of the [S3 API](https://docs.aws.amazon.com/cli/latest/reference/s3api/index.html) operations - # + # The S3 object key the request refers to. Corresponds to the `--key` parameter of the [S3 API](https://docs.aws.amazon.com/cli/latest/reference/s3api/index.html) operations. + # # The `key` attribute is applicable to all object-related S3 operations, i.e. that require the object key as a mandatory parameter. - # This applies in particular to the following operations: - # - # - [copy-object](https://docs.aws.amazon.com/cli/latest/reference/s3api/copy-object.html) - # - [delete-object](https://docs.aws.amazon.com/cli/latest/reference/s3api/delete-object.html) - # - [get-object](https://docs.aws.amazon.com/cli/latest/reference/s3api/get-object.html) - # - [head-object](https://docs.aws.amazon.com/cli/latest/reference/s3api/head-object.html) - # - [put-object](https://docs.aws.amazon.com/cli/latest/reference/s3api/put-object.html) - # - [restore-object](https://docs.aws.amazon.com/cli/latest/reference/s3api/restore-object.html) - # - [select-object-content](https://docs.aws.amazon.com/cli/latest/reference/s3api/select-object-content.html) - # - [abort-multipart-upload](https://docs.aws.amazon.com/cli/latest/reference/s3api/abort-multipart-upload.html) - # - [complete-multipart-upload](https://docs.aws.amazon.com/cli/latest/reference/s3api/complete-multipart-upload.html) - # - [create-multipart-upload](https://docs.aws.amazon.com/cli/latest/reference/s3api/create-multipart-upload.html) - # - [list-parts](https://docs.aws.amazon.com/cli/latest/reference/s3api/list-parts.html) - # - [upload-part](https://docs.aws.amazon.com/cli/latest/reference/s3api/upload-part.html) - # - [upload-part-copy](https://docs.aws.amazon.com/cli/latest/reference/s3api/upload-part-copy.html) - # - # @note StabilityLevel.EXPERIMENTAL + # This applies in particular to the following operations: + # + # - [copy-object](https://docs.aws.amazon.com/cli/latest/reference/s3api/copy-object.html) + # - [delete-object](https://docs.aws.amazon.com/cli/latest/reference/s3api/delete-object.html) + # - [get-object](https://docs.aws.amazon.com/cli/latest/reference/s3api/get-object.html) + # - [head-object](https://docs.aws.amazon.com/cli/latest/reference/s3api/head-object.html) + # - [put-object](https://docs.aws.amazon.com/cli/latest/reference/s3api/put-object.html) + # - [restore-object](https://docs.aws.amazon.com/cli/latest/reference/s3api/restore-object.html) + # - [select-object-content](https://docs.aws.amazon.com/cli/latest/reference/s3api/select-object-content.html) + # - [abort-multipart-upload](https://docs.aws.amazon.com/cli/latest/reference/s3api/abort-multipart-upload.html) + # - [complete-multipart-upload](https://docs.aws.amazon.com/cli/latest/reference/s3api/complete-multipart-upload.html) + # - [create-multipart-upload](https://docs.aws.amazon.com/cli/latest/reference/s3api/create-multipart-upload.html) + # - [list-parts](https://docs.aws.amazon.com/cli/latest/reference/s3api/list-parts.html) + # - [upload-part](https://docs.aws.amazon.com/cli/latest/reference/s3api/upload-part.html) + # - [upload-part-copy](https://docs.aws.amazon.com/cli/latest/reference/s3api/upload-part-copy.html) + # + # @note Stability Level: experimental AWS_S3_KEY = 'aws.s3.key' - # The part number of the part being uploaded in a multipart-upload operation. This is a positive integer between 1 and 10,000 - # + # The part number of the part being uploaded in a multipart-upload operation. This is a positive integer between 1 and 10,000. + # # The `part_number` attribute is only applicable to the [upload-part](https://docs.aws.amazon.com/cli/latest/reference/s3api/upload-part.html) - # and [upload-part-copy](https://docs.aws.amazon.com/cli/latest/reference/s3api/upload-part-copy.html) operations. - # The `part_number` attribute corresponds to the `--part-number` parameter of the - # [upload-part operation within the S3 API](https://docs.aws.amazon.com/cli/latest/reference/s3api/upload-part.html) - # - # @note StabilityLevel.EXPERIMENTAL + # and [upload-part-copy](https://docs.aws.amazon.com/cli/latest/reference/s3api/upload-part-copy.html) operations. + # The `part_number` attribute corresponds to the `--part-number` parameter of the + # [upload-part operation within the S3 API](https://docs.aws.amazon.com/cli/latest/reference/s3api/upload-part.html). + # + # @note Stability Level: experimental AWS_S3_PART_NUMBER = 'aws.s3.part_number' - # Upload ID that identifies the multipart upload - # + # Upload ID that identifies the multipart upload. + # # The `upload_id` attribute applies to S3 multipart-upload operations and corresponds to the `--upload-id` parameter - # of the [S3 API](https://docs.aws.amazon.com/cli/latest/reference/s3api/index.html) multipart operations. - # This applies in particular to the following operations: - # - # - [abort-multipart-upload](https://docs.aws.amazon.com/cli/latest/reference/s3api/abort-multipart-upload.html) - # - [complete-multipart-upload](https://docs.aws.amazon.com/cli/latest/reference/s3api/complete-multipart-upload.html) - # - [list-parts](https://docs.aws.amazon.com/cli/latest/reference/s3api/list-parts.html) - # - [upload-part](https://docs.aws.amazon.com/cli/latest/reference/s3api/upload-part.html) - # - [upload-part-copy](https://docs.aws.amazon.com/cli/latest/reference/s3api/upload-part-copy.html) - # - # @note StabilityLevel.EXPERIMENTAL + # of the [S3 API](https://docs.aws.amazon.com/cli/latest/reference/s3api/index.html) multipart operations. + # This applies in particular to the following operations: + # + # - [abort-multipart-upload](https://docs.aws.amazon.com/cli/latest/reference/s3api/abort-multipart-upload.html) + # - [complete-multipart-upload](https://docs.aws.amazon.com/cli/latest/reference/s3api/complete-multipart-upload.html) + # - [list-parts](https://docs.aws.amazon.com/cli/latest/reference/s3api/list-parts.html) + # - [upload-part](https://docs.aws.amazon.com/cli/latest/reference/s3api/upload-part.html) + # - [upload-part-copy](https://docs.aws.amazon.com/cli/latest/reference/s3api/upload-part-copy.html) + # + # @note Stability Level: experimental AWS_S3_UPLOAD_ID = 'aws.s3.upload_id' # @!endgroup @@ -293,6 +293,6 @@ module AWS # @!group Metric Names # @!endgroup end - end # module Incubating + end end end \ No newline at end of file diff --git a/semantic_conventions/lib/opentelemetry/semconv/incubating/browser.rb b/semantic_conventions/lib/opentelemetry/semconv/incubating/browser.rb index 220d6db4a0..4ebb823143 100644 --- a/semantic_conventions/lib/opentelemetry/semconv/incubating/browser.rb +++ b/semantic_conventions/lib/opentelemetry/semconv/incubating/browser.rb @@ -25,32 +25,32 @@ module BROWSER # @!group Attribute Names # Array of brand name and version separated by a space - # - # This value is intended to be taken from the [UA client hints API](https://wicg.github.io/ua-client-hints/#interface) (`navigator.userAgentData.brands`) - # - # @note StabilityLevel.EXPERIMENTAL + # + # This value is intended to be taken from the [UA client hints API](https://wicg.github.io/ua-client-hints/#interface) (`navigator.userAgentData.brands`). + # + # @note Stability Level: experimental BROWSER_BRANDS = 'browser.brands' # Preferred language of the user using the browser - # - # This value is intended to be taken from the Navigator API `navigator.language` - # - # @note StabilityLevel.EXPERIMENTAL + # + # This value is intended to be taken from the Navigator API `navigator.language`. + # + # @note Stability Level: experimental BROWSER_LANGUAGE = 'browser.language' # A boolean that is true if the browser is running on a mobile device - # - # This value is intended to be taken from the [UA client hints API](https://wicg.github.io/ua-client-hints/#interface) (`navigator.userAgentData.mobile`). If unavailable, this attribute SHOULD be left unset - # - # @note StabilityLevel.EXPERIMENTAL + # + # This value is intended to be taken from the [UA client hints API](https://wicg.github.io/ua-client-hints/#interface) (`navigator.userAgentData.mobile`). If unavailable, this attribute SHOULD be left unset. + # + # @note Stability Level: experimental BROWSER_MOBILE = 'browser.mobile' # The platform on which the browser is running - # + # # This value is intended to be taken from the [UA client hints API](https://wicg.github.io/ua-client-hints/#interface) (`navigator.userAgentData.platform`). If unavailable, the legacy `navigator.platform` API SHOULD NOT be used instead and this attribute SHOULD be left unset in order for the values to be consistent. - # The list of possible values is defined in the [W3C User-Agent Client Hints specification](https://wicg.github.io/ua-client-hints/#sec-ch-ua-platform). Note that some (but not all) of these values can overlap with values in the [`os.type` and `os.name` attributes](./os.md). However, for consistency, the values in the `browser.platform` attribute should capture the exact value that the user agent provides - # - # @note StabilityLevel.EXPERIMENTAL + # The list of possible values is defined in the [W3C User-Agent Client Hints specification](https://wicg.github.io/ua-client-hints/#sec-ch-ua-platform). Note that some (but not all) of these values can overlap with values in the [`os.type` and `os.name` attributes](./os.md). However, for consistency, the values in the `browser.platform` attribute should capture the exact value that the user agent provides. + # + # @note Stability Level: experimental BROWSER_PLATFORM = 'browser.platform' # @!endgroup @@ -58,6 +58,6 @@ module BROWSER # @!group Metric Names # @!endgroup end - end # module Incubating + end end end \ No newline at end of file diff --git a/semantic_conventions/lib/opentelemetry/semconv/incubating/client.rb b/semantic_conventions/lib/opentelemetry/semconv/incubating/client.rb index 09db54112f..bdd75c81cd 100644 --- a/semantic_conventions/lib/opentelemetry/semconv/incubating/client.rb +++ b/semantic_conventions/lib/opentelemetry/semconv/incubating/client.rb @@ -24,22 +24,22 @@ module Incubating module CLIENT # @!group Attribute Names - # Client address - domain name if available without reverse DNS lookup; otherwise, IP address or Unix domain socket name + # Client address - domain name if available without reverse DNS lookup; otherwise, IP address or Unix domain socket name. + # + # When observed from the server side, and when communicating through an intermediary, `client.address` SHOULD represent the client address behind any intermediaries, for example proxies, if it's available. + # + # @note Stability Level: stable # - # When observed from the server side, and when communicating through an intermediary, `client.address` SHOULD represent the client address behind any intermediaries, for example proxies, if it's available - # - # @note StabilityLevel.STABLE - # - # @deprecated Now available in the stable namespace at {OpenTelemetry::SemConv::CLIENT::CLIENT_ADDRESS}. + # @deprecated Now available in the stable namespace at {OpenTelemetry::SemConv::Client::CLIENT_ADDRESS}. CLIENT_ADDRESS = 'client.address' - # Client port number - # - # When observed from the server side, and when communicating through an intermediary, `client.port` SHOULD represent the client port behind any intermediaries, for example proxies, if it's available + # Client port number. + # + # When observed from the server side, and when communicating through an intermediary, `client.port` SHOULD represent the client port behind any intermediaries, for example proxies, if it's available. + # + # @note Stability Level: stable # - # @note StabilityLevel.STABLE - # - # @deprecated Now available in the stable namespace at {OpenTelemetry::SemConv::CLIENT::CLIENT_PORT}. + # @deprecated Now available in the stable namespace at {OpenTelemetry::SemConv::Client::CLIENT_PORT}. CLIENT_PORT = 'client.port' # @!endgroup @@ -47,6 +47,6 @@ module CLIENT # @!group Metric Names # @!endgroup end - end # module Incubating + end end end \ No newline at end of file diff --git a/semantic_conventions/lib/opentelemetry/semconv/incubating/cloud.rb b/semantic_conventions/lib/opentelemetry/semconv/incubating/cloud.rb index e450c6e78a..fa59fcce90 100644 --- a/semantic_conventions/lib/opentelemetry/semconv/incubating/cloud.rb +++ b/semantic_conventions/lib/opentelemetry/semconv/incubating/cloud.rb @@ -24,58 +24,58 @@ module Incubating module CLOUD # @!group Attribute Names - # The cloud account ID the resource is assigned to - # - # @note StabilityLevel.EXPERIMENTAL + # The cloud account ID the resource is assigned to. + # + # @note Stability Level: experimental CLOUD_ACCOUNT_ID = 'cloud.account.id' - # Cloud regions often have multiple, isolated locations known as zones to increase availability. Availability zone represents the zone where the resource is running - # - # Availability zones are called "zones" on Alibaba Cloud and Google Cloud - # - # @note StabilityLevel.EXPERIMENTAL + # Cloud regions often have multiple, isolated locations known as zones to increase availability. Availability zone represents the zone where the resource is running. + # + # Availability zones are called "zones" on Alibaba Cloud and Google Cloud. + # + # @note Stability Level: experimental CLOUD_AVAILABILITY_ZONE = 'cloud.availability_zone' - # The cloud platform in use - # - # The prefix of the service SHOULD match the one specified in `cloud.provider` - # - # @note StabilityLevel.EXPERIMENTAL + # The cloud platform in use. + # + # The prefix of the service SHOULD match the one specified in `cloud.provider`. + # + # @note Stability Level: experimental CLOUD_PLATFORM = 'cloud.platform' - # Name of the cloud provider - # - # @note StabilityLevel.EXPERIMENTAL + # Name of the cloud provider. + # + # @note Stability Level: experimental CLOUD_PROVIDER = 'cloud.provider' - # The geographical region the resource is running - # - # Refer to your provider's docs to see the available regions, for example [Alibaba Cloud regions](https://www.alibabacloud.com/help/doc-detail/40654.htm), [AWS regions](https://aws.amazon.com/about-aws/global-infrastructure/regions_az/), [Azure regions](https://azure.microsoft.com/global-infrastructure/geographies/), [Google Cloud regions](https://cloud.google.com/about/locations), or [Tencent Cloud regions](https://www.tencentcloud.com/document/product/213/6091) - # - # @note StabilityLevel.EXPERIMENTAL + # The geographical region the resource is running. + # + # Refer to your provider's docs to see the available regions, for example [Alibaba Cloud regions](https://www.alibabacloud.com/help/doc-detail/40654.htm), [AWS regions](https://aws.amazon.com/about-aws/global-infrastructure/regions_az/), [Azure regions](https://azure.microsoft.com/global-infrastructure/geographies/), [Google Cloud regions](https://cloud.google.com/about/locations), or [Tencent Cloud regions](https://www.tencentcloud.com/document/product/213/6091). + # + # @note Stability Level: experimental CLOUD_REGION = 'cloud.region' # Cloud provider-specific native identifier of the monitored cloud resource (e.g. an [ARN](https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) on AWS, a [fully qualified resource ID](https://learn.microsoft.com/rest/api/resources/resources/get-by-id) on Azure, a [full resource name](https://cloud.google.com/apis/design/resource_names#full_resource_name) on GCP) - # + # # On some cloud providers, it may not be possible to determine the full ID at startup, - # so it may be necessary to set `cloud.resource_id` as a span attribute instead. - # - # The exact value to use for `cloud.resource_id` depends on the cloud provider. - # The following well-known definitions MUST be used if you set this attribute and they apply: - # - # * **AWS Lambda:** The function [ARN](https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html). - # Take care not to use the "invoked ARN" directly but replace any - # [alias suffix](https://docs.aws.amazon.com/lambda/latest/dg/configuration-aliases.html) - # with the resolved function version, as the same runtime instance may be invokable with - # multiple different aliases. - # * **GCP:** The [URI of the resource](https://cloud.google.com/iam/docs/full-resource-names) - # * **Azure:** The [Fully Qualified Resource ID](https://docs.microsoft.com/rest/api/resources/resources/get-by-id) of the invoked function, - # *not* the function app, having the form - # `/subscriptions//resourceGroups//providers/Microsoft.Web/sites//functions/`. - # This means that a span attribute MUST be used, as an Azure function app can host multiple functions that would usually share - # a TracerProvider - # - # @note StabilityLevel.EXPERIMENTAL + # so it may be necessary to set `cloud.resource_id` as a span attribute instead. + # + # The exact value to use for `cloud.resource_id` depends on the cloud provider. + # The following well-known definitions MUST be used if you set this attribute and they apply: + # + # - **AWS Lambda:** The function [ARN](https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html). + # Take care not to use the "invoked ARN" directly but replace any + # [alias suffix](https://docs.aws.amazon.com/lambda/latest/dg/configuration-aliases.html) + # with the resolved function version, as the same runtime instance may be invokable with + # multiple different aliases. + # - **GCP:** The [URI of the resource](https://cloud.google.com/iam/docs/full-resource-names) + # - **Azure:** The [Fully Qualified Resource ID](https://docs.microsoft.com/rest/api/resources/resources/get-by-id) of the invoked function, + # *not* the function app, having the form + # `/subscriptions//resourceGroups//providers/Microsoft.Web/sites//functions/`. + # This means that a span attribute MUST be used, as an Azure function app can host multiple functions that would usually share + # a TracerProvider. + # + # @note Stability Level: experimental CLOUD_RESOURCE_ID = 'cloud.resource_id' # @!endgroup @@ -83,6 +83,6 @@ module CLOUD # @!group Metric Names # @!endgroup end - end # module Incubating + end end end \ No newline at end of file diff --git a/semantic_conventions/lib/opentelemetry/semconv/incubating/cloudevents.rb b/semantic_conventions/lib/opentelemetry/semconv/incubating/cloudevents.rb index 83dc8f4097..10993c8fed 100644 --- a/semantic_conventions/lib/opentelemetry/semconv/incubating/cloudevents.rb +++ b/semantic_conventions/lib/opentelemetry/semconv/incubating/cloudevents.rb @@ -24,29 +24,29 @@ module Incubating module CLOUDEVENTS # @!group Attribute Names - # The [event_id](https://github.com/cloudevents/spec/blob/v1.0.2/cloudevents/spec.md#id) uniquely identifies the event - # - # @note StabilityLevel.EXPERIMENTAL + # The [event_id](https://github.com/cloudevents/spec/blob/v1.0.2/cloudevents/spec.md#id) uniquely identifies the event. + # + # @note Stability Level: experimental CLOUDEVENTS_EVENT_ID = 'cloudevents.event_id' - # The [source](https://github.com/cloudevents/spec/blob/v1.0.2/cloudevents/spec.md#source-1) identifies the context in which an event happened - # - # @note StabilityLevel.EXPERIMENTAL + # The [source](https://github.com/cloudevents/spec/blob/v1.0.2/cloudevents/spec.md#source-1) identifies the context in which an event happened. + # + # @note Stability Level: experimental CLOUDEVENTS_EVENT_SOURCE = 'cloudevents.event_source' - # The [version of the CloudEvents specification](https://github.com/cloudevents/spec/blob/v1.0.2/cloudevents/spec.md#specversion) which the event uses - # - # @note StabilityLevel.EXPERIMENTAL + # The [version of the CloudEvents specification](https://github.com/cloudevents/spec/blob/v1.0.2/cloudevents/spec.md#specversion) which the event uses. + # + # @note Stability Level: experimental CLOUDEVENTS_EVENT_SPEC_VERSION = 'cloudevents.event_spec_version' - # The [subject](https://github.com/cloudevents/spec/blob/v1.0.2/cloudevents/spec.md#subject) of the event in the context of the event producer (identified by source) - # - # @note StabilityLevel.EXPERIMENTAL + # The [subject](https://github.com/cloudevents/spec/blob/v1.0.2/cloudevents/spec.md#subject) of the event in the context of the event producer (identified by source). + # + # @note Stability Level: experimental CLOUDEVENTS_EVENT_SUBJECT = 'cloudevents.event_subject' - # The [event_type](https://github.com/cloudevents/spec/blob/v1.0.2/cloudevents/spec.md#type) contains a value describing the type of event related to the originating occurrence - # - # @note StabilityLevel.EXPERIMENTAL + # The [event_type](https://github.com/cloudevents/spec/blob/v1.0.2/cloudevents/spec.md#type) contains a value describing the type of event related to the originating occurrence. + # + # @note Stability Level: experimental CLOUDEVENTS_EVENT_TYPE = 'cloudevents.event_type' # @!endgroup @@ -54,6 +54,6 @@ module CLOUDEVENTS # @!group Metric Names # @!endgroup end - end # module Incubating + end end end \ No newline at end of file diff --git a/semantic_conventions/lib/opentelemetry/semconv/incubating/code.rb b/semantic_conventions/lib/opentelemetry/semconv/incubating/code.rb index 30c7fd58bc..6587558d2c 100644 --- a/semantic_conventions/lib/opentelemetry/semconv/incubating/code.rb +++ b/semantic_conventions/lib/opentelemetry/semconv/incubating/code.rb @@ -24,34 +24,34 @@ module Incubating module CODE # @!group Attribute Names - # The column number in `code.filepath` best representing the operation. It SHOULD point within the code unit named in `code.function` - # - # @note StabilityLevel.EXPERIMENTAL + # The column number in `code.filepath` best representing the operation. It SHOULD point within the code unit named in `code.function`. + # + # @note Stability Level: experimental CODE_COLUMN = 'code.column' - # The source code file name that identifies the code unit as uniquely as possible (preferably an absolute file path) - # - # @note StabilityLevel.EXPERIMENTAL + # The source code file name that identifies the code unit as uniquely as possible (preferably an absolute file path). + # + # @note Stability Level: experimental CODE_FILEPATH = 'code.filepath' - # The method or function name, or equivalent (usually rightmost part of the code unit's name) - # - # @note StabilityLevel.EXPERIMENTAL + # The method or function name, or equivalent (usually rightmost part of the code unit's name). + # + # @note Stability Level: experimental CODE_FUNCTION = 'code.function' - # The line number in `code.filepath` best representing the operation. It SHOULD point within the code unit named in `code.function` - # - # @note StabilityLevel.EXPERIMENTAL + # The line number in `code.filepath` best representing the operation. It SHOULD point within the code unit named in `code.function`. + # + # @note Stability Level: experimental CODE_LINENO = 'code.lineno' - # 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 - # - # @note StabilityLevel.EXPERIMENTAL + # 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. + # + # @note Stability Level: experimental CODE_NAMESPACE = 'code.namespace' - # 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 StabilityLevel.EXPERIMENTAL + # 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: experimental CODE_STACKTRACE = 'code.stacktrace' # @!endgroup @@ -59,6 +59,6 @@ module CODE # @!group Metric Names # @!endgroup end - end # module Incubating + end end end \ No newline at end of file diff --git a/semantic_conventions/lib/opentelemetry/semconv/incubating/container.rb b/semantic_conventions/lib/opentelemetry/semconv/incubating/container.rb index 3e01848701..342a367616 100644 --- a/semantic_conventions/lib/opentelemetry/semconv/incubating/container.rb +++ b/semantic_conventions/lib/opentelemetry/semconv/incubating/container.rb @@ -24,79 +24,78 @@ module Incubating module CONTAINER # @!group Attribute Names - # The command used to run the container (i.e. the command name) - # - # If using embedded credentials or sensitive data, it is recommended to remove them to prevent potential leakage - # - # @note StabilityLevel.EXPERIMENTAL + # The command used to run the container (i.e. the command name). + # + # If using embedded credentials or sensitive data, it is recommended to remove them to prevent potential leakage. + # + # @note Stability Level: experimental CONTAINER_COMMAND = 'container.command' # All the command arguments (including the command/executable itself) run by the container. [2] - # - # @note StabilityLevel.EXPERIMENTAL + # + # @note Stability Level: experimental CONTAINER_COMMAND_ARGS = 'container.command_args' # The full command run by the container as a single string representing the full command. [2] - # - # @note StabilityLevel.EXPERIMENTAL + # + # @note Stability Level: experimental CONTAINER_COMMAND_LINE = 'container.command_line' - # The CPU state for this data point - # - # @note StabilityLevel.EXPERIMENTAL + # The CPU state for this data point. + # + # @note Stability Level: experimental CONTAINER_CPU_STATE = 'container.cpu.state' - # 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 - # - # @note StabilityLevel.EXPERIMENTAL + # 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. + # + # @note Stability Level: experimental CONTAINER_ID = 'container.id' - # Runtime specific image identifier. Usually a hash algorithm followed by a UUID - # + # Runtime specific image identifier. Usually a hash algorithm followed by a UUID. + # # Docker defines a sha256 of the image id; `container.image.id` corresponds to the `Image` field from the Docker container inspect [API](https://docs.docker.com/engine/api/v1.43/#tag/Container/operation/ContainerInspect) endpoint. - # K8s defines a link to the container registry repository with digest `"imageID": "registry.azurecr.io /namespace/service/dockerfile@sha256:bdeabd40c3a8a492eaf9e8e44d0ebbb84bac7ee25ac0cf8a7159d25f62555625"`. - # The ID is assinged by the container runtime and can vary in different environments. Consider using `oci.manifest.digest` if it is important to identify the same image in different environments/runtimes - # - # @note StabilityLevel.EXPERIMENTAL + # K8s defines a link to the container registry repository with digest `"imageID": "registry.azurecr.io /namespace/service/dockerfile@sha256:bdeabd40c3a8a492eaf9e8e44d0ebbb84bac7ee25ac0cf8a7159d25f62555625"`. + # The ID is assigned by the container runtime and can vary in different environments. Consider using `oci.manifest.digest` if it is important to identify the same image in different environments/runtimes. + # + # @note Stability Level: experimental CONTAINER_IMAGE_ID = 'container.image.id' - # Name of the image the container was built on - # - # @note StabilityLevel.EXPERIMENTAL + # Name of the image the container was built on. + # + # @note Stability Level: experimental CONTAINER_IMAGE_NAME = 'container.image.name' - # Repo digests of the container image as provided by the container runtime - # - # [Docker](https://docs.docker.com/engine/api/v1.43/#tag/Image/operation/ImageInspect) and [CRI](https://github.com/kubernetes/cri-api/blob/c75ef5b473bbe2d0a4fc92f82235efd665ea8e9f/pkg/apis/runtime/v1/api.proto#L1237-L1238) report those under the `RepoDigests` field - # - # @note StabilityLevel.EXPERIMENTAL + # Repo digests of the container image as provided by the container runtime. + # + # [Docker](https://docs.docker.com/engine/api/v1.43/#tag/Image/operation/ImageInspect) and [CRI](https://github.com/kubernetes/cri-api/blob/c75ef5b473bbe2d0a4fc92f82235efd665ea8e9f/pkg/apis/runtime/v1/api.proto#L1237-L1238) report those under the `RepoDigests` field. + # + # @note Stability Level: experimental CONTAINER_IMAGE_REPO_DIGESTS = 'container.image.repo_digests' - # Container image tags. An example can be found in [Docker Image Inspect](https://docs.docker.com/engine/api/v1.43/#tag/Image/operation/ImageInspect). Should be only the `` section of the full name for example from `registry.example.com/my-org/my-image:` - # - # @note StabilityLevel.EXPERIMENTAL + # Container image tags. An example can be found in [Docker Image Inspect](https://docs.docker.com/engine/api/v1.43/#tag/Image/operation/ImageInspect). Should be only the `` section of the full name for example from `registry.example.com/my-org/my-image:`. + # + # @note Stability Level: experimental CONTAINER_IMAGE_TAGS = 'container.image.tags' - # Container labels, `` being the label name, the value being the label value - # - # @note StabilityLevel.EXPERIMENTAL - CONTAINER_LABEL_LAMBDA = -> (key) { "container.label.#{key}" } + # Container labels, `` being the label name, the value being the label value. + # + # @note Stability Level: experimental + CONTAINER_LABEL_LAMBDA = ->(key) { "container.label.#{key}" } - # Deprecated, use `container.label` instead - # - # @note StabilityLevel.EXPERIMENTAL - # - # @deprecated Replaced by `container.label` - CONTAINER_LABELS_LAMBDA = -> (key) { "container.labels.#{key}" } + # Deprecated, use `container.label` instead. + # + # @note Stability Level: experimental + # @deprecated Replaced by `container.label`. + CONTAINER_LABELS_LAMBDA = ->(key) { "container.labels.#{key}" } - # Container name used by container runtime - # - # @note StabilityLevel.EXPERIMENTAL + # Container name used by container runtime. + # + # @note Stability Level: experimental CONTAINER_NAME = 'container.name' - # The container runtime managing this container - # - # @note StabilityLevel.EXPERIMENTAL + # The container runtime managing this container. + # + # @note Stability Level: experimental CONTAINER_RUNTIME = 'container.runtime' # @!endgroup @@ -104,6 +103,6 @@ module CONTAINER # @!group Metric Names # @!endgroup end - end # module Incubating + end end end \ No newline at end of file diff --git a/semantic_conventions/lib/opentelemetry/semconv/incubating/db.rb b/semantic_conventions/lib/opentelemetry/semconv/incubating/db.rb index 4953c4e476..6dd3dad695 100644 --- a/semantic_conventions/lib/opentelemetry/semconv/incubating/db.rb +++ b/semantic_conventions/lib/opentelemetry/semconv/incubating/db.rb @@ -24,172 +24,218 @@ module Incubating module DB # @!group Attribute Names - # 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) - # - # @note StabilityLevel.EXPERIMENTAL + # 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). + # + # @note Stability Level: experimental DB_CASSANDRA_CONSISTENCY_LEVEL = 'db.cassandra.consistency_level' - # The data center of the coordinating node for a query - # - # @note StabilityLevel.EXPERIMENTAL + # The data center of the coordinating node for a query. + # + # @note Stability Level: experimental DB_CASSANDRA_COORDINATOR_DC = 'db.cassandra.coordinator.dc' - # The ID of the coordinating node for a query - # - # @note StabilityLevel.EXPERIMENTAL + # The ID of the coordinating node for a query. + # + # @note Stability Level: experimental DB_CASSANDRA_COORDINATOR_ID = 'db.cassandra.coordinator.id' - # Whether or not the query is idempotent - # - # @note StabilityLevel.EXPERIMENTAL + # Whether or not the query is idempotent. + # + # @note Stability Level: experimental DB_CASSANDRA_IDEMPOTENCE = 'db.cassandra.idempotence' - # The fetch size used for paging, i.e. how many rows will be returned at once - # - # @note StabilityLevel.EXPERIMENTAL + # The fetch size used for paging, i.e. how many rows will be returned at once. + # + # @note Stability Level: experimental DB_CASSANDRA_PAGE_SIZE = 'db.cassandra.page_size' - # The number of times a query was speculatively executed. Not set or `0` if the query was not executed speculatively - # - # @note StabilityLevel.EXPERIMENTAL + # The number of times a query was speculatively executed. Not set or `0` if the query was not executed speculatively. + # + # @note Stability Level: experimental DB_CASSANDRA_SPECULATIVE_EXECUTION_COUNT = 'db.cassandra.speculative_execution_count' - # The name of the primary Cassandra table that the operation is acting upon, including the keyspace name (if applicable) - # - # 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 - # - # @note StabilityLevel.EXPERIMENTAL + # Deprecated, use `db.collection.name` instead. + # + # @note Stability Level: experimental + # @deprecated Replaced by `db.collection.name`. DB_CASSANDRA_TABLE = 'db.cassandra.table' - # Deprecated, use `server.address`, `server.port` attributes instead - # - # @note StabilityLevel.EXPERIMENTAL - # + # The name of the connection pool; unique within the instrumented application. In case the connection pool implementation doesn't provide a name, instrumentation should use a combination of `server.address` and `server.port` attributes formatted as `server.address:server.port`. + # + # @note Stability Level: experimental + DB_CLIENT_CONNECTIONS_POOL_NAME = 'db.client.connections.pool.name' + + # The state of a connection in the pool + # + # @note Stability Level: experimental + DB_CLIENT_CONNECTIONS_STATE = 'db.client.connections.state' + + # The name of a collection (table, container) within the database. + # + # If the collection name is parsed from the query, it SHOULD match the value provided in the query and may be qualified with the schema and database name. + # It is RECOMMENDED to capture the value as provided by the application without attempting to do any case normalization. + # + # @note Stability Level: experimental + DB_COLLECTION_NAME = 'db.collection.name' + + # Deprecated, use `server.address`, `server.port` attributes instead. + # + # @note Stability Level: experimental # @deprecated "Replaced by `server.address` and `server.port`." DB_CONNECTION_STRING = 'db.connection_string' - # Unique Cosmos client instance id - # - # @note StabilityLevel.EXPERIMENTAL + # Unique Cosmos client instance id. + # + # @note Stability Level: experimental DB_COSMOSDB_CLIENT_ID = 'db.cosmosdb.client_id' - # Cosmos client connection mode - # - # @note StabilityLevel.EXPERIMENTAL + # Cosmos client connection mode. + # + # @note Stability Level: experimental DB_COSMOSDB_CONNECTION_MODE = 'db.cosmosdb.connection_mode' - # Cosmos DB container name - # - # @note StabilityLevel.EXPERIMENTAL + # Deprecated, use `db.collection.name` instead. + # + # @note Stability Level: experimental + # @deprecated Replaced by `db.collection.name`. DB_COSMOSDB_CONTAINER = 'db.cosmosdb.container' - # CosmosDB Operation Type - # - # @note StabilityLevel.EXPERIMENTAL + # CosmosDB Operation Type. + # + # @note Stability Level: experimental DB_COSMOSDB_OPERATION_TYPE = 'db.cosmosdb.operation_type' # RU consumed for that operation - # - # @note StabilityLevel.EXPERIMENTAL + # + # @note Stability Level: experimental DB_COSMOSDB_REQUEST_CHARGE = 'db.cosmosdb.request_charge' # Request payload size in bytes - # - # @note StabilityLevel.EXPERIMENTAL + # + # @note Stability Level: experimental DB_COSMOSDB_REQUEST_CONTENT_LENGTH = 'db.cosmosdb.request_content_length' - # Cosmos DB status code - # - # @note StabilityLevel.EXPERIMENTAL + # Cosmos DB status code. + # + # @note Stability Level: experimental DB_COSMOSDB_STATUS_CODE = 'db.cosmosdb.status_code' - # Cosmos DB sub status code - # - # @note StabilityLevel.EXPERIMENTAL + # Cosmos DB sub status code. + # + # @note Stability Level: experimental DB_COSMOSDB_SUB_STATUS_CODE = 'db.cosmosdb.sub_status_code' - # Represents the identifier of an Elasticsearch cluster - # - # @note StabilityLevel.EXPERIMENTAL + # Represents the identifier of an Elasticsearch cluster. + # + # @note Stability Level: experimental DB_ELASTICSEARCH_CLUSTER_NAME = 'db.elasticsearch.cluster.name' - # Deprecated, use `db.instance.id` instead - # - # @note StabilityLevel.EXPERIMENTAL - # - # @deprecated Replaced by `db.instance.id` + # Represents the human-readable identifier of the node/instance to which a request was routed. + # + # @note Stability Level: experimental DB_ELASTICSEARCH_NODE_NAME = 'db.elasticsearch.node.name' - # A dynamic value in the url path - # - # Many Elasticsearch url paths allow dynamic values. These SHOULD be recorded in span attributes in the format `db.elasticsearch.path_parts.`, where `` is the url path part name. The implementation SHOULD reference the [elasticsearch schema](https://raw.githubusercontent.com/elastic/elasticsearch-specification/main/output/schema/schema.json) in order to map the path part values to their names - # - # @note StabilityLevel.EXPERIMENTAL - DB_ELASTICSEARCH_PATH_PARTS_LAMBDA = -> (key) { "db.elasticsearch.path_parts.#{key}" } - - # An identifier (address, unique name, or any other identifier) of the database instance that is executing queries or mutations on the current connection. This is useful in cases where the database is running in a clustered environment and the instrumentation is able to record the node executing the query. The client may obtain this value in databases like MySQL using queries like `select @@hostname` - # - # @note StabilityLevel.EXPERIMENTAL + # A dynamic value in the url path. + # + # Many Elasticsearch url paths allow dynamic values. These SHOULD be recorded in span attributes in the format `db.elasticsearch.path_parts.`, where `` is the url path part name. The implementation SHOULD reference the [elasticsearch schema](https://raw.githubusercontent.com/elastic/elasticsearch-specification/main/output/schema/schema.json) in order to map the path part values to their names. + # + # @note Stability Level: experimental + DB_ELASTICSEARCH_PATH_PARTS_LAMBDA = ->(key) { "db.elasticsearch.path_parts.#{key}" } + + # Deprecated, no general replacement at this time. For Elasticsearch, use `db.elasticsearch.node.name` instead. + # + # @note Stability Level: experimental + # @deprecated Deprecated, no general replacement at this time. For Elasticsearch, use `db.elasticsearch.node.name` instead. DB_INSTANCE_ID = 'db.instance.id' - # Removed, no replacement at this time - # - # @note StabilityLevel.EXPERIMENTAL - # - # @deprecated Removed as not used + # Removed, no replacement at this time. + # + # @note Stability Level: experimental + # @deprecated Removed as not used. DB_JDBC_DRIVER_CLASSNAME = 'db.jdbc.driver_classname' - # The MongoDB collection being accessed within the database stated in `db.name` - # - # @note StabilityLevel.EXPERIMENTAL + # Deprecated, use `db.collection.name` instead. + # + # @note Stability Level: experimental + # @deprecated Replaced by `db.collection.name`. DB_MONGODB_COLLECTION = 'db.mongodb.collection' - # The Microsoft SQL Server [instance name](https://docs.microsoft.com/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 - # - # If setting a `db.mssql.instance_name`, `server.port` is no longer required (but still recommended if non-standard) - # - # @note StabilityLevel.EXPERIMENTAL + # Deprecated, SQL Server instance is now populated as a part of `db.namespace` attribute. + # + # @note Stability Level: experimental + # @deprecated Deprecated, no replacement at this time. DB_MSSQL_INSTANCE_NAME = 'db.mssql.instance_name' - # 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) - # - # In some SQL databases, the database name to be used is called "schema name". In case there are multiple layers that could be considered for database name (e.g. Oracle instance name and schema name), the database name to be used is the more specific layer (e.g. Oracle schema name) - # - # @note StabilityLevel.EXPERIMENTAL + # Deprecated, use `db.namespace` instead. + # + # @note Stability Level: experimental + # @deprecated Replaced by `db.namespace`. DB_NAME = 'db.name' - # 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 - # - # 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 - # - # @note StabilityLevel.EXPERIMENTAL + # The name of the database, fully qualified within the server address and port. + # + # If a database system has multiple namespace components, they SHOULD be concatenated (potentially using database system specific conventions) from most general to most specific namespace component, and more specific namespaces SHOULD NOT be captured without the more general namespaces, to ensure that "startswith" queries for the more general namespaces will be valid. + # Semantic conventions for individual database systems SHOULD document what `db.namespace` means in the context of that system. + # It is RECOMMENDED to capture the value as provided by the application without attempting to do any case normalization. + # + # @note Stability Level: experimental + DB_NAMESPACE = 'db.namespace' + + # Deprecated, use `db.operation.name` instead. + # + # @note Stability Level: experimental + # @deprecated Replaced by `db.operation.name`. DB_OPERATION = 'db.operation' - # 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 - # - # @note StabilityLevel.EXPERIMENTAL + # The name of the operation or command being executed. + # + # It is RECOMMENDED to capture the value as provided by the application without attempting to do any case normalization. + # + # @note Stability Level: experimental + DB_OPERATION_NAME = 'db.operation.name' + + # The query parameters used in `db.query.text`, with `` being the parameter name, and the attribute value being the parameter value. + # + # Query parameters should only be captured when `db.query.text` is parameterized with placeholders. + # If a parameter has no name and instead is referenced only by index, then `` SHOULD be the 0-based index. + # + # @note Stability Level: experimental + DB_QUERY_PARAMETER_LAMBDA = ->(key) { "db.query.parameter.#{key}" } + + # The database query being executed. + # + # @note Stability Level: experimental + DB_QUERY_TEXT = 'db.query.text' + + # Deprecated, use `db.namespace` instead. + # + # @note Stability Level: experimental + # @deprecated Replaced by `db.namespace`. DB_REDIS_DATABASE_INDEX = 'db.redis.database_index' - # The name of the primary table that the operation is acting upon, including the database name (if applicable) - # - # 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 - # - # @note StabilityLevel.EXPERIMENTAL + # Deprecated, use `db.collection.name` instead. + # + # @note Stability Level: experimental + # @deprecated Replaced by `db.collection.name`. DB_SQL_TABLE = 'db.sql.table' - # The database statement being executed - # - # @note StabilityLevel.EXPERIMENTAL + # The database statement being executed. + # + # @note Stability Level: experimental + # @deprecated Replaced by `db.query.text`. DB_STATEMENT = 'db.statement' - # An identifier for the database management system (DBMS) product being used. See below for a list of well-known identifiers - # - # @note StabilityLevel.EXPERIMENTAL + # The database management system (DBMS) product as identified by the client instrumentation. + # + # The actual DBMS may differ from the one identified by the client. For example, when using PostgreSQL client libraries to connect to a CockroachDB, the `db.system` is set to `postgresql` based on the instrumentation's best knowledge. + # + # @note Stability Level: experimental DB_SYSTEM = 'db.system' - # Username for accessing the database - # - # @note StabilityLevel.EXPERIMENTAL + # Deprecated, no replacement at this time. + # + # @note Stability Level: experimental + # @deprecated No replacement at this time. DB_USER = 'db.user' # @!endgroup @@ -197,6 +243,6 @@ module DB # @!group Metric Names # @!endgroup end - end # module Incubating + end end end \ No newline at end of file diff --git a/semantic_conventions/lib/opentelemetry/semconv/incubating/deployment.rb b/semantic_conventions/lib/opentelemetry/semconv/incubating/deployment.rb index 0390fce977..b2a30b42ce 100644 --- a/semantic_conventions/lib/opentelemetry/semconv/incubating/deployment.rb +++ b/semantic_conventions/lib/opentelemetry/semconv/incubating/deployment.rb @@ -24,17 +24,17 @@ module Incubating module DEPLOYMENT # @!group Attribute Names - # Name of the [deployment environment](https://wikipedia.org/wiki/Deployment_environment) (aka deployment tier) - # + # Name of the [deployment environment](https://wikipedia.org/wiki/Deployment_environment) (aka deployment tier). + # # `deployment.environment` does not affect the uniqueness constraints defined through - # the `service.namespace`, `service.name` and `service.instance.id` resource attributes. - # This implies that resources carrying the following attribute combinations MUST be - # considered to be identifying the same service: - # - # * `service.name=frontend`, `deployment.environment=production` - # * `service.name=frontend`, `deployment.environment=staging` - # - # @note StabilityLevel.EXPERIMENTAL + # the `service.namespace`, `service.name` and `service.instance.id` resource attributes. + # This implies that resources carrying the following attribute combinations MUST be + # considered to be identifying the same service: + # + # - `service.name=frontend`, `deployment.environment=production` + # - `service.name=frontend`, `deployment.environment=staging`. + # + # @note Stability Level: experimental DEPLOYMENT_ENVIRONMENT = 'deployment.environment' # @!endgroup @@ -42,6 +42,6 @@ module DEPLOYMENT # @!group Metric Names # @!endgroup end - end # module Incubating + end end end \ No newline at end of file diff --git a/semantic_conventions/lib/opentelemetry/semconv/incubating/destination.rb b/semantic_conventions/lib/opentelemetry/semconv/incubating/destination.rb index 151861b4dc..1123a0a14c 100644 --- a/semantic_conventions/lib/opentelemetry/semconv/incubating/destination.rb +++ b/semantic_conventions/lib/opentelemetry/semconv/incubating/destination.rb @@ -24,16 +24,16 @@ module Incubating module DESTINATION # @!group Attribute Names - # Destination address - domain name if available without reverse DNS lookup; otherwise, IP address or Unix domain socket name - # - # When observed from the source side, and when communicating through an intermediary, `destination.address` SHOULD represent the destination address behind any intermediaries, for example proxies, if it's available - # - # @note StabilityLevel.EXPERIMENTAL + # Destination address - domain name if available without reverse DNS lookup; otherwise, IP address or Unix domain socket name. + # + # When observed from the source side, and when communicating through an intermediary, `destination.address` SHOULD represent the destination address behind any intermediaries, for example proxies, if it's available. + # + # @note Stability Level: experimental DESTINATION_ADDRESS = 'destination.address' # Destination port number - # - # @note StabilityLevel.EXPERIMENTAL + # + # @note Stability Level: experimental DESTINATION_PORT = 'destination.port' # @!endgroup @@ -41,6 +41,6 @@ module DESTINATION # @!group Metric Names # @!endgroup end - end # module Incubating + end end end \ No newline at end of file diff --git a/semantic_conventions/lib/opentelemetry/semconv/incubating/device.rb b/semantic_conventions/lib/opentelemetry/semconv/incubating/device.rb index 1d486ed63d..bf5519eee9 100644 --- a/semantic_conventions/lib/opentelemetry/semconv/incubating/device.rb +++ b/semantic_conventions/lib/opentelemetry/semconv/incubating/device.rb @@ -25,31 +25,31 @@ module DEVICE # @!group Attribute Names # A unique identifier representing the device - # - # 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 - # - # @note StabilityLevel.EXPERIMENTAL + # + # 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. + # + # @note Stability Level: experimental DEVICE_ID = 'device.id' # The name of the device manufacturer - # - # The Android OS provides this field via [Build](https://developer.android.com/reference/android/os/Build#MANUFACTURER). iOS apps SHOULD hardcode the value `Apple` - # - # @note StabilityLevel.EXPERIMENTAL + # + # The Android OS provides this field via [Build](https://developer.android.com/reference/android/os/Build#MANUFACTURER). iOS apps SHOULD hardcode the value `Apple`. + # + # @note Stability Level: experimental DEVICE_MANUFACTURER = 'device.manufacturer' # The model identifier for the device - # - # 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 - # - # @note StabilityLevel.EXPERIMENTAL + # + # 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. + # + # @note Stability Level: experimental DEVICE_MODEL_IDENTIFIER = 'device.model.identifier' # The marketing name for the device model - # - # It's recommended this value represents a human-readable version of the device model rather than a machine-readable alternative - # - # @note StabilityLevel.EXPERIMENTAL + # + # It's recommended this value represents a human-readable version of the device model rather than a machine-readable alternative. + # + # @note Stability Level: experimental DEVICE_MODEL_NAME = 'device.model.name' # @!endgroup @@ -57,6 +57,6 @@ module DEVICE # @!group Metric Names # @!endgroup end - end # module Incubating + end end end \ No newline at end of file diff --git a/semantic_conventions/lib/opentelemetry/semconv/incubating/disk.rb b/semantic_conventions/lib/opentelemetry/semconv/incubating/disk.rb index 09c4bf85e6..670436e794 100644 --- a/semantic_conventions/lib/opentelemetry/semconv/incubating/disk.rb +++ b/semantic_conventions/lib/opentelemetry/semconv/incubating/disk.rb @@ -24,9 +24,9 @@ module Incubating module DISK # @!group Attribute Names - # The disk IO operation direction - # - # @note StabilityLevel.EXPERIMENTAL + # The disk IO operation direction. + # + # @note Stability Level: experimental DISK_IO_DIRECTION = 'disk.io.direction' # @!endgroup @@ -34,6 +34,6 @@ module DISK # @!group Metric Names # @!endgroup end - end # module Incubating + end end end \ No newline at end of file diff --git a/semantic_conventions/lib/opentelemetry/semconv/incubating/dns.rb b/semantic_conventions/lib/opentelemetry/semconv/incubating/dns.rb index ba85696b10..937bf2e52e 100644 --- a/semantic_conventions/lib/opentelemetry/semconv/incubating/dns.rb +++ b/semantic_conventions/lib/opentelemetry/semconv/incubating/dns.rb @@ -24,11 +24,11 @@ module Incubating module DNS # @!group Attribute Names - # The name being queried - # - # If the name field contains non-printable characters (below 32 or above 126), those characters should be represented as escaped base 10 integers (\DDD). Back slashes and quotes should be escaped. Tabs, carriage returns, and line feeds should be converted to \t, \r, and \n respectively - # - # @note StabilityLevel.EXPERIMENTAL + # The name being queried. + # + # If the name field contains non-printable characters (below 32 or above 126), those characters should be represented as escaped base 10 integers (\DDD). Back slashes and quotes should be escaped. Tabs, carriage returns, and line feeds should be converted to \t, \r, and \n respectively. + # + # @note Stability Level: experimental DNS_QUESTION_NAME = 'dns.question.name' # @!endgroup @@ -36,6 +36,6 @@ module DNS # @!group Metric Names # @!endgroup end - end # module Incubating + end end end \ No newline at end of file diff --git a/semantic_conventions/lib/opentelemetry/semconv/incubating/enduser.rb b/semantic_conventions/lib/opentelemetry/semconv/incubating/enduser.rb index f82da215c8..b961e5168b 100644 --- a/semantic_conventions/lib/opentelemetry/semconv/incubating/enduser.rb +++ b/semantic_conventions/lib/opentelemetry/semconv/incubating/enduser.rb @@ -24,19 +24,19 @@ module Incubating module ENDUSER # @!group Attribute Names - # 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 - # - # @note StabilityLevel.EXPERIMENTAL + # 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. + # + # @note Stability Level: experimental ENDUSER_ID = 'enduser.id' - # Actual/assumed role the client is making the request under extracted from token or application security context - # - # @note StabilityLevel.EXPERIMENTAL + # Actual/assumed role the client is making the request under extracted from token or application security context. + # + # @note Stability Level: experimental ENDUSER_ROLE = 'enduser.role' - # 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) - # - # @note StabilityLevel.EXPERIMENTAL + # 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). + # + # @note Stability Level: experimental ENDUSER_SCOPE = 'enduser.scope' # @!endgroup @@ -44,6 +44,6 @@ module ENDUSER # @!group Metric Names # @!endgroup end - end # module Incubating + end end end \ No newline at end of file diff --git a/semantic_conventions/lib/opentelemetry/semconv/incubating/error.rb b/semantic_conventions/lib/opentelemetry/semconv/incubating/error.rb index 9ea0e28e01..1a086a262b 100644 --- a/semantic_conventions/lib/opentelemetry/semconv/incubating/error.rb +++ b/semantic_conventions/lib/opentelemetry/semconv/incubating/error.rb @@ -24,27 +24,31 @@ module Incubating module ERROR # @!group Attribute Names - # Describes a class of error the operation ended with + # Describes a class of error the operation ended with. + # + # The `error.type` SHOULD be predictable, and SHOULD have low cardinality. + # + # When `error.type` is set to a type (e.g., an exception type), its + # canonical class name identifying the type within the artifact SHOULD be used. + # + # Instrumentations SHOULD document the list of errors they report. + # + # The cardinality of `error.type` within one instrumentation library SHOULD be low. + # Telemetry consumers that aggregate data from multiple instrumentation libraries and applications + # should be prepared for `error.type` to have high cardinality at query time when no + # additional filters are applied. + # + # If the operation has completed successfully, instrumentations SHOULD NOT set `error.type`. + # + # If a specific domain defines its own set of error identifiers (such as HTTP or gRPC status codes), + # it's RECOMMENDED to: + # + # - Use a domain-specific attribute + # - Set `error.type` to capture all errors, regardless of whether they are defined within the domain-specific set or not. + # + # @note Stability Level: stable # - # The `error.type` SHOULD be predictable and SHOULD have low cardinality. - # Instrumentations SHOULD document the list of errors they report. - # - # The cardinality of `error.type` within one instrumentation library SHOULD be low. - # Telemetry consumers that aggregate data from multiple instrumentation libraries and applications - # should be prepared for `error.type` to have high cardinality at query time when no - # additional filters are applied. - # - # If the operation has completed successfully, instrumentations SHOULD NOT set `error.type`. - # - # If a specific domain defines its own set of error identifiers (such as HTTP or gRPC status codes), - # it's RECOMMENDED to: - # - # * Use a domain-specific attribute - # * Set `error.type` to capture all errors, regardless of whether they are defined within the domain-specific set or not - # - # @note StabilityLevel.STABLE - # - # @deprecated Now available in the stable namespace at {OpenTelemetry::SemConv::ERROR::ERROR_TYPE}. + # @deprecated Now available in the stable namespace at {OpenTelemetry::SemConv::Error::ERROR_TYPE}. ERROR_TYPE = 'error.type' # @!endgroup @@ -52,6 +56,6 @@ module ERROR # @!group Metric Names # @!endgroup end - end # module Incubating + end end end \ No newline at end of file diff --git a/semantic_conventions/lib/opentelemetry/semconv/incubating/event.rb b/semantic_conventions/lib/opentelemetry/semconv/incubating/event.rb index 9610d20c23..8d0a2bd0be 100644 --- a/semantic_conventions/lib/opentelemetry/semconv/incubating/event.rb +++ b/semantic_conventions/lib/opentelemetry/semconv/incubating/event.rb @@ -24,11 +24,11 @@ module Incubating module EVENT # @!group Attribute Names - # Identifies the class / type of event - # - # Event names are subject to the same rules as [attribute names](https://github.com/open-telemetry/opentelemetry-specification/tree/v1.31.0/specification/common/attribute-naming.md). Notably, event names are namespaced to avoid collisions and provide a clean separation of semantics for events in separate domains like browser, mobile, and kubernetes - # - # @note StabilityLevel.EXPERIMENTAL + # Identifies the class / type of event. + # + # Event names are subject to the same rules as [attribute names](https://github.com/open-telemetry/opentelemetry-specification/tree/v1.33.0/specification/common/attribute-naming.md). Notably, event names are namespaced to avoid collisions and provide a clean separation of semantics for events in separate domains like browser, mobile, and kubernetes. + # + # @note Stability Level: experimental EVENT_NAME = 'event.name' # @!endgroup @@ -36,6 +36,6 @@ module EVENT # @!group Metric Names # @!endgroup end - end # module Incubating + end end end \ No newline at end of file diff --git a/semantic_conventions/lib/opentelemetry/semconv/incubating/exception.rb b/semantic_conventions/lib/opentelemetry/semconv/incubating/exception.rb index e289c834a5..ee962f88b0 100644 --- a/semantic_conventions/lib/opentelemetry/semconv/incubating/exception.rb +++ b/semantic_conventions/lib/opentelemetry/semconv/incubating/exception.rb @@ -24,49 +24,49 @@ module Incubating module EXCEPTION # @!group Attribute Names - # 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 - # + # 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. + # # An exception is considered to have escaped (or left) the scope of a span, - # if that span is ended while the exception is still logically "in flight". - # This may be actually "in flight" in some languages (e.g. if the exception - # is passed to a Context manager's `__exit__` method in Python) but will - # usually be caught at the point of recording the exception in most languages. - # - # It is usually not possible to determine at the point where an exception is thrown - # whether it will escape the scope of a span. - # However, it is trivial to know that an exception - # will escape, if one checks for an active exception just before ending the span, - # as done in the [example for recording span exceptions](#recording-an-exception). - # - # It follows that an exception may still escape the scope of the span - # even if the `exception.escaped` attribute was not set or set to false, - # since the event might have been recorded at a time where it was not - # clear whether the exception will escape - # - # @note StabilityLevel.STABLE + # if that span is ended while the exception is still logically "in flight". + # This may be actually "in flight" in some languages (e.g. if the exception + # is passed to a Context manager's `__exit__` method in Python) but will + # usually be caught at the point of recording the exception in most languages. + # + # It is usually not possible to determine at the point where an exception is thrown + # whether it will escape the scope of a span. + # However, it is trivial to know that an exception + # will escape, if one checks for an active exception just before ending the span, + # as done in the [example for recording span exceptions](https://opentelemetry.io/docs/specs/semconv/exceptions/exceptions-spans/#recording-an-exception). + # + # It follows that an exception may still escape the scope of the span + # even if the `exception.escaped` attribute was not set or set to false, + # since the event might have been recorded at a time where it was not + # clear whether the exception will escape. + # + # @note Stability Level: stable # - # @deprecated Now available in the stable namespace at {OpenTelemetry::SemConv::EXCEPTION::EXCEPTION_ESCAPED}. + # @deprecated Now available in the stable namespace at {OpenTelemetry::SemConv::Exception::EXCEPTION_ESCAPED}. EXCEPTION_ESCAPED = 'exception.escaped' - # The exception message - # - # @note StabilityLevel.STABLE + # The exception message. + # + # @note Stability Level: stable # - # @deprecated Now available in the stable namespace at {OpenTelemetry::SemConv::EXCEPTION::EXCEPTION_MESSAGE}. + # @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 + # 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 # - # @note StabilityLevel.STABLE - # - # @deprecated Now available in the stable namespace at {OpenTelemetry::SemConv::EXCEPTION::EXCEPTION_STACKTRACE}. + # @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 StabilityLevel.STABLE + # 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 # - # @deprecated Now available in the stable namespace at {OpenTelemetry::SemConv::EXCEPTION::EXCEPTION_TYPE}. + # @deprecated Now available in the stable namespace at {OpenTelemetry::SemConv::Exception::EXCEPTION_TYPE}. EXCEPTION_TYPE = 'exception.type' # @!endgroup @@ -74,6 +74,6 @@ module EXCEPTION # @!group Metric Names # @!endgroup end - end # module Incubating + end end end \ No newline at end of file diff --git a/semantic_conventions/lib/opentelemetry/semconv/incubating/faas.rb b/semantic_conventions/lib/opentelemetry/semconv/incubating/faas.rb index 4dd6f11789..ac25103c55 100644 --- a/semantic_conventions/lib/opentelemetry/semconv/incubating/faas.rb +++ b/semantic_conventions/lib/opentelemetry/semconv/incubating/faas.rb @@ -24,121 +24,121 @@ 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 StabilityLevel.EXPERIMENTAL + # A boolean that is true if the serverless function is executed for the first time (aka cold-start). + # + # @note Stability Level: experimental 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 StabilityLevel.EXPERIMENTAL + # 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: experimental 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 StabilityLevel.EXPERIMENTAL + # 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: experimental 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 StabilityLevel.EXPERIMENTAL + # 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: experimental FAAS_DOCUMENT_NAME = 'faas.document.name' - # Describes the type of the operation that was performed on the data - # - # @note StabilityLevel.EXPERIMENTAL + # Describes the type of the operation that was performed on the data. + # + # @note Stability Level: experimental 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 StabilityLevel.EXPERIMENTAL + # 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: experimental 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 StabilityLevel.EXPERIMENTAL + # 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: experimental FAAS_INSTANCE = 'faas.instance' - # The invocation ID of the current function invocation - # - # @note StabilityLevel.EXPERIMENTAL + # The invocation ID of the current function invocation. + # + # @note Stability Level: experimental 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 StabilityLevel.EXPERIMENTAL + # The name of the invoked function. + # + # SHOULD be equal to the `faas.name` resource attribute of the invoked function. + # + # @note Stability Level: experimental 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 StabilityLevel.EXPERIMENTAL + # The cloud provider of the invoked function. + # + # SHOULD be equal to the `cloud.provider` resource attribute of the invoked function. + # + # @note Stability Level: experimental 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 StabilityLevel.EXPERIMENTAL + # The cloud region of the invoked function. + # + # SHOULD be equal to the `cloud.region` resource attribute of the invoked function. + # + # @note Stability Level: experimental 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 StabilityLevel.EXPERIMENTAL + # 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: experimental FAAS_MAX_MEMORY = 'faas.max_memory' - # The name of the single function that this runtime instance executes - # + # 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`](/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 `/`, 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 StabilityLevel.EXPERIMENTAL + # platform and is usually different from the name of the callback + # function (which may be stored in the + # [`code.namespace`/`code.function`](/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 `/`, 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: experimental 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 StabilityLevel.EXPERIMENTAL + # 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: experimental FAAS_TIME = 'faas.time' - # Type of the trigger which caused this function invocation - # - # @note StabilityLevel.EXPERIMENTAL + # Type of the trigger which caused this function invocation. + # + # @note Stability Level: experimental FAAS_TRIGGER = 'faas.trigger' - # The immutable version of the function being executed - # + # 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 StabilityLevel.EXPERIMENTAL + # + # - **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: experimental FAAS_VERSION = 'faas.version' # @!endgroup @@ -146,6 +146,6 @@ module FAAS # @!group Metric Names # @!endgroup end - end # module Incubating + end end end \ No newline at end of file diff --git a/semantic_conventions/lib/opentelemetry/semconv/incubating/feature_flag.rb b/semantic_conventions/lib/opentelemetry/semconv/incubating/feature_flag.rb index d2db2c0fe6..fd3cbd2fa0 100644 --- a/semantic_conventions/lib/opentelemetry/semconv/incubating/feature_flag.rb +++ b/semantic_conventions/lib/opentelemetry/semconv/incubating/feature_flag.rb @@ -24,28 +24,28 @@ module Incubating module FEATURE_FLAG # @!group Attribute Names - # The unique identifier of the feature flag - # - # @note StabilityLevel.EXPERIMENTAL + # The unique identifier of the feature flag. + # + # @note Stability Level: experimental FEATURE_FLAG_KEY = 'feature_flag.key' - # The name of the service provider that performs the flag evaluation - # - # @note StabilityLevel.EXPERIMENTAL + # The name of the service provider that performs the flag evaluation. + # + # @note Stability Level: experimental FEATURE_FLAG_PROVIDER_NAME = 'feature_flag.provider_name' - # SHOULD be a semantic identifier for a value. If one is unavailable, a stringified version of the value can be used - # + # SHOULD be a semantic identifier for a value. If one is unavailable, a stringified version of the value can be used. + # # 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`. - # - # A stringified version of the value can be used in situations where a - # semantic identifier is unavailable. String representation of the value - # should be determined by the implementer - # - # @note StabilityLevel.EXPERIMENTAL + # 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`. + # + # A stringified version of the value can be used in situations where a + # semantic identifier is unavailable. String representation of the value + # should be determined by the implementer. + # + # @note Stability Level: experimental FEATURE_FLAG_VARIANT = 'feature_flag.variant' # @!endgroup @@ -53,6 +53,6 @@ module FEATURE_FLAG # @!group Metric Names # @!endgroup end - end # module Incubating + end end end \ No newline at end of file diff --git a/semantic_conventions/lib/opentelemetry/semconv/incubating/file.rb b/semantic_conventions/lib/opentelemetry/semconv/incubating/file.rb index 369b9e8e5a..cbaf84b84c 100644 --- a/semantic_conventions/lib/opentelemetry/semconv/incubating/file.rb +++ b/semantic_conventions/lib/opentelemetry/semconv/incubating/file.rb @@ -24,31 +24,31 @@ module Incubating module FILE # @!group Attribute Names - # Directory where the file is located. It should include the drive letter, when appropriate - # - # @note StabilityLevel.EXPERIMENTAL + # Directory where the file is located. It should include the drive letter, when appropriate. + # + # @note Stability Level: experimental FILE_DIRECTORY = 'file.directory' - # File extension, excluding the leading dot - # - # When the file name has multiple extensions (example.tar.gz), only the last one should be captured ("gz", not "tar.gz") - # - # @note StabilityLevel.EXPERIMENTAL + # File extension, excluding the leading dot. + # + # When the file name has multiple extensions (example.tar.gz), only the last one should be captured ("gz", not "tar.gz"). + # + # @note Stability Level: experimental FILE_EXTENSION = 'file.extension' - # Name of the file including the extension, without the directory - # - # @note StabilityLevel.EXPERIMENTAL + # Name of the file including the extension, without the directory. + # + # @note Stability Level: experimental FILE_NAME = 'file.name' - # Full path to the file, including the file name. It should include the drive letter, when appropriate - # - # @note StabilityLevel.EXPERIMENTAL + # Full path to the file, including the file name. It should include the drive letter, when appropriate. + # + # @note Stability Level: experimental FILE_PATH = 'file.path' - # File size in bytes - # - # @note StabilityLevel.EXPERIMENTAL + # File size in bytes. + # + # @note Stability Level: experimental FILE_SIZE = 'file.size' # @!endgroup @@ -56,6 +56,6 @@ module FILE # @!group Metric Names # @!endgroup end - end # module Incubating + end end end \ No newline at end of file diff --git a/semantic_conventions/lib/opentelemetry/semconv/incubating/gcp.rb b/semantic_conventions/lib/opentelemetry/semconv/incubating/gcp.rb index 58f1f18c7a..fffb38033f 100644 --- a/semantic_conventions/lib/opentelemetry/semconv/incubating/gcp.rb +++ b/semantic_conventions/lib/opentelemetry/semconv/incubating/gcp.rb @@ -24,24 +24,24 @@ module Incubating module GCP # @!group Attribute Names - # The name of the Cloud Run [execution](https://cloud.google.com/run/docs/managing/job-executions) being run for the Job, as set by the [`CLOUD_RUN_EXECUTION`](https://cloud.google.com/run/docs/container-contract#jobs-env-vars) environment variable - # - # @note StabilityLevel.EXPERIMENTAL + # The name of the Cloud Run [execution](https://cloud.google.com/run/docs/managing/job-executions) being run for the Job, as set by the [`CLOUD_RUN_EXECUTION`](https://cloud.google.com/run/docs/container-contract#jobs-env-vars) environment variable. + # + # @note Stability Level: experimental GCP_CLOUD_RUN_JOB_EXECUTION = 'gcp.cloud_run.job.execution' - # The index for a task within an execution as provided by the [`CLOUD_RUN_TASK_INDEX`](https://cloud.google.com/run/docs/container-contract#jobs-env-vars) environment variable - # - # @note StabilityLevel.EXPERIMENTAL + # The index for a task within an execution as provided by the [`CLOUD_RUN_TASK_INDEX`](https://cloud.google.com/run/docs/container-contract#jobs-env-vars) environment variable. + # + # @note Stability Level: experimental GCP_CLOUD_RUN_JOB_TASK_INDEX = 'gcp.cloud_run.job.task_index' - # The hostname of a GCE instance. This is the full value of the default or [custom hostname](https://cloud.google.com/compute/docs/instances/custom-hostname-vm) - # - # @note StabilityLevel.EXPERIMENTAL + # The hostname of a GCE instance. This is the full value of the default or [custom hostname](https://cloud.google.com/compute/docs/instances/custom-hostname-vm). + # + # @note Stability Level: experimental GCP_GCE_INSTANCE_HOSTNAME = 'gcp.gce.instance.hostname' - # The instance name of a GCE instance. This is the value provided by `host.name`, the visible name of the instance in the Cloud Console UI, and the prefix for the default hostname of the instance as defined by the [default internal DNS name](https://cloud.google.com/compute/docs/internal-dns#instance-fully-qualified-domain-names) - # - # @note StabilityLevel.EXPERIMENTAL + # The instance name of a GCE instance. This is the value provided by `host.name`, the visible name of the instance in the Cloud Console UI, and the prefix for the default hostname of the instance as defined by the [default internal DNS name](https://cloud.google.com/compute/docs/internal-dns#instance-fully-qualified-domain-names). + # + # @note Stability Level: experimental GCP_GCE_INSTANCE_NAME = 'gcp.gce.instance.name' # @!endgroup @@ -49,6 +49,6 @@ module GCP # @!group Metric Names # @!endgroup end - end # module Incubating + end end end \ No newline at end of file diff --git a/semantic_conventions/lib/opentelemetry/semconv/incubating/gen_ai.rb b/semantic_conventions/lib/opentelemetry/semconv/incubating/gen_ai.rb new file mode 100644 index 0000000000..c700616391 --- /dev/null +++ b/semantic_conventions/lib/opentelemetry/semconv/incubating/gen_ai.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 GEN_AI + # @!group Attribute Names + + # The full response received from the LLM. + # + # It's RECOMMENDED to format completions as JSON string matching [OpenAI messages format](https://platform.openai.com/docs/guides/text-generation) + # + # @note Stability Level: experimental + GEN_AI_COMPLETION = 'gen_ai.completion' + + # The full prompt sent to an LLM. + # + # It's RECOMMENDED to format prompts as JSON string matching [OpenAI messages format](https://platform.openai.com/docs/guides/text-generation) + # + # @note Stability Level: experimental + GEN_AI_PROMPT = 'gen_ai.prompt' + + # The maximum number of tokens the LLM generates for a request. + # + # @note Stability Level: experimental + GEN_AI_REQUEST_MAX_TOKENS = 'gen_ai.request.max_tokens' + + # The name of the LLM a request is being made to. + # + # @note Stability Level: experimental + GEN_AI_REQUEST_MODEL = 'gen_ai.request.model' + + # The temperature setting for the LLM request. + # + # @note Stability Level: experimental + GEN_AI_REQUEST_TEMPERATURE = 'gen_ai.request.temperature' + + # The top_p sampling setting for the LLM request. + # + # @note Stability Level: experimental + GEN_AI_REQUEST_TOP_P = 'gen_ai.request.top_p' + + # Array of reasons the model stopped generating tokens, corresponding to each generation received. + # + # @note Stability Level: experimental + GEN_AI_RESPONSE_FINISH_REASONS = 'gen_ai.response.finish_reasons' + + # The unique identifier for the completion. + # + # @note Stability Level: experimental + GEN_AI_RESPONSE_ID = 'gen_ai.response.id' + + # The name of the LLM a response was generated from. + # + # @note Stability Level: experimental + GEN_AI_RESPONSE_MODEL = 'gen_ai.response.model' + + # The Generative AI product as identified by the client instrumentation. + # + # The actual GenAI product may differ from the one identified by the client. For example, when using OpenAI client libraries to communicate with Mistral, the `gen_ai.system` is set to `openai` based on the instrumentation's best knowledge. + # + # @note Stability Level: experimental + GEN_AI_SYSTEM = 'gen_ai.system' + + # The number of tokens used in the LLM response (completion). + # + # @note Stability Level: experimental + GEN_AI_USAGE_COMPLETION_TOKENS = 'gen_ai.usage.completion_tokens' + + # The number of tokens used in the LLM prompt. + # + # @note Stability Level: experimental + GEN_AI_USAGE_PROMPT_TOKENS = 'gen_ai.usage.prompt_tokens' + + # @!endgroup + + # @!group Metric Names + # @!endgroup + end + end + end +end \ No newline at end of file diff --git a/semantic_conventions/lib/opentelemetry/semconv/incubating/graphql.rb b/semantic_conventions/lib/opentelemetry/semconv/incubating/graphql.rb index 3f391e2a21..c7c9fbb0ee 100644 --- a/semantic_conventions/lib/opentelemetry/semconv/incubating/graphql.rb +++ b/semantic_conventions/lib/opentelemetry/semconv/incubating/graphql.rb @@ -24,21 +24,21 @@ module Incubating module GRAPHQL # @!group Attribute Names - # The GraphQL document being executed - # - # The value may be sanitized to exclude sensitive information - # - # @note StabilityLevel.EXPERIMENTAL + # The GraphQL document being executed. + # + # The value may be sanitized to exclude sensitive information. + # + # @note Stability Level: experimental GRAPHQL_DOCUMENT = 'graphql.document' - # The name of the operation being executed - # - # @note StabilityLevel.EXPERIMENTAL + # The name of the operation being executed. + # + # @note Stability Level: experimental GRAPHQL_OPERATION_NAME = 'graphql.operation.name' - # The type of the operation being executed - # - # @note StabilityLevel.EXPERIMENTAL + # The type of the operation being executed. + # + # @note Stability Level: experimental GRAPHQL_OPERATION_TYPE = 'graphql.operation.type' # @!endgroup @@ -46,6 +46,6 @@ module GRAPHQL # @!group Metric Names # @!endgroup end - end # module Incubating + end end end \ No newline at end of file diff --git a/semantic_conventions/lib/opentelemetry/semconv/incubating/heroku.rb b/semantic_conventions/lib/opentelemetry/semconv/incubating/heroku.rb index 5cce49da4a..84ad504a0e 100644 --- a/semantic_conventions/lib/opentelemetry/semconv/incubating/heroku.rb +++ b/semantic_conventions/lib/opentelemetry/semconv/incubating/heroku.rb @@ -25,18 +25,18 @@ module HEROKU # @!group Attribute Names # Unique identifier for the application - # - # @note StabilityLevel.EXPERIMENTAL + # + # @note Stability Level: experimental HEROKU_APP_ID = 'heroku.app.id' # Commit hash for the current release - # - # @note StabilityLevel.EXPERIMENTAL + # + # @note Stability Level: experimental HEROKU_RELEASE_COMMIT = 'heroku.release.commit' # Time and date the release was created - # - # @note StabilityLevel.EXPERIMENTAL + # + # @note Stability Level: experimental HEROKU_RELEASE_CREATION_TIMESTAMP = 'heroku.release.creation_timestamp' # @!endgroup @@ -44,6 +44,6 @@ module HEROKU # @!group Metric Names # @!endgroup end - end # module Incubating + end end end \ No newline at end of file diff --git a/semantic_conventions/lib/opentelemetry/semconv/incubating/host.rb b/semantic_conventions/lib/opentelemetry/semconv/incubating/host.rb index 28cca6c82a..0ac67ccd74 100644 --- a/semantic_conventions/lib/opentelemetry/semconv/incubating/host.rb +++ b/semantic_conventions/lib/opentelemetry/semconv/incubating/host.rb @@ -24,85 +24,85 @@ module Incubating module HOST # @!group Attribute Names - # The CPU architecture the host system is running on - # - # @note StabilityLevel.EXPERIMENTAL + # The CPU architecture the host system is running on. + # + # @note Stability Level: experimental HOST_ARCH = 'host.arch' - # The amount of level 2 memory cache available to the processor (in Bytes) - # - # @note StabilityLevel.EXPERIMENTAL + # The amount of level 2 memory cache available to the processor (in Bytes). + # + # @note Stability Level: experimental HOST_CPU_CACHE_L2_SIZE = 'host.cpu.cache.l2.size' - # Family or generation of the CPU - # - # @note StabilityLevel.EXPERIMENTAL + # Family or generation of the CPU. + # + # @note Stability Level: experimental HOST_CPU_FAMILY = 'host.cpu.family' - # Model identifier. It provides more granular information about the CPU, distinguishing it from other CPUs within the same family - # - # @note StabilityLevel.EXPERIMENTAL + # Model identifier. It provides more granular information about the CPU, distinguishing it from other CPUs within the same family. + # + # @note Stability Level: experimental HOST_CPU_MODEL_ID = 'host.cpu.model.id' - # Model designation of the processor - # - # @note StabilityLevel.EXPERIMENTAL + # Model designation of the processor. + # + # @note Stability Level: experimental HOST_CPU_MODEL_NAME = 'host.cpu.model.name' - # Stepping or core revisions - # - # @note StabilityLevel.EXPERIMENTAL + # Stepping or core revisions. + # + # @note Stability Level: experimental HOST_CPU_STEPPING = 'host.cpu.stepping' - # Processor manufacturer identifier. A maximum 12-character string - # - # [CPUID](https://wiki.osdev.org/CPUID) command returns the vendor ID string in EBX, EDX and ECX registers. Writing these to memory in this order results in a 12-character string - # - # @note StabilityLevel.EXPERIMENTAL + # Processor manufacturer identifier. A maximum 12-character string. + # + # [CPUID](https://wiki.osdev.org/CPUID) command returns the vendor ID string in EBX, EDX and ECX registers. Writing these to memory in this order results in a 12-character string. + # + # @note Stability Level: experimental HOST_CPU_VENDOR_ID = 'host.cpu.vendor.id' - # Unique host ID. For Cloud, this must be the instance_id assigned by the cloud provider. For non-containerized systems, this should be the `machine-id`. See the table below for the sources to use to determine the `machine-id` based on operating system - # - # @note StabilityLevel.EXPERIMENTAL + # Unique host ID. For Cloud, this must be the instance_id assigned by the cloud provider. For non-containerized systems, this should be the `machine-id`. See the table below for the sources to use to determine the `machine-id` based on operating system. + # + # @note Stability Level: experimental HOST_ID = 'host.id' - # VM image ID or host OS image ID. For Cloud, this value is from the provider - # - # @note StabilityLevel.EXPERIMENTAL + # VM image ID or host OS image ID. For Cloud, this value is from the provider. + # + # @note Stability Level: experimental HOST_IMAGE_ID = 'host.image.id' - # Name of the VM image or OS install the host was instantiated from - # - # @note StabilityLevel.EXPERIMENTAL + # Name of the VM image or OS install the host was instantiated from. + # + # @note Stability Level: experimental HOST_IMAGE_NAME = 'host.image.name' - # The version string of the VM image or host OS as defined in [Version Attributes](/docs/resource/README.md#version-attributes) - # - # @note StabilityLevel.EXPERIMENTAL + # The version string of the VM image or host OS as defined in [Version Attributes](/docs/resource/README.md#version-attributes). + # + # @note Stability Level: experimental HOST_IMAGE_VERSION = 'host.image.version' - # Available IP addresses of the host, excluding loopback interfaces - # - # IPv4 Addresses MUST be specified in dotted-quad notation. IPv6 addresses MUST be specified in the [RFC 5952](https://www.rfc-editor.org/rfc/rfc5952.html) format - # - # @note StabilityLevel.EXPERIMENTAL + # Available IP addresses of the host, excluding loopback interfaces. + # + # IPv4 Addresses MUST be specified in dotted-quad notation. IPv6 addresses MUST be specified in the [RFC 5952](https://www.rfc-editor.org/rfc/rfc5952.html) format. + # + # @note Stability Level: experimental HOST_IP = 'host.ip' - # Available MAC addresses of the host, excluding loopback interfaces - # - # MAC Addresses MUST be represented in [IEEE RA hexadecimal form](https://standards.ieee.org/wp-content/uploads/import/documents/tutorials/eui.pdf): as hyphen-separated octets in uppercase hexadecimal form from most to least significant - # - # @note StabilityLevel.EXPERIMENTAL + # Available MAC addresses of the host, excluding loopback interfaces. + # + # MAC Addresses MUST be represented in [IEEE RA hexadecimal form](https://standards.ieee.org/wp-content/uploads/import/documents/tutorials/eui.pdf): as hyphen-separated octets in uppercase hexadecimal form from most to least significant. + # + # @note Stability Level: experimental HOST_MAC = 'host.mac' - # 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 - # - # @note StabilityLevel.EXPERIMENTAL + # 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. + # + # @note Stability Level: experimental HOST_NAME = 'host.name' - # Type of host. For Cloud, this must be the machine type - # - # @note StabilityLevel.EXPERIMENTAL + # Type of host. For Cloud, this must be the machine type. + # + # @note Stability Level: experimental HOST_TYPE = 'host.type' # @!endgroup @@ -110,6 +110,6 @@ module HOST # @!group Metric Names # @!endgroup end - end # module Incubating + end end end \ No newline at end of file diff --git a/semantic_conventions/lib/opentelemetry/semconv/incubating/http.rb b/semantic_conventions/lib/opentelemetry/semconv/incubating/http.rb index dd2fd2c336..98a93beddc 100644 --- a/semantic_conventions/lib/opentelemetry/semconv/incubating/http.rb +++ b/semantic_conventions/lib/opentelemetry/semconv/incubating/http.rb @@ -24,169 +24,190 @@ module Incubating module HTTP # @!group Attribute Names - # State of the HTTP connection in the HTTP connection pool - # - # @note StabilityLevel.EXPERIMENTAL + # Deprecated, use `client.address` instead. + # + # @note Stability Level: experimental + # @deprecated Replaced by `client.address`. + HTTP_CLIENT_IP = 'http.client_ip' + + # State of the HTTP connection in the HTTP connection pool. + # + # @note Stability Level: experimental HTTP_CONNECTION_STATE = 'http.connection.state' - # Deprecated, use `network.protocol.name` instead - # - # @note StabilityLevel.EXPERIMENTAL - # - # @deprecated Replaced by `network.protocol.name` + # Deprecated, use `network.protocol.name` instead. + # + # @note Stability Level: experimental + # @deprecated Replaced by `network.protocol.name`. HTTP_FLAVOR = 'http.flavor' - # Deprecated, use `http.request.method` instead - # - # @note StabilityLevel.EXPERIMENTAL - # - # @deprecated Replaced by `http.request.method` + # Deprecated, use one of `server.address`, `client.address` or `http.request.header.host` instead, depending on the usage. + # + # @note Stability Level: experimental + # @deprecated Replaced by one of `server.address`, `client.address` or `http.request.header.host`, depending on the usage. + HTTP_HOST = 'http.host' + + # Deprecated, use `http.request.method` instead. + # + # @note Stability Level: experimental + # @deprecated Replaced by `http.request.method`. HTTP_METHOD = 'http.method' - # The size of the request payload body in bytes. This is the number of bytes transferred excluding headers and is often, but not always, present as the [Content-Length](https://www.rfc-editor.org/rfc/rfc9110.html#field.content-length) header. For requests using transport encoding, this should be the compressed size - # - # @note StabilityLevel.EXPERIMENTAL + # The size of the request payload body in bytes. This is the number of bytes transferred excluding headers and is often, but not always, present as the [Content-Length](https://www.rfc-editor.org/rfc/rfc9110.html#field.content-length) header. For requests using transport encoding, this should be the compressed size. + # + # @note Stability Level: experimental HTTP_REQUEST_BODY_SIZE = 'http.request.body.size' - # HTTP request headers, `` being the normalized HTTP Header name (lowercase), the value being the header values - # + # HTTP request headers, `` being the normalized HTTP Header name (lowercase), the value being the header values. + # # Instrumentations SHOULD require an explicit configuration of which headers are to be captured. Including all request headers can be a security risk - explicit configuration helps avoid leaking sensitive information. - # The `User-Agent` header is already captured in the `user_agent.original` attribute. Users MAY explicitly configure instrumentations to capture them even though it is not recommended. - # The attribute value MUST consist of either multiple header values as an array of strings or a single-item array containing a possibly comma-concatenated string, depending on the way the HTTP library provides access to headers - # - # @note StabilityLevel.STABLE + # The `User-Agent` header is already captured in the `user_agent.original` attribute. Users MAY explicitly configure instrumentations to capture them even though it is not recommended. + # The attribute value MUST consist of either multiple header values as an array of strings or a single-item array containing a possibly comma-concatenated string, depending on the way the HTTP library provides access to headers. + # + # @note Stability Level: stable # - # @deprecated Now available in the stable namespace at {OpenTelemetry::SemConv::HTTP::HTTP_REQUEST_HEADER}. - HTTP_REQUEST_HEADER_LAMBDA = -> (key) { "http.request.header.#{key}" } + # @deprecated Now available in the stable namespace at {OpenTelemetry::SemConv::Http::HTTP_REQUEST_HEADER_LAMBDA}. + HTTP_REQUEST_HEADER_LAMBDA = ->(key) { "http.request.header.#{key}" } - # HTTP request method - # + # HTTP request method. + # # HTTP request method value SHOULD be "known" to the instrumentation. - # By default, this convention defines "known" methods as the ones listed in [RFC9110](https://www.rfc-editor.org/rfc/rfc9110.html#name-methods) - # and the PATCH method defined in [RFC5789](https://www.rfc-editor.org/rfc/rfc5789.html). - # - # If the HTTP request method is not known to instrumentation, it MUST set the `http.request.method` attribute to `_OTHER`. - # - # If the HTTP instrumentation could end up converting valid HTTP request methods to `_OTHER`, then it MUST provide a way to override - # the list of known HTTP methods. If this override is done via environment variable, then the environment variable MUST be named - # OTEL_INSTRUMENTATION_HTTP_KNOWN_METHODS and support a comma-separated list of case-sensitive known HTTP methods - # (this list MUST be a full override of the default known method, it is not a list of known methods in addition to the defaults). - # - # HTTP method names are case-sensitive and `http.request.method` attribute value MUST match a known HTTP method name exactly. - # Instrumentations for specific web frameworks that consider HTTP methods to be case insensitive, SHOULD populate a canonical equivalent. - # Tracing instrumentations that do so, MUST also set `http.request.method_original` to the original value - # - # @note StabilityLevel.STABLE - # - # @deprecated Now available in the stable namespace at {OpenTelemetry::SemConv::HTTP::HTTP_REQUEST_METHOD}. + # By default, this convention defines "known" methods as the ones listed in [RFC9110](https://www.rfc-editor.org/rfc/rfc9110.html#name-methods) + # and the PATCH method defined in [RFC5789](https://www.rfc-editor.org/rfc/rfc5789.html). + # + # If the HTTP request method is not known to instrumentation, it MUST set the `http.request.method` attribute to `_OTHER`. + # + # If the HTTP instrumentation could end up converting valid HTTP request methods to `_OTHER`, then it MUST provide a way to override + # the list of known HTTP methods. If this override is done via environment variable, then the environment variable MUST be named + # OTEL_INSTRUMENTATION_HTTP_KNOWN_METHODS and support a comma-separated list of case-sensitive known HTTP methods + # (this list MUST be a full override of the default known method, it is not a list of known methods in addition to the defaults). + # + # HTTP method names are case-sensitive and `http.request.method` attribute value MUST match a known HTTP method name exactly. + # Instrumentations for specific web frameworks that consider HTTP methods to be case insensitive, SHOULD populate a canonical equivalent. + # Tracing instrumentations that do so, MUST also set `http.request.method_original` to the original value. + # + # @note Stability Level: stable + # + # @deprecated Now available in the stable namespace at {OpenTelemetry::SemConv::Http::HTTP_REQUEST_METHOD}. HTTP_REQUEST_METHOD = 'http.request.method' - # Original HTTP method sent by the client in the request line - # - # @note StabilityLevel.STABLE + # Original HTTP method sent by the client in the request line. + # + # @note Stability Level: stable # - # @deprecated Now available in the stable namespace at {OpenTelemetry::SemConv::HTTP::HTTP_REQUEST_METHOD_ORIGINAL}. + # @deprecated Now available in the stable namespace at {OpenTelemetry::SemConv::Http::HTTP_REQUEST_METHOD_ORIGINAL}. HTTP_REQUEST_METHOD_ORIGINAL = 'http.request.method_original' - # The ordinal number of request resending attempt (for any reason, including redirects) - # - # The resend count SHOULD be updated each time an HTTP request gets resent by the client, regardless of what was the cause of the resending (e.g. redirection, authorization failure, 503 Server Unavailable, network issues, or any other) + # The ordinal number of request resending attempt (for any reason, including redirects). + # + # The resend count SHOULD be updated each time an HTTP request gets resent by the client, regardless of what was the cause of the resending (e.g. redirection, authorization failure, 503 Server Unavailable, network issues, or any other). + # + # @note Stability Level: stable # - # @note StabilityLevel.STABLE - # - # @deprecated Now available in the stable namespace at {OpenTelemetry::SemConv::HTTP::HTTP_REQUEST_RESEND_COUNT}. + # @deprecated Now available in the stable namespace at {OpenTelemetry::SemConv::Http::HTTP_REQUEST_RESEND_COUNT}. HTTP_REQUEST_RESEND_COUNT = 'http.request.resend_count' - # The total size of the request in bytes. This should be the total number of bytes sent over the wire, including the request line (HTTP/1.1), framing (HTTP/2 and HTTP/3), headers, and request body if any - # - # @note StabilityLevel.EXPERIMENTAL + # The total size of the request in bytes. This should be the total number of bytes sent over the wire, including the request line (HTTP/1.1), framing (HTTP/2 and HTTP/3), headers, and request body if any. + # + # @note Stability Level: experimental HTTP_REQUEST_SIZE = 'http.request.size' - # Deprecated, use `http.request.header.content-length` instead - # - # @note StabilityLevel.EXPERIMENTAL - # - # @deprecated Replaced by `http.request.header.content-length` + # Deprecated, use `http.request.header.content-length` instead. + # + # @note Stability Level: experimental + # @deprecated Replaced by `http.request.header.content-length`. HTTP_REQUEST_CONTENT_LENGTH = 'http.request_content_length' - # The size of the response payload body in bytes. This is the number of bytes transferred excluding headers and is often, but not always, present as the [Content-Length](https://www.rfc-editor.org/rfc/rfc9110.html#field.content-length) header. For requests using transport encoding, this should be the compressed size - # - # @note StabilityLevel.EXPERIMENTAL + # Deprecated, use `http.request.body.size` instead. + # + # @note Stability Level: experimental + # @deprecated Replaced by `http.request.body.size`. + HTTP_REQUEST_CONTENT_LENGTH_UNCOMPRESSED = 'http.request_content_length_uncompressed' + + # The size of the response payload body in bytes. This is the number of bytes transferred excluding headers and is often, but not always, present as the [Content-Length](https://www.rfc-editor.org/rfc/rfc9110.html#field.content-length) header. For requests using transport encoding, this should be the compressed size. + # + # @note Stability Level: experimental HTTP_RESPONSE_BODY_SIZE = 'http.response.body.size' - # HTTP response headers, `` being the normalized HTTP Header name (lowercase), the value being the header values - # + # HTTP response headers, `` being the normalized HTTP Header name (lowercase), the value being the header values. + # # Instrumentations SHOULD require an explicit configuration of which headers are to be captured. Including all response headers can be a security risk - explicit configuration helps avoid leaking sensitive information. - # Users MAY explicitly configure instrumentations to capture them even though it is not recommended. - # The attribute value MUST consist of either multiple header values as an array of strings or a single-item array containing a possibly comma-concatenated string, depending on the way the HTTP library provides access to headers + # Users MAY explicitly configure instrumentations to capture them even though it is not recommended. + # The attribute value MUST consist of either multiple header values as an array of strings or a single-item array containing a possibly comma-concatenated string, depending on the way the HTTP library provides access to headers. + # + # @note Stability Level: stable # - # @note StabilityLevel.STABLE - # - # @deprecated Now available in the stable namespace at {OpenTelemetry::SemConv::HTTP::HTTP_RESPONSE_HEADER}. - HTTP_RESPONSE_HEADER_LAMBDA = -> (key) { "http.response.header.#{key}" } + # @deprecated Now available in the stable namespace at {OpenTelemetry::SemConv::Http::HTTP_RESPONSE_HEADER_LAMBDA}. + HTTP_RESPONSE_HEADER_LAMBDA = ->(key) { "http.response.header.#{key}" } - # The total size of the response in bytes. This should be the total number of bytes sent over the wire, including the status line (HTTP/1.1), framing (HTTP/2 and HTTP/3), headers, and response body and trailers if any - # - # @note StabilityLevel.EXPERIMENTAL + # The total size of the response in bytes. This should be the total number of bytes sent over the wire, including the status line (HTTP/1.1), framing (HTTP/2 and HTTP/3), headers, and response body and trailers if any. + # + # @note Stability Level: experimental HTTP_RESPONSE_SIZE = 'http.response.size' - # [HTTP response status code](https://tools.ietf.org/html/rfc7231#section-6) - # - # @note StabilityLevel.STABLE + # [HTTP response status code](https://tools.ietf.org/html/rfc7231#section-6). + # + # @note Stability Level: stable # - # @deprecated Now available in the stable namespace at {OpenTelemetry::SemConv::HTTP::HTTP_RESPONSE_STATUS_CODE}. + # @deprecated Now available in the stable namespace at {OpenTelemetry::SemConv::Http::HTTP_RESPONSE_STATUS_CODE}. HTTP_RESPONSE_STATUS_CODE = 'http.response.status_code' - # Deprecated, use `http.response.header.content-length` instead - # - # @note StabilityLevel.EXPERIMENTAL - # - # @deprecated Replaced by `http.response.header.content-length` + # Deprecated, use `http.response.header.content-length` instead. + # + # @note Stability Level: experimental + # @deprecated Replaced by `http.response.header.content-length`. HTTP_RESPONSE_CONTENT_LENGTH = 'http.response_content_length' - # The matched route, that is, the path template in the format used by the respective server framework - # + # Deprecated, use `http.response.body.size` instead. + # + # @note Stability Level: experimental + # @deprecated Replace by `http.response.body.size`. + HTTP_RESPONSE_CONTENT_LENGTH_UNCOMPRESSED = 'http.response_content_length_uncompressed' + + # The matched route, that is, the path template in the format used by the respective server framework. + # # MUST NOT be populated when this is not supported by the HTTP server framework as the route attribute should have low-cardinality and the URI path can NOT substitute it. - # SHOULD include the [application root](/docs/http/http-spans.md#http-server-definitions) if there is one - # - # @note StabilityLevel.STABLE + # SHOULD include the [application root](/docs/http/http-spans.md#http-server-definitions) if there is one. + # + # @note Stability Level: stable # - # @deprecated Now available in the stable namespace at {OpenTelemetry::SemConv::HTTP::HTTP_ROUTE}. + # @deprecated Now available in the stable namespace at {OpenTelemetry::SemConv::Http::HTTP_ROUTE}. HTTP_ROUTE = 'http.route' - # Deprecated, use `url.scheme` instead - # - # @note StabilityLevel.EXPERIMENTAL - # - # @deprecated Replaced by `url.scheme` instead + # Deprecated, use `url.scheme` instead. + # + # @note Stability Level: experimental + # @deprecated Replaced by `url.scheme` instead. HTTP_SCHEME = 'http.scheme' - # Deprecated, use `http.response.status_code` instead - # - # @note StabilityLevel.EXPERIMENTAL - # - # @deprecated Replaced by `http.response.status_code` + # Deprecated, use `server.address` instead. + # + # @note Stability Level: experimental + # @deprecated Replaced by `server.address`. + HTTP_SERVER_NAME = 'http.server_name' + + # Deprecated, use `http.response.status_code` instead. + # + # @note Stability Level: experimental + # @deprecated Replaced by `http.response.status_code`. HTTP_STATUS_CODE = 'http.status_code' - # Deprecated, use `url.path` and `url.query` instead - # - # @note StabilityLevel.EXPERIMENTAL - # - # @deprecated Split to `url.path` and `url.query + # Deprecated, use `url.path` and `url.query` instead. + # + # @note Stability Level: experimental + # @deprecated Split to `url.path` and `url.query. HTTP_TARGET = 'http.target' - # Deprecated, use `url.full` instead - # - # @note StabilityLevel.EXPERIMENTAL - # - # @deprecated Replaced by `url.full` + # Deprecated, use `url.full` instead. + # + # @note Stability Level: experimental + # @deprecated Replaced by `url.full`. HTTP_URL = 'http.url' - # Deprecated, use `user_agent.original` instead - # - # @note StabilityLevel.EXPERIMENTAL - # - # @deprecated Replaced by `user_agent.original` + # Deprecated, use `user_agent.original` instead. + # + # @note Stability Level: experimental + # @deprecated Replaced by `user_agent.original`. HTTP_USER_AGENT = 'http.user_agent' # @!endgroup @@ -194,6 +215,6 @@ module HTTP # @!group Metric Names # @!endgroup end - end # module Incubating + end end end \ No newline at end of file diff --git a/semantic_conventions/lib/opentelemetry/semconv/incubating/ios.rb b/semantic_conventions/lib/opentelemetry/semconv/incubating/ios.rb index a94f6fa165..a6fd6348e1 100644 --- a/semantic_conventions/lib/opentelemetry/semconv/incubating/ios.rb +++ b/semantic_conventions/lib/opentelemetry/semconv/incubating/ios.rb @@ -24,11 +24,12 @@ module Incubating module IOS # @!group Attribute Names - # This attribute represents the state the application has transitioned into at the occurrence of the event - # - # The iOS lifecycle states are defined in the [UIApplicationDelegate documentation](https://developer.apple.com/documentation/uikit/uiapplicationdelegate#1656902), and from which the `OS terminology` column values are derived - # - # @note StabilityLevel.EXPERIMENTAL + # Deprecated use the `device.app.lifecycle` event definition including `ios.state` as a payload field instead. + # + # The iOS lifecycle states are defined in the [UIApplicationDelegate documentation](https://developer.apple.com/documentation/uikit/uiapplicationdelegate#1656902), and from which the `OS terminology` column values are derived. + # + # @note Stability Level: experimental + # @deprecated Moved to a payload field of `device.app.lifecycle`. IOS_STATE = 'ios.state' # @!endgroup @@ -36,6 +37,6 @@ module IOS # @!group Metric Names # @!endgroup end - end # module Incubating + end end end \ No newline at end of file diff --git a/semantic_conventions/lib/opentelemetry/semconv/incubating/jvm.rb b/semantic_conventions/lib/opentelemetry/semconv/incubating/jvm.rb index 517776ce82..0a60c8fa8e 100644 --- a/semantic_conventions/lib/opentelemetry/semconv/incubating/jvm.rb +++ b/semantic_conventions/lib/opentelemetry/semconv/incubating/jvm.rb @@ -24,59 +24,59 @@ module Incubating module JVM # @!group Attribute Names - # Name of the buffer pool - # - # Pool names are generally obtained via [BufferPoolMXBean#getName()](https://docs.oracle.com/en/java/javase/11/docs/api/java.management/java/lang/management/BufferPoolMXBean.html#getName()) - # - # @note StabilityLevel.EXPERIMENTAL + # Name of the buffer pool. + # + # Pool names are generally obtained via [BufferPoolMXBean#getName()](https://docs.oracle.com/en/java/javase/11/docs/api/java.management/java/lang/management/BufferPoolMXBean.html#getName()). + # + # @note Stability Level: experimental JVM_BUFFER_POOL_NAME = 'jvm.buffer.pool.name' - # Name of the garbage collector action - # - # Garbage collector action is generally obtained via [GarbageCollectionNotificationInfo#getGcAction()](https://docs.oracle.com/en/java/javase/11/docs/api/jdk.management/com/sun/management/GarbageCollectionNotificationInfo.html#getGcAction()) + # Name of the garbage collector action. + # + # Garbage collector action is generally obtained via [GarbageCollectionNotificationInfo#getGcAction()](https://docs.oracle.com/en/java/javase/11/docs/api/jdk.management/com/sun/management/GarbageCollectionNotificationInfo.html#getGcAction()). + # + # @note Stability Level: stable # - # @note StabilityLevel.STABLE - # - # @deprecated Now available in the stable namespace at {OpenTelemetry::SemConv::JVM::JVM_GC_ACTION}. + # @deprecated Now available in the stable namespace at {OpenTelemetry::SemConv::Jvm::JVM_GC_ACTION}. JVM_GC_ACTION = 'jvm.gc.action' - # Name of the garbage collector - # - # Garbage collector name is generally obtained via [GarbageCollectionNotificationInfo#getGcName()](https://docs.oracle.com/en/java/javase/11/docs/api/jdk.management/com/sun/management/GarbageCollectionNotificationInfo.html#getGcName()) - # - # @note StabilityLevel.STABLE + # Name of the garbage collector. + # + # Garbage collector name is generally obtained via [GarbageCollectionNotificationInfo#getGcName()](https://docs.oracle.com/en/java/javase/11/docs/api/jdk.management/com/sun/management/GarbageCollectionNotificationInfo.html#getGcName()). + # + # @note Stability Level: stable # - # @deprecated Now available in the stable namespace at {OpenTelemetry::SemConv::JVM::JVM_GC_NAME}. + # @deprecated Now available in the stable namespace at {OpenTelemetry::SemConv::Jvm::JVM_GC_NAME}. JVM_GC_NAME = 'jvm.gc.name' - # Name of the memory pool + # Name of the memory pool. + # + # Pool names are generally obtained via [MemoryPoolMXBean#getName()](https://docs.oracle.com/en/java/javase/11/docs/api/java.management/java/lang/management/MemoryPoolMXBean.html#getName()). + # + # @note Stability Level: stable # - # Pool names are generally obtained via [MemoryPoolMXBean#getName()](https://docs.oracle.com/en/java/javase/11/docs/api/java.management/java/lang/management/MemoryPoolMXBean.html#getName()) - # - # @note StabilityLevel.STABLE - # - # @deprecated Now available in the stable namespace at {OpenTelemetry::SemConv::JVM::JVM_MEMORY_POOL_NAME}. + # @deprecated Now available in the stable namespace at {OpenTelemetry::SemConv::Jvm::JVM_MEMORY_POOL_NAME}. JVM_MEMORY_POOL_NAME = 'jvm.memory.pool.name' - # The type of memory - # - # @note StabilityLevel.STABLE + # The type of memory. + # + # @note Stability Level: stable # - # @deprecated Now available in the stable namespace at {OpenTelemetry::SemConv::JVM::JVM_MEMORY_TYPE}. + # @deprecated Now available in the stable namespace at {OpenTelemetry::SemConv::Jvm::JVM_MEMORY_TYPE}. JVM_MEMORY_TYPE = 'jvm.memory.type' - # Whether the thread is daemon or not + # Whether the thread is daemon or not. + # + # @note Stability Level: stable # - # @note StabilityLevel.STABLE - # - # @deprecated Now available in the stable namespace at {OpenTelemetry::SemConv::JVM::JVM_THREAD_DAEMON}. + # @deprecated Now available in the stable namespace at {OpenTelemetry::SemConv::Jvm::JVM_THREAD_DAEMON}. JVM_THREAD_DAEMON = 'jvm.thread.daemon' - # State of the thread - # - # @note StabilityLevel.STABLE + # State of the thread. + # + # @note Stability Level: stable # - # @deprecated Now available in the stable namespace at {OpenTelemetry::SemConv::JVM::JVM_THREAD_STATE}. + # @deprecated Now available in the stable namespace at {OpenTelemetry::SemConv::Jvm::JVM_THREAD_STATE}. JVM_THREAD_STATE = 'jvm.thread.state' # @!endgroup @@ -84,6 +84,6 @@ module JVM # @!group Metric Names # @!endgroup end - end # module Incubating + end end end \ No newline at end of file diff --git a/semantic_conventions/lib/opentelemetry/semconv/incubating/k8s.rb b/semantic_conventions/lib/opentelemetry/semconv/incubating/k8s.rb index e996345d4c..896bbe3739 100644 --- a/semantic_conventions/lib/opentelemetry/semconv/incubating/k8s.rb +++ b/semantic_conventions/lib/opentelemetry/semconv/incubating/k8s.rb @@ -24,149 +24,153 @@ module Incubating module K8S # @!group Attribute Names - # The name of the cluster - # - # @note StabilityLevel.EXPERIMENTAL + # The name of the cluster. + # + # @note Stability Level: experimental K8S_CLUSTER_NAME = 'k8s.cluster.name' - # A pseudo-ID for the cluster, set to the UID of the `kube-system` namespace - # + # A pseudo-ID for the cluster, set to the UID of the `kube-system` namespace. + # # K8s doesn't have support for obtaining a cluster ID. If this is ever - # added, we will recommend collecting the `k8s.cluster.uid` through the - # official APIs. In the meantime, we are able to use the `uid` of the - # `kube-system` namespace as a proxy for cluster ID. Read on for the - # rationale. - # - # Every object created in a K8s cluster is assigned a distinct UID. The - # `kube-system` namespace is used by Kubernetes itself and will exist - # for the lifetime of the cluster. Using the `uid` of the `kube-system` - # namespace is a reasonable proxy for the K8s ClusterID as it will only - # change if the cluster is rebuilt. Furthermore, Kubernetes UIDs are - # UUIDs as standardized by - # [ISO/IEC 9834-8 and ITU-T X.667](https://www.itu.int/ITU-T/studygroups/com17/oid.html). - # Which states: - # - # > If generated according to one of the mechanisms defined in Rec. - # ITU-T X.667 | ISO/IEC 9834-8, a UUID is either guaranteed to be - # different from all other UUIDs generated before 3603 A.D., or is - # extremely likely to be different (depending on the mechanism chosen). - # - # Therefore, UIDs between clusters should be extremely unlikely to - # conflict - # - # @note StabilityLevel.EXPERIMENTAL + # added, we will recommend collecting the `k8s.cluster.uid` through the + # official APIs. In the meantime, we are able to use the `uid` of the + # `kube-system` namespace as a proxy for cluster ID. Read on for the + # rationale. + # + # Every object created in a K8s cluster is assigned a distinct UID. The + # `kube-system` namespace is used by Kubernetes itself and will exist + # for the lifetime of the cluster. Using the `uid` of the `kube-system` + # namespace is a reasonable proxy for the K8s ClusterID as it will only + # change if the cluster is rebuilt. Furthermore, Kubernetes UIDs are + # UUIDs as standardized by + # [ISO/IEC 9834-8 and ITU-T X.667](https://www.itu.int/ITU-T/studygroups/com17/oid.html). + # Which states: + # + # > If generated according to one of the mechanisms defined in Rec. + # > ITU-T X.667 | ISO/IEC 9834-8, a UUID is either guaranteed to be + # > different from all other UUIDs generated before 3603 A.D., or is + # > extremely likely to be different (depending on the mechanism chosen). + # + # Therefore, UIDs between clusters should be extremely unlikely to + # conflict. + # + # @note Stability Level: experimental K8S_CLUSTER_UID = 'k8s.cluster.uid' - # The name of the Container from Pod specification, must be unique within a Pod. Container runtime usually uses different globally unique name (`container.name`) - # - # @note StabilityLevel.EXPERIMENTAL + # The name of the Container from Pod specification, must be unique within a Pod. Container runtime usually uses different globally unique name (`container.name`). + # + # @note Stability Level: experimental K8S_CONTAINER_NAME = 'k8s.container.name' - # Number of times the container was restarted. This attribute can be used to identify a particular container (running or stopped) within a container spec - # - # @note StabilityLevel.EXPERIMENTAL + # Number of times the container was restarted. This attribute can be used to identify a particular container (running or stopped) within a container spec. + # + # @note Stability Level: experimental K8S_CONTAINER_RESTART_COUNT = 'k8s.container.restart_count' - # The name of the CronJob - # - # @note StabilityLevel.EXPERIMENTAL + # Last terminated reason of the Container. + # + # @note Stability Level: experimental + K8S_CONTAINER_STATUS_LAST_TERMINATED_REASON = 'k8s.container.status.last_terminated_reason' + + # The name of the CronJob. + # + # @note Stability Level: experimental K8S_CRONJOB_NAME = 'k8s.cronjob.name' - # The UID of the CronJob - # - # @note StabilityLevel.EXPERIMENTAL + # The UID of the CronJob. + # + # @note Stability Level: experimental K8S_CRONJOB_UID = 'k8s.cronjob.uid' - # The name of the DaemonSet - # - # @note StabilityLevel.EXPERIMENTAL + # The name of the DaemonSet. + # + # @note Stability Level: experimental K8S_DAEMONSET_NAME = 'k8s.daemonset.name' - # The UID of the DaemonSet - # - # @note StabilityLevel.EXPERIMENTAL + # The UID of the DaemonSet. + # + # @note Stability Level: experimental K8S_DAEMONSET_UID = 'k8s.daemonset.uid' - # The name of the Deployment - # - # @note StabilityLevel.EXPERIMENTAL + # The name of the Deployment. + # + # @note Stability Level: experimental K8S_DEPLOYMENT_NAME = 'k8s.deployment.name' - # The UID of the Deployment - # - # @note StabilityLevel.EXPERIMENTAL + # The UID of the Deployment. + # + # @note Stability Level: experimental K8S_DEPLOYMENT_UID = 'k8s.deployment.uid' - # The name of the Job - # - # @note StabilityLevel.EXPERIMENTAL + # The name of the Job. + # + # @note Stability Level: experimental K8S_JOB_NAME = 'k8s.job.name' - # The UID of the Job - # - # @note StabilityLevel.EXPERIMENTAL + # The UID of the Job. + # + # @note Stability Level: experimental K8S_JOB_UID = 'k8s.job.uid' - # The name of the namespace that the pod is running in - # - # @note StabilityLevel.EXPERIMENTAL + # The name of the namespace that the pod is running in. + # + # @note Stability Level: experimental K8S_NAMESPACE_NAME = 'k8s.namespace.name' - # The name of the Node - # - # @note StabilityLevel.EXPERIMENTAL + # The name of the Node. + # + # @note Stability Level: experimental K8S_NODE_NAME = 'k8s.node.name' - # The UID of the Node - # - # @note StabilityLevel.EXPERIMENTAL + # The UID of the Node. + # + # @note Stability Level: experimental K8S_NODE_UID = 'k8s.node.uid' - # The annotation key-value pairs placed on the Pod, the `` being the annotation name, the value being the annotation value - # - # @note StabilityLevel.EXPERIMENTAL - K8S_POD_ANNOTATION_LAMBDA = -> (key) { "k8s.pod.annotation.#{key}" } - - # The label key-value pairs placed on the Pod, the `` being the label name, the value being the label value - # - # @note StabilityLevel.EXPERIMENTAL - K8S_POD_LABEL_LAMBDA = -> (key) { "k8s.pod.label.#{key}" } - - # Deprecated, use `k8s.pod.label` instead - # - # @note StabilityLevel.EXPERIMENTAL - # - # @deprecated Replaced by `k8s.pod.label` - K8S_POD_LABELS_LAMBDA = -> (key) { "k8s.pod.labels.#{key}" } - - # The name of the Pod - # - # @note StabilityLevel.EXPERIMENTAL + # The annotation key-value pairs placed on the Pod, the `` being the annotation name, the value being the annotation value. + # + # @note Stability Level: experimental + K8S_POD_ANNOTATION_LAMBDA = ->(key) { "k8s.pod.annotation.#{key}" } + + # The label key-value pairs placed on the Pod, the `` being the label name, the value being the label value. + # + # @note Stability Level: experimental + K8S_POD_LABEL_LAMBDA = ->(key) { "k8s.pod.label.#{key}" } + + # Deprecated, use `k8s.pod.label` instead. + # + # @note Stability Level: experimental + # @deprecated Replaced by `k8s.pod.label`. + K8S_POD_LABELS_LAMBDA = ->(key) { "k8s.pod.labels.#{key}" } + + # The name of the Pod. + # + # @note Stability Level: experimental K8S_POD_NAME = 'k8s.pod.name' - # The UID of the Pod - # - # @note StabilityLevel.EXPERIMENTAL + # The UID of the Pod. + # + # @note Stability Level: experimental K8S_POD_UID = 'k8s.pod.uid' - # The name of the ReplicaSet - # - # @note StabilityLevel.EXPERIMENTAL + # The name of the ReplicaSet. + # + # @note Stability Level: experimental K8S_REPLICASET_NAME = 'k8s.replicaset.name' - # The UID of the ReplicaSet - # - # @note StabilityLevel.EXPERIMENTAL + # The UID of the ReplicaSet. + # + # @note Stability Level: experimental K8S_REPLICASET_UID = 'k8s.replicaset.uid' - # The name of the StatefulSet - # - # @note StabilityLevel.EXPERIMENTAL + # The name of the StatefulSet. + # + # @note Stability Level: experimental K8S_STATEFULSET_NAME = 'k8s.statefulset.name' - # The UID of the StatefulSet - # - # @note StabilityLevel.EXPERIMENTAL + # The UID of the StatefulSet. + # + # @note Stability Level: experimental K8S_STATEFULSET_UID = 'k8s.statefulset.uid' # @!endgroup @@ -174,6 +178,6 @@ module K8S # @!group Metric Names # @!endgroup end - end # module Incubating + end end end \ No newline at end of file diff --git a/semantic_conventions/lib/opentelemetry/semconv/incubating/log.rb b/semantic_conventions/lib/opentelemetry/semconv/incubating/log.rb index f297f94677..207621e5cb 100644 --- a/semantic_conventions/lib/opentelemetry/semconv/incubating/log.rb +++ b/semantic_conventions/lib/opentelemetry/semconv/incubating/log.rb @@ -24,37 +24,37 @@ module Incubating module LOG # @!group Attribute Names - # The basename of the file - # - # @note StabilityLevel.EXPERIMENTAL + # The basename of the file. + # + # @note Stability Level: experimental LOG_FILE_NAME = 'log.file.name' - # The basename of the file, with symlinks resolved - # - # @note StabilityLevel.EXPERIMENTAL + # The basename of the file, with symlinks resolved. + # + # @note Stability Level: experimental LOG_FILE_NAME_RESOLVED = 'log.file.name_resolved' - # The full path to the file - # - # @note StabilityLevel.EXPERIMENTAL + # The full path to the file. + # + # @note Stability Level: experimental LOG_FILE_PATH = 'log.file.path' - # The full path to the file, with symlinks resolved - # - # @note StabilityLevel.EXPERIMENTAL + # The full path to the file, with symlinks resolved. + # + # @note Stability Level: experimental LOG_FILE_PATH_RESOLVED = 'log.file.path_resolved' - # The stream associated with the log. See below for a list of well-known values - # - # @note StabilityLevel.EXPERIMENTAL + # The stream associated with the log. See below for a list of well-known values. + # + # @note Stability Level: experimental LOG_IOSTREAM = 'log.iostream' - # A unique identifier for the Log Record - # + # A unique identifier for the Log Record. + # # If an id is provided, other log records with the same id will be considered duplicates and can be removed safely. This means, that two distinguishable log records MUST have different values. - # The id MAY be an [Universally Unique Lexicographically Sortable Identifier (ULID)](https://github.com/ulid/spec), but other identifiers (e.g. UUID) may be used as needed - # - # @note StabilityLevel.EXPERIMENTAL + # The id MAY be an [Universally Unique Lexicographically Sortable Identifier (ULID)](https://github.com/ulid/spec), but other identifiers (e.g. UUID) may be used as needed. + # + # @note Stability Level: experimental LOG_RECORD_UID = 'log.record.uid' # @!endgroup @@ -62,6 +62,6 @@ module LOG # @!group Metric Names # @!endgroup end - end # module Incubating + end end end \ No newline at end of file diff --git a/semantic_conventions/lib/opentelemetry/semconv/incubating/message.rb b/semantic_conventions/lib/opentelemetry/semconv/incubating/message.rb index eaa20b90bd..e3115f696d 100644 --- a/semantic_conventions/lib/opentelemetry/semconv/incubating/message.rb +++ b/semantic_conventions/lib/opentelemetry/semconv/incubating/message.rb @@ -24,26 +24,28 @@ module Incubating module MESSAGE # @!group Attribute Names - # Compressed size of the message in bytes - # - # @note StabilityLevel.EXPERIMENTAL + # Deprecated, use `rpc.message.compressed_size` instead. + # + # @note Stability Level: experimental + # @deprecated Replaced by `rpc.message.compressed_size`. MESSAGE_COMPRESSED_SIZE = 'message.compressed_size' - # MUST be calculated as two different counters starting from `1` one for sent messages and one for received message - # - # This way we guarantee that the values will be consistent between different implementations - # - # @note StabilityLevel.EXPERIMENTAL + # Deprecated, use `rpc.message.id` instead. + # + # @note Stability Level: experimental + # @deprecated Replaced by `rpc.message.id`. MESSAGE_ID = 'message.id' - # Whether this is a received or sent message - # - # @note StabilityLevel.EXPERIMENTAL + # Deprecated, use `rpc.message.type` instead. + # + # @note Stability Level: experimental + # @deprecated Replaced by `rpc.message.type`. MESSAGE_TYPE = 'message.type' - # Uncompressed size of the message in bytes - # - # @note StabilityLevel.EXPERIMENTAL + # Deprecated, use `rpc.message.uncompressed_size` instead. + # + # @note Stability Level: experimental + # @deprecated Replaced by `rpc.message.uncompressed_size`. MESSAGE_UNCOMPRESSED_SIZE = 'message.uncompressed_size' # @!endgroup @@ -51,6 +53,6 @@ module MESSAGE # @!group Metric Names # @!endgroup end - end # module Incubating + end end end \ No newline at end of file diff --git a/semantic_conventions/lib/opentelemetry/semconv/incubating/messaging.rb b/semantic_conventions/lib/opentelemetry/semconv/incubating/messaging.rb index 16c63e070c..b01e62e7ec 100644 --- a/semantic_conventions/lib/opentelemetry/semconv/incubating/messaging.rb +++ b/semantic_conventions/lib/opentelemetry/semconv/incubating/messaging.rb @@ -24,216 +24,243 @@ module Incubating module MESSAGING # @!group Attribute Names - # The number of messages sent, received, or processed in the scope of the batching operation - # - # Instrumentations SHOULD NOT set `messaging.batch.message_count` on spans that operate with a single message. When a messaging client library supports both batch and single-message API for the same operation, instrumentations SHOULD use `messaging.batch.message_count` for batching APIs and SHOULD NOT use it for single-message APIs - # - # @note StabilityLevel.EXPERIMENTAL + # The number of messages sent, received, or processed in the scope of the batching operation. + # + # Instrumentations SHOULD NOT set `messaging.batch.message_count` on spans that operate with a single message. When a messaging client library supports both batch and single-message API for the same operation, instrumentations SHOULD use `messaging.batch.message_count` for batching APIs and SHOULD NOT use it for single-message APIs. + # + # @note Stability Level: experimental MESSAGING_BATCH_MESSAGE_COUNT = 'messaging.batch.message_count' - # A unique identifier for the client that consumes or produces a message - # - # @note StabilityLevel.EXPERIMENTAL - MESSAGING_CLIENT_ID = 'messaging.client_id' + # A unique identifier for the client that consumes or produces a message. + # + # @note Stability Level: experimental + MESSAGING_CLIENT_ID = 'messaging.client.id' - # A boolean that is true if the message destination is anonymous (could be unnamed or have auto-generated name) - # - # @note StabilityLevel.EXPERIMENTAL + # A boolean that is true if the message destination is anonymous (could be unnamed or have auto-generated name). + # + # @note Stability Level: experimental MESSAGING_DESTINATION_ANONYMOUS = 'messaging.destination.anonymous' # The message destination name - # + # # Destination name SHOULD uniquely identify a specific queue, topic or other entity within the broker. If - # the broker doesn't have such notion, the destination name SHOULD uniquely identify the broker - # - # @note StabilityLevel.EXPERIMENTAL + # the broker doesn't have such notion, the destination name SHOULD uniquely identify the broker. + # + # @note Stability Level: experimental MESSAGING_DESTINATION_NAME = 'messaging.destination.name' - # The identifier of the partition messages are sent to or received from, unique within the `messaging.destination.name` - # - # @note StabilityLevel.EXPERIMENTAL + # The identifier of the partition messages are sent to or received from, unique within the `messaging.destination.name`. + # + # @note Stability Level: experimental MESSAGING_DESTINATION_PARTITION_ID = 'messaging.destination.partition.id' # Low cardinality representation of the messaging destination name - # - # Destination names could be constructed from templates. An example would be a destination name involving a user name or product id. Although the destination name in this case is of high cardinality, the underlying template is of low cardinality and can be effectively used for grouping and aggregation - # - # @note StabilityLevel.EXPERIMENTAL + # + # Destination names could be constructed from templates. An example would be a destination name involving a user name or product id. Although the destination name in this case is of high cardinality, the underlying template is of low cardinality and can be effectively used for grouping and aggregation. + # + # @note Stability Level: experimental MESSAGING_DESTINATION_TEMPLATE = 'messaging.destination.template' - # A boolean that is true if the message destination is temporary and might not exist anymore after messages are processed - # - # @note StabilityLevel.EXPERIMENTAL + # A boolean that is true if the message destination is temporary and might not exist anymore after messages are processed. + # + # @note Stability Level: experimental MESSAGING_DESTINATION_TEMPORARY = 'messaging.destination.temporary' - # A boolean that is true if the publish message destination is anonymous (could be unnamed or have auto-generated name) - # - # @note StabilityLevel.EXPERIMENTAL + # A boolean that is true if the publish message destination is anonymous (could be unnamed or have auto-generated name). + # + # @note Stability Level: experimental MESSAGING_DESTINATION_PUBLISH_ANONYMOUS = 'messaging.destination_publish.anonymous' # The name of the original destination the message was published to - # + # # The name SHOULD uniquely identify a specific queue, topic, or other entity within the broker. If - # the broker doesn't have such notion, the original destination name SHOULD uniquely identify the broker - # - # @note StabilityLevel.EXPERIMENTAL + # the broker doesn't have such notion, the original destination name SHOULD uniquely identify the broker. + # + # @note Stability Level: experimental MESSAGING_DESTINATION_PUBLISH_NAME = 'messaging.destination_publish.name' - # The name of the consumer group the event consumer is associated with - # - # @note StabilityLevel.EXPERIMENTAL + # The name of the consumer group the event consumer is associated with. + # + # @note Stability Level: experimental MESSAGING_EVENTHUBS_CONSUMER_GROUP = 'messaging.eventhubs.consumer.group' - # The UTC epoch seconds at which the message has been accepted and stored in the entity - # - # @note StabilityLevel.EXPERIMENTAL + # The UTC epoch seconds at which the message has been accepted and stored in the entity. + # + # @note Stability Level: experimental MESSAGING_EVENTHUBS_MESSAGE_ENQUEUED_TIME = 'messaging.eventhubs.message.enqueued_time' - # The ordering key for a given message. If the attribute is not present, the message does not have an ordering key - # - # @note StabilityLevel.EXPERIMENTAL + # The ack deadline in seconds set for the modify ack deadline request. + # + # @note Stability Level: experimental + MESSAGING_GCP_PUBSUB_MESSAGE_ACK_DEADLINE = 'messaging.gcp_pubsub.message.ack_deadline' + + # The ack id for a given message. + # + # @note Stability Level: experimental + MESSAGING_GCP_PUBSUB_MESSAGE_ACK_ID = 'messaging.gcp_pubsub.message.ack_id' + + # The delivery attempt for a given message. + # + # @note Stability Level: experimental + MESSAGING_GCP_PUBSUB_MESSAGE_DELIVERY_ATTEMPT = 'messaging.gcp_pubsub.message.delivery_attempt' + + # The ordering key for a given message. If the attribute is not present, the message does not have an ordering key. + # + # @note Stability Level: experimental MESSAGING_GCP_PUBSUB_MESSAGE_ORDERING_KEY = 'messaging.gcp_pubsub.message.ordering_key' - # Name of the Kafka Consumer Group that is handling the message. Only applies to consumers, not producers - # - # @note StabilityLevel.EXPERIMENTAL + # Name of the Kafka Consumer Group that is handling the message. Only applies to consumers, not producers. + # + # @note Stability Level: experimental MESSAGING_KAFKA_CONSUMER_GROUP = 'messaging.kafka.consumer.group' - # "Deprecated, use `messaging.destination.partition.id` instead." - # - # @note StabilityLevel.EXPERIMENTAL - # - # @deprecated Replaced by `messaging.destination.partition.id` + # Deprecated, use `messaging.destination.partition.id` instead. + # + # @note Stability Level: experimental + # @deprecated Replaced by `messaging.destination.partition.id`. MESSAGING_KAFKA_DESTINATION_PARTITION = 'messaging.kafka.destination.partition' - # 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 - # - # 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 - # - # @note StabilityLevel.EXPERIMENTAL + # 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. + # + # 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. + # + # @note Stability Level: experimental MESSAGING_KAFKA_MESSAGE_KEY = 'messaging.kafka.message.key' - # The offset of a record in the corresponding Kafka partition - # - # @note StabilityLevel.EXPERIMENTAL + # The offset of a record in the corresponding Kafka partition. + # + # @note Stability Level: experimental MESSAGING_KAFKA_MESSAGE_OFFSET = 'messaging.kafka.message.offset' - # A boolean that is true if the message is a tombstone - # - # @note StabilityLevel.EXPERIMENTAL + # A boolean that is true if the message is a tombstone. + # + # @note Stability Level: experimental MESSAGING_KAFKA_MESSAGE_TOMBSTONE = 'messaging.kafka.message.tombstone' - # The size of the message body in bytes - # + # The size of the message body in bytes. + # # This can refer to both the compressed or uncompressed body size. If both sizes are known, the uncompressed - # body size should be used - # - # @note StabilityLevel.EXPERIMENTAL + # body size should be used. + # + # @note Stability Level: experimental MESSAGING_MESSAGE_BODY_SIZE = 'messaging.message.body.size' - # The conversation ID identifying the conversation to which the message belongs, represented as a string. Sometimes called "Correlation ID" - # - # @note StabilityLevel.EXPERIMENTAL + # The conversation ID identifying the conversation to which the message belongs, represented as a string. Sometimes called "Correlation ID". + # + # @note Stability Level: experimental MESSAGING_MESSAGE_CONVERSATION_ID = 'messaging.message.conversation_id' - # The size of the message body and metadata in bytes - # + # The size of the message body and metadata in bytes. + # # This can refer to both the compressed or uncompressed size. If both sizes are known, the uncompressed - # size should be used - # - # @note StabilityLevel.EXPERIMENTAL + # size should be used. + # + # @note Stability Level: experimental MESSAGING_MESSAGE_ENVELOPE_SIZE = 'messaging.message.envelope.size' - # A value used by the messaging system as an identifier for the message, represented as a string - # - # @note StabilityLevel.EXPERIMENTAL + # A value used by the messaging system as an identifier for the message, represented as a string. + # + # @note Stability Level: experimental MESSAGING_MESSAGE_ID = 'messaging.message.id' - # A string identifying the kind of messaging operation - # - # If a custom value is used, it MUST be of low cardinality - # - # @note StabilityLevel.EXPERIMENTAL + # Deprecated, use `messaging.operation.type` instead. + # + # @note Stability Level: experimental + # @deprecated Replaced by `messaging.operation.type`. MESSAGING_OPERATION = 'messaging.operation' - # RabbitMQ message routing key - # - # @note StabilityLevel.EXPERIMENTAL + # The system-specific name of the messaging operation. + # + # @note Stability Level: experimental + MESSAGING_OPERATION_NAME = 'messaging.operation.name' + + # A string identifying the type of the messaging operation. + # + # If a custom value is used, it MUST be of low cardinality. + # + # @note Stability Level: experimental + MESSAGING_OPERATION_TYPE = 'messaging.operation.type' + + # RabbitMQ message routing key. + # + # @note Stability Level: experimental MESSAGING_RABBITMQ_DESTINATION_ROUTING_KEY = 'messaging.rabbitmq.destination.routing_key' # RabbitMQ message delivery tag - # - # @note StabilityLevel.EXPERIMENTAL + # + # @note Stability Level: experimental MESSAGING_RABBITMQ_MESSAGE_DELIVERY_TAG = 'messaging.rabbitmq.message.delivery_tag' - # Name of the RocketMQ producer/consumer group that is handling the message. The client type is identified by the SpanKind - # - # @note StabilityLevel.EXPERIMENTAL + # Name of the RocketMQ producer/consumer group that is handling the message. The client type is identified by the SpanKind. + # + # @note Stability Level: experimental MESSAGING_ROCKETMQ_CLIENT_GROUP = 'messaging.rocketmq.client_group' - # Model of message consumption. This only applies to consumer spans - # - # @note StabilityLevel.EXPERIMENTAL + # Model of message consumption. This only applies to consumer spans. + # + # @note Stability Level: experimental MESSAGING_ROCKETMQ_CONSUMPTION_MODEL = 'messaging.rocketmq.consumption_model' - # The delay time level for delay message, which determines the message delay time - # - # @note StabilityLevel.EXPERIMENTAL + # The delay time level for delay message, which determines the message delay time. + # + # @note Stability Level: experimental MESSAGING_ROCKETMQ_MESSAGE_DELAY_TIME_LEVEL = 'messaging.rocketmq.message.delay_time_level' - # The timestamp in milliseconds that the delay message is expected to be delivered to consumer - # - # @note StabilityLevel.EXPERIMENTAL + # The timestamp in milliseconds that the delay message is expected to be delivered to consumer. + # + # @note Stability Level: experimental MESSAGING_ROCKETMQ_MESSAGE_DELIVERY_TIMESTAMP = 'messaging.rocketmq.message.delivery_timestamp' - # It is essential for FIFO message. Messages that belong to the same message group are always processed one by one within the same consumer group - # - # @note StabilityLevel.EXPERIMENTAL + # It is essential for FIFO message. Messages that belong to the same message group are always processed one by one within the same consumer group. + # + # @note Stability Level: experimental MESSAGING_ROCKETMQ_MESSAGE_GROUP = 'messaging.rocketmq.message.group' - # Key(s) of message, another way to mark message besides message id - # - # @note StabilityLevel.EXPERIMENTAL + # Key(s) of message, another way to mark message besides message id. + # + # @note Stability Level: experimental MESSAGING_ROCKETMQ_MESSAGE_KEYS = 'messaging.rocketmq.message.keys' - # The secondary classifier of message besides topic - # - # @note StabilityLevel.EXPERIMENTAL + # The secondary classifier of message besides topic. + # + # @note Stability Level: experimental MESSAGING_ROCKETMQ_MESSAGE_TAG = 'messaging.rocketmq.message.tag' - # Type of message - # - # @note StabilityLevel.EXPERIMENTAL + # Type of message. + # + # @note Stability Level: experimental MESSAGING_ROCKETMQ_MESSAGE_TYPE = 'messaging.rocketmq.message.type' - # Namespace of RocketMQ resources, resources in different namespaces are individual - # - # @note StabilityLevel.EXPERIMENTAL + # Namespace of RocketMQ resources, resources in different namespaces are individual. + # + # @note Stability Level: experimental MESSAGING_ROCKETMQ_NAMESPACE = 'messaging.rocketmq.namespace' - # The name of the subscription in the topic messages are received from - # - # @note StabilityLevel.EXPERIMENTAL + # The name of the subscription in the topic messages are received from. + # + # @note Stability Level: experimental MESSAGING_SERVICEBUS_DESTINATION_SUBSCRIPTION_NAME = 'messaging.servicebus.destination.subscription_name' - # Describes the [settlement type](https://learn.microsoft.com/azure/service-bus-messaging/message-transfers-locks-settlement#peeklock) - # - # @note StabilityLevel.EXPERIMENTAL + # Describes the [settlement type](https://learn.microsoft.com/azure/service-bus-messaging/message-transfers-locks-settlement#peeklock). + # + # @note Stability Level: experimental MESSAGING_SERVICEBUS_DISPOSITION_STATUS = 'messaging.servicebus.disposition_status' - # Number of deliveries that have been attempted for this message - # - # @note StabilityLevel.EXPERIMENTAL + # Number of deliveries that have been attempted for this message. + # + # @note Stability Level: experimental MESSAGING_SERVICEBUS_MESSAGE_DELIVERY_COUNT = 'messaging.servicebus.message.delivery_count' - # The UTC epoch seconds at which the message has been accepted and stored in the entity - # - # @note StabilityLevel.EXPERIMENTAL + # The UTC epoch seconds at which the message has been accepted and stored in the entity. + # + # @note Stability Level: experimental MESSAGING_SERVICEBUS_MESSAGE_ENQUEUED_TIME = 'messaging.servicebus.message.enqueued_time' - # An identifier for the messaging system being used. See below for a list of well-known identifiers - # - # @note StabilityLevel.EXPERIMENTAL + # The messaging system as identified by the client instrumentation. + # + # The actual messaging system may differ from the one known by the client. For example, when using Kafka client libraries to communicate with Azure Event Hubs, the `messaging.system` is set to `kafka` based on the instrumentation's best knowledge. + # + # @note Stability Level: experimental MESSAGING_SYSTEM = 'messaging.system' # @!endgroup @@ -241,6 +268,6 @@ module MESSAGING # @!group Metric Names # @!endgroup end - end # module Incubating + end end end \ No newline at end of file diff --git a/semantic_conventions/lib/opentelemetry/semconv/incubating/net.rb b/semantic_conventions/lib/opentelemetry/semconv/incubating/net.rb index f5611134df..5473cf71d5 100644 --- a/semantic_conventions/lib/opentelemetry/semconv/incubating/net.rb +++ b/semantic_conventions/lib/opentelemetry/semconv/incubating/net.rb @@ -24,95 +24,94 @@ module Incubating module NET # @!group Attribute Names - # Deprecated, use `server.address` - # - # @note StabilityLevel.EXPERIMENTAL - # - # @deprecated Replaced by `server.address` + # Deprecated, use `network.local.address`. + # + # @note Stability Level: experimental + # @deprecated Replaced by `network.local.address`. + NET_HOST_IP = 'net.host.ip' + + # Deprecated, use `server.address`. + # + # @note Stability Level: experimental + # @deprecated Replaced by `server.address`. NET_HOST_NAME = 'net.host.name' - # Deprecated, use `server.port` - # - # @note StabilityLevel.EXPERIMENTAL - # - # @deprecated Replaced by `server.port` + # Deprecated, use `server.port`. + # + # @note Stability Level: experimental + # @deprecated Replaced by `server.port`. NET_HOST_PORT = 'net.host.port' - # Deprecated, use `server.address` on client spans and `client.address` on server spans - # - # @note StabilityLevel.EXPERIMENTAL - # - # @deprecated Replaced by `server.address` on client spans and `client.address` on server spans + # Deprecated, use `network.peer.address`. + # + # @note Stability Level: experimental + # @deprecated Replaced by `network.peer.address`. + NET_PEER_IP = 'net.peer.ip' + + # Deprecated, use `server.address` on client spans and `client.address` on server spans. + # + # @note Stability Level: experimental + # @deprecated Replaced by `server.address` on client spans and `client.address` on server spans. NET_PEER_NAME = 'net.peer.name' - # Deprecated, use `server.port` on client spans and `client.port` on server spans - # - # @note StabilityLevel.EXPERIMENTAL - # - # @deprecated Replaced by `server.port` on client spans and `client.port` on server spans + # Deprecated, use `server.port` on client spans and `client.port` on server spans. + # + # @note Stability Level: experimental + # @deprecated Replaced by `server.port` on client spans and `client.port` on server spans. NET_PEER_PORT = 'net.peer.port' - # Deprecated, use `network.protocol.name` - # - # @note StabilityLevel.EXPERIMENTAL - # - # @deprecated Replaced by `network.protocol.name` + # Deprecated, use `network.protocol.name`. + # + # @note Stability Level: experimental + # @deprecated Replaced by `network.protocol.name`. NET_PROTOCOL_NAME = 'net.protocol.name' - # Deprecated, use `network.protocol.version` - # - # @note StabilityLevel.EXPERIMENTAL - # - # @deprecated Replaced by `network.protocol.version` + # Deprecated, use `network.protocol.version`. + # + # @note Stability Level: experimental + # @deprecated Replaced by `network.protocol.version`. NET_PROTOCOL_VERSION = 'net.protocol.version' - # Deprecated, use `network.transport` and `network.type` - # - # @note StabilityLevel.EXPERIMENTAL - # - # @deprecated Split to `network.transport` and `network.type` + # Deprecated, use `network.transport` and `network.type`. + # + # @note Stability Level: experimental + # @deprecated Split to `network.transport` and `network.type`. NET_SOCK_FAMILY = 'net.sock.family' - # Deprecated, use `network.local.address` - # - # @note StabilityLevel.EXPERIMENTAL - # - # @deprecated Replaced by `network.local.address` + # Deprecated, use `network.local.address`. + # + # @note Stability Level: experimental + # @deprecated Replaced by `network.local.address`. NET_SOCK_HOST_ADDR = 'net.sock.host.addr' - # Deprecated, use `network.local.port` - # - # @note StabilityLevel.EXPERIMENTAL - # - # @deprecated Replaced by `network.local.port` + # Deprecated, use `network.local.port`. + # + # @note Stability Level: experimental + # @deprecated Replaced by `network.local.port`. NET_SOCK_HOST_PORT = 'net.sock.host.port' - # Deprecated, use `network.peer.address` - # - # @note StabilityLevel.EXPERIMENTAL - # - # @deprecated Replaced by `network.peer.address` + # Deprecated, use `network.peer.address`. + # + # @note Stability Level: experimental + # @deprecated Replaced by `network.peer.address`. NET_SOCK_PEER_ADDR = 'net.sock.peer.addr' - # Deprecated, no replacement at this time - # - # @note StabilityLevel.EXPERIMENTAL - # - # @deprecated Removed + # Deprecated, no replacement at this time. + # + # @note Stability Level: experimental + # @deprecated Removed. NET_SOCK_PEER_NAME = 'net.sock.peer.name' - # Deprecated, use `network.peer.port` - # - # @note StabilityLevel.EXPERIMENTAL - # - # @deprecated Replaced by `network.peer.port` + # Deprecated, use `network.peer.port`. + # + # @note Stability Level: experimental + # @deprecated Replaced by `network.peer.port`. NET_SOCK_PEER_PORT = 'net.sock.peer.port' - # Deprecated, use `network.transport` - # - # @note StabilityLevel.EXPERIMENTAL - # - # @deprecated Replaced by `network.transport` + # Deprecated, use `network.transport`. + # + # @note Stability Level: experimental + # @deprecated Replaced by `network.transport`. NET_TRANSPORT = 'net.transport' # @!endgroup @@ -120,6 +119,6 @@ module NET # @!group Metric Names # @!endgroup end - end # module Incubating + end end end \ No newline at end of file diff --git a/semantic_conventions/lib/opentelemetry/semconv/incubating/network.rb b/semantic_conventions/lib/opentelemetry/semconv/incubating/network.rb index 681ae8594c..f07fa46a28 100644 --- a/semantic_conventions/lib/opentelemetry/semconv/incubating/network.rb +++ b/semantic_conventions/lib/opentelemetry/semconv/incubating/network.rb @@ -24,107 +24,107 @@ module Incubating module NETWORK # @!group Attribute Names - # The ISO 3166-1 alpha-2 2-character country code associated with the mobile carrier network - # - # @note StabilityLevel.EXPERIMENTAL + # The ISO 3166-1 alpha-2 2-character country code associated with the mobile carrier network. + # + # @note Stability Level: experimental NETWORK_CARRIER_ICC = 'network.carrier.icc' - # The mobile carrier country code - # - # @note StabilityLevel.EXPERIMENTAL + # The mobile carrier country code. + # + # @note Stability Level: experimental NETWORK_CARRIER_MCC = 'network.carrier.mcc' - # The mobile carrier network code - # - # @note StabilityLevel.EXPERIMENTAL + # The mobile carrier network code. + # + # @note Stability Level: experimental NETWORK_CARRIER_MNC = 'network.carrier.mnc' - # The name of the mobile carrier - # - # @note StabilityLevel.EXPERIMENTAL + # The name of the mobile carrier. + # + # @note Stability Level: experimental NETWORK_CARRIER_NAME = 'network.carrier.name' - # This describes more details regarding the connection.type. It may be the type of cell technology connection, but it could be used for describing details about a wifi connection - # - # @note StabilityLevel.EXPERIMENTAL + # This describes more details regarding the connection.type. It may be the type of cell technology connection, but it could be used for describing details about a wifi connection. + # + # @note Stability Level: experimental NETWORK_CONNECTION_SUBTYPE = 'network.connection.subtype' - # The internet connection type - # - # @note StabilityLevel.EXPERIMENTAL + # The internet connection type. + # + # @note Stability Level: experimental NETWORK_CONNECTION_TYPE = 'network.connection.type' - # The network IO operation direction - # - # @note StabilityLevel.EXPERIMENTAL + # The network IO operation direction. + # + # @note Stability Level: experimental NETWORK_IO_DIRECTION = 'network.io.direction' - # Local address of the network connection - IP address or Unix domain socket name - # - # @note StabilityLevel.STABLE + # Local address of the network connection - IP address or Unix domain socket name. + # + # @note Stability Level: stable # - # @deprecated Now available in the stable namespace at {OpenTelemetry::SemConv::NETWORK::NETWORK_LOCAL_ADDRESS}. + # @deprecated Now available in the stable namespace at {OpenTelemetry::SemConv::Network::NETWORK_LOCAL_ADDRESS}. NETWORK_LOCAL_ADDRESS = 'network.local.address' - # Local port number of the network connection - # - # @note StabilityLevel.STABLE + # Local port number of the network connection. + # + # @note Stability Level: stable # - # @deprecated Now available in the stable namespace at {OpenTelemetry::SemConv::NETWORK::NETWORK_LOCAL_PORT}. + # @deprecated Now available in the stable namespace at {OpenTelemetry::SemConv::Network::NETWORK_LOCAL_PORT}. NETWORK_LOCAL_PORT = 'network.local.port' - # Peer address of the network connection - IP address or Unix domain socket name + # Peer address of the network connection - IP address or Unix domain socket name. + # + # @note Stability Level: stable # - # @note StabilityLevel.STABLE - # - # @deprecated Now available in the stable namespace at {OpenTelemetry::SemConv::NETWORK::NETWORK_PEER_ADDRESS}. + # @deprecated Now available in the stable namespace at {OpenTelemetry::SemConv::Network::NETWORK_PEER_ADDRESS}. NETWORK_PEER_ADDRESS = 'network.peer.address' - # Peer port number of the network connection - # - # @note StabilityLevel.STABLE + # Peer port number of the network connection. + # + # @note Stability Level: stable # - # @deprecated Now available in the stable namespace at {OpenTelemetry::SemConv::NETWORK::NETWORK_PEER_PORT}. + # @deprecated Now available in the stable namespace at {OpenTelemetry::SemConv::Network::NETWORK_PEER_PORT}. NETWORK_PEER_PORT = 'network.peer.port' - # [OSI application layer](https://osi-model.com/application-layer/) or non-OSI equivalent - # - # The value SHOULD be normalized to lowercase - # - # @note StabilityLevel.STABLE + # [OSI application layer](https://osi-model.com/application-layer/) or non-OSI equivalent. + # + # The value SHOULD be normalized to lowercase. + # + # @note Stability Level: stable # - # @deprecated Now available in the stable namespace at {OpenTelemetry::SemConv::NETWORK::NETWORK_PROTOCOL_NAME}. + # @deprecated Now available in the stable namespace at {OpenTelemetry::SemConv::Network::NETWORK_PROTOCOL_NAME}. NETWORK_PROTOCOL_NAME = 'network.protocol.name' - # The actual version of the protocol used for network communication - # - # If protocol version is subject to negotiation (for example using [ALPN](https://www.rfc-editor.org/rfc/rfc7301.html)), this attribute SHOULD be set to the negotiated version. If the actual protocol version is not known, this attribute SHOULD NOT be set + # The actual version of the protocol used for network communication. + # + # If protocol version is subject to negotiation (for example using [ALPN](https://www.rfc-editor.org/rfc/rfc7301.html)), this attribute SHOULD be set to the negotiated version. If the actual protocol version is not known, this attribute SHOULD NOT be set. + # + # @note Stability Level: stable # - # @note StabilityLevel.STABLE - # - # @deprecated Now available in the stable namespace at {OpenTelemetry::SemConv::NETWORK::NETWORK_PROTOCOL_VERSION}. + # @deprecated Now available in the stable namespace at {OpenTelemetry::SemConv::Network::NETWORK_PROTOCOL_VERSION}. NETWORK_PROTOCOL_VERSION = 'network.protocol.version' - # [OSI transport layer](https://osi-model.com/transport-layer/) or [inter-process communication method](https://wikipedia.org/wiki/Inter-process_communication) - # + # [OSI transport layer](https://osi-model.com/transport-layer/) or [inter-process communication method](https://wikipedia.org/wiki/Inter-process_communication). + # # The value SHOULD be normalized to lowercase. - # - # Consider always setting the transport when setting a port number, since - # a port number is ambiguous without knowing the transport. For example - # different processes could be listening on TCP port 12345 and UDP port 12345 - # - # @note StabilityLevel.STABLE - # - # @deprecated Now available in the stable namespace at {OpenTelemetry::SemConv::NETWORK::NETWORK_TRANSPORT}. + # + # Consider always setting the transport when setting a port number, since + # a port number is ambiguous without knowing the transport. For example + # different processes could be listening on TCP port 12345 and UDP port 12345. + # + # @note Stability Level: stable + # + # @deprecated Now available in the stable namespace at {OpenTelemetry::SemConv::Network::NETWORK_TRANSPORT}. NETWORK_TRANSPORT = 'network.transport' - # [OSI network layer](https://osi-model.com/network-layer/) or non-OSI equivalent - # - # The value SHOULD be normalized to lowercase - # - # @note StabilityLevel.STABLE + # [OSI network layer](https://osi-model.com/network-layer/) or non-OSI equivalent. + # + # The value SHOULD be normalized to lowercase. + # + # @note Stability Level: stable # - # @deprecated Now available in the stable namespace at {OpenTelemetry::SemConv::NETWORK::NETWORK_TYPE}. + # @deprecated Now available in the stable namespace at {OpenTelemetry::SemConv::Network::NETWORK_TYPE}. NETWORK_TYPE = 'network.type' # @!endgroup @@ -132,6 +132,6 @@ module NETWORK # @!group Metric Names # @!endgroup end - end # module Incubating + end end end \ No newline at end of file diff --git a/semantic_conventions/lib/opentelemetry/semconv/incubating/oci.rb b/semantic_conventions/lib/opentelemetry/semconv/incubating/oci.rb index 4129ed1f16..0b597ddea7 100644 --- a/semantic_conventions/lib/opentelemetry/semconv/incubating/oci.rb +++ b/semantic_conventions/lib/opentelemetry/semconv/incubating/oci.rb @@ -24,12 +24,12 @@ module Incubating module OCI # @!group Attribute Names - # The digest of the OCI image manifest. For container images specifically is the digest by which the container image is known - # + # The digest of the OCI image manifest. For container images specifically is the digest by which the container image is known. + # # Follows [OCI Image Manifest Specification](https://github.com/opencontainers/image-spec/blob/main/manifest.md), and specifically the [Digest property](https://github.com/opencontainers/image-spec/blob/main/descriptor.md#digests). - # An example can be found in [Example Image Manifest](https://docs.docker.com/registry/spec/manifest-v2-2/#example-image-manifest) - # - # @note StabilityLevel.EXPERIMENTAL + # An example can be found in [Example Image Manifest](https://docs.docker.com/registry/spec/manifest-v2-2/#example-image-manifest). + # + # @note Stability Level: experimental OCI_MANIFEST_DIGEST = 'oci.manifest.digest' # @!endgroup @@ -37,6 +37,6 @@ module OCI # @!group Metric Names # @!endgroup end - end # module Incubating + end end end \ No newline at end of file diff --git a/semantic_conventions/lib/opentelemetry/semconv/incubating/opentracing.rb b/semantic_conventions/lib/opentelemetry/semconv/incubating/opentracing.rb index cfbb426e48..f7baf15387 100644 --- a/semantic_conventions/lib/opentelemetry/semconv/incubating/opentracing.rb +++ b/semantic_conventions/lib/opentelemetry/semconv/incubating/opentracing.rb @@ -25,10 +25,10 @@ module OPENTRACING # @!group Attribute Names # Parent-child Reference type - # - # The causal relationship between a child Span and a parent Span - # - # @note StabilityLevel.EXPERIMENTAL + # + # The causal relationship between a child Span and a parent Span. + # + # @note Stability Level: experimental OPENTRACING_REF_TYPE = 'opentracing.ref_type' # @!endgroup @@ -36,6 +36,6 @@ module OPENTRACING # @!group Metric Names # @!endgroup end - end # module Incubating + end end end \ No newline at end of file diff --git a/semantic_conventions/lib/opentelemetry/semconv/incubating/os.rb b/semantic_conventions/lib/opentelemetry/semconv/incubating/os.rb index 8f2664afee..e84ad39552 100644 --- a/semantic_conventions/lib/opentelemetry/semconv/incubating/os.rb +++ b/semantic_conventions/lib/opentelemetry/semconv/incubating/os.rb @@ -24,29 +24,29 @@ module Incubating module OS # @!group Attribute Names - # Unique identifier for a particular build or compilation of the operating system - # - # @note StabilityLevel.EXPERIMENTAL + # Unique identifier for a particular build or compilation of the operating system. + # + # @note Stability Level: experimental OS_BUILD_ID = 'os.build_id' - # Human readable (not intended to be parsed) OS version information, like e.g. reported by `ver` or `lsb_release -a` commands - # - # @note StabilityLevel.EXPERIMENTAL + # Human readable (not intended to be parsed) OS version information, like e.g. reported by `ver` or `lsb_release -a` commands. + # + # @note Stability Level: experimental OS_DESCRIPTION = 'os.description' - # Human readable operating system name - # - # @note StabilityLevel.EXPERIMENTAL + # Human readable operating system name. + # + # @note Stability Level: experimental OS_NAME = 'os.name' - # The operating system type - # - # @note StabilityLevel.EXPERIMENTAL + # The operating system type. + # + # @note Stability Level: experimental OS_TYPE = 'os.type' - # The version string of the operating system as defined in [Version Attributes](/docs/resource/README.md#version-attributes) - # - # @note StabilityLevel.EXPERIMENTAL + # The version string of the operating system as defined in [Version Attributes](/docs/resource/README.md#version-attributes). + # + # @note Stability Level: experimental OS_VERSION = 'os.version' # @!endgroup @@ -54,6 +54,6 @@ module OS # @!group Metric Names # @!endgroup end - end # module Incubating + end end end \ No newline at end of file diff --git a/semantic_conventions/lib/opentelemetry/semconv/incubating/otel.rb b/semantic_conventions/lib/opentelemetry/semconv/incubating/otel.rb index 2fecf8972d..7852abdd89 100644 --- a/semantic_conventions/lib/opentelemetry/semconv/incubating/otel.rb +++ b/semantic_conventions/lib/opentelemetry/semconv/incubating/otel.rb @@ -24,46 +24,40 @@ module Incubating module OTEL # @!group Attribute Names - # None - # - # @note StabilityLevel.EXPERIMENTAL - # - # @deprecated use the `otel.scope.name` attribute + # @note Stability Level: experimental + # @deprecated use the `otel.scope.name` attribute. OTEL_LIBRARY_NAME = 'otel.library.name' - # None - # - # @note StabilityLevel.EXPERIMENTAL - # - # @deprecated use the `otel.scope.version` attribute + # @note Stability Level: experimental + # @deprecated use the `otel.scope.version` attribute. OTEL_LIBRARY_VERSION = 'otel.library.version' - # The name of the instrumentation scope - (`InstrumentationScope.Name` in OTLP) - # - # @note StabilityLevel.STABLE + # The name of the instrumentation scope - (`InstrumentationScope.Name` in OTLP). + # + # @note Stability Level: stable # - # @deprecated Now available in the stable namespace at {OpenTelemetry::SemConv::OTEL::OTEL_SCOPE_NAME}. + # @deprecated Now available in the stable namespace at {OpenTelemetry::SemConv::Otel::OTEL_SCOPE_NAME}. OTEL_SCOPE_NAME = 'otel.scope.name' - # The version of the instrumentation scope - (`InstrumentationScope.Version` in OTLP) + # The version of the instrumentation scope - (`InstrumentationScope.Version` in OTLP). + # + # @note Stability Level: stable # - # @note StabilityLevel.STABLE - # - # @deprecated Now available in the stable namespace at {OpenTelemetry::SemConv::OTEL::OTEL_SCOPE_VERSION}. + # @deprecated Now available in the stable namespace at {OpenTelemetry::SemConv::Otel::OTEL_SCOPE_VERSION}. OTEL_SCOPE_VERSION = 'otel.scope.version' - # Name of the code, either "OK" or "ERROR". MUST NOT be set if the status code is UNSET - # - # @note StabilityLevel.STABLE + # Name of the code, either "OK" or "ERROR". MUST NOT be set if the status code is UNSET. + # + # @note Stability Level: stable # - # @deprecated Now available in the stable namespace at {OpenTelemetry::SemConv::OTEL::OTEL_STATUS_CODE}. + # @deprecated Now available in the stable namespace at {OpenTelemetry::SemConv::Otel::OTEL_STATUS_CODE}. OTEL_STATUS_CODE = 'otel.status_code' - # Description of the Status if it has a value, otherwise not set + # Description of the Status if it has a value, otherwise not set. + # + # @note Stability Level: stable # - # @note StabilityLevel.STABLE - # - # @deprecated Now available in the stable namespace at {OpenTelemetry::SemConv::OTEL::OTEL_STATUS_DESCRIPTION}. + # @deprecated Now available in the stable namespace at {OpenTelemetry::SemConv::Otel::OTEL_STATUS_DESCRIPTION}. OTEL_STATUS_DESCRIPTION = 'otel.status_description' # @!endgroup @@ -71,6 +65,6 @@ module OTEL # @!group Metric Names # @!endgroup end - end # module Incubating + end end end \ No newline at end of file diff --git a/semantic_conventions/lib/opentelemetry/semconv/incubating/other.rb b/semantic_conventions/lib/opentelemetry/semconv/incubating/other.rb index 752d9d3840..c12f396b1d 100644 --- a/semantic_conventions/lib/opentelemetry/semconv/incubating/other.rb +++ b/semantic_conventions/lib/opentelemetry/semconv/incubating/other.rb @@ -24,9 +24,10 @@ module Incubating module OTHER # @!group Attribute Names - # The state of a connection in the pool - # - # @note StabilityLevel.EXPERIMENTAL + # Deprecated, use `db.client.connections.state` instead. + # + # @note Stability Level: experimental + # @deprecated Replaced by `db.client.connections.state`. STATE = 'state' # @!endgroup @@ -34,6 +35,6 @@ module OTHER # @!group Metric Names # @!endgroup end - end # module Incubating + end end end \ No newline at end of file diff --git a/semantic_conventions/lib/opentelemetry/semconv/incubating/peer.rb b/semantic_conventions/lib/opentelemetry/semconv/incubating/peer.rb index 2d3c6aded0..24ff342ce3 100644 --- a/semantic_conventions/lib/opentelemetry/semconv/incubating/peer.rb +++ b/semantic_conventions/lib/opentelemetry/semconv/incubating/peer.rb @@ -24,9 +24,9 @@ module Incubating module PEER # @!group Attribute Names - # The [`service.name`](/docs/resource/README.md#service) of the remote service. SHOULD be equal to the actual `service.name` resource attribute of the remote service if any - # - # @note StabilityLevel.EXPERIMENTAL + # The [`service.name`](/docs/resource/README.md#service) of the remote service. SHOULD be equal to the actual `service.name` resource attribute of the remote service if any. + # + # @note Stability Level: experimental PEER_SERVICE = 'peer.service' # @!endgroup @@ -34,6 +34,6 @@ module PEER # @!group Metric Names # @!endgroup end - end # module Incubating + end end end \ No newline at end of file diff --git a/semantic_conventions/lib/opentelemetry/semconv/incubating/pool.rb b/semantic_conventions/lib/opentelemetry/semconv/incubating/pool.rb index 867a6b5e43..0c3751ebeb 100644 --- a/semantic_conventions/lib/opentelemetry/semconv/incubating/pool.rb +++ b/semantic_conventions/lib/opentelemetry/semconv/incubating/pool.rb @@ -24,9 +24,10 @@ module Incubating module POOL # @!group Attribute Names - # The name of the connection pool; unique within the instrumented application. In case the connection pool implementation doesn't provide a name, instrumentation should use a combination of `server.address` and `server.port` attributes formatted as `server.address:server.port` - # - # @note StabilityLevel.EXPERIMENTAL + # Deprecated, use `db.client.connections.pool.name` instead. + # + # @note Stability Level: experimental + # @deprecated Replaced by `db.client.connections.pool.name`. POOL_NAME = 'pool.name' # @!endgroup @@ -34,6 +35,6 @@ module POOL # @!group Metric Names # @!endgroup end - end # module Incubating + end end end \ No newline at end of file diff --git a/semantic_conventions/lib/opentelemetry/semconv/incubating/process.rb b/semantic_conventions/lib/opentelemetry/semconv/incubating/process.rb index de570e4fa4..90c565f1d7 100644 --- a/semantic_conventions/lib/opentelemetry/semconv/incubating/process.rb +++ b/semantic_conventions/lib/opentelemetry/semconv/incubating/process.rb @@ -24,81 +24,148 @@ module Incubating module PROCESS # @!group Attribute Names - # 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` - # - # @note StabilityLevel.EXPERIMENTAL + # 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`. + # + # @note Stability Level: experimental PROCESS_COMMAND = 'process.command' - # 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` - # - # @note StabilityLevel.EXPERIMENTAL + # 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`. + # + # @note Stability Level: experimental PROCESS_COMMAND_ARGS = 'process.command_args' - # 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 - # - # @note StabilityLevel.EXPERIMENTAL + # 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. + # + # @note Stability Level: experimental PROCESS_COMMAND_LINE = 'process.command_line' - # Specifies whether the context switches for this data point were voluntary or involuntary - # - # @note StabilityLevel.EXPERIMENTAL + # Specifies whether the context switches for this data point were voluntary or involuntary. + # + # @note Stability Level: experimental PROCESS_CONTEXT_SWITCH_TYPE = 'process.context_switch_type' - # The CPU state for this data point. A process SHOULD be characterized _either_ by data points with no `state` labels, _or only_ data points with `state` labels - # - # @note StabilityLevel.EXPERIMENTAL + # The CPU state of the process. + # + # @note Stability Level: experimental PROCESS_CPU_STATE = 'process.cpu.state' - # 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` - # - # @note StabilityLevel.EXPERIMENTAL + # The date and time the process was created, in ISO 8601 format. + # + # @note Stability Level: experimental + PROCESS_CREATION_TIME = 'process.creation.time' + + # 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`. + # + # @note Stability Level: experimental PROCESS_EXECUTABLE_NAME = 'process.executable.name' - # 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` - # - # @note StabilityLevel.EXPERIMENTAL + # 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`. + # + # @note Stability Level: experimental PROCESS_EXECUTABLE_PATH = 'process.executable.path' - # The username of the user that owns the process - # - # @note StabilityLevel.EXPERIMENTAL + # The exit code of the process. + # + # @note Stability Level: experimental + PROCESS_EXIT_CODE = 'process.exit.code' + + # The date and time the process exited, in ISO 8601 format. + # + # @note Stability Level: experimental + PROCESS_EXIT_TIME = 'process.exit.time' + + # The PID of the process's group leader. This is also the process group ID (PGID) of the process. + # + # @note Stability Level: experimental + PROCESS_GROUP_LEADER_PID = 'process.group_leader.pid' + + # Whether the process is connected to an interactive shell. + # + # @note Stability Level: experimental + PROCESS_INTERACTIVE = 'process.interactive' + + # The username of the user that owns the process. + # + # @note Stability Level: experimental PROCESS_OWNER = 'process.owner' - # The type of page fault for this data point. Type `major` is for major/hard page faults, and `minor` is for minor/soft page faults - # - # @note StabilityLevel.EXPERIMENTAL + # The type of page fault for this data point. Type `major` is for major/hard page faults, and `minor` is for minor/soft page faults. + # + # @note Stability Level: experimental PROCESS_PAGING_FAULT_TYPE = 'process.paging.fault_type' - # Parent Process identifier (PPID) - # - # @note StabilityLevel.EXPERIMENTAL + # Parent Process identifier (PPID). + # + # @note Stability Level: experimental PROCESS_PARENT_PID = 'process.parent_pid' - # Process identifier (PID) - # - # @note StabilityLevel.EXPERIMENTAL + # Process identifier (PID). + # + # @note Stability Level: experimental PROCESS_PID = 'process.pid' - # An additional description about the runtime of the process, for example a specific vendor customization of the runtime environment - # - # @note StabilityLevel.EXPERIMENTAL + # The real user ID (RUID) of the process. + # + # @note Stability Level: experimental + PROCESS_REAL_USER_ID = 'process.real_user.id' + + # The username of the real user of the process. + # + # @note Stability Level: experimental + PROCESS_REAL_USER_NAME = 'process.real_user.name' + + # An additional description about the runtime of the process, for example a specific vendor customization of the runtime environment. + # + # @note Stability Level: experimental PROCESS_RUNTIME_DESCRIPTION = 'process.runtime.description' - # The name of the runtime of this process. For compiled native binaries, this SHOULD be the name of the compiler - # - # @note StabilityLevel.EXPERIMENTAL + # The name of the runtime of this process. For compiled native binaries, this SHOULD be the name of the compiler. + # + # @note Stability Level: experimental PROCESS_RUNTIME_NAME = 'process.runtime.name' - # The version of the runtime of this process, as returned by the runtime without modification - # - # @note StabilityLevel.EXPERIMENTAL + # The version of the runtime of this process, as returned by the runtime without modification. + # + # @note Stability Level: experimental PROCESS_RUNTIME_VERSION = 'process.runtime.version' + # The saved user ID (SUID) of the process. + # + # @note Stability Level: experimental + PROCESS_SAVED_USER_ID = 'process.saved_user.id' + + # The username of the saved user. + # + # @note Stability Level: experimental + PROCESS_SAVED_USER_NAME = 'process.saved_user.name' + + # The PID of the process's session leader. This is also the session ID (SID) of the process. + # + # @note Stability Level: experimental + PROCESS_SESSION_LEADER_PID = 'process.session_leader.pid' + + # The effective user ID (EUID) of the process. + # + # @note Stability Level: experimental + PROCESS_USER_ID = 'process.user.id' + + # The username of the effective user of the process. + # + # @note Stability Level: experimental + PROCESS_USER_NAME = 'process.user.name' + + # Virtual process identifier. + # + # The process ID within a PID namespace. This is not necessarily unique across all processes on the host but it is unique within the process namespace that the process exists within. + # + # @note Stability Level: experimental + PROCESS_VPID = 'process.vpid' + # @!endgroup # @!group Metric Names # @!endgroup end - end # module Incubating + end end end \ No newline at end of file diff --git a/semantic_conventions/lib/opentelemetry/semconv/incubating/rpc.rb b/semantic_conventions/lib/opentelemetry/semconv/incubating/rpc.rb index a0fef031c3..40a9fa8378 100644 --- a/semantic_conventions/lib/opentelemetry/semconv/incubating/rpc.rb +++ b/semantic_conventions/lib/opentelemetry/semconv/incubating/rpc.rb @@ -24,81 +24,103 @@ module Incubating module RPC # @!group Attribute Names - # The [error codes](https://connect.build/docs/protocol/#error-codes) of the Connect request. Error codes are always string values - # - # @note StabilityLevel.EXPERIMENTAL + # The [error codes](https://connect.build/docs/protocol/#error-codes) of the Connect request. Error codes are always string values. + # + # @note Stability Level: experimental RPC_CONNECT_RPC_ERROR_CODE = 'rpc.connect_rpc.error_code' - # Connect request metadata, `` being the normalized Connect Metadata key (lowercase), the value being the metadata values - # - # Instrumentations SHOULD require an explicit configuration of which metadata values are to be captured. Including all request metadata values can be a security risk - explicit configuration helps avoid leaking sensitive information - # - # @note StabilityLevel.EXPERIMENTAL - RPC_CONNECT_RPC_REQUEST_METADATA_LAMBDA = -> (key) { "rpc.connect_rpc.request.metadata.#{key}" } - - # Connect response metadata, `` being the normalized Connect Metadata key (lowercase), the value being the metadata values - # - # Instrumentations SHOULD require an explicit configuration of which metadata values are to be captured. Including all response metadata values can be a security risk - explicit configuration helps avoid leaking sensitive information - # - # @note StabilityLevel.EXPERIMENTAL - RPC_CONNECT_RPC_RESPONSE_METADATA_LAMBDA = -> (key) { "rpc.connect_rpc.response.metadata.#{key}" } - - # gRPC request metadata, `` being the normalized gRPC Metadata key (lowercase), the value being the metadata values - # - # Instrumentations SHOULD require an explicit configuration of which metadata values are to be captured. Including all request metadata values can be a security risk - explicit configuration helps avoid leaking sensitive information - # - # @note StabilityLevel.EXPERIMENTAL - RPC_GRPC_REQUEST_METADATA_LAMBDA = -> (key) { "rpc.grpc.request.metadata.#{key}" } - - # gRPC response metadata, `` being the normalized gRPC Metadata key (lowercase), the value being the metadata values - # - # Instrumentations SHOULD require an explicit configuration of which metadata values are to be captured. Including all response metadata values can be a security risk - explicit configuration helps avoid leaking sensitive information - # - # @note StabilityLevel.EXPERIMENTAL - RPC_GRPC_RESPONSE_METADATA_LAMBDA = -> (key) { "rpc.grpc.response.metadata.#{key}" } - - # The [numeric status code](https://github.com/grpc/grpc/blob/v1.33.2/doc/statuscodes.md) of the gRPC request - # - # @note StabilityLevel.EXPERIMENTAL + # Connect request metadata, `` being the normalized Connect Metadata key (lowercase), the value being the metadata values. + # + # Instrumentations SHOULD require an explicit configuration of which metadata values are to be captured. Including all request metadata values can be a security risk - explicit configuration helps avoid leaking sensitive information. + # + # @note Stability Level: experimental + RPC_CONNECT_RPC_REQUEST_METADATA_LAMBDA = ->(key) { "rpc.connect_rpc.request.metadata.#{key}" } + + # Connect response metadata, `` being the normalized Connect Metadata key (lowercase), the value being the metadata values. + # + # Instrumentations SHOULD require an explicit configuration of which metadata values are to be captured. Including all response metadata values can be a security risk - explicit configuration helps avoid leaking sensitive information. + # + # @note Stability Level: experimental + RPC_CONNECT_RPC_RESPONSE_METADATA_LAMBDA = ->(key) { "rpc.connect_rpc.response.metadata.#{key}" } + + # gRPC request metadata, `` being the normalized gRPC Metadata key (lowercase), the value being the metadata values. + # + # Instrumentations SHOULD require an explicit configuration of which metadata values are to be captured. Including all request metadata values can be a security risk - explicit configuration helps avoid leaking sensitive information. + # + # @note Stability Level: experimental + RPC_GRPC_REQUEST_METADATA_LAMBDA = ->(key) { "rpc.grpc.request.metadata.#{key}" } + + # gRPC response metadata, `` being the normalized gRPC Metadata key (lowercase), the value being the metadata values. + # + # Instrumentations SHOULD require an explicit configuration of which metadata values are to be captured. Including all response metadata values can be a security risk - explicit configuration helps avoid leaking sensitive information. + # + # @note Stability Level: experimental + RPC_GRPC_RESPONSE_METADATA_LAMBDA = ->(key) { "rpc.grpc.response.metadata.#{key}" } + + # The [numeric status code](https://github.com/grpc/grpc/blob/v1.33.2/doc/statuscodes.md) of the gRPC request. + # + # @note Stability Level: experimental RPC_GRPC_STATUS_CODE = 'rpc.grpc.status_code' - # `error.code` property of response if it is an error response - # - # @note StabilityLevel.EXPERIMENTAL + # `error.code` property of response if it is an error response. + # + # @note Stability Level: experimental RPC_JSONRPC_ERROR_CODE = 'rpc.jsonrpc.error_code' - # `error.message` property of response if it is an error response - # - # @note StabilityLevel.EXPERIMENTAL + # `error.message` property of response if it is an error response. + # + # @note Stability Level: experimental RPC_JSONRPC_ERROR_MESSAGE = 'rpc.jsonrpc.error_message' - # `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 - # - # @note StabilityLevel.EXPERIMENTAL + # `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. + # + # @note Stability Level: experimental RPC_JSONRPC_REQUEST_ID = 'rpc.jsonrpc.request_id' - # Protocol version as in `jsonrpc` property of request/response. Since JSON-RPC 1.0 doesn't specify this, the value can be omitted - # - # @note StabilityLevel.EXPERIMENTAL + # Protocol version as in `jsonrpc` property of request/response. Since JSON-RPC 1.0 doesn't specify this, the value can be omitted. + # + # @note Stability Level: experimental RPC_JSONRPC_VERSION = 'rpc.jsonrpc.version' - # The name of the (logical) method being called, must be equal to the $method part in the span name - # - # This is the logical name of the method from the RPC interface perspective, which can be different from the name of any implementing method/function. The `code.function` attribute may be used to store the latter (e.g., method actually executing the call on the server side, RPC client stub method on the client side) - # - # @note StabilityLevel.EXPERIMENTAL + # Compressed size of the message in bytes. + # + # @note Stability Level: experimental + RPC_MESSAGE_COMPRESSED_SIZE = 'rpc.message.compressed_size' + + # MUST be calculated as two different counters starting from `1` one for sent messages and one for received message. + # + # This way we guarantee that the values will be consistent between different implementations. + # + # @note Stability Level: experimental + RPC_MESSAGE_ID = 'rpc.message.id' + + # Whether this is a received or sent message. + # + # @note Stability Level: experimental + RPC_MESSAGE_TYPE = 'rpc.message.type' + + # Uncompressed size of the message in bytes. + # + # @note Stability Level: experimental + RPC_MESSAGE_UNCOMPRESSED_SIZE = 'rpc.message.uncompressed_size' + + # The name of the (logical) method being called, must be equal to the $method part in the span name. + # + # This is the logical name of the method from the RPC interface perspective, which can be different from the name of any implementing method/function. The `code.function` attribute may be used to store the latter (e.g., method actually executing the call on the server side, RPC client stub method on the client side). + # + # @note Stability Level: experimental RPC_METHOD = 'rpc.method' - # The full (logical) name of the service being called, including its package name, if applicable - # - # This is the logical name of the service from the RPC interface perspective, which can be different from the name of any implementing class. The `code.namespace` attribute may be used to store the latter (despite the attribute name, it may include a class name; e.g., class with method actually executing the call on the server side, RPC client stub class on the client side) - # - # @note StabilityLevel.EXPERIMENTAL + # The full (logical) name of the service being called, including its package name, if applicable. + # + # This is the logical name of the service from the RPC interface perspective, which can be different from the name of any implementing class. The `code.namespace` attribute may be used to store the latter (despite the attribute name, it may include a class name; e.g., class with method actually executing the call on the server side, RPC client stub class on the client side). + # + # @note Stability Level: experimental RPC_SERVICE = 'rpc.service' - # A string identifying the remoting system. See below for a list of well-known identifiers - # - # @note StabilityLevel.EXPERIMENTAL + # A string identifying the remoting system. See below for a list of well-known identifiers. + # + # @note Stability Level: experimental RPC_SYSTEM = 'rpc.system' # @!endgroup @@ -106,6 +128,6 @@ module RPC # @!group Metric Names # @!endgroup end - end # module Incubating + end end end \ No newline at end of file diff --git a/semantic_conventions/lib/opentelemetry/semconv/incubating/server.rb b/semantic_conventions/lib/opentelemetry/semconv/incubating/server.rb index ed2d08fb29..33c142784c 100644 --- a/semantic_conventions/lib/opentelemetry/semconv/incubating/server.rb +++ b/semantic_conventions/lib/opentelemetry/semconv/incubating/server.rb @@ -24,22 +24,22 @@ module Incubating module SERVER # @!group Attribute Names - # Server domain name if available without reverse DNS lookup; otherwise, IP address or Unix domain socket name + # Server domain name if available without reverse DNS lookup; otherwise, IP address or Unix domain socket name. + # + # When observed from the client side, and when communicating through an intermediary, `server.address` SHOULD represent the server address behind any intermediaries, for example proxies, if it's available. + # + # @note Stability Level: stable # - # When observed from the client side, and when communicating through an intermediary, `server.address` SHOULD represent the server address behind any intermediaries, for example proxies, if it's available - # - # @note StabilityLevel.STABLE - # - # @deprecated Now available in the stable namespace at {OpenTelemetry::SemConv::SERVER::SERVER_ADDRESS}. + # @deprecated Now available in the stable namespace at {OpenTelemetry::SemConv::Server::SERVER_ADDRESS}. SERVER_ADDRESS = 'server.address' - # Server port number - # - # When observed from the client side, and when communicating through an intermediary, `server.port` SHOULD represent the server port behind any intermediaries, for example proxies, if it's available + # Server port number. + # + # When observed from the client side, and when communicating through an intermediary, `server.port` SHOULD represent the server port behind any intermediaries, for example proxies, if it's available. + # + # @note Stability Level: stable # - # @note StabilityLevel.STABLE - # - # @deprecated Now available in the stable namespace at {OpenTelemetry::SemConv::SERVER::SERVER_PORT}. + # @deprecated Now available in the stable namespace at {OpenTelemetry::SemConv::Server::SERVER_PORT}. SERVER_PORT = 'server.port' # @!endgroup @@ -47,6 +47,6 @@ module SERVER # @!group Metric Names # @!endgroup end - end # module Incubating + end end end \ No newline at end of file diff --git a/semantic_conventions/lib/opentelemetry/semconv/incubating/service.rb b/semantic_conventions/lib/opentelemetry/semconv/incubating/service.rb index bbaf151902..51241bddaa 100644 --- a/semantic_conventions/lib/opentelemetry/semconv/incubating/service.rb +++ b/semantic_conventions/lib/opentelemetry/semconv/incubating/service.rb @@ -24,59 +24,59 @@ module Incubating module SERVICE # @!group Attribute Names - # The string ID of the service instance - # + # The string ID of the service instance. + # # 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). - # - # Implementations, such as SDKs, are recommended to generate a random Version 1 or Version 4 [RFC - # 4122](https://www.ietf.org/rfc/rfc4122.txt) UUID, but are free to use an inherent unique ID as the source of - # this value if stability is desirable. In that case, the ID SHOULD be used as source of a UUID Version 5 and - # SHOULD use the following UUID as the namespace: `4d63009a-8d0f-11ee-aad7-4c796ed8e320`. - # - # UUIDs are typically recommended, as only an opaque value for the purposes of identifying a service instance is - # needed. Similar to what can be seen in the man page for the - # [`/etc/machine-id`](https://www.freedesktop.org/software/systemd/man/machine-id.html) file, the underlying - # data, such as pod name and namespace should be treated as confidential, being the user's choice to expose it - # or not via another resource attribute. - # - # For applications running behind an application server (like unicorn), we do not recommend using one identifier - # for all processes participating in the application. Instead, it's recommended each division (e.g. a worker - # thread in unicorn) to have its own instance.id. - # - # It's not recommended for a Collector to set `service.instance.id` if it can't unambiguously determine the - # service instance that is generating that telemetry. For instance, creating an UUID based on `pod.name` will - # likely be wrong, as the Collector might not know from which container within that pod the telemetry originated. - # However, Collectors can set the `service.instance.id` if they can unambiguously determine the service instance - # for that telemetry. This is typically the case for scraping receivers, as they know the target address and - # port - # - # @note StabilityLevel.EXPERIMENTAL + # `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). + # + # Implementations, such as SDKs, are recommended to generate a random Version 1 or Version 4 [RFC + # 4122](https://www.ietf.org/rfc/rfc4122.txt) UUID, but are free to use an inherent unique ID as the source of + # this value if stability is desirable. In that case, the ID SHOULD be used as source of a UUID Version 5 and + # SHOULD use the following UUID as the namespace: `4d63009a-8d0f-11ee-aad7-4c796ed8e320`. + # + # UUIDs are typically recommended, as only an opaque value for the purposes of identifying a service instance is + # needed. Similar to what can be seen in the man page for the + # [`/etc/machine-id`](https://www.freedesktop.org/software/systemd/man/machine-id.html) file, the underlying + # data, such as pod name and namespace should be treated as confidential, being the user's choice to expose it + # or not via another resource attribute. + # + # For applications running behind an application server (like unicorn), we do not recommend using one identifier + # for all processes participating in the application. Instead, it's recommended each division (e.g. a worker + # thread in unicorn) to have its own instance.id. + # + # It's not recommended for a Collector to set `service.instance.id` if it can't unambiguously determine the + # service instance that is generating that telemetry. For instance, creating an UUID based on `pod.name` will + # likely be wrong, as the Collector might not know from which container within that pod the telemetry originated. + # However, Collectors can set the `service.instance.id` if they can unambiguously determine the service instance + # for that telemetry. This is typically the case for scraping receivers, as they know the target address and + # port. + # + # @note Stability Level: experimental SERVICE_INSTANCE_ID = 'service.instance.id' - # Logical name of the service - # - # 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` - # - # @note StabilityLevel.STABLE + # Logical name of the service. + # + # MUST be the same for all instances of horizontally scaled services. If the value was not specified, SDKs MUST fallback to `unknown_service:` concatenated with [`process.executable.name`](process.md), e.g. `unknown_service:bash`. If `process.executable.name` is not available, the value MUST be set to `unknown_service`. + # + # @note Stability Level: stable # - # @deprecated Now available in the stable namespace at {OpenTelemetry::SemConv::SERVICE::SERVICE_NAME}. + # @deprecated Now available in the stable namespace at {OpenTelemetry::SemConv::Service::SERVICE_NAME}. SERVICE_NAME = 'service.name' - # A namespace for `service.name` - # - # 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 - # - # @note StabilityLevel.EXPERIMENTAL + # A namespace for `service.name`. + # + # 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. + # + # @note Stability Level: experimental SERVICE_NAMESPACE = 'service.namespace' - # The version string of the service API or implementation. The format is not defined by these conventions + # The version string of the service API or implementation. The format is not defined by these conventions. + # + # @note Stability Level: stable # - # @note StabilityLevel.STABLE - # - # @deprecated Now available in the stable namespace at {OpenTelemetry::SemConv::SERVICE::SERVICE_VERSION}. + # @deprecated Now available in the stable namespace at {OpenTelemetry::SemConv::Service::SERVICE_VERSION}. SERVICE_VERSION = 'service.version' # @!endgroup @@ -84,6 +84,6 @@ module SERVICE # @!group Metric Names # @!endgroup end - end # module Incubating + end end end \ No newline at end of file diff --git a/semantic_conventions/lib/opentelemetry/semconv/incubating/session.rb b/semantic_conventions/lib/opentelemetry/semconv/incubating/session.rb index 47cf0f3e93..a6bf8b741b 100644 --- a/semantic_conventions/lib/opentelemetry/semconv/incubating/session.rb +++ b/semantic_conventions/lib/opentelemetry/semconv/incubating/session.rb @@ -24,14 +24,14 @@ module Incubating module SESSION # @!group Attribute Names - # A unique id to identify a session - # - # @note StabilityLevel.EXPERIMENTAL + # A unique id to identify a session. + # + # @note Stability Level: experimental SESSION_ID = 'session.id' - # The previous `session.id` for this user, when known - # - # @note StabilityLevel.EXPERIMENTAL + # The previous `session.id` for this user, when known. + # + # @note Stability Level: experimental SESSION_PREVIOUS_ID = 'session.previous_id' # @!endgroup @@ -39,6 +39,6 @@ module SESSION # @!group Metric Names # @!endgroup end - end # module Incubating + end end end \ No newline at end of file diff --git a/semantic_conventions/lib/opentelemetry/semconv/incubating/signalr.rb b/semantic_conventions/lib/opentelemetry/semconv/incubating/signalr.rb index 24ad444cbd..4a17b2853f 100644 --- a/semantic_conventions/lib/opentelemetry/semconv/incubating/signalr.rb +++ b/semantic_conventions/lib/opentelemetry/semconv/incubating/signalr.rb @@ -24,18 +24,18 @@ module Incubating module SIGNALR # @!group Attribute Names - # SignalR HTTP connection closure status + # SignalR HTTP connection closure status. + # + # @note Stability Level: stable # - # @note StabilityLevel.STABLE - # - # @deprecated Now available in the stable namespace at {OpenTelemetry::SemConv::SIGNALR::SIGNALR_CONNECTION_STATUS}. + # @deprecated Now available in the stable namespace at {OpenTelemetry::SemConv::Signalr::SIGNALR_CONNECTION_STATUS}. SIGNALR_CONNECTION_STATUS = 'signalr.connection.status' # [SignalR transport type](https://github.com/dotnet/aspnetcore/blob/main/src/SignalR/docs/specs/TransportProtocols.md) + # + # @note Stability Level: stable # - # @note StabilityLevel.STABLE - # - # @deprecated Now available in the stable namespace at {OpenTelemetry::SemConv::SIGNALR::SIGNALR_TRANSPORT}. + # @deprecated Now available in the stable namespace at {OpenTelemetry::SemConv::Signalr::SIGNALR_TRANSPORT}. SIGNALR_TRANSPORT = 'signalr.transport' # @!endgroup @@ -43,6 +43,6 @@ module SIGNALR # @!group Metric Names # @!endgroup end - end # module Incubating + end end end \ No newline at end of file diff --git a/semantic_conventions/lib/opentelemetry/semconv/incubating/source.rb b/semantic_conventions/lib/opentelemetry/semconv/incubating/source.rb index cc1b5322a4..6c6c00220a 100644 --- a/semantic_conventions/lib/opentelemetry/semconv/incubating/source.rb +++ b/semantic_conventions/lib/opentelemetry/semconv/incubating/source.rb @@ -24,16 +24,16 @@ module Incubating module SOURCE # @!group Attribute Names - # Source address - domain name if available without reverse DNS lookup; otherwise, IP address or Unix domain socket name - # - # When observed from the destination side, and when communicating through an intermediary, `source.address` SHOULD represent the source address behind any intermediaries, for example proxies, if it's available - # - # @note StabilityLevel.EXPERIMENTAL + # Source address - domain name if available without reverse DNS lookup; otherwise, IP address or Unix domain socket name. + # + # When observed from the destination side, and when communicating through an intermediary, `source.address` SHOULD represent the source address behind any intermediaries, for example proxies, if it's available. + # + # @note Stability Level: experimental SOURCE_ADDRESS = 'source.address' # Source port number - # - # @note StabilityLevel.EXPERIMENTAL + # + # @note Stability Level: experimental SOURCE_PORT = 'source.port' # @!endgroup @@ -41,6 +41,6 @@ module SOURCE # @!group Metric Names # @!endgroup end - end # module Incubating + end end end \ No newline at end of file diff --git a/semantic_conventions/lib/opentelemetry/semconv/incubating/system.rb b/semantic_conventions/lib/opentelemetry/semconv/incubating/system.rb index 65ec43b2ce..56dfc04bd0 100644 --- a/semantic_conventions/lib/opentelemetry/semconv/incubating/system.rb +++ b/semantic_conventions/lib/opentelemetry/semconv/incubating/system.rb @@ -25,75 +25,74 @@ module SYSTEM # @!group Attribute Names # The logical CPU number [0..n-1] - # - # @note StabilityLevel.EXPERIMENTAL + # + # @note Stability Level: experimental SYSTEM_CPU_LOGICAL_NUMBER = 'system.cpu.logical_number' - # The CPU state for this data point. A system's CPU SHOULD be characterized *either* by data points with no `state` labels, *or only* data points with `state` labels - # - # @note StabilityLevel.EXPERIMENTAL + # The state of the CPU + # + # @note Stability Level: experimental SYSTEM_CPU_STATE = 'system.cpu.state' # The device identifier - # - # @note StabilityLevel.EXPERIMENTAL + # + # @note Stability Level: experimental SYSTEM_DEVICE = 'system.device' # The filesystem mode - # - # @note StabilityLevel.EXPERIMENTAL + # + # @note Stability Level: experimental SYSTEM_FILESYSTEM_MODE = 'system.filesystem.mode' # The filesystem mount path - # - # @note StabilityLevel.EXPERIMENTAL + # + # @note Stability Level: experimental SYSTEM_FILESYSTEM_MOUNTPOINT = 'system.filesystem.mountpoint' # The filesystem state - # - # @note StabilityLevel.EXPERIMENTAL + # + # @note Stability Level: experimental SYSTEM_FILESYSTEM_STATE = 'system.filesystem.state' # The filesystem type - # - # @note StabilityLevel.EXPERIMENTAL + # + # @note Stability Level: experimental SYSTEM_FILESYSTEM_TYPE = 'system.filesystem.type' # The memory state - # - # @note StabilityLevel.EXPERIMENTAL + # + # @note Stability Level: experimental SYSTEM_MEMORY_STATE = 'system.memory.state' # A stateless protocol MUST NOT set this attribute - # - # @note StabilityLevel.EXPERIMENTAL + # + # @note Stability Level: experimental SYSTEM_NETWORK_STATE = 'system.network.state' # The paging access direction - # - # @note StabilityLevel.EXPERIMENTAL + # + # @note Stability Level: experimental SYSTEM_PAGING_DIRECTION = 'system.paging.direction' # The memory paging state - # - # @note StabilityLevel.EXPERIMENTAL + # + # @note Stability Level: experimental SYSTEM_PAGING_STATE = 'system.paging.state' # The memory paging type - # - # @note StabilityLevel.EXPERIMENTAL + # + # @note Stability Level: experimental SYSTEM_PAGING_TYPE = 'system.paging.type' # The process state, e.g., [Linux Process State Codes](https://man7.org/linux/man-pages/man1/ps.1.html#PROCESS_STATE_CODES) - # - # @note StabilityLevel.EXPERIMENTAL + # + # @note Stability Level: experimental SYSTEM_PROCESS_STATUS = 'system.process.status' - # Deprecated, use `system.process.status` instead - # - # @note StabilityLevel.EXPERIMENTAL - # - # @deprecated Replaced by `system.process.status` + # Deprecated, use `system.process.status` instead. + # + # @note Stability Level: experimental + # @deprecated Replaced by `system.process.status`. SYSTEM_PROCESSES_STATUS = 'system.processes.status' # @!endgroup @@ -101,6 +100,6 @@ module SYSTEM # @!group Metric Names # @!endgroup end - end # module Incubating + end end end \ No newline at end of file diff --git a/semantic_conventions/lib/opentelemetry/semconv/incubating/telemetry.rb b/semantic_conventions/lib/opentelemetry/semconv/incubating/telemetry.rb index 0fa6358180..8307589f46 100644 --- a/semantic_conventions/lib/opentelemetry/semconv/incubating/telemetry.rb +++ b/semantic_conventions/lib/opentelemetry/semconv/incubating/telemetry.rb @@ -24,45 +24,45 @@ module Incubating module TELEMETRY # @!group Attribute Names - # The name of the auto instrumentation agent or distribution, if used - # + # The name of the auto instrumentation agent or distribution, if used. + # # Official auto instrumentation agents and distributions SHOULD set the `telemetry.distro.name` attribute to - # a string starting with `opentelemetry-`, e.g. `opentelemetry-java-instrumentation` - # - # @note StabilityLevel.EXPERIMENTAL + # a string starting with `opentelemetry-`, e.g. `opentelemetry-java-instrumentation`. + # + # @note Stability Level: experimental TELEMETRY_DISTRO_NAME = 'telemetry.distro.name' - # The version string of the auto instrumentation agent or distribution, if used - # - # @note StabilityLevel.EXPERIMENTAL + # The version string of the auto instrumentation agent or distribution, if used. + # + # @note Stability Level: experimental TELEMETRY_DISTRO_VERSION = 'telemetry.distro.version' - # The language of the telemetry SDK - # - # @note StabilityLevel.STABLE + # The language of the telemetry SDK. + # + # @note Stability Level: stable # - # @deprecated Now available in the stable namespace at {OpenTelemetry::SemConv::TELEMETRY::TELEMETRY_SDK_LANGUAGE}. + # @deprecated Now available in the stable namespace at {OpenTelemetry::SemConv::Telemetry::TELEMETRY_SDK_LANGUAGE}. TELEMETRY_SDK_LANGUAGE = 'telemetry.sdk.language' - # The name of the telemetry SDK as defined above - # + # The name of the telemetry SDK as defined above. + # # The OpenTelemetry SDK MUST set the `telemetry.sdk.name` attribute to `opentelemetry`. - # If another SDK, like a fork or a vendor-provided implementation, is used, this SDK MUST set the - # `telemetry.sdk.name` attribute to the fully-qualified class or module name of this SDK's main entry point - # or another suitable identifier depending on the language. - # The identifier `opentelemetry` is reserved and MUST NOT be used in this case. - # All custom identifiers SHOULD be stable across different versions of an implementation - # - # @note StabilityLevel.STABLE + # If another SDK, like a fork or a vendor-provided implementation, is used, this SDK MUST set the + # `telemetry.sdk.name` attribute to the fully-qualified class or module name of this SDK's main entry point + # or another suitable identifier depending on the language. + # The identifier `opentelemetry` is reserved and MUST NOT be used in this case. + # All custom identifiers SHOULD be stable across different versions of an implementation. + # + # @note Stability Level: stable # - # @deprecated Now available in the stable namespace at {OpenTelemetry::SemConv::TELEMETRY::TELEMETRY_SDK_NAME}. + # @deprecated Now available in the stable namespace at {OpenTelemetry::SemConv::Telemetry::TELEMETRY_SDK_NAME}. TELEMETRY_SDK_NAME = 'telemetry.sdk.name' - # The version string of the telemetry SDK + # The version string of the telemetry SDK. + # + # @note Stability Level: stable # - # @note StabilityLevel.STABLE - # - # @deprecated Now available in the stable namespace at {OpenTelemetry::SemConv::TELEMETRY::TELEMETRY_SDK_VERSION}. + # @deprecated Now available in the stable namespace at {OpenTelemetry::SemConv::Telemetry::TELEMETRY_SDK_VERSION}. TELEMETRY_SDK_VERSION = 'telemetry.sdk.version' # @!endgroup @@ -70,6 +70,6 @@ module TELEMETRY # @!group Metric Names # @!endgroup end - end # module Incubating + end end end \ No newline at end of file diff --git a/semantic_conventions/lib/opentelemetry/semconv/incubating/thread.rb b/semantic_conventions/lib/opentelemetry/semconv/incubating/thread.rb index e2cf4bea33..f93ed3f1c1 100644 --- a/semantic_conventions/lib/opentelemetry/semconv/incubating/thread.rb +++ b/semantic_conventions/lib/opentelemetry/semconv/incubating/thread.rb @@ -24,14 +24,14 @@ module Incubating module THREAD # @!group Attribute Names - # Current "managed" thread ID (as opposed to OS thread ID) - # - # @note StabilityLevel.EXPERIMENTAL + # Current "managed" thread ID (as opposed to OS thread ID). + # + # @note Stability Level: experimental THREAD_ID = 'thread.id' - # Current thread name - # - # @note StabilityLevel.EXPERIMENTAL + # Current thread name. + # + # @note Stability Level: experimental THREAD_NAME = 'thread.name' # @!endgroup @@ -39,6 +39,6 @@ module THREAD # @!group Metric Names # @!endgroup end - end # module Incubating + end end end \ No newline at end of file diff --git a/semantic_conventions/lib/opentelemetry/semconv/incubating/tls.rb b/semantic_conventions/lib/opentelemetry/semconv/incubating/tls.rb index b37554e48a..6d29ea5c53 100644 --- a/semantic_conventions/lib/opentelemetry/semconv/incubating/tls.rb +++ b/semantic_conventions/lib/opentelemetry/semconv/incubating/tls.rb @@ -24,151 +24,151 @@ module Incubating module TLS # @!group Attribute Names - # String indicating the [cipher](https://datatracker.ietf.org/doc/html/rfc5246#appendix-A.5) used during the current connection - # - # The values allowed for `tls.cipher` MUST be one of the `Descriptions` of the [registered TLS Cipher Suits](https://www.iana.org/assignments/tls-parameters/tls-parameters.xhtml#table-tls-parameters-4) - # - # @note StabilityLevel.EXPERIMENTAL + # String indicating the [cipher](https://datatracker.ietf.org/doc/html/rfc5246#appendix-A.5) used during the current connection. + # + # The values allowed for `tls.cipher` MUST be one of the `Descriptions` of the [registered TLS Cipher Suits](https://www.iana.org/assignments/tls-parameters/tls-parameters.xhtml#table-tls-parameters-4). + # + # @note Stability Level: experimental TLS_CIPHER = 'tls.cipher' - # PEM-encoded stand-alone certificate offered by the client. This is usually mutually-exclusive of `client.certificate_chain` since this value also exists in that list - # - # @note StabilityLevel.EXPERIMENTAL + # PEM-encoded stand-alone certificate offered by the client. This is usually mutually-exclusive of `client.certificate_chain` since this value also exists in that list. + # + # @note Stability Level: experimental TLS_CLIENT_CERTIFICATE = 'tls.client.certificate' - # Array of PEM-encoded certificates that make up the certificate chain offered by the client. This is usually mutually-exclusive of `client.certificate` since that value should be the first certificate in the chain - # - # @note StabilityLevel.EXPERIMENTAL + # Array of PEM-encoded certificates that make up the certificate chain offered by the client. This is usually mutually-exclusive of `client.certificate` since that value should be the first certificate in the chain. + # + # @note Stability Level: experimental TLS_CLIENT_CERTIFICATE_CHAIN = 'tls.client.certificate_chain' - # Certificate fingerprint using the MD5 digest of DER-encoded version of certificate offered by the client. For consistency with other hash values, this value should be formatted as an uppercase hash - # - # @note StabilityLevel.EXPERIMENTAL + # Certificate fingerprint using the MD5 digest of DER-encoded version of certificate offered by the client. For consistency with other hash values, this value should be formatted as an uppercase hash. + # + # @note Stability Level: experimental TLS_CLIENT_HASH_MD5 = 'tls.client.hash.md5' - # Certificate fingerprint using the SHA1 digest of DER-encoded version of certificate offered by the client. For consistency with other hash values, this value should be formatted as an uppercase hash - # - # @note StabilityLevel.EXPERIMENTAL + # Certificate fingerprint using the SHA1 digest of DER-encoded version of certificate offered by the client. For consistency with other hash values, this value should be formatted as an uppercase hash. + # + # @note Stability Level: experimental TLS_CLIENT_HASH_SHA1 = 'tls.client.hash.sha1' - # Certificate fingerprint using the SHA256 digest of DER-encoded version of certificate offered by the client. For consistency with other hash values, this value should be formatted as an uppercase hash - # - # @note StabilityLevel.EXPERIMENTAL + # Certificate fingerprint using the SHA256 digest of DER-encoded version of certificate offered by the client. For consistency with other hash values, this value should be formatted as an uppercase hash. + # + # @note Stability Level: experimental TLS_CLIENT_HASH_SHA256 = 'tls.client.hash.sha256' - # Distinguished name of [subject](https://datatracker.ietf.org/doc/html/rfc5280#section-4.1.2.6) of the issuer of the x.509 certificate presented by the client - # - # @note StabilityLevel.EXPERIMENTAL + # Distinguished name of [subject](https://datatracker.ietf.org/doc/html/rfc5280#section-4.1.2.6) of the issuer of the x.509 certificate presented by the client. + # + # @note Stability Level: experimental TLS_CLIENT_ISSUER = 'tls.client.issuer' - # A hash that identifies clients based on how they perform an SSL/TLS handshake - # - # @note StabilityLevel.EXPERIMENTAL + # A hash that identifies clients based on how they perform an SSL/TLS handshake. + # + # @note Stability Level: experimental TLS_CLIENT_JA3 = 'tls.client.ja3' - # Date/Time indicating when client certificate is no longer considered valid - # - # @note StabilityLevel.EXPERIMENTAL + # Date/Time indicating when client certificate is no longer considered valid. + # + # @note Stability Level: experimental TLS_CLIENT_NOT_AFTER = 'tls.client.not_after' - # Date/Time indicating when client certificate is first considered valid - # - # @note StabilityLevel.EXPERIMENTAL + # Date/Time indicating when client certificate is first considered valid. + # + # @note Stability Level: experimental TLS_CLIENT_NOT_BEFORE = 'tls.client.not_before' - # Also called an SNI, this tells the server which hostname to which the client is attempting to connect to - # - # @note StabilityLevel.EXPERIMENTAL + # Also called an SNI, this tells the server which hostname to which the client is attempting to connect to. + # + # @note Stability Level: experimental TLS_CLIENT_SERVER_NAME = 'tls.client.server_name' - # Distinguished name of subject of the x.509 certificate presented by the client - # - # @note StabilityLevel.EXPERIMENTAL + # Distinguished name of subject of the x.509 certificate presented by the client. + # + # @note Stability Level: experimental TLS_CLIENT_SUBJECT = 'tls.client.subject' - # Array of ciphers offered by the client during the client hello - # - # @note StabilityLevel.EXPERIMENTAL + # Array of ciphers offered by the client during the client hello. + # + # @note Stability Level: experimental TLS_CLIENT_SUPPORTED_CIPHERS = 'tls.client.supported_ciphers' # String indicating the curve used for the given cipher, when applicable - # - # @note StabilityLevel.EXPERIMENTAL + # + # @note Stability Level: experimental TLS_CURVE = 'tls.curve' - # Boolean flag indicating if the TLS negotiation was successful and transitioned to an encrypted tunnel - # - # @note StabilityLevel.EXPERIMENTAL + # Boolean flag indicating if the TLS negotiation was successful and transitioned to an encrypted tunnel. + # + # @note Stability Level: experimental TLS_ESTABLISHED = 'tls.established' - # String indicating the protocol being tunneled. Per the values in the [IANA registry](https://www.iana.org/assignments/tls-extensiontype-values/tls-extensiontype-values.xhtml#alpn-protocol-ids), this string should be lower case - # - # @note StabilityLevel.EXPERIMENTAL + # String indicating the protocol being tunneled. Per the values in the [IANA registry](https://www.iana.org/assignments/tls-extensiontype-values/tls-extensiontype-values.xhtml#alpn-protocol-ids), this string should be lower case. + # + # @note Stability Level: experimental TLS_NEXT_PROTOCOL = 'tls.next_protocol' # Normalized lowercase protocol name parsed from original string of the negotiated [SSL/TLS protocol version](https://www.openssl.org/docs/man1.1.1/man3/SSL_get_version.html#RETURN-VALUES) - # - # @note StabilityLevel.EXPERIMENTAL + # + # @note Stability Level: experimental TLS_PROTOCOL_NAME = 'tls.protocol.name' # Numeric part of the version parsed from the original string of the negotiated [SSL/TLS protocol version](https://www.openssl.org/docs/man1.1.1/man3/SSL_get_version.html#RETURN-VALUES) - # - # @note StabilityLevel.EXPERIMENTAL + # + # @note Stability Level: experimental TLS_PROTOCOL_VERSION = 'tls.protocol.version' - # Boolean flag indicating if this TLS connection was resumed from an existing TLS negotiation - # - # @note StabilityLevel.EXPERIMENTAL + # Boolean flag indicating if this TLS connection was resumed from an existing TLS negotiation. + # + # @note Stability Level: experimental TLS_RESUMED = 'tls.resumed' - # PEM-encoded stand-alone certificate offered by the server. This is usually mutually-exclusive of `server.certificate_chain` since this value also exists in that list - # - # @note StabilityLevel.EXPERIMENTAL + # PEM-encoded stand-alone certificate offered by the server. This is usually mutually-exclusive of `server.certificate_chain` since this value also exists in that list. + # + # @note Stability Level: experimental TLS_SERVER_CERTIFICATE = 'tls.server.certificate' - # Array of PEM-encoded certificates that make up the certificate chain offered by the server. This is usually mutually-exclusive of `server.certificate` since that value should be the first certificate in the chain - # - # @note StabilityLevel.EXPERIMENTAL + # Array of PEM-encoded certificates that make up the certificate chain offered by the server. This is usually mutually-exclusive of `server.certificate` since that value should be the first certificate in the chain. + # + # @note Stability Level: experimental TLS_SERVER_CERTIFICATE_CHAIN = 'tls.server.certificate_chain' - # Certificate fingerprint using the MD5 digest of DER-encoded version of certificate offered by the server. For consistency with other hash values, this value should be formatted as an uppercase hash - # - # @note StabilityLevel.EXPERIMENTAL + # Certificate fingerprint using the MD5 digest of DER-encoded version of certificate offered by the server. For consistency with other hash values, this value should be formatted as an uppercase hash. + # + # @note Stability Level: experimental TLS_SERVER_HASH_MD5 = 'tls.server.hash.md5' - # Certificate fingerprint using the SHA1 digest of DER-encoded version of certificate offered by the server. For consistency with other hash values, this value should be formatted as an uppercase hash - # - # @note StabilityLevel.EXPERIMENTAL + # Certificate fingerprint using the SHA1 digest of DER-encoded version of certificate offered by the server. For consistency with other hash values, this value should be formatted as an uppercase hash. + # + # @note Stability Level: experimental TLS_SERVER_HASH_SHA1 = 'tls.server.hash.sha1' - # Certificate fingerprint using the SHA256 digest of DER-encoded version of certificate offered by the server. For consistency with other hash values, this value should be formatted as an uppercase hash - # - # @note StabilityLevel.EXPERIMENTAL + # Certificate fingerprint using the SHA256 digest of DER-encoded version of certificate offered by the server. For consistency with other hash values, this value should be formatted as an uppercase hash. + # + # @note Stability Level: experimental TLS_SERVER_HASH_SHA256 = 'tls.server.hash.sha256' - # Distinguished name of [subject](https://datatracker.ietf.org/doc/html/rfc5280#section-4.1.2.6) of the issuer of the x.509 certificate presented by the client - # - # @note StabilityLevel.EXPERIMENTAL + # Distinguished name of [subject](https://datatracker.ietf.org/doc/html/rfc5280#section-4.1.2.6) of the issuer of the x.509 certificate presented by the client. + # + # @note Stability Level: experimental TLS_SERVER_ISSUER = 'tls.server.issuer' - # A hash that identifies servers based on how they perform an SSL/TLS handshake - # - # @note StabilityLevel.EXPERIMENTAL + # A hash that identifies servers based on how they perform an SSL/TLS handshake. + # + # @note Stability Level: experimental TLS_SERVER_JA3S = 'tls.server.ja3s' - # Date/Time indicating when server certificate is no longer considered valid - # - # @note StabilityLevel.EXPERIMENTAL + # Date/Time indicating when server certificate is no longer considered valid. + # + # @note Stability Level: experimental TLS_SERVER_NOT_AFTER = 'tls.server.not_after' - # Date/Time indicating when server certificate is first considered valid - # - # @note StabilityLevel.EXPERIMENTAL + # Date/Time indicating when server certificate is first considered valid. + # + # @note Stability Level: experimental TLS_SERVER_NOT_BEFORE = 'tls.server.not_before' - # Distinguished name of subject of the x.509 certificate presented by the server - # - # @note StabilityLevel.EXPERIMENTAL + # Distinguished name of subject of the x.509 certificate presented by the server. + # + # @note Stability Level: experimental TLS_SERVER_SUBJECT = 'tls.server.subject' # @!endgroup @@ -176,6 +176,6 @@ module TLS # @!group Metric Names # @!endgroup end - end # module Incubating + end end end \ No newline at end of file diff --git a/semantic_conventions/lib/opentelemetry/semconv/incubating/url.rb b/semantic_conventions/lib/opentelemetry/semconv/incubating/url.rb index cc7862f49a..d1b01a0764 100644 --- a/semantic_conventions/lib/opentelemetry/semconv/incubating/url.rb +++ b/semantic_conventions/lib/opentelemetry/semconv/incubating/url.rb @@ -24,95 +24,100 @@ 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 StabilityLevel.EXPERIMENTAL + # 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: experimental 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 StabilityLevel.EXPERIMENTAL + # 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: experimental URL_EXTENSION = 'url.extension' # The [URI fragment](https://www.rfc-editor.org/rfc/rfc3986#section-3.5) component + # + # @note Stability Level: stable # - # @note StabilityLevel.STABLE - # - # @deprecated Now available in the stable namespace at {OpenTelemetry::SemConv::URL::URL_FRAGMENT}. + # @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 + # `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. + # + # @note Stability Level: stable # - # @note StabilityLevel.STABLE - # - # @deprecated Now available in the stable namespace at {OpenTelemetry::SemConv::URL::URL_FULL}. + # @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 - # + # 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 StabilityLevel.EXPERIMENTAL + # `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: experimental 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 # - # Sensitive content provided in `url.path` SHOULD be scrubbed when instrumentations can identify it - # - # @note StabilityLevel.STABLE - # - # @deprecated Now available in the stable namespace at {OpenTelemetry::SemConv::URL::URL_PATH}. + # @deprecated Now available in the stable namespace at {OpenTelemetry::SemConv::Url::URL_PATH}. URL_PATH = 'url.path' # Port extracted from the `url.full` - # - # @note StabilityLevel.EXPERIMENTAL + # + # @note Stability Level: experimental 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. + # + # @note Stability Level: stable # - # Sensitive content provided in `url.query` SHOULD be scrubbed when instrumentations can identify it - # - # @note StabilityLevel.STABLE - # - # @deprecated Now available in the stable namespace at {OpenTelemetry::SemConv::URL::URL_QUERY}. + # @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](http://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 StabilityLevel.EXPERIMENTAL + # The highest registered url domain, stripped of the subdomain. + # + # This value can be determined precisely with the [public suffix list](http://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: experimental 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 StabilityLevel.STABLE + # The [URI scheme](https://www.rfc-editor.org/rfc/rfc3986#section-3.1) component identifying the used protocol. + # + # @note Stability Level: stable # - # @deprecated Now available in the stable namespace at {OpenTelemetry::SemConv::URL::URL_SCHEME}. + # @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 StabilityLevel.EXPERIMENTAL + # 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: experimental URL_SUBDOMAIN = 'url.subdomain' - # 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](http://publicsuffix.org) - # - # @note StabilityLevel.EXPERIMENTAL + # The low-cardinality template of an [absolute path reference](https://www.rfc-editor.org/rfc/rfc3986#section-4.2). + # + # @note Stability Level: experimental + 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](http://publicsuffix.org). + # + # @note Stability Level: experimental URL_TOP_LEVEL_DOMAIN = 'url.top_level_domain' # @!endgroup @@ -120,6 +125,6 @@ module URL # @!group Metric Names # @!endgroup end - end # module Incubating + end end end \ No newline at end of file diff --git a/semantic_conventions/lib/opentelemetry/semconv/incubating/user_agent.rb b/semantic_conventions/lib/opentelemetry/semconv/incubating/user_agent.rb index 7c37cc6247..338695f25b 100644 --- a/semantic_conventions/lib/opentelemetry/semconv/incubating/user_agent.rb +++ b/semantic_conventions/lib/opentelemetry/semconv/incubating/user_agent.rb @@ -24,25 +24,25 @@ module Incubating module USER_AGENT # @!group Attribute Names - # Name of the user-agent extracted from original. Usually refers to the browser's name - # + # 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 StabilityLevel.EXPERIMENTAL + # + # @note Stability Level: experimental 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 StabilityLevel.STABLE + # 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 # - # @deprecated Now available in the stable namespace at {OpenTelemetry::SemConv::USER_AGENT::USER_AGENT_ORIGINAL}. + # @deprecated Now available in the stable namespace at {OpenTelemetry::SemConv::UserAgent::USER_AGENT_ORIGINAL}. USER_AGENT_ORIGINAL = 'user_agent.original' # 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 StabilityLevel.EXPERIMENTAL + # + # @note Stability Level: experimental USER_AGENT_VERSION = 'user_agent.version' # @!endgroup @@ -50,6 +50,6 @@ module USER_AGENT # @!group Metric Names # @!endgroup end - end # module Incubating + end end end \ No newline at end of file diff --git a/semantic_conventions/lib/opentelemetry/semconv/incubating/webengine.rb b/semantic_conventions/lib/opentelemetry/semconv/incubating/webengine.rb index 56448fe3ea..05f6fef153 100644 --- a/semantic_conventions/lib/opentelemetry/semconv/incubating/webengine.rb +++ b/semantic_conventions/lib/opentelemetry/semconv/incubating/webengine.rb @@ -24,19 +24,19 @@ module Incubating module WEBENGINE # @!group Attribute Names - # Additional description of the web engine (e.g. detailed version and edition information) - # - # @note StabilityLevel.EXPERIMENTAL + # Additional description of the web engine (e.g. detailed version and edition information). + # + # @note Stability Level: experimental WEBENGINE_DESCRIPTION = 'webengine.description' - # The name of the web engine - # - # @note StabilityLevel.EXPERIMENTAL + # The name of the web engine. + # + # @note Stability Level: experimental WEBENGINE_NAME = 'webengine.name' - # The version of the web engine - # - # @note StabilityLevel.EXPERIMENTAL + # The version of the web engine. + # + # @note Stability Level: experimental WEBENGINE_VERSION = 'webengine.version' # @!endgroup @@ -44,6 +44,6 @@ module WEBENGINE # @!group Metric Names # @!endgroup end - end # module Incubating + end end end \ No newline at end of file diff --git a/semantic_conventions/lib/opentelemetry/semconv/jvm.rb b/semantic_conventions/lib/opentelemetry/semconv/jvm.rb index abbd3e2d37..1bf54d467f 100644 --- a/semantic_conventions/lib/opentelemetry/semconv/jvm.rb +++ b/semantic_conventions/lib/opentelemetry/semconv/jvm.rb @@ -23,40 +23,40 @@ module SemConv module JVM # @!group Attribute Names - # Name of the garbage collector action - # - # Garbage collector action is generally obtained via [GarbageCollectionNotificationInfo#getGcAction()](https://docs.oracle.com/en/java/javase/11/docs/api/jdk.management/com/sun/management/GarbageCollectionNotificationInfo.html#getGcAction()) - # - # @note StabilityLevel.STABLE + # Name of the garbage collector action. + # + # Garbage collector action is generally obtained via [GarbageCollectionNotificationInfo#getGcAction()](https://docs.oracle.com/en/java/javase/11/docs/api/jdk.management/com/sun/management/GarbageCollectionNotificationInfo.html#getGcAction()). + # + # @note Stability Level: stable JVM_GC_ACTION = 'jvm.gc.action' - # Name of the garbage collector - # - # Garbage collector name is generally obtained via [GarbageCollectionNotificationInfo#getGcName()](https://docs.oracle.com/en/java/javase/11/docs/api/jdk.management/com/sun/management/GarbageCollectionNotificationInfo.html#getGcName()) - # - # @note StabilityLevel.STABLE + # Name of the garbage collector. + # + # Garbage collector name is generally obtained via [GarbageCollectionNotificationInfo#getGcName()](https://docs.oracle.com/en/java/javase/11/docs/api/jdk.management/com/sun/management/GarbageCollectionNotificationInfo.html#getGcName()). + # + # @note Stability Level: stable JVM_GC_NAME = 'jvm.gc.name' - # Name of the memory pool - # - # Pool names are generally obtained via [MemoryPoolMXBean#getName()](https://docs.oracle.com/en/java/javase/11/docs/api/java.management/java/lang/management/MemoryPoolMXBean.html#getName()) - # - # @note StabilityLevel.STABLE + # Name of the memory pool. + # + # Pool names are generally obtained via [MemoryPoolMXBean#getName()](https://docs.oracle.com/en/java/javase/11/docs/api/java.management/java/lang/management/MemoryPoolMXBean.html#getName()). + # + # @note Stability Level: stable JVM_MEMORY_POOL_NAME = 'jvm.memory.pool.name' - # The type of memory - # - # @note StabilityLevel.STABLE + # The type of memory. + # + # @note Stability Level: stable JVM_MEMORY_TYPE = 'jvm.memory.type' - # Whether the thread is daemon or not - # - # @note StabilityLevel.STABLE + # Whether the thread is daemon or not. + # + # @note Stability Level: stable JVM_THREAD_DAEMON = 'jvm.thread.daemon' - # State of the thread - # - # @note StabilityLevel.STABLE + # State of the thread. + # + # @note Stability Level: stable JVM_THREAD_STATE = 'jvm.thread.state' # @!endgroup diff --git a/semantic_conventions/lib/opentelemetry/semconv/network.rb b/semantic_conventions/lib/opentelemetry/semconv/network.rb index 15bdf963a7..a9d4041fc2 100644 --- a/semantic_conventions/lib/opentelemetry/semconv/network.rb +++ b/semantic_conventions/lib/opentelemetry/semconv/network.rb @@ -23,56 +23,56 @@ module SemConv module NETWORK # @!group Attribute Names - # Local address of the network connection - IP address or Unix domain socket name - # - # @note StabilityLevel.STABLE + # Local address of the network connection - IP address or Unix domain socket name. + # + # @note Stability Level: stable NETWORK_LOCAL_ADDRESS = 'network.local.address' - # Local port number of the network connection - # - # @note StabilityLevel.STABLE + # Local port number of the network connection. + # + # @note Stability Level: stable NETWORK_LOCAL_PORT = 'network.local.port' - # Peer address of the network connection - IP address or Unix domain socket name - # - # @note StabilityLevel.STABLE + # Peer address of the network connection - IP address or Unix domain socket name. + # + # @note Stability Level: stable NETWORK_PEER_ADDRESS = 'network.peer.address' - # Peer port number of the network connection - # - # @note StabilityLevel.STABLE + # Peer port number of the network connection. + # + # @note Stability Level: stable NETWORK_PEER_PORT = 'network.peer.port' - # [OSI application layer](https://osi-model.com/application-layer/) or non-OSI equivalent - # - # The value SHOULD be normalized to lowercase - # - # @note StabilityLevel.STABLE + # [OSI application layer](https://osi-model.com/application-layer/) or non-OSI equivalent. + # + # The value SHOULD be normalized to lowercase. + # + # @note Stability Level: stable NETWORK_PROTOCOL_NAME = 'network.protocol.name' - # The actual version of the protocol used for network communication - # - # If protocol version is subject to negotiation (for example using [ALPN](https://www.rfc-editor.org/rfc/rfc7301.html)), this attribute SHOULD be set to the negotiated version. If the actual protocol version is not known, this attribute SHOULD NOT be set - # - # @note StabilityLevel.STABLE + # The actual version of the protocol used for network communication. + # + # If protocol version is subject to negotiation (for example using [ALPN](https://www.rfc-editor.org/rfc/rfc7301.html)), this attribute SHOULD be set to the negotiated version. If the actual protocol version is not known, this attribute SHOULD NOT be set. + # + # @note Stability Level: stable NETWORK_PROTOCOL_VERSION = 'network.protocol.version' - # [OSI transport layer](https://osi-model.com/transport-layer/) or [inter-process communication method](https://wikipedia.org/wiki/Inter-process_communication) - # + # [OSI transport layer](https://osi-model.com/transport-layer/) or [inter-process communication method](https://wikipedia.org/wiki/Inter-process_communication). + # # The value SHOULD be normalized to lowercase. - # - # Consider always setting the transport when setting a port number, since - # a port number is ambiguous without knowing the transport. For example - # different processes could be listening on TCP port 12345 and UDP port 12345 - # - # @note StabilityLevel.STABLE + # + # Consider always setting the transport when setting a port number, since + # a port number is ambiguous without knowing the transport. For example + # different processes could be listening on TCP port 12345 and UDP port 12345. + # + # @note Stability Level: stable NETWORK_TRANSPORT = 'network.transport' - # [OSI network layer](https://osi-model.com/network-layer/) or non-OSI equivalent - # - # The value SHOULD be normalized to lowercase - # - # @note StabilityLevel.STABLE + # [OSI network layer](https://osi-model.com/network-layer/) or non-OSI equivalent. + # + # The value SHOULD be normalized to lowercase. + # + # @note Stability Level: stable NETWORK_TYPE = 'network.type' # @!endgroup diff --git a/semantic_conventions/lib/opentelemetry/semconv/otel.rb b/semantic_conventions/lib/opentelemetry/semconv/otel.rb index 699a11d7ce..2d83fd08c1 100644 --- a/semantic_conventions/lib/opentelemetry/semconv/otel.rb +++ b/semantic_conventions/lib/opentelemetry/semconv/otel.rb @@ -23,24 +23,24 @@ module SemConv module OTEL # @!group Attribute Names - # The name of the instrumentation scope - (`InstrumentationScope.Name` in OTLP) - # - # @note StabilityLevel.STABLE + # The name of the instrumentation scope - (`InstrumentationScope.Name` in OTLP). + # + # @note Stability Level: stable OTEL_SCOPE_NAME = 'otel.scope.name' - # The version of the instrumentation scope - (`InstrumentationScope.Version` in OTLP) - # - # @note StabilityLevel.STABLE + # The version of the instrumentation scope - (`InstrumentationScope.Version` in OTLP). + # + # @note Stability Level: stable OTEL_SCOPE_VERSION = 'otel.scope.version' - # Name of the code, either "OK" or "ERROR". MUST NOT be set if the status code is UNSET - # - # @note StabilityLevel.STABLE + # Name of the code, either "OK" or "ERROR". MUST NOT be set if the status code is UNSET. + # + # @note Stability Level: stable OTEL_STATUS_CODE = 'otel.status_code' - # Description of the Status if it has a value, otherwise not set - # - # @note StabilityLevel.STABLE + # Description of the Status if it has a value, otherwise not set. + # + # @note Stability Level: stable OTEL_STATUS_DESCRIPTION = 'otel.status_description' # @!endgroup diff --git a/semantic_conventions/lib/opentelemetry/semconv/server.rb b/semantic_conventions/lib/opentelemetry/semconv/server.rb index 1b5132e3da..43343cca59 100644 --- a/semantic_conventions/lib/opentelemetry/semconv/server.rb +++ b/semantic_conventions/lib/opentelemetry/semconv/server.rb @@ -23,18 +23,18 @@ module SemConv module SERVER # @!group Attribute Names - # Server domain name if available without reverse DNS lookup; otherwise, IP address or Unix domain socket name - # - # When observed from the client side, and when communicating through an intermediary, `server.address` SHOULD represent the server address behind any intermediaries, for example proxies, if it's available - # - # @note StabilityLevel.STABLE + # Server domain name if available without reverse DNS lookup; otherwise, IP address or Unix domain socket name. + # + # When observed from the client side, and when communicating through an intermediary, `server.address` SHOULD represent the server address behind any intermediaries, for example proxies, if it's available. + # + # @note Stability Level: stable SERVER_ADDRESS = 'server.address' - # Server port number - # - # When observed from the client side, and when communicating through an intermediary, `server.port` SHOULD represent the server port behind any intermediaries, for example proxies, if it's available - # - # @note StabilityLevel.STABLE + # Server port number. + # + # When observed from the client side, and when communicating through an intermediary, `server.port` SHOULD represent the server port behind any intermediaries, for example proxies, if it's available. + # + # @note Stability Level: stable SERVER_PORT = 'server.port' # @!endgroup diff --git a/semantic_conventions/lib/opentelemetry/semconv/service.rb b/semantic_conventions/lib/opentelemetry/semconv/service.rb index d3ae0a44d8..7d8fd31e4b 100644 --- a/semantic_conventions/lib/opentelemetry/semconv/service.rb +++ b/semantic_conventions/lib/opentelemetry/semconv/service.rb @@ -23,16 +23,16 @@ module SemConv module SERVICE # @!group Attribute Names - # Logical name of the service - # - # 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` - # - # @note StabilityLevel.STABLE + # Logical name of the service. + # + # MUST be the same for all instances of horizontally scaled services. If the value was not specified, SDKs MUST fallback to `unknown_service:` concatenated with [`process.executable.name`](process.md), e.g. `unknown_service:bash`. If `process.executable.name` is not available, the value MUST be set to `unknown_service`. + # + # @note Stability Level: stable SERVICE_NAME = 'service.name' - # The version string of the service API or implementation. The format is not defined by these conventions - # - # @note StabilityLevel.STABLE + # The version string of the service API or implementation. The format is not defined by these conventions. + # + # @note Stability Level: stable SERVICE_VERSION = 'service.version' # @!endgroup diff --git a/semantic_conventions/lib/opentelemetry/semconv/signalr.rb b/semantic_conventions/lib/opentelemetry/semconv/signalr.rb index 1fc16ebfbd..715212e97c 100644 --- a/semantic_conventions/lib/opentelemetry/semconv/signalr.rb +++ b/semantic_conventions/lib/opentelemetry/semconv/signalr.rb @@ -23,14 +23,14 @@ module SemConv module SIGNALR # @!group Attribute Names - # SignalR HTTP connection closure status - # - # @note StabilityLevel.STABLE + # SignalR HTTP connection closure status. + # + # @note Stability Level: stable SIGNALR_CONNECTION_STATUS = 'signalr.connection.status' # [SignalR transport type](https://github.com/dotnet/aspnetcore/blob/main/src/SignalR/docs/specs/TransportProtocols.md) - # - # @note StabilityLevel.STABLE + # + # @note Stability Level: stable SIGNALR_TRANSPORT = 'signalr.transport' # @!endgroup diff --git a/semantic_conventions/lib/opentelemetry/semconv/telemetry.rb b/semantic_conventions/lib/opentelemetry/semconv/telemetry.rb index 47c5fe043c..8fdca7bc02 100644 --- a/semantic_conventions/lib/opentelemetry/semconv/telemetry.rb +++ b/semantic_conventions/lib/opentelemetry/semconv/telemetry.rb @@ -23,26 +23,26 @@ module SemConv module TELEMETRY # @!group Attribute Names - # The language of the telemetry SDK - # - # @note StabilityLevel.STABLE + # The language of the telemetry SDK. + # + # @note Stability Level: stable TELEMETRY_SDK_LANGUAGE = 'telemetry.sdk.language' - # The name of the telemetry SDK as defined above - # + # The name of the telemetry SDK as defined above. + # # The OpenTelemetry SDK MUST set the `telemetry.sdk.name` attribute to `opentelemetry`. - # If another SDK, like a fork or a vendor-provided implementation, is used, this SDK MUST set the - # `telemetry.sdk.name` attribute to the fully-qualified class or module name of this SDK's main entry point - # or another suitable identifier depending on the language. - # The identifier `opentelemetry` is reserved and MUST NOT be used in this case. - # All custom identifiers SHOULD be stable across different versions of an implementation - # - # @note StabilityLevel.STABLE + # If another SDK, like a fork or a vendor-provided implementation, is used, this SDK MUST set the + # `telemetry.sdk.name` attribute to the fully-qualified class or module name of this SDK's main entry point + # or another suitable identifier depending on the language. + # The identifier `opentelemetry` is reserved and MUST NOT be used in this case. + # All custom identifiers SHOULD be stable across different versions of an implementation. + # + # @note Stability Level: stable TELEMETRY_SDK_NAME = 'telemetry.sdk.name' - # The version string of the telemetry SDK - # - # @note StabilityLevel.STABLE + # The version string of the telemetry SDK. + # + # @note Stability Level: stable TELEMETRY_SDK_VERSION = 'telemetry.sdk.version' # @!endgroup diff --git a/semantic_conventions/lib/opentelemetry/semconv/url.rb b/semantic_conventions/lib/opentelemetry/semconv/url.rb index 00ee7831ef..3acdd31049 100644 --- a/semantic_conventions/lib/opentelemetry/semconv/url.rb +++ b/semantic_conventions/lib/opentelemetry/semconv/url.rb @@ -24,36 +24,36 @@ module URL # @!group Attribute Names # The [URI fragment](https://www.rfc-editor.org/rfc/rfc3986#section-3.5) component - # - # @note StabilityLevel.STABLE + # + # @note Stability Level: stable 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 - # - # @note StabilityLevel.STABLE + # `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. + # + # @note Stability Level: stable URL_FULL = 'url.full' # 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 StabilityLevel.STABLE + # + # Sensitive content provided in `url.path` SHOULD be scrubbed when instrumentations can identify it. + # + # @note Stability Level: stable URL_PATH = 'url.path' # 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 - # - # @note StabilityLevel.STABLE + # + # Sensitive content provided in `url.query` SHOULD be scrubbed when instrumentations can identify it. + # + # @note Stability Level: stable URL_QUERY = 'url.query' - # The [URI scheme](https://www.rfc-editor.org/rfc/rfc3986#section-3.1) component identifying the used protocol - # - # @note StabilityLevel.STABLE + # The [URI scheme](https://www.rfc-editor.org/rfc/rfc3986#section-3.1) component identifying the used protocol. + # + # @note Stability Level: stable URL_SCHEME = 'url.scheme' # @!endgroup diff --git a/semantic_conventions/lib/opentelemetry/semconv/user_agent.rb b/semantic_conventions/lib/opentelemetry/semconv/user_agent.rb index 64c43de9c4..b85a09473e 100644 --- a/semantic_conventions/lib/opentelemetry/semconv/user_agent.rb +++ b/semantic_conventions/lib/opentelemetry/semconv/user_agent.rb @@ -23,9 +23,9 @@ module SemConv module USER_AGENT # @!group Attribute Names - # Value of the [HTTP User-Agent](https://www.rfc-editor.org/rfc/rfc9110.html#field.user-agent) header sent by the client - # - # @note StabilityLevel.STABLE + # 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 USER_AGENT_ORIGINAL = 'user_agent.original' # @!endgroup diff --git a/semantic_conventions/templates/attributes.j2 b/semantic_conventions/templates/attributes.j2 deleted file mode 100644 index 4cb04ba905..0000000000 --- a/semantic_conventions/templates/attributes.j2 +++ /dev/null @@ -1,66 +0,0 @@ -{#- -# 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. -#} -{%- import 'common.j2' as common -%} -{%- if selector == 'any' -%} -{%- set filtered_attributes = attributes_and_templates | list -%} -{%- set gen_incubating = true -%} -{%- elif selector == 'is_stable' -%} -{%- set filtered_attributes = attributes_and_templates | select(selector) | list -%} -{%- set gen_incubating = false -%} -{%- endif -%} -{%- if filtered_attributes | count > 0 -%} {# only produce code if there are attributes #} -{{- common.file_header() }} - -module OpenTelemetry - module SemConv - {%- if gen_incubating %} - module Incubating - {%- endif %} - module {{ root_namespace | to_const_name }} - # @!group Attribute Names - {% for attribute in filtered_attributes %} - # {{ common.to_docstring(attribute.brief) }} - {%- if attribute.note %} - # - # {{ common.to_docstring(attribute.note) }} - {%- endif %} - # - # @note {{ attribute.stability }} - {%- if attribute | is_deprecated %} - # - # @deprecated {{ common.to_docstring(attribute.deprecated) }} - {%- elif attribute | is_stable and gen_incubating %} - # - # @deprecated Now available in the stable namespace at {OpenTelemetry::SemConv::{{ root_namespace | to_const_name }}::{{ attribute.fqn | to_const_name }}}. - {%- endif %} - {%- if attribute.fqn not in excluded_attributes %} - {%- if attribute | is_template %} - {{ attribute.fqn | to_const_name }}_LAMBDA = -> (key) { "{{ attribute.fqn }}.#{key}" } - {%- else %} - {{ attribute.fqn | to_const_name }} = '{{ attribute.fqn }}' - {%- endif %} - {%- endif %} - {% endfor %} - # @!endgroup - - # @!group Metric Names - # @!endgroup - end - {%- if gen_incubating %} - end # module Incubating - {%- endif %} - end -end -{%- endif -%} {# only produce code if there are attributes #} diff --git a/semantic_conventions/templates/registry/ruby/attributes.j2 b/semantic_conventions/templates/registry/ruby/attributes.j2 new file mode 100644 index 0000000000..4e7b8f7cd3 --- /dev/null +++ b/semantic_conventions/templates/registry/ruby/attributes.j2 @@ -0,0 +1,57 @@ +{#- +# 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. +#} +{%- import 'common.j2' as common -%} +{{- common.file_header() }} + +module OpenTelemetry + module SemConv + {%- if params.incubating %} + module Incubating + {%- endif %} + module {{ ctx.root_namespace | screaming_snake_case }} + # @!group Attribute Names + {% for attribute in ctx.attributes | rejectattr("name", "in", params.excluded_attributes) %} + {%- set attr_const_name = attribute.name | screaming_snake_case %} + {%- if attribute.type is template_type %} + {%- set attr_const_name = attr_const_name ~ "_LAMBDA" %} + {%- endif %} + {{ [attribute.brief, + concat_if("\n", attribute.note), + concat_if("\n@note Stability Level: ", attribute.stability), + ] | comment(indent=6) }} + {%- if attribute is deprecated %} + {{ concat_if("\n@deprecated ", attribute.deprecated) | comment(indent=6)}} + {%- elif attribute is stable and params.incubating %} + # + # @deprecated Now available in the stable namespace at {OpenTelemetry::SemConv::{{ ctx.root_namespace | pascal_case }}::{{ attr_const_name }}}. + {%- endif %} + {%- if attribute.fqn not in excluded_attributes %} + {%- if attribute.type is template_type %} + {{ attr_const_name }} = ->(key) { "{{ attribute.name }}.#{key}" } + {%- else %} + {{ attr_const_name }} = '{{ attribute.name }}' + {%- endif %} + {%- endif %} + {% endfor %} + # @!endgroup + + # @!group Metric Names + # @!endgroup + end + {%- if params.incubating %} + end + {%- endif %} + end +end diff --git a/semantic_conventions/templates/common.j2 b/semantic_conventions/templates/registry/ruby/common.j2 similarity index 91% rename from semantic_conventions/templates/common.j2 rename to semantic_conventions/templates/registry/ruby/common.j2 index 432c05e8dc..8b6de0dba3 100644 --- a/semantic_conventions/templates/common.j2 +++ b/semantic_conventions/templates/registry/ruby/common.j2 @@ -21,5 +21,5 @@ {%- endmacro -%} {%- macro to_docstring(str) -%} -{{ str | to_doc_brief | regex_replace(pattern="\n", replace="\n # ") }} +{{ str | comment }} {%- endmacro -%} diff --git a/semantic_conventions/templates/registry/ruby/weaver.yaml b/semantic_conventions/templates/registry/ruby/weaver.yaml new file mode 100644 index 0000000000..c6e9fbe497 --- /dev/null +++ b/semantic_conventions/templates/registry/ruby/weaver.yaml @@ -0,0 +1,34 @@ +params: + excluded_namespaces: [] + excluded_attributes: ["messaging.client_id"] + +templates: + # stable + - template: attributes.j2 + application_mode: each + filter: > + semconv_grouped_attributes({ + "exclude_root_namespace": $excluded_namespaces, + "exclude_stability": ["experimental", "deprecated"], + "exclude_deprecated": false + }) + file_name: "{{ctx.root_namespace | snake_case}}.rb" + # incubating + - pattern: attributes.j2 + application_mode: each + filter: > + semconv_grouped_attributes({ + "exclude_root_namespace": $excluded_namespaces, + "exclude_stability": [], + "exclude_deprecated": false + }) + file_name: "incubating/{{ctx.root_namespace | snake_case}}.rb" + params: + incubating: true + +default_comment_format: yard_doc +comment_formats: + yard_doc: + format: markdown + prefix: "# " + From af1516bc91cc5d804c29f8ee0787957739fb188c Mon Sep 17 00:00:00 2001 From: Robb Kidd Date: Mon, 16 Sep 2024 17:12:51 -0400 Subject: [PATCH 15/17] generate separate attrs and metrics files Each root namespace gets separate attributes and metrics files. Include examples of possible values for attributes. Include a usage example of the template attributes as lambdas. Fix links in doc comments referencing stable constants. Co-authored-by: Hannah Ramadan Co-authored-by: Kayla Reopelle --- semantic_conventions/Rakefile | 2 +- .../attributes.rb} | 36 +++- .../semconv/aspnetcore/metrics.rb | 83 ++++++++ .../{client.rb => client/attributes.rb} | 13 +- .../semconv/{error.rb => error/attributes.rb} | 10 +- .../exception.rb => exception/attributes.rb} | 21 +- .../semconv/{http.rb => http/attributes.rb} | 50 ++++- .../lib/opentelemetry/semconv/http/metrics.rb | 39 ++++ .../{android.rb => android/attributes.rb} | 8 +- .../attributes.rb} | 50 ++++- .../semconv/incubating/aspnetcore/metrics.rb | 99 ++++++++++ .../incubating/{aws.rb => aws/attributes.rb} | 172 +++++++++++++++- .../{browser.rb => browser/attributes.rb} | 22 ++- .../{client.rb => client/attributes.rb} | 17 +- .../{cloud.rb => cloud/attributes.rb} | 23 ++- .../attributes.rb} | 27 ++- .../{code.rb => code/attributes.rb} | 27 ++- .../{container.rb => container/attributes.rb} | 72 ++++++- .../semconv/incubating/container/metrics.rb | 59 ++++++ .../incubating/{db.rb => db/attributes.rb} | 158 ++++++++++++++- .../semconv/incubating/db/metrics.rb | 135 +++++++++++++ .../attributes.rb} | 8 +- .../attributes.rb} | 14 +- .../{device.rb => device/attributes.rb} | 22 ++- .../{disk.rb => disk/attributes.rb} | 7 +- .../incubating/{dns.rb => dns/attributes.rb} | 8 +- .../semconv/incubating/dns/metrics.rb | 36 ++++ .../{enduser.rb => enduser/attributes.rb} | 15 +- .../{error.rb => error/attributes.rb} | 12 +- .../{event.rb => event/attributes.rb} | 8 +- .../exception/attributes.rb} | 27 ++- .../{faas.rb => faas/attributes.rb} | 55 +++++- .../semconv/incubating/faas/metrics.rb | 76 +++++++ .../attributes.rb} | 17 +- .../{file.rb => file/attributes.rb} | 22 ++- .../incubating/{gcp.rb => gcp/attributes.rb} | 23 ++- .../{gen_ai.rb => gen_ai/attributes.rb} | 51 ++++- .../{graphql.rb => graphql/attributes.rb} | 17 +- .../{heroku.rb => heroku/attributes.rb} | 15 +- .../{host.rb => host/attributes.rb} | 65 +++++- .../{http.rb => http/attributes.rb} | 141 ++++++++++++- .../semconv/incubating/http/metrics.rb | 93 +++++++++ .../incubating/{ios.rb => ios/attributes.rb} | 3 - .../incubating/{jvm.rb => jvm/attributes.rb} | 46 ++++- .../semconv/incubating/jvm/metrics.rb | 151 ++++++++++++++ .../incubating/{k8s.rb => k8s/attributes.rb} | 122 +++++++++++- .../semconv/incubating/kestrel/metrics.rb | 106 ++++++++++ .../incubating/{log.rb => log/attributes.rb} | 23 ++- .../{message.rb => message/attributes.rb} | 3 - .../{messaging.rb => messaging/attributes.rb} | 149 +++++++++++++- .../semconv/incubating/messaging/metrics.rb | 61 ++++++ .../incubating/{net.rb => net/attributes.rb} | 57 +++++- .../{network.rb => network/attributes.rb} | 86 ++++++-- .../incubating/{oci.rb => oci/attributes.rb} | 7 +- .../attributes.rb} | 3 - .../incubating/{os.rb => os/attributes.rb} | 25 ++- .../{otel.rb => otel/attributes.rb} | 31 ++- .../{other.rb => other/attributes.rb} | 7 +- .../{peer.rb => peer/attributes.rb} | 7 +- .../{pool.rb => pool/attributes.rb} | 7 +- .../{process.rb => process/attributes.rb} | 96 ++++++++- .../semconv/incubating/process/metrics.rb | 81 ++++++++ .../incubating/{rpc.rb => rpc/attributes.rb} | 72 ++++++- .../semconv/incubating/rpc/metrics.rb | 115 +++++++++++ .../{server.rb => server/attributes.rb} | 19 +- .../{service.rb => service/attributes.rb} | 24 ++- .../{session.rb => session/attributes.rb} | 11 +- .../{signalr.rb => signalr/attributes.rb} | 17 +- .../semconv/incubating/signalr/metrics.rb | 49 +++++ .../{source.rb => source/attributes.rb} | 14 +- .../{system.rb => system/attributes.rb} | 61 +++++- .../semconv/incubating/system/metrics.rb | 185 ++++++++++++++++++ .../{telemetry.rb => telemetry/attributes.rb} | 25 ++- .../{thread.rb => thread/attributes.rb} | 11 +- .../incubating/{tls.rb => tls/attributes.rb} | 119 ++++++++++- .../incubating/{url.rb => url/attributes.rb} | 78 +++++++- .../attributes.rb} | 21 +- .../{webengine.rb => webengine/attributes.rb} | 15 +- .../semconv/{jvm.rb => jvm/attributes.rb} | 29 ++- .../lib/opentelemetry/semconv/jvm/metrics.rb | 91 +++++++++ .../opentelemetry/semconv/kestrel/metrics.rb | 88 +++++++++ .../{network.rb => network/attributes.rb} | 42 +++- .../semconv/{otel.rb => otel/attributes.rb} | 15 +- .../{server.rb => server/attributes.rb} | 15 +- .../{service.rb => service/attributes.rb} | 12 +- .../{signalr.rb => signalr/attributes.rb} | 13 +- .../opentelemetry/semconv/signalr/metrics.rb | 43 ++++ .../{telemetry.rb => telemetry/attributes.rb} | 11 +- .../semconv/{url.rb => url/attributes.rb} | 26 ++- .../attributes.rb} | 9 +- .../templates/registry/ruby/attributes.j2 | 39 ++-- .../templates/registry/ruby/metrics.j2 | 52 +++++ .../templates/registry/ruby/weaver.yaml | 24 ++- 93 files changed, 3986 insertions(+), 285 deletions(-) rename semantic_conventions/lib/opentelemetry/semconv/{aspnetcore.rb => aspnetcore/attributes.rb} (80%) create mode 100644 semantic_conventions/lib/opentelemetry/semconv/aspnetcore/metrics.rb rename semantic_conventions/lib/opentelemetry/semconv/{client.rb => client/attributes.rb} (89%) rename semantic_conventions/lib/opentelemetry/semconv/{error.rb => error/attributes.rb} (93%) rename semantic_conventions/lib/opentelemetry/semconv/{incubating/exception.rb => exception/attributes.rb} (84%) rename semantic_conventions/lib/opentelemetry/semconv/{http.rb => http/attributes.rb} (80%) create mode 100644 semantic_conventions/lib/opentelemetry/semconv/http/metrics.rb rename semantic_conventions/lib/opentelemetry/semconv/incubating/{android.rb => android/attributes.rb} (95%) rename semantic_conventions/lib/opentelemetry/semconv/incubating/{aspnetcore.rb => aspnetcore/attributes.rb} (74%) create mode 100644 semantic_conventions/lib/opentelemetry/semconv/incubating/aspnetcore/metrics.rb rename semantic_conventions/lib/opentelemetry/semconv/incubating/{aws.rb => aws/attributes.rb} (73%) rename semantic_conventions/lib/opentelemetry/semconv/incubating/{browser.rb => browser/attributes.rb} (89%) rename semantic_conventions/lib/opentelemetry/semconv/incubating/{client.rb => client/attributes.rb} (86%) rename semantic_conventions/lib/opentelemetry/semconv/incubating/{cloud.rb => cloud/attributes.rb} (88%) rename semantic_conventions/lib/opentelemetry/semconv/incubating/{cloudevents.rb => cloudevents/attributes.rb} (81%) rename semantic_conventions/lib/opentelemetry/semconv/incubating/{code.rb => code/attributes.rb} (78%) rename semantic_conventions/lib/opentelemetry/semconv/incubating/{container.rb => container/attributes.rb} (71%) create mode 100644 semantic_conventions/lib/opentelemetry/semconv/incubating/container/metrics.rb rename semantic_conventions/lib/opentelemetry/semconv/incubating/{db.rb => db/attributes.rb} (76%) create mode 100644 semantic_conventions/lib/opentelemetry/semconv/incubating/db/metrics.rb rename semantic_conventions/lib/opentelemetry/semconv/incubating/{deployment.rb => deployment/attributes.rb} (94%) rename semantic_conventions/lib/opentelemetry/semconv/incubating/{destination.rb => destination/attributes.rb} (88%) rename semantic_conventions/lib/opentelemetry/semconv/incubating/{device.rb => device/attributes.rb} (88%) rename semantic_conventions/lib/opentelemetry/semconv/incubating/{disk.rb => disk/attributes.rb} (94%) rename semantic_conventions/lib/opentelemetry/semconv/incubating/{dns.rb => dns/attributes.rb} (92%) create mode 100644 semantic_conventions/lib/opentelemetry/semconv/incubating/dns/metrics.rb rename semantic_conventions/lib/opentelemetry/semconv/incubating/{enduser.rb => enduser/attributes.rb} (89%) rename semantic_conventions/lib/opentelemetry/semconv/incubating/{error.rb => error/attributes.rb} (91%) rename semantic_conventions/lib/opentelemetry/semconv/incubating/{event.rb => event/attributes.rb} (92%) rename semantic_conventions/lib/opentelemetry/semconv/{exception.rb => incubating/exception/attributes.rb} (73%) rename semantic_conventions/lib/opentelemetry/semconv/incubating/{faas.rb => faas/attributes.rb} (86%) create mode 100644 semantic_conventions/lib/opentelemetry/semconv/incubating/faas/metrics.rb rename semantic_conventions/lib/opentelemetry/semconv/incubating/{feature_flag.rb => feature_flag/attributes.rb} (89%) rename semantic_conventions/lib/opentelemetry/semconv/incubating/{file.rb => file/attributes.rb} (83%) rename semantic_conventions/lib/opentelemetry/semconv/incubating/{gcp.rb => gcp/attributes.rb} (85%) rename semantic_conventions/lib/opentelemetry/semconv/incubating/{gen_ai.rb => gen_ai/attributes.rb} (79%) rename semantic_conventions/lib/opentelemetry/semconv/incubating/{graphql.rb => graphql/attributes.rb} (83%) rename semantic_conventions/lib/opentelemetry/semconv/incubating/{heroku.rb => heroku/attributes.rb} (83%) rename semantic_conventions/lib/opentelemetry/semconv/incubating/{host.rb => host/attributes.rb} (78%) rename semantic_conventions/lib/opentelemetry/semconv/incubating/{http.rb => http/attributes.rb} (77%) create mode 100644 semantic_conventions/lib/opentelemetry/semconv/incubating/http/metrics.rb rename semantic_conventions/lib/opentelemetry/semconv/incubating/{ios.rb => ios/attributes.rb} (96%) rename semantic_conventions/lib/opentelemetry/semconv/incubating/{jvm.rb => jvm/attributes.rb} (78%) create mode 100644 semantic_conventions/lib/opentelemetry/semconv/incubating/jvm/metrics.rb rename semantic_conventions/lib/opentelemetry/semconv/incubating/{k8s.rb => k8s/attributes.rb} (67%) create mode 100644 semantic_conventions/lib/opentelemetry/semconv/incubating/kestrel/metrics.rb rename semantic_conventions/lib/opentelemetry/semconv/incubating/{log.rb => log/attributes.rb} (85%) rename semantic_conventions/lib/opentelemetry/semconv/incubating/{message.rb => message/attributes.rb} (97%) rename semantic_conventions/lib/opentelemetry/semconv/incubating/{messaging.rb => messaging/attributes.rb} (83%) create mode 100644 semantic_conventions/lib/opentelemetry/semconv/incubating/messaging/metrics.rb rename semantic_conventions/lib/opentelemetry/semconv/incubating/{net.rb => net/attributes.rb} (82%) rename semantic_conventions/lib/opentelemetry/semconv/incubating/{network.rb => network/attributes.rb} (76%) rename semantic_conventions/lib/opentelemetry/semconv/incubating/{oci.rb => oci/attributes.rb} (92%) rename semantic_conventions/lib/opentelemetry/semconv/incubating/{opentracing.rb => opentracing/attributes.rb} (95%) rename semantic_conventions/lib/opentelemetry/semconv/incubating/{os.rb => os/attributes.rb} (80%) rename semantic_conventions/lib/opentelemetry/semconv/incubating/{otel.rb => otel/attributes.rb} (79%) rename semantic_conventions/lib/opentelemetry/semconv/incubating/{other.rb => other/attributes.rb} (94%) rename semantic_conventions/lib/opentelemetry/semconv/incubating/{peer.rb => peer/attributes.rb} (94%) rename semantic_conventions/lib/opentelemetry/semconv/incubating/{pool.rb => pool/attributes.rb} (93%) rename semantic_conventions/lib/opentelemetry/semconv/incubating/{process.rb => process/attributes.rb} (80%) create mode 100644 semantic_conventions/lib/opentelemetry/semconv/incubating/process/metrics.rb rename semantic_conventions/lib/opentelemetry/semconv/incubating/{rpc.rb => rpc/attributes.rb} (75%) create mode 100644 semantic_conventions/lib/opentelemetry/semconv/incubating/rpc/metrics.rb rename semantic_conventions/lib/opentelemetry/semconv/incubating/{server.rb => server/attributes.rb} (85%) rename semantic_conventions/lib/opentelemetry/semconv/incubating/{service.rb => service/attributes.rb} (92%) rename semantic_conventions/lib/opentelemetry/semconv/incubating/{session.rb => session/attributes.rb} (86%) rename semantic_conventions/lib/opentelemetry/semconv/incubating/{signalr.rb => signalr/attributes.rb} (82%) create mode 100644 semantic_conventions/lib/opentelemetry/semconv/incubating/signalr/metrics.rb rename semantic_conventions/lib/opentelemetry/semconv/incubating/{source.rb => source/attributes.rb} (87%) rename semantic_conventions/lib/opentelemetry/semconv/incubating/{system.rb => system/attributes.rb} (76%) create mode 100644 semantic_conventions/lib/opentelemetry/semconv/incubating/system/metrics.rb rename semantic_conventions/lib/opentelemetry/semconv/incubating/{telemetry.rb => telemetry/attributes.rb} (85%) rename semantic_conventions/lib/opentelemetry/semconv/incubating/{thread.rb => thread/attributes.rb} (90%) rename semantic_conventions/lib/opentelemetry/semconv/incubating/{tls.rb => tls/attributes.rb} (76%) rename semantic_conventions/lib/opentelemetry/semconv/incubating/{url.rb => url/attributes.rb} (81%) rename semantic_conventions/lib/opentelemetry/semconv/incubating/{user_agent.rb => user_agent/attributes.rb} (81%) rename semantic_conventions/lib/opentelemetry/semconv/incubating/{webengine.rb => webengine/attributes.rb} (84%) rename semantic_conventions/lib/opentelemetry/semconv/{jvm.rb => jvm/attributes.rb} (82%) create mode 100644 semantic_conventions/lib/opentelemetry/semconv/jvm/metrics.rb create mode 100644 semantic_conventions/lib/opentelemetry/semconv/kestrel/metrics.rb rename semantic_conventions/lib/opentelemetry/semconv/{network.rb => network/attributes.rb} (83%) rename semantic_conventions/lib/opentelemetry/semconv/{otel.rb => otel/attributes.rb} (87%) rename semantic_conventions/lib/opentelemetry/semconv/{server.rb => server/attributes.rb} (88%) rename semantic_conventions/lib/opentelemetry/semconv/{service.rb => service/attributes.rb} (90%) rename semantic_conventions/lib/opentelemetry/semconv/{signalr.rb => signalr/attributes.rb} (87%) create mode 100644 semantic_conventions/lib/opentelemetry/semconv/signalr/metrics.rb rename semantic_conventions/lib/opentelemetry/semconv/{telemetry.rb => telemetry/attributes.rb} (93%) rename semantic_conventions/lib/opentelemetry/semconv/{url.rb => url/attributes.rb} (86%) rename semantic_conventions/lib/opentelemetry/semconv/{user_agent.rb => user_agent/attributes.rb} (78%) create mode 100644 semantic_conventions/templates/registry/ruby/metrics.j2 diff --git a/semantic_conventions/Rakefile b/semantic_conventions/Rakefile index 263e0e5676..20f0de5148 100644 --- a/semantic_conventions/Rakefile +++ b/semantic_conventions/Rakefile @@ -51,7 +51,7 @@ end task generate: %i[update_gem_version check_out_semconv_version] do puts "\n+++ Removing previously generated semantic conventions code.\n" semconv_output_dir - .glob('*.rb') + .glob('**/*.rb') .then { |files| FileUtils.rm(files) } puts "\n+++ Generating semantic conventions code.\n" diff --git a/semantic_conventions/lib/opentelemetry/semconv/aspnetcore.rb b/semantic_conventions/lib/opentelemetry/semconv/aspnetcore/attributes.rb similarity index 80% rename from semantic_conventions/lib/opentelemetry/semconv/aspnetcore.rb rename to semantic_conventions/lib/opentelemetry/semconv/aspnetcore/attributes.rb index c28700955c..6245932873 100644 --- a/semantic_conventions/lib/opentelemetry/semconv/aspnetcore.rb +++ b/semantic_conventions/lib/opentelemetry/semconv/aspnetcore/attributes.rb @@ -26,42 +26,72 @@ module ASPNETCORE # ASP.NET Core exception middleware handling result # # @note Stability Level: stable + # + # @example Sample Values + # handled + # unhandled + # ASPNETCORE_DIAGNOSTICS_EXCEPTION_RESULT = 'aspnetcore.diagnostics.exception.result' # Full type name of the [`IExceptionHandler`](https://learn.microsoft.com/dotnet/api/microsoft.aspnetcore.diagnostics.iexceptionhandler) implementation that handled the exception. # # @note Stability Level: stable + # + # @example Sample Values + # Contoso.MyHandler + # ASPNETCORE_DIAGNOSTICS_HANDLER_TYPE = 'aspnetcore.diagnostics.handler.type' # Rate limiting policy name. # # @note Stability Level: stable + # + # @example Sample Values + # fixed + # sliding + # token + # ASPNETCORE_RATE_LIMITING_POLICY = 'aspnetcore.rate_limiting.policy' # Rate-limiting result, shows whether the lease was acquired or contains a rejection reason # # @note Stability Level: stable + # + # @example Sample Values + # acquired + # request_canceled + # ASPNETCORE_RATE_LIMITING_RESULT = 'aspnetcore.rate_limiting.result' # Flag indicating if request was handled by the application pipeline. # # @note Stability Level: stable + # + # @example Sample Values + # true + # ASPNETCORE_REQUEST_IS_UNHANDLED = 'aspnetcore.request.is_unhandled' # A value that indicates whether the matched route is a fallback route. # # @note Stability Level: stable + # + # @example Sample Values + # true + # ASPNETCORE_ROUTING_IS_FALLBACK = 'aspnetcore.routing.is_fallback' # Match result - success or failure # # @note Stability Level: stable + # + # @example Sample Values + # success + # failure + # ASPNETCORE_ROUTING_MATCH_STATUS = 'aspnetcore.routing.match_status' # @!endgroup - - # @!group Metric Names - # @!endgroup end end end \ No newline at end of file diff --git a/semantic_conventions/lib/opentelemetry/semconv/aspnetcore/metrics.rb b/semantic_conventions/lib/opentelemetry/semconv/aspnetcore/metrics.rb new file mode 100644 index 0000000000..8b228e39fb --- /dev/null +++ b/semantic_conventions/lib/opentelemetry/semconv/aspnetcore/metrics.rb @@ -0,0 +1,83 @@ +# 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 ASPNETCORE + # @!group Metrics Names + + # Number of exceptions caught by exception handling middleware. + # + # Meter name: `Microsoft.AspNetCore.Diagnostics`; Added in: ASP.NET Core 8.0 + # + # @note Stability Level: stable + ASPNETCORE_DIAGNOSTICS_EXCEPTIONS = 'aspnetcore.diagnostics.exceptions' + + # Number of requests that are currently active on the server that hold a rate limiting lease. + # + # Meter name: `Microsoft.AspNetCore.RateLimiting`; Added in: ASP.NET Core 8.0 + # + # @note Stability Level: stable + ASPNETCORE_RATE_LIMITING_ACTIVE_REQUEST_LEASES = 'aspnetcore.rate_limiting.active_request_leases' + + # Number of requests that are currently queued, waiting to acquire a rate limiting lease. + # + # Meter name: `Microsoft.AspNetCore.RateLimiting`; Added in: ASP.NET Core 8.0 + # + # @note Stability Level: stable + ASPNETCORE_RATE_LIMITING_QUEUED_REQUESTS = 'aspnetcore.rate_limiting.queued_requests' + + # The time the request spent in a queue waiting to acquire a rate limiting lease. + # + # Meter name: `Microsoft.AspNetCore.RateLimiting`; Added in: ASP.NET Core 8.0 + # + # @note Stability Level: stable + ASPNETCORE_RATE_LIMITING_REQUEST_TIME_IN_QUEUE = 'aspnetcore.rate_limiting.request.time_in_queue' + + # The duration of rate limiting lease held by requests on the server. + # + # Meter name: `Microsoft.AspNetCore.RateLimiting`; Added in: ASP.NET Core 8.0 + # + # @note Stability Level: stable + ASPNETCORE_RATE_LIMITING_REQUEST_LEASE_DURATION = 'aspnetcore.rate_limiting.request_lease.duration' + + # Number of requests that tried to acquire a rate limiting lease. + # + # Requests could be: + # + # - Rejected by global or endpoint rate limiting policies + # - Canceled while waiting for the lease. + # + # Meter name: `Microsoft.AspNetCore.RateLimiting`; Added in: ASP.NET Core 8.0 + # + # @note Stability Level: stable + ASPNETCORE_RATE_LIMITING_REQUESTS = 'aspnetcore.rate_limiting.requests' + + # Number of requests that were attempted to be matched to an endpoint. + # + # Meter name: `Microsoft.AspNetCore.Routing`; Added in: ASP.NET Core 8.0 + # + # @note Stability Level: stable + ASPNETCORE_ROUTING_MATCH_ATTEMPTS = 'aspnetcore.routing.match_attempts' + + # @!endgroup + end + end +end \ No newline at end of file diff --git a/semantic_conventions/lib/opentelemetry/semconv/client.rb b/semantic_conventions/lib/opentelemetry/semconv/client/attributes.rb similarity index 89% rename from semantic_conventions/lib/opentelemetry/semconv/client.rb rename to semantic_conventions/lib/opentelemetry/semconv/client/attributes.rb index 049db89201..3624822912 100644 --- a/semantic_conventions/lib/opentelemetry/semconv/client.rb +++ b/semantic_conventions/lib/opentelemetry/semconv/client/attributes.rb @@ -28,6 +28,12 @@ module CLIENT # When observed from the server side, and when communicating through an intermediary, `client.address` SHOULD represent the client address behind any intermediaries, for example proxies, if it's available. # # @note Stability Level: stable + # + # @example Sample Values + # client.example.com + # 10.1.2.80 + # /tmp/my.sock + # CLIENT_ADDRESS = 'client.address' # Client port number. @@ -35,12 +41,13 @@ module CLIENT # When observed from the server side, and when communicating through an intermediary, `client.port` SHOULD represent the client port behind any intermediaries, for example proxies, if it's available. # # @note Stability Level: stable + # + # @example Sample Values + # 65123 + # CLIENT_PORT = 'client.port' # @!endgroup - - # @!group Metric Names - # @!endgroup end end end \ No newline at end of file diff --git a/semantic_conventions/lib/opentelemetry/semconv/error.rb b/semantic_conventions/lib/opentelemetry/semconv/error/attributes.rb similarity index 93% rename from semantic_conventions/lib/opentelemetry/semconv/error.rb rename to semantic_conventions/lib/opentelemetry/semconv/error/attributes.rb index 35075439ba..6f03f679a7 100644 --- a/semantic_conventions/lib/opentelemetry/semconv/error.rb +++ b/semantic_conventions/lib/opentelemetry/semconv/error/attributes.rb @@ -46,12 +46,16 @@ module ERROR # - Set `error.type` to capture all errors, regardless of whether they are defined within the domain-specific set or not. # # @note Stability Level: stable + # + # @example Sample Values + # timeout + # java.net.UnknownHostException + # server_certificate_invalid + # 500 + # ERROR_TYPE = 'error.type' # @!endgroup - - # @!group Metric Names - # @!endgroup end end end \ No newline at end of file diff --git a/semantic_conventions/lib/opentelemetry/semconv/incubating/exception.rb b/semantic_conventions/lib/opentelemetry/semconv/exception/attributes.rb similarity index 84% rename from semantic_conventions/lib/opentelemetry/semconv/incubating/exception.rb rename to semantic_conventions/lib/opentelemetry/semconv/exception/attributes.rb index ee962f88b0..2c037c3dfc 100644 --- a/semantic_conventions/lib/opentelemetry/semconv/incubating/exception.rb +++ b/semantic_conventions/lib/opentelemetry/semconv/exception/attributes.rb @@ -20,7 +20,6 @@ module OpenTelemetry module SemConv - module Incubating module EXCEPTION # @!group Attribute Names @@ -44,36 +43,38 @@ module EXCEPTION # clear whether the exception will escape. # # @note Stability Level: stable - # - # @deprecated Now available in the stable namespace at {OpenTelemetry::SemConv::Exception::EXCEPTION_ESCAPED}. EXCEPTION_ESCAPED = 'exception.escaped' # The exception message. # # @note Stability Level: stable # - # @deprecated Now available in the stable namespace at {OpenTelemetry::SemConv::Exception::EXCEPTION_MESSAGE}. + # @example Sample Values + # Division by zero + # Can't convert 'int' object to str implicitly + # 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 # - # @deprecated Now available in the stable namespace at {OpenTelemetry::SemConv::Exception::EXCEPTION_STACKTRACE}. + # @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) + # 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 # - # @deprecated Now available in the stable namespace at {OpenTelemetry::SemConv::Exception::EXCEPTION_TYPE}. + # @example Sample Values + # java.net.ConnectException + # OSError + # EXCEPTION_TYPE = 'exception.type' # @!endgroup - - # @!group Metric Names - # @!endgroup end end - end end \ No newline at end of file diff --git a/semantic_conventions/lib/opentelemetry/semconv/http.rb b/semantic_conventions/lib/opentelemetry/semconv/http/attributes.rb similarity index 80% rename from semantic_conventions/lib/opentelemetry/semconv/http.rb rename to semantic_conventions/lib/opentelemetry/semconv/http/attributes.rb index 19d26ecf90..cb1a3d6de1 100644 --- a/semantic_conventions/lib/opentelemetry/semconv/http.rb +++ b/semantic_conventions/lib/opentelemetry/semconv/http/attributes.rb @@ -23,6 +23,12 @@ module SemConv module HTTP # @!group Attribute Names + # Must be called with a key for the full attribute name. See notes below about the expectations + # for the state of the key. + # + # @example Usage + # HTTP_REQUEST_HEADER_LAMBDA.call('some-cool-key') #=> 'http.request.header.some-cool-key' + # # HTTP request headers, `` being the normalized HTTP Header name (lowercase), the value being the header values. # # Instrumentations SHOULD require an explicit configuration of which headers are to be captured. Including all request headers can be a security risk - explicit configuration helps avoid leaking sensitive information. @@ -30,6 +36,11 @@ module HTTP # The attribute value MUST consist of either multiple header values as an array of strings or a single-item array containing a possibly comma-concatenated string, depending on the way the HTTP library provides access to headers. # # @note Stability Level: stable + # + # @example Sample Values + # http.request.header.content-type=["application/json"] + # http.request.header.x-forwarded-for=["1.2.3.4", "1.2.3.5"] + # HTTP_REQUEST_HEADER_LAMBDA = ->(key) { "http.request.header.#{key}" } # HTTP request method. @@ -50,11 +61,23 @@ module HTTP # Tracing instrumentations that do so, MUST also set `http.request.method_original` to the original value. # # @note Stability Level: stable + # + # @example Sample Values + # GET + # POST + # HEAD + # HTTP_REQUEST_METHOD = 'http.request.method' # Original HTTP method sent by the client in the request line. # # @note Stability Level: stable + # + # @example Sample Values + # GeT + # ACL + # foo + # HTTP_REQUEST_METHOD_ORIGINAL = 'http.request.method_original' # The ordinal number of request resending attempt (for any reason, including redirects). @@ -62,8 +85,18 @@ module HTTP # The resend count SHOULD be updated each time an HTTP request gets resent by the client, regardless of what was the cause of the resending (e.g. redirection, authorization failure, 503 Server Unavailable, network issues, or any other). # # @note Stability Level: stable + # + # @example Sample Values + # 3 + # HTTP_REQUEST_RESEND_COUNT = 'http.request.resend_count' + # Must be called with a key for the full attribute name. See notes below about the expectations + # for the state of the key. + # + # @example Usage + # HTTP_RESPONSE_HEADER_LAMBDA.call('some-cool-key') #=> 'http.response.header.some-cool-key' + # # HTTP response headers, `` being the normalized HTTP Header name (lowercase), the value being the header values. # # Instrumentations SHOULD require an explicit configuration of which headers are to be captured. Including all response headers can be a security risk - explicit configuration helps avoid leaking sensitive information. @@ -71,11 +104,20 @@ module HTTP # The attribute value MUST consist of either multiple header values as an array of strings or a single-item array containing a possibly comma-concatenated string, depending on the way the HTTP library provides access to headers. # # @note Stability Level: stable + # + # @example Sample Values + # http.response.header.content-type=["application/json"] + # http.response.header.my-custom-header=["abc", "def"] + # HTTP_RESPONSE_HEADER_LAMBDA = ->(key) { "http.response.header.#{key}" } # [HTTP response status code](https://tools.ietf.org/html/rfc7231#section-6). # # @note Stability Level: stable + # + # @example Sample Values + # 200 + # HTTP_RESPONSE_STATUS_CODE = 'http.response.status_code' # The matched route, that is, the path template in the format used by the respective server framework. @@ -84,12 +126,14 @@ module HTTP # SHOULD include the [application root](/docs/http/http-spans.md#http-server-definitions) if there is one. # # @note Stability Level: stable + # + # @example Sample Values + # /users/:userID? + # {controller}/{action}/{id?} + # HTTP_ROUTE = 'http.route' # @!endgroup - - # @!group Metric Names - # @!endgroup end end end \ No newline at end of file diff --git a/semantic_conventions/lib/opentelemetry/semconv/http/metrics.rb b/semantic_conventions/lib/opentelemetry/semconv/http/metrics.rb new file mode 100644 index 0000000000..c6e6f68fc1 --- /dev/null +++ b/semantic_conventions/lib/opentelemetry/semconv/http/metrics.rb @@ -0,0 +1,39 @@ +# 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 HTTP + # @!group Metrics Names + + # Duration of HTTP client requests. + # + # @note Stability Level: stable + HTTP_CLIENT_REQUEST_DURATION = 'http.client.request.duration' + + # Duration of HTTP server requests. + # + # @note Stability Level: stable + HTTP_SERVER_REQUEST_DURATION = 'http.server.request.duration' + + # @!endgroup + end + end +end \ No newline at end of file diff --git a/semantic_conventions/lib/opentelemetry/semconv/incubating/android.rb b/semantic_conventions/lib/opentelemetry/semconv/incubating/android/attributes.rb similarity index 95% rename from semantic_conventions/lib/opentelemetry/semconv/incubating/android.rb rename to semantic_conventions/lib/opentelemetry/semconv/incubating/android/attributes.rb index 129ed23cc1..24ff4efa26 100644 --- a/semantic_conventions/lib/opentelemetry/semconv/incubating/android.rb +++ b/semantic_conventions/lib/opentelemetry/semconv/incubating/android/attributes.rb @@ -27,6 +27,11 @@ module ANDROID # Uniquely identifies the framework API revision offered by a version (`os.version`) of the android operating system. More information can be found [here](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels). # # @note Stability Level: experimental + # + # @example Sample Values + # 33 + # 32 + # ANDROID_OS_API_LEVEL = 'android.os.api_level' # Deprecated use the `device.app.lifecycle` event definition including `android.state` as a payload field instead. @@ -37,9 +42,6 @@ module ANDROID ANDROID_STATE = 'android.state' # @!endgroup - - # @!group Metric Names - # @!endgroup end end end diff --git a/semantic_conventions/lib/opentelemetry/semconv/incubating/aspnetcore.rb b/semantic_conventions/lib/opentelemetry/semconv/incubating/aspnetcore/attributes.rb similarity index 74% rename from semantic_conventions/lib/opentelemetry/semconv/incubating/aspnetcore.rb rename to semantic_conventions/lib/opentelemetry/semconv/incubating/aspnetcore/attributes.rb index c5a26895bd..137506ec95 100644 --- a/semantic_conventions/lib/opentelemetry/semconv/incubating/aspnetcore.rb +++ b/semantic_conventions/lib/opentelemetry/semconv/incubating/aspnetcore/attributes.rb @@ -28,55 +28,85 @@ module ASPNETCORE # # @note Stability Level: stable # - # @deprecated Now available in the stable namespace at {OpenTelemetry::SemConv::Aspnetcore::ASPNETCORE_DIAGNOSTICS_EXCEPTION_RESULT}. + # @example Sample Values + # handled + # unhandled + # + # + # @deprecated Now available in the stable namespace at {OpenTelemetry::SemConv::ASPNETCORE::ASPNETCORE_DIAGNOSTICS_EXCEPTION_RESULT}. ASPNETCORE_DIAGNOSTICS_EXCEPTION_RESULT = 'aspnetcore.diagnostics.exception.result' # Full type name of the [`IExceptionHandler`](https://learn.microsoft.com/dotnet/api/microsoft.aspnetcore.diagnostics.iexceptionhandler) implementation that handled the exception. # # @note Stability Level: stable # - # @deprecated Now available in the stable namespace at {OpenTelemetry::SemConv::Aspnetcore::ASPNETCORE_DIAGNOSTICS_HANDLER_TYPE}. + # @example Sample Values + # Contoso.MyHandler + # + # + # @deprecated Now available in the stable namespace at {OpenTelemetry::SemConv::ASPNETCORE::ASPNETCORE_DIAGNOSTICS_HANDLER_TYPE}. ASPNETCORE_DIAGNOSTICS_HANDLER_TYPE = 'aspnetcore.diagnostics.handler.type' # Rate limiting policy name. # # @note Stability Level: stable # - # @deprecated Now available in the stable namespace at {OpenTelemetry::SemConv::Aspnetcore::ASPNETCORE_RATE_LIMITING_POLICY}. + # @example Sample Values + # fixed + # sliding + # token + # + # + # @deprecated Now available in the stable namespace at {OpenTelemetry::SemConv::ASPNETCORE::ASPNETCORE_RATE_LIMITING_POLICY}. ASPNETCORE_RATE_LIMITING_POLICY = 'aspnetcore.rate_limiting.policy' # Rate-limiting result, shows whether the lease was acquired or contains a rejection reason # # @note Stability Level: stable # - # @deprecated Now available in the stable namespace at {OpenTelemetry::SemConv::Aspnetcore::ASPNETCORE_RATE_LIMITING_RESULT}. + # @example Sample Values + # acquired + # request_canceled + # + # + # @deprecated Now available in the stable namespace at {OpenTelemetry::SemConv::ASPNETCORE::ASPNETCORE_RATE_LIMITING_RESULT}. ASPNETCORE_RATE_LIMITING_RESULT = 'aspnetcore.rate_limiting.result' # Flag indicating if request was handled by the application pipeline. # # @note Stability Level: stable # - # @deprecated Now available in the stable namespace at {OpenTelemetry::SemConv::Aspnetcore::ASPNETCORE_REQUEST_IS_UNHANDLED}. + # @example Sample Values + # true + # + # + # @deprecated Now available in the stable namespace at {OpenTelemetry::SemConv::ASPNETCORE::ASPNETCORE_REQUEST_IS_UNHANDLED}. ASPNETCORE_REQUEST_IS_UNHANDLED = 'aspnetcore.request.is_unhandled' # A value that indicates whether the matched route is a fallback route. # # @note Stability Level: stable # - # @deprecated Now available in the stable namespace at {OpenTelemetry::SemConv::Aspnetcore::ASPNETCORE_ROUTING_IS_FALLBACK}. + # @example Sample Values + # true + # + # + # @deprecated Now available in the stable namespace at {OpenTelemetry::SemConv::ASPNETCORE::ASPNETCORE_ROUTING_IS_FALLBACK}. ASPNETCORE_ROUTING_IS_FALLBACK = 'aspnetcore.routing.is_fallback' # Match result - success or failure # # @note Stability Level: stable # - # @deprecated Now available in the stable namespace at {OpenTelemetry::SemConv::Aspnetcore::ASPNETCORE_ROUTING_MATCH_STATUS}. + # @example Sample Values + # success + # failure + # + # + # @deprecated Now available in the stable namespace at {OpenTelemetry::SemConv::ASPNETCORE::ASPNETCORE_ROUTING_MATCH_STATUS}. ASPNETCORE_ROUTING_MATCH_STATUS = 'aspnetcore.routing.match_status' # @!endgroup - - # @!group Metric Names - # @!endgroup end end end diff --git a/semantic_conventions/lib/opentelemetry/semconv/incubating/aspnetcore/metrics.rb b/semantic_conventions/lib/opentelemetry/semconv/incubating/aspnetcore/metrics.rb new file mode 100644 index 0000000000..35908c0c2a --- /dev/null +++ b/semantic_conventions/lib/opentelemetry/semconv/incubating/aspnetcore/metrics.rb @@ -0,0 +1,99 @@ +# 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 ASPNETCORE + # @!group Metrics Names + + # Number of exceptions caught by exception handling middleware. + # + # Meter name: `Microsoft.AspNetCore.Diagnostics`; Added in: ASP.NET Core 8.0 + # + # @note Stability Level: stable + # + # @deprecated Now available in the stable namespace at {OpenTelemetry::SemConv::ASPNETCORE::ASPNETCORE_DIAGNOSTICS_EXCEPTIONS}. + ASPNETCORE_DIAGNOSTICS_EXCEPTIONS = 'aspnetcore.diagnostics.exceptions' + + # Number of requests that are currently active on the server that hold a rate limiting lease. + # + # Meter name: `Microsoft.AspNetCore.RateLimiting`; Added in: ASP.NET Core 8.0 + # + # @note Stability Level: stable + # + # @deprecated Now available in the stable namespace at {OpenTelemetry::SemConv::ASPNETCORE::ASPNETCORE_RATE_LIMITING_ACTIVE_REQUEST_LEASES}. + ASPNETCORE_RATE_LIMITING_ACTIVE_REQUEST_LEASES = 'aspnetcore.rate_limiting.active_request_leases' + + # Number of requests that are currently queued, waiting to acquire a rate limiting lease. + # + # Meter name: `Microsoft.AspNetCore.RateLimiting`; Added in: ASP.NET Core 8.0 + # + # @note Stability Level: stable + # + # @deprecated Now available in the stable namespace at {OpenTelemetry::SemConv::ASPNETCORE::ASPNETCORE_RATE_LIMITING_QUEUED_REQUESTS}. + ASPNETCORE_RATE_LIMITING_QUEUED_REQUESTS = 'aspnetcore.rate_limiting.queued_requests' + + # The time the request spent in a queue waiting to acquire a rate limiting lease. + # + # Meter name: `Microsoft.AspNetCore.RateLimiting`; Added in: ASP.NET Core 8.0 + # + # @note Stability Level: stable + # + # @deprecated Now available in the stable namespace at {OpenTelemetry::SemConv::ASPNETCORE::ASPNETCORE_RATE_LIMITING_REQUEST_TIME_IN_QUEUE}. + ASPNETCORE_RATE_LIMITING_REQUEST_TIME_IN_QUEUE = 'aspnetcore.rate_limiting.request.time_in_queue' + + # The duration of rate limiting lease held by requests on the server. + # + # Meter name: `Microsoft.AspNetCore.RateLimiting`; Added in: ASP.NET Core 8.0 + # + # @note Stability Level: stable + # + # @deprecated Now available in the stable namespace at {OpenTelemetry::SemConv::ASPNETCORE::ASPNETCORE_RATE_LIMITING_REQUEST_LEASE_DURATION}. + ASPNETCORE_RATE_LIMITING_REQUEST_LEASE_DURATION = 'aspnetcore.rate_limiting.request_lease.duration' + + # Number of requests that tried to acquire a rate limiting lease. + # + # Requests could be: + # + # - Rejected by global or endpoint rate limiting policies + # - Canceled while waiting for the lease. + # + # Meter name: `Microsoft.AspNetCore.RateLimiting`; Added in: ASP.NET Core 8.0 + # + # @note Stability Level: stable + # + # @deprecated Now available in the stable namespace at {OpenTelemetry::SemConv::ASPNETCORE::ASPNETCORE_RATE_LIMITING_REQUESTS}. + ASPNETCORE_RATE_LIMITING_REQUESTS = 'aspnetcore.rate_limiting.requests' + + # Number of requests that were attempted to be matched to an endpoint. + # + # Meter name: `Microsoft.AspNetCore.Routing`; Added in: ASP.NET Core 8.0 + # + # @note Stability Level: stable + # + # @deprecated Now available in the stable namespace at {OpenTelemetry::SemConv::ASPNETCORE::ASPNETCORE_ROUTING_MATCH_ATTEMPTS}. + ASPNETCORE_ROUTING_MATCH_ATTEMPTS = 'aspnetcore.routing.match_attempts' + + # @!endgroup + end + end + end +end \ No newline at end of file diff --git a/semantic_conventions/lib/opentelemetry/semconv/incubating/aws.rb b/semantic_conventions/lib/opentelemetry/semconv/incubating/aws/attributes.rb similarity index 73% rename from semantic_conventions/lib/opentelemetry/semconv/incubating/aws.rb rename to semantic_conventions/lib/opentelemetry/semconv/incubating/aws/attributes.rb index e66977dcdd..710fc5e6ab 100644 --- a/semantic_conventions/lib/opentelemetry/semconv/incubating/aws.rb +++ b/semantic_conventions/lib/opentelemetry/semconv/incubating/aws/attributes.rb @@ -27,11 +27,20 @@ module AWS # The JSON-serialized value of each item in the `AttributeDefinitions` request field. # # @note Stability Level: experimental + # + # @example Sample Values + # { "AttributeName": "string", "AttributeType": "string" } + # AWS_DYNAMODB_ATTRIBUTE_DEFINITIONS = 'aws.dynamodb.attribute_definitions' # The value of the `AttributesToGet` request parameter. # # @note Stability Level: experimental + # + # @example Sample Values + # lives + # id + # AWS_DYNAMODB_ATTRIBUTES_TO_GET = 'aws.dynamodb.attributes_to_get' # The value of the `ConsistentRead` request parameter. @@ -42,61 +51,114 @@ module AWS # The JSON-serialized value of each item in the `ConsumedCapacity` response field. # # @note Stability Level: experimental + # + # @example Sample Values + # { "CapacityUnits": number, "GlobalSecondaryIndexes": { "string" : { "CapacityUnits": number, "ReadCapacityUnits": number, "WriteCapacityUnits": number } }, "LocalSecondaryIndexes": { "string" : { "CapacityUnits": number, "ReadCapacityUnits": number, "WriteCapacityUnits": number } }, "ReadCapacityUnits": number, "Table": { "CapacityUnits": number, "ReadCapacityUnits": number, "WriteCapacityUnits": number }, "TableName": "string", "WriteCapacityUnits": number } + # AWS_DYNAMODB_CONSUMED_CAPACITY = 'aws.dynamodb.consumed_capacity' # The value of the `Count` response parameter. # # @note Stability Level: experimental + # + # @example Sample Values + # 10 + # AWS_DYNAMODB_COUNT = 'aws.dynamodb.count' # The value of the `ExclusiveStartTableName` request parameter. # # @note Stability Level: experimental + # + # @example Sample Values + # Users + # CatsTable + # AWS_DYNAMODB_EXCLUSIVE_START_TABLE = 'aws.dynamodb.exclusive_start_table' # The JSON-serialized value of each item in the `GlobalSecondaryIndexUpdates` request field. # # @note Stability Level: experimental + # + # @example Sample Values + # { "Create": { "IndexName": "string", "KeySchema": [ { "AttributeName": "string", "KeyType": "string" } ], "Projection": { "NonKeyAttributes": [ "string" ], "ProjectionType": "string" }, "ProvisionedThroughput": { "ReadCapacityUnits": number, "WriteCapacityUnits": number } } + # AWS_DYNAMODB_GLOBAL_SECONDARY_INDEX_UPDATES = 'aws.dynamodb.global_secondary_index_updates' # The JSON-serialized value of each item of the `GlobalSecondaryIndexes` request field # # @note Stability Level: experimental + # + # @example Sample Values + # { "IndexName": "string", "KeySchema": [ { "AttributeName": "string", "KeyType": "string" } ], "Projection": { "NonKeyAttributes": [ "string" ], "ProjectionType": "string" }, "ProvisionedThroughput": { "ReadCapacityUnits": number, "WriteCapacityUnits": number } } + # AWS_DYNAMODB_GLOBAL_SECONDARY_INDEXES = 'aws.dynamodb.global_secondary_indexes' # The value of the `IndexName` request parameter. # # @note Stability Level: experimental + # + # @example Sample Values + # name_to_group + # AWS_DYNAMODB_INDEX_NAME = 'aws.dynamodb.index_name' # The JSON-serialized value of the `ItemCollectionMetrics` response field. # # @note Stability Level: experimental + # + # @example Sample Values + # { "string" : [ { "ItemCollectionKey": { "string" : { "B": blob, "BOOL": boolean, "BS": [ blob ], "L": [ "AttributeValue" ], "M": { "string" : "AttributeValue" }, "N": "string", "NS": [ "string" ], "NULL": boolean, "S": "string", "SS": [ "string" ] } }, "SizeEstimateRangeGB": [ number ] } ] } + # AWS_DYNAMODB_ITEM_COLLECTION_METRICS = 'aws.dynamodb.item_collection_metrics' # The value of the `Limit` request parameter. # # @note Stability Level: experimental + # + # @example Sample Values + # 10 + # AWS_DYNAMODB_LIMIT = 'aws.dynamodb.limit' # The JSON-serialized value of each item of the `LocalSecondaryIndexes` request field. # # @note Stability Level: experimental + # + # @example Sample Values + # { "IndexArn": "string", "IndexName": "string", "IndexSizeBytes": number, "ItemCount": number, "KeySchema": [ { "AttributeName": "string", "KeyType": "string" } ], "Projection": { "NonKeyAttributes": [ "string" ], "ProjectionType": "string" } } + # AWS_DYNAMODB_LOCAL_SECONDARY_INDEXES = 'aws.dynamodb.local_secondary_indexes' # The value of the `ProjectionExpression` request parameter. # # @note Stability Level: experimental + # + # @example Sample Values + # Title + # Title, Price, Color + # Title, Description, RelatedItems, ProductReviews + # AWS_DYNAMODB_PROJECTION = 'aws.dynamodb.projection' # The value of the `ProvisionedThroughput.ReadCapacityUnits` request parameter. # # @note Stability Level: experimental + # + # @example Sample Values + # 1.0 + # 2.0 + # AWS_DYNAMODB_PROVISIONED_READ_CAPACITY = 'aws.dynamodb.provisioned_read_capacity' # The value of the `ProvisionedThroughput.WriteCapacityUnits` request parameter. # # @note Stability Level: experimental + # + # @example Sample Values + # 1.0 + # 2.0 + # AWS_DYNAMODB_PROVISIONED_WRITE_CAPACITY = 'aws.dynamodb.provisioned_write_capacity' # The value of the `ScanIndexForward` request parameter. @@ -107,41 +169,75 @@ module AWS # The value of the `ScannedCount` response parameter. # # @note Stability Level: experimental + # + # @example Sample Values + # 50 + # AWS_DYNAMODB_SCANNED_COUNT = 'aws.dynamodb.scanned_count' # The value of the `Segment` request parameter. # # @note Stability Level: experimental + # + # @example Sample Values + # 10 + # AWS_DYNAMODB_SEGMENT = 'aws.dynamodb.segment' # The value of the `Select` request parameter. # # @note Stability Level: experimental + # + # @example Sample Values + # ALL_ATTRIBUTES + # COUNT + # AWS_DYNAMODB_SELECT = 'aws.dynamodb.select' # The number of items in the `TableNames` response parameter. # # @note Stability Level: experimental + # + # @example Sample Values + # 20 + # AWS_DYNAMODB_TABLE_COUNT = 'aws.dynamodb.table_count' # The keys in the `RequestItems` object field. # # @note Stability Level: experimental + # + # @example Sample Values + # Users + # Cats + # AWS_DYNAMODB_TABLE_NAMES = 'aws.dynamodb.table_names' # The value of the `TotalSegments` request parameter. # # @note Stability Level: experimental + # + # @example Sample Values + # 100 + # AWS_DYNAMODB_TOTAL_SEGMENTS = 'aws.dynamodb.total_segments' # The ARN of an [ECS cluster](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/clusters.html). # # @note Stability Level: experimental + # + # @example Sample Values + # arn:aws:ecs:us-west-2:123456789123:cluster/my-cluster + # AWS_ECS_CLUSTER_ARN = 'aws.ecs.cluster.arn' # The Amazon Resource Name (ARN) of an [ECS container instance](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ECS_instances.html). # # @note Stability Level: experimental + # + # @example Sample Values + # arn:aws:ecs:us-west-1:123456789123:container/32624152-9086-4f0e-acae-1a75b14fe4d9 + # AWS_ECS_CONTAINER_ARN = 'aws.ecs.container.arn' # The [launch type](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/launch_types.html) for an ECS task. @@ -152,26 +248,49 @@ module AWS # The ARN of a running [ECS task](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-account-settings.html#ecs-resource-ids). # # @note Stability Level: experimental + # + # @example Sample Values + # arn:aws:ecs:us-west-1:123456789123:task/10838bed-421f-43ef-870a-f43feacbbb5b + # arn:aws:ecs:us-west-1:123456789123:task/my-cluster/task-id/23ebb8ac-c18f-46c6-8bbe-d55d0e37cfbd + # AWS_ECS_TASK_ARN = 'aws.ecs.task.arn' # The family name of the [ECS task definition](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task_definitions.html) used to create the ECS task. # # @note Stability Level: experimental + # + # @example Sample Values + # opentelemetry-family + # AWS_ECS_TASK_FAMILY = 'aws.ecs.task.family' # The ID of a running ECS task. The ID MUST be extracted from `task.arn`. # # @note Stability Level: experimental + # + # @example Sample Values + # 10838bed-421f-43ef-870a-f43feacbbb5b + # 23ebb8ac-c18f-46c6-8bbe-d55d0e37cfbd + # AWS_ECS_TASK_ID = 'aws.ecs.task.id' # The revision for the task definition used to create the ECS task. # # @note Stability Level: experimental + # + # @example Sample Values + # 8 + # 26 + # AWS_ECS_TASK_REVISION = 'aws.ecs.task.revision' # The ARN of an EKS cluster. # # @note Stability Level: experimental + # + # @example Sample Values + # arn:aws:ecs:us-west-2:123456789123:cluster/my-cluster + # AWS_EKS_CLUSTER_ARN = 'aws.eks.cluster.arn' # The full invoked ARN as provided on the `Context` passed to the function (`Lambda-Runtime-Invoked-Function-Arn` header on the `/runtime/invocation/next` applicable). @@ -179,6 +298,10 @@ module AWS # This may be different from `cloud.resource_id` if an alias is involved. # # @note Stability Level: experimental + # + # @example Sample Values + # arn:aws:lambda:us-east-1:123456:function:myfunction:myalias + # AWS_LAMBDA_INVOKED_ARN = 'aws.lambda.invoked_arn' # The Amazon Resource Name(s) (ARN) of the AWS log group(s). @@ -186,6 +309,10 @@ module AWS # See the [log group ARN format documentation](https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/iam-access-control-overview-cwl.html#CWL_ARN_Format). # # @note Stability Level: experimental + # + # @example Sample Values + # arn:aws:logs:us-west-1:123456789012:log-group:/aws/my/group:* + # AWS_LOG_GROUP_ARNS = 'aws.log.group.arns' # The name(s) of the AWS log group(s) an application is writing to. @@ -193,6 +320,11 @@ module AWS # 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. # # @note Stability Level: experimental + # + # @example Sample Values + # /aws/lambda/my-function + # opentelemetry-service + # AWS_LOG_GROUP_NAMES = 'aws.log.group.names' # The ARN(s) of the AWS log stream(s). @@ -200,16 +332,29 @@ module AWS # 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. # # @note Stability Level: experimental + # + # @example Sample Values + # arn:aws:logs:us-west-1:123456789012:log-group:/aws/my/group:log-stream:logs/main/10838bed-421f-43ef-870a-f43feacbbb5b + # AWS_LOG_STREAM_ARNS = 'aws.log.stream.arns' # The name(s) of the AWS log stream(s) an application is writing to. # # @note Stability Level: experimental + # + # @example Sample Values + # logs/main/10838bed-421f-43ef-870a-f43feacbbb5b + # AWS_LOG_STREAM_NAMES = 'aws.log.stream.names' # The AWS request ID as returned in the response headers `x-amz-request-id` or `x-amz-requestid`. # # @note Stability Level: experimental + # + # @example Sample Values + # 79b9da39-b7ae-508a-a6bc-864b2829c622 + # C9ER4AJX75574TDJ + # AWS_REQUEST_ID = 'aws.request_id' # The S3 bucket name the request refers to. Corresponds to the `--bucket` parameter of the [S3 API](https://docs.aws.amazon.com/cli/latest/reference/s3api/index.html) operations. @@ -218,6 +363,10 @@ module AWS # This applies to almost all S3 operations except `list-buckets`. # # @note Stability Level: experimental + # + # @example Sample Values + # some-bucket-name + # AWS_S3_BUCKET = 'aws.s3.bucket' # The source object (in the form `bucket`/`key`) for the copy operation. @@ -230,6 +379,10 @@ module AWS # - [upload-part-copy](https://docs.aws.amazon.com/cli/latest/reference/s3api/upload-part-copy.html) # # @note Stability Level: experimental + # + # @example Sample Values + # someFile.yml + # AWS_S3_COPY_SOURCE = 'aws.s3.copy_source' # The delete request container that specifies the objects to be deleted. @@ -239,6 +392,10 @@ module AWS # [delete-objects operation within the S3 API](https://docs.aws.amazon.com/cli/latest/reference/s3api/delete-objects.html). # # @note Stability Level: experimental + # + # @example Sample Values + # Objects=[{Key=string,VersionId=string},{Key=string,VersionId=string}],Quiet=boolean + # AWS_S3_DELETE = 'aws.s3.delete' # The S3 object key the request refers to. Corresponds to the `--key` parameter of the [S3 API](https://docs.aws.amazon.com/cli/latest/reference/s3api/index.html) operations. @@ -261,6 +418,10 @@ module AWS # - [upload-part-copy](https://docs.aws.amazon.com/cli/latest/reference/s3api/upload-part-copy.html) # # @note Stability Level: experimental + # + # @example Sample Values + # someFile.yml + # AWS_S3_KEY = 'aws.s3.key' # The part number of the part being uploaded in a multipart-upload operation. This is a positive integer between 1 and 10,000. @@ -271,6 +432,10 @@ module AWS # [upload-part operation within the S3 API](https://docs.aws.amazon.com/cli/latest/reference/s3api/upload-part.html). # # @note Stability Level: experimental + # + # @example Sample Values + # 3456 + # AWS_S3_PART_NUMBER = 'aws.s3.part_number' # Upload ID that identifies the multipart upload. @@ -286,12 +451,13 @@ module AWS # - [upload-part-copy](https://docs.aws.amazon.com/cli/latest/reference/s3api/upload-part-copy.html) # # @note Stability Level: experimental + # + # @example Sample Values + # dfRtDYWFbkRONycy.Yxwh66Yjlx.cph0gtNBtJ + # AWS_S3_UPLOAD_ID = 'aws.s3.upload_id' # @!endgroup - - # @!group Metric Names - # @!endgroup end end end diff --git a/semantic_conventions/lib/opentelemetry/semconv/incubating/browser.rb b/semantic_conventions/lib/opentelemetry/semconv/incubating/browser/attributes.rb similarity index 89% rename from semantic_conventions/lib/opentelemetry/semconv/incubating/browser.rb rename to semantic_conventions/lib/opentelemetry/semconv/incubating/browser/attributes.rb index 4ebb823143..c15e8a06de 100644 --- a/semantic_conventions/lib/opentelemetry/semconv/incubating/browser.rb +++ b/semantic_conventions/lib/opentelemetry/semconv/incubating/browser/attributes.rb @@ -29,6 +29,12 @@ module BROWSER # This value is intended to be taken from the [UA client hints API](https://wicg.github.io/ua-client-hints/#interface) (`navigator.userAgentData.brands`). # # @note Stability Level: experimental + # + # @example Sample Values + # Not A;Brand 99 + # Chromium 99 + # Chrome 99 + # BROWSER_BRANDS = 'browser.brands' # Preferred language of the user using the browser @@ -36,6 +42,13 @@ module BROWSER # This value is intended to be taken from the Navigator API `navigator.language`. # # @note Stability Level: experimental + # + # @example Sample Values + # en + # en-US + # fr + # fr-FR + # BROWSER_LANGUAGE = 'browser.language' # A boolean that is true if the browser is running on a mobile device @@ -51,12 +64,15 @@ module BROWSER # The list of possible values is defined in the [W3C User-Agent Client Hints specification](https://wicg.github.io/ua-client-hints/#sec-ch-ua-platform). Note that some (but not all) of these values can overlap with values in the [`os.type` and `os.name` attributes](./os.md). However, for consistency, the values in the `browser.platform` attribute should capture the exact value that the user agent provides. # # @note Stability Level: experimental + # + # @example Sample Values + # Windows + # macOS + # Android + # BROWSER_PLATFORM = 'browser.platform' # @!endgroup - - # @!group Metric Names - # @!endgroup end end end diff --git a/semantic_conventions/lib/opentelemetry/semconv/incubating/client.rb b/semantic_conventions/lib/opentelemetry/semconv/incubating/client/attributes.rb similarity index 86% rename from semantic_conventions/lib/opentelemetry/semconv/incubating/client.rb rename to semantic_conventions/lib/opentelemetry/semconv/incubating/client/attributes.rb index bdd75c81cd..e614610532 100644 --- a/semantic_conventions/lib/opentelemetry/semconv/incubating/client.rb +++ b/semantic_conventions/lib/opentelemetry/semconv/incubating/client/attributes.rb @@ -30,7 +30,13 @@ module CLIENT # # @note Stability Level: stable # - # @deprecated Now available in the stable namespace at {OpenTelemetry::SemConv::Client::CLIENT_ADDRESS}. + # @example Sample Values + # client.example.com + # 10.1.2.80 + # /tmp/my.sock + # + # + # @deprecated Now available in the stable namespace at {OpenTelemetry::SemConv::CLIENT::CLIENT_ADDRESS}. CLIENT_ADDRESS = 'client.address' # Client port number. @@ -39,13 +45,14 @@ module CLIENT # # @note Stability Level: stable # - # @deprecated Now available in the stable namespace at {OpenTelemetry::SemConv::Client::CLIENT_PORT}. + # @example Sample Values + # 65123 + # + # + # @deprecated Now available in the stable namespace at {OpenTelemetry::SemConv::CLIENT::CLIENT_PORT}. CLIENT_PORT = 'client.port' # @!endgroup - - # @!group Metric Names - # @!endgroup end end end diff --git a/semantic_conventions/lib/opentelemetry/semconv/incubating/cloud.rb b/semantic_conventions/lib/opentelemetry/semconv/incubating/cloud/attributes.rb similarity index 88% rename from semantic_conventions/lib/opentelemetry/semconv/incubating/cloud.rb rename to semantic_conventions/lib/opentelemetry/semconv/incubating/cloud/attributes.rb index fa59fcce90..2870c6080d 100644 --- a/semantic_conventions/lib/opentelemetry/semconv/incubating/cloud.rb +++ b/semantic_conventions/lib/opentelemetry/semconv/incubating/cloud/attributes.rb @@ -27,6 +27,11 @@ module CLOUD # The cloud account ID the resource is assigned to. # # @note Stability Level: experimental + # + # @example Sample Values + # 111111111111 + # opentelemetry + # CLOUD_ACCOUNT_ID = 'cloud.account.id' # Cloud regions often have multiple, isolated locations known as zones to increase availability. Availability zone represents the zone where the resource is running. @@ -34,6 +39,10 @@ module CLOUD # Availability zones are called "zones" on Alibaba Cloud and Google Cloud. # # @note Stability Level: experimental + # + # @example Sample Values + # us-east-1c + # CLOUD_AVAILABILITY_ZONE = 'cloud.availability_zone' # The cloud platform in use. @@ -53,6 +62,11 @@ module CLOUD # Refer to your provider's docs to see the available regions, for example [Alibaba Cloud regions](https://www.alibabacloud.com/help/doc-detail/40654.htm), [AWS regions](https://aws.amazon.com/about-aws/global-infrastructure/regions_az/), [Azure regions](https://azure.microsoft.com/global-infrastructure/geographies/), [Google Cloud regions](https://cloud.google.com/about/locations), or [Tencent Cloud regions](https://www.tencentcloud.com/document/product/213/6091). # # @note Stability Level: experimental + # + # @example Sample Values + # us-central1 + # us-east-1 + # CLOUD_REGION = 'cloud.region' # Cloud provider-specific native identifier of the monitored cloud resource (e.g. an [ARN](https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) on AWS, a [fully qualified resource ID](https://learn.microsoft.com/rest/api/resources/resources/get-by-id) on Azure, a [full resource name](https://cloud.google.com/apis/design/resource_names#full_resource_name) on GCP) @@ -76,12 +90,15 @@ module CLOUD # a TracerProvider. # # @note Stability Level: experimental + # + # @example Sample Values + # arn:aws:lambda:REGION:ACCOUNT_ID:function:my-function + # //run.googleapis.com/projects/PROJECT_ID/locations/LOCATION_ID/services/SERVICE_ID + # /subscriptions//resourceGroups//providers/Microsoft.Web/sites//functions/ + # CLOUD_RESOURCE_ID = 'cloud.resource_id' # @!endgroup - - # @!group Metric Names - # @!endgroup end end end diff --git a/semantic_conventions/lib/opentelemetry/semconv/incubating/cloudevents.rb b/semantic_conventions/lib/opentelemetry/semconv/incubating/cloudevents/attributes.rb similarity index 81% rename from semantic_conventions/lib/opentelemetry/semconv/incubating/cloudevents.rb rename to semantic_conventions/lib/opentelemetry/semconv/incubating/cloudevents/attributes.rb index 10993c8fed..9fa135b698 100644 --- a/semantic_conventions/lib/opentelemetry/semconv/incubating/cloudevents.rb +++ b/semantic_conventions/lib/opentelemetry/semconv/incubating/cloudevents/attributes.rb @@ -27,32 +27,53 @@ module CLOUDEVENTS # The [event_id](https://github.com/cloudevents/spec/blob/v1.0.2/cloudevents/spec.md#id) uniquely identifies the event. # # @note Stability Level: experimental + # + # @example Sample Values + # 123e4567-e89b-12d3-a456-426614174000 + # 0001 + # CLOUDEVENTS_EVENT_ID = 'cloudevents.event_id' # The [source](https://github.com/cloudevents/spec/blob/v1.0.2/cloudevents/spec.md#source-1) identifies the context in which an event happened. # # @note Stability Level: experimental + # + # @example Sample Values + # https://github.com/cloudevents + # /cloudevents/spec/pull/123 + # my-service + # CLOUDEVENTS_EVENT_SOURCE = 'cloudevents.event_source' # The [version of the CloudEvents specification](https://github.com/cloudevents/spec/blob/v1.0.2/cloudevents/spec.md#specversion) which the event uses. # # @note Stability Level: experimental + # + # @example Sample Values + # 1.0 + # CLOUDEVENTS_EVENT_SPEC_VERSION = 'cloudevents.event_spec_version' # The [subject](https://github.com/cloudevents/spec/blob/v1.0.2/cloudevents/spec.md#subject) of the event in the context of the event producer (identified by source). # # @note Stability Level: experimental + # + # @example Sample Values + # mynewfile.jpg + # CLOUDEVENTS_EVENT_SUBJECT = 'cloudevents.event_subject' # The [event_type](https://github.com/cloudevents/spec/blob/v1.0.2/cloudevents/spec.md#type) contains a value describing the type of event related to the originating occurrence. # # @note Stability Level: experimental + # + # @example Sample Values + # com.github.pull_request.opened + # com.example.object.deleted.v2 + # CLOUDEVENTS_EVENT_TYPE = 'cloudevents.event_type' # @!endgroup - - # @!group Metric Names - # @!endgroup end end end diff --git a/semantic_conventions/lib/opentelemetry/semconv/incubating/code.rb b/semantic_conventions/lib/opentelemetry/semconv/incubating/code/attributes.rb similarity index 78% rename from semantic_conventions/lib/opentelemetry/semconv/incubating/code.rb rename to semantic_conventions/lib/opentelemetry/semconv/incubating/code/attributes.rb index 6587558d2c..cb9785d297 100644 --- a/semantic_conventions/lib/opentelemetry/semconv/incubating/code.rb +++ b/semantic_conventions/lib/opentelemetry/semconv/incubating/code/attributes.rb @@ -27,37 +27,58 @@ module CODE # The column number in `code.filepath` best representing the operation. It SHOULD point within the code unit named in `code.function`. # # @note Stability Level: experimental + # + # @example Sample Values + # 16 + # CODE_COLUMN = 'code.column' # The source code file name that identifies the code unit as uniquely as possible (preferably an absolute file path). # # @note Stability Level: experimental + # + # @example Sample Values + # /usr/local/MyApplication/content_root/app/index.php + # CODE_FILEPATH = 'code.filepath' # The method or function name, or equivalent (usually rightmost part of the code unit's name). # # @note Stability Level: experimental + # + # @example Sample Values + # serveRequest + # CODE_FUNCTION = 'code.function' # The line number in `code.filepath` best representing the operation. It SHOULD point within the code unit named in `code.function`. # # @note Stability Level: experimental + # + # @example Sample Values + # 42 + # CODE_LINENO = 'code.lineno' # 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. # # @note Stability Level: experimental + # + # @example Sample Values + # com.example.MyHttpService + # CODE_NAMESPACE = 'code.namespace' # 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: experimental + # + # @example Sample Values + # 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) + # CODE_STACKTRACE = 'code.stacktrace' # @!endgroup - - # @!group Metric Names - # @!endgroup end end end diff --git a/semantic_conventions/lib/opentelemetry/semconv/incubating/container.rb b/semantic_conventions/lib/opentelemetry/semconv/incubating/container/attributes.rb similarity index 71% rename from semantic_conventions/lib/opentelemetry/semconv/incubating/container.rb rename to semantic_conventions/lib/opentelemetry/semconv/incubating/container/attributes.rb index 342a367616..e24a1dd478 100644 --- a/semantic_conventions/lib/opentelemetry/semconv/incubating/container.rb +++ b/semantic_conventions/lib/opentelemetry/semconv/incubating/container/attributes.rb @@ -29,26 +29,47 @@ module CONTAINER # If using embedded credentials or sensitive data, it is recommended to remove them to prevent potential leakage. # # @note Stability Level: experimental + # + # @example Sample Values + # otelcontribcol + # CONTAINER_COMMAND = 'container.command' # All the command arguments (including the command/executable itself) run by the container. [2] # # @note Stability Level: experimental + # + # @example Sample Values + # otelcontribcol, --config, config.yaml + # CONTAINER_COMMAND_ARGS = 'container.command_args' # The full command run by the container as a single string representing the full command. [2] # # @note Stability Level: experimental + # + # @example Sample Values + # otelcontribcol --config config.yaml + # CONTAINER_COMMAND_LINE = 'container.command_line' # The CPU state for this data point. # # @note Stability Level: experimental + # + # @example Sample Values + # user + # kernel + # CONTAINER_CPU_STATE = 'container.cpu.state' # 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. # # @note Stability Level: experimental + # + # @example Sample Values + # a3bf90e006b2 + # CONTAINER_ID = 'container.id' # Runtime specific image identifier. Usually a hash algorithm followed by a UUID. @@ -58,11 +79,19 @@ module CONTAINER # The ID is assigned by the container runtime and can vary in different environments. Consider using `oci.manifest.digest` if it is important to identify the same image in different environments/runtimes. # # @note Stability Level: experimental + # + # @example Sample Values + # sha256:19c92d0a00d1b66d897bceaa7319bee0dd38a10a851c60bcec9474aa3f01e50f + # CONTAINER_IMAGE_ID = 'container.image.id' # Name of the image the container was built on. # # @note Stability Level: experimental + # + # @example Sample Values + # gcr.io/opentelemetry/operator + # CONTAINER_IMAGE_NAME = 'container.image.name' # Repo digests of the container image as provided by the container runtime. @@ -70,38 +99,75 @@ module CONTAINER # [Docker](https://docs.docker.com/engine/api/v1.43/#tag/Image/operation/ImageInspect) and [CRI](https://github.com/kubernetes/cri-api/blob/c75ef5b473bbe2d0a4fc92f82235efd665ea8e9f/pkg/apis/runtime/v1/api.proto#L1237-L1238) report those under the `RepoDigests` field. # # @note Stability Level: experimental + # + # @example Sample Values + # example@sha256:afcc7f1ac1b49db317a7196c902e61c6c3c4607d63599ee1a82d702d249a0ccb + # internal.registry.example.com:5000/example@sha256:b69959407d21e8a062e0416bf13405bb2b71ed7a84dde4158ebafacfa06f5578 + # CONTAINER_IMAGE_REPO_DIGESTS = 'container.image.repo_digests' # Container image tags. An example can be found in [Docker Image Inspect](https://docs.docker.com/engine/api/v1.43/#tag/Image/operation/ImageInspect). Should be only the `` section of the full name for example from `registry.example.com/my-org/my-image:`. # # @note Stability Level: experimental + # + # @example Sample Values + # v1.27.1 + # 3.5.7-0 + # CONTAINER_IMAGE_TAGS = 'container.image.tags' + # Must be called with a key for the full attribute name. See notes below about the expectations + # for the state of the key. + # + # @example Usage + # CONTAINER_LABEL_LAMBDA.call('some-cool-key') #=> 'container.label.some-cool-key' + # # Container labels, `` being the label name, the value being the label value. # # @note Stability Level: experimental + # + # @example Sample Values + # container.label.app=nginx + # CONTAINER_LABEL_LAMBDA = ->(key) { "container.label.#{key}" } + # Must be called with a key for the full attribute name. See notes below about the expectations + # for the state of the key. + # + # @example Usage + # CONTAINER_LABELS_LAMBDA.call('some-cool-key') #=> 'container.labels.some-cool-key' + # # Deprecated, use `container.label` instead. # # @note Stability Level: experimental + # + # @example Sample Values + # container.label.app=nginx + # # @deprecated Replaced by `container.label`. CONTAINER_LABELS_LAMBDA = ->(key) { "container.labels.#{key}" } # Container name used by container runtime. # # @note Stability Level: experimental + # + # @example Sample Values + # opentelemetry-autoconf + # CONTAINER_NAME = 'container.name' # The container runtime managing this container. # # @note Stability Level: experimental + # + # @example Sample Values + # docker + # containerd + # rkt + # CONTAINER_RUNTIME = 'container.runtime' # @!endgroup - - # @!group Metric Names - # @!endgroup end end end diff --git a/semantic_conventions/lib/opentelemetry/semconv/incubating/container/metrics.rb b/semantic_conventions/lib/opentelemetry/semconv/incubating/container/metrics.rb new file mode 100644 index 0000000000..632e1a8e78 --- /dev/null +++ b/semantic_conventions/lib/opentelemetry/semconv/incubating/container/metrics.rb @@ -0,0 +1,59 @@ +# 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 CONTAINER + # @!group Metrics Names + + # Total CPU time consumed + # + # Total CPU time consumed by the specific container on all available CPU cores + # + # @note Stability Level: experimental + CONTAINER_CPU_TIME = 'container.cpu.time' + + # Disk bytes for the container. + # + # The total number of bytes read/written successfully (aggregated from all disks). + # + # @note Stability Level: experimental + CONTAINER_DISK_IO = 'container.disk.io' + + # Memory usage of the container. + # + # Memory usage of the container. + # + # @note Stability Level: experimental + CONTAINER_MEMORY_USAGE = 'container.memory.usage' + + # Network bytes for the container. + # + # The number of bytes sent/received on all network interfaces by the container. + # + # @note Stability Level: experimental + CONTAINER_NETWORK_IO = 'container.network.io' + + # @!endgroup + end + end + end +end \ No newline at end of file diff --git a/semantic_conventions/lib/opentelemetry/semconv/incubating/db.rb b/semantic_conventions/lib/opentelemetry/semconv/incubating/db/attributes.rb similarity index 76% rename from semantic_conventions/lib/opentelemetry/semconv/incubating/db.rb rename to semantic_conventions/lib/opentelemetry/semconv/incubating/db/attributes.rb index 6dd3dad695..ed32e14bd6 100644 --- a/semantic_conventions/lib/opentelemetry/semconv/incubating/db.rb +++ b/semantic_conventions/lib/opentelemetry/semconv/incubating/db/attributes.rb @@ -32,11 +32,19 @@ module DB # The data center of the coordinating node for a query. # # @note Stability Level: experimental + # + # @example Sample Values + # us-west-2 + # DB_CASSANDRA_COORDINATOR_DC = 'db.cassandra.coordinator.dc' # The ID of the coordinating node for a query. # # @note Stability Level: experimental + # + # @example Sample Values + # be13faa2-8574-4d71-926d-27f16cf8a7af + # DB_CASSANDRA_COORDINATOR_ID = 'db.cassandra.coordinator.id' # Whether or not the query is idempotent. @@ -47,27 +55,48 @@ module DB # The fetch size used for paging, i.e. how many rows will be returned at once. # # @note Stability Level: experimental + # + # @example Sample Values + # 5000 + # DB_CASSANDRA_PAGE_SIZE = 'db.cassandra.page_size' # The number of times a query was speculatively executed. Not set or `0` if the query was not executed speculatively. # # @note Stability Level: experimental + # + # @example Sample Values + # 0 + # 2 + # DB_CASSANDRA_SPECULATIVE_EXECUTION_COUNT = 'db.cassandra.speculative_execution_count' # Deprecated, use `db.collection.name` instead. # # @note Stability Level: experimental + # + # @example Sample Values + # mytable + # # @deprecated Replaced by `db.collection.name`. DB_CASSANDRA_TABLE = 'db.cassandra.table' # The name of the connection pool; unique within the instrumented application. In case the connection pool implementation doesn't provide a name, instrumentation should use a combination of `server.address` and `server.port` attributes formatted as `server.address:server.port`. # # @note Stability Level: experimental + # + # @example Sample Values + # myDataSource + # DB_CLIENT_CONNECTIONS_POOL_NAME = 'db.client.connections.pool.name' # The state of a connection in the pool # # @note Stability Level: experimental + # + # @example Sample Values + # idle + # DB_CLIENT_CONNECTIONS_STATE = 'db.client.connections.state' # The name of a collection (table, container) within the database. @@ -76,17 +105,30 @@ module DB # It is RECOMMENDED to capture the value as provided by the application without attempting to do any case normalization. # # @note Stability Level: experimental + # + # @example Sample Values + # public.users + # customers + # DB_COLLECTION_NAME = 'db.collection.name' # Deprecated, use `server.address`, `server.port` attributes instead. # # @note Stability Level: experimental + # + # @example Sample Values + # Server=(localdb)\v11.0;Integrated Security=true; + # # @deprecated "Replaced by `server.address` and `server.port`." DB_CONNECTION_STRING = 'db.connection_string' # Unique Cosmos client instance id. # # @note Stability Level: experimental + # + # @example Sample Values + # 3ba4827d-4422-483f-b59f-85b74211c11d + # DB_COSMOSDB_CLIENT_ID = 'db.cosmosdb.client_id' # Cosmos client connection mode. @@ -97,6 +139,10 @@ module DB # Deprecated, use `db.collection.name` instead. # # @note Stability Level: experimental + # + # @example Sample Values + # mytable + # # @deprecated Replaced by `db.collection.name`. DB_COSMOSDB_CONTAINER = 'db.cosmosdb.container' @@ -108,6 +154,11 @@ module DB # RU consumed for that operation # # @note Stability Level: experimental + # + # @example Sample Values + # 46.18 + # 1.0 + # DB_COSMOSDB_REQUEST_CHARGE = 'db.cosmosdb.request_charge' # Request payload size in bytes @@ -118,57 +169,108 @@ module DB # Cosmos DB status code. # # @note Stability Level: experimental + # + # @example Sample Values + # 200 + # 201 + # DB_COSMOSDB_STATUS_CODE = 'db.cosmosdb.status_code' # Cosmos DB sub status code. # # @note Stability Level: experimental + # + # @example Sample Values + # 1000 + # 1002 + # DB_COSMOSDB_SUB_STATUS_CODE = 'db.cosmosdb.sub_status_code' # Represents the identifier of an Elasticsearch cluster. # # @note Stability Level: experimental + # + # @example Sample Values + # e9106fc68e3044f0b1475b04bf4ffd5f + # DB_ELASTICSEARCH_CLUSTER_NAME = 'db.elasticsearch.cluster.name' # Represents the human-readable identifier of the node/instance to which a request was routed. # # @note Stability Level: experimental + # + # @example Sample Values + # instance-0000000001 + # DB_ELASTICSEARCH_NODE_NAME = 'db.elasticsearch.node.name' + # Must be called with a key for the full attribute name. See notes below about the expectations + # for the state of the key. + # + # @example Usage + # DB_ELASTICSEARCH_PATH_PARTS_LAMBDA.call('some-cool-key') #=> 'db.elasticsearch.path_parts.some-cool-key' + # # A dynamic value in the url path. # # Many Elasticsearch url paths allow dynamic values. These SHOULD be recorded in span attributes in the format `db.elasticsearch.path_parts.`, where `` is the url path part name. The implementation SHOULD reference the [elasticsearch schema](https://raw.githubusercontent.com/elastic/elasticsearch-specification/main/output/schema/schema.json) in order to map the path part values to their names. # # @note Stability Level: experimental + # + # @example Sample Values + # db.elasticsearch.path_parts.index=test-index + # db.elasticsearch.path_parts.doc_id=123 + # DB_ELASTICSEARCH_PATH_PARTS_LAMBDA = ->(key) { "db.elasticsearch.path_parts.#{key}" } # Deprecated, no general replacement at this time. For Elasticsearch, use `db.elasticsearch.node.name` instead. # # @note Stability Level: experimental + # + # @example Sample Values + # mysql-e26b99z.example.com + # # @deprecated Deprecated, no general replacement at this time. For Elasticsearch, use `db.elasticsearch.node.name` instead. DB_INSTANCE_ID = 'db.instance.id' # Removed, no replacement at this time. # # @note Stability Level: experimental + # + # @example Sample Values + # org.postgresql.Driver + # com.microsoft.sqlserver.jdbc.SQLServerDriver + # # @deprecated Removed as not used. DB_JDBC_DRIVER_CLASSNAME = 'db.jdbc.driver_classname' # Deprecated, use `db.collection.name` instead. # # @note Stability Level: experimental + # + # @example Sample Values + # mytable + # # @deprecated Replaced by `db.collection.name`. DB_MONGODB_COLLECTION = 'db.mongodb.collection' # Deprecated, SQL Server instance is now populated as a part of `db.namespace` attribute. # # @note Stability Level: experimental + # + # @example Sample Values + # MSSQLSERVER + # # @deprecated Deprecated, no replacement at this time. DB_MSSQL_INSTANCE_NAME = 'db.mssql.instance_name' # Deprecated, use `db.namespace` instead. # # @note Stability Level: experimental + # + # @example Sample Values + # customers + # main + # # @deprecated Replaced by `db.namespace`. DB_NAME = 'db.name' @@ -179,11 +281,22 @@ module DB # It is RECOMMENDED to capture the value as provided by the application without attempting to do any case normalization. # # @note Stability Level: experimental + # + # @example Sample Values + # customers + # test.users + # DB_NAMESPACE = 'db.namespace' # Deprecated, use `db.operation.name` instead. # # @note Stability Level: experimental + # + # @example Sample Values + # findAndModify + # HMSET + # SELECT + # # @deprecated Replaced by `db.operation.name`. DB_OPERATION = 'db.operation' @@ -192,36 +305,73 @@ module DB # It is RECOMMENDED to capture the value as provided by the application without attempting to do any case normalization. # # @note Stability Level: experimental + # + # @example Sample Values + # findAndModify + # HMSET + # SELECT + # DB_OPERATION_NAME = 'db.operation.name' + # Must be called with a key for the full attribute name. See notes below about the expectations + # for the state of the key. + # + # @example Usage + # DB_QUERY_PARAMETER_LAMBDA.call('some-cool-key') #=> 'db.query.parameter.some-cool-key' + # # The query parameters used in `db.query.text`, with `` being the parameter name, and the attribute value being the parameter value. # # Query parameters should only be captured when `db.query.text` is parameterized with placeholders. # If a parameter has no name and instead is referenced only by index, then `` SHOULD be the 0-based index. # # @note Stability Level: experimental + # + # @example Sample Values + # someval + # 55 + # DB_QUERY_PARAMETER_LAMBDA = ->(key) { "db.query.parameter.#{key}" } # The database query being executed. # # @note Stability Level: experimental + # + # @example Sample Values + # SELECT * FROM wuser_table where username = ? + # SET mykey "WuValue" + # DB_QUERY_TEXT = 'db.query.text' # Deprecated, use `db.namespace` instead. # # @note Stability Level: experimental + # + # @example Sample Values + # 0 + # 1 + # 15 + # # @deprecated Replaced by `db.namespace`. DB_REDIS_DATABASE_INDEX = 'db.redis.database_index' # Deprecated, use `db.collection.name` instead. # # @note Stability Level: experimental + # + # @example Sample Values + # mytable + # # @deprecated Replaced by `db.collection.name`. DB_SQL_TABLE = 'db.sql.table' # The database statement being executed. # # @note Stability Level: experimental + # + # @example Sample Values + # SELECT * FROM wuser_table + # SET mykey "WuValue" + # # @deprecated Replaced by `db.query.text`. DB_STATEMENT = 'db.statement' @@ -235,13 +385,15 @@ module DB # Deprecated, no replacement at this time. # # @note Stability Level: experimental + # + # @example Sample Values + # readonly_user + # reporting_user + # # @deprecated No replacement at this time. DB_USER = 'db.user' # @!endgroup - - # @!group Metric Names - # @!endgroup end end end diff --git a/semantic_conventions/lib/opentelemetry/semconv/incubating/db/metrics.rb b/semantic_conventions/lib/opentelemetry/semconv/incubating/db/metrics.rb new file mode 100644 index 0000000000..388d5a683f --- /dev/null +++ b/semantic_conventions/lib/opentelemetry/semconv/incubating/db/metrics.rb @@ -0,0 +1,135 @@ +# 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 DB + # @!group Metrics Names + + # The number of connections that are currently in state described by the `state` attribute + # + # @note Stability Level: experimental + DB_CLIENT_CONNECTION_COUNT = 'db.client.connection.count' + + # The time it took to create a new connection + # + # @note Stability Level: experimental + DB_CLIENT_CONNECTION_CREATE_TIME = 'db.client.connection.create_time' + + # The maximum number of idle open connections allowed + # + # @note Stability Level: experimental + DB_CLIENT_CONNECTION_IDLE_MAX = 'db.client.connection.idle.max' + + # The minimum number of idle open connections allowed + # + # @note Stability Level: experimental + DB_CLIENT_CONNECTION_IDLE_MIN = 'db.client.connection.idle.min' + + # The maximum number of open connections allowed + # + # @note Stability Level: experimental + DB_CLIENT_CONNECTION_MAX = 'db.client.connection.max' + + # The number of pending requests for an open connection, cumulative for the entire pool + # + # @note Stability Level: experimental + DB_CLIENT_CONNECTION_PENDING_REQUESTS = 'db.client.connection.pending_requests' + + # The number of connection timeouts that have occurred trying to obtain a connection from the pool + # + # @note Stability Level: experimental + DB_CLIENT_CONNECTION_TIMEOUTS = 'db.client.connection.timeouts' + + # The time between borrowing a connection and returning it to the pool + # + # @note Stability Level: experimental + DB_CLIENT_CONNECTION_USE_TIME = 'db.client.connection.use_time' + + # The time it took to obtain an open connection from the pool + # + # @note Stability Level: experimental + DB_CLIENT_CONNECTION_WAIT_TIME = 'db.client.connection.wait_time' + + # Deprecated, use `db.client.connection.create_time` instead. Note: the unit also changed from `ms` to `s`. + # + # @note Stability Level: experimental + # @deprecated Replaced by `db.client.connection.create_time`. Note: the unit also changed from `ms` to `s`. + DB_CLIENT_CONNECTIONS_CREATE_TIME = 'db.client.connections.create_time' + + # Deprecated, use `db.client.connection.idle.max` instead. + # + # @note Stability Level: experimental + # @deprecated Replaced by `db.client.connection.idle.max`. + DB_CLIENT_CONNECTIONS_IDLE_MAX = 'db.client.connections.idle.max' + + # Deprecated, use `db.client.connection.idle.min` instead. + # + # @note Stability Level: experimental + # @deprecated Replaced by `db.client.connection.idle.min`. + DB_CLIENT_CONNECTIONS_IDLE_MIN = 'db.client.connections.idle.min' + + # Deprecated, use `db.client.connection.max` instead. + # + # @note Stability Level: experimental + # @deprecated Replaced by `db.client.connection.max`. + DB_CLIENT_CONNECTIONS_MAX = 'db.client.connections.max' + + # Deprecated, use `db.client.connection.pending_requests` instead. + # + # @note Stability Level: experimental + # @deprecated Replaced by `db.client.connection.pending_requests`. + DB_CLIENT_CONNECTIONS_PENDING_REQUESTS = 'db.client.connections.pending_requests' + + # Deprecated, use `db.client.connection.timeouts` instead. + # + # @note Stability Level: experimental + # @deprecated Replaced by `db.client.connection.timeouts`. + DB_CLIENT_CONNECTIONS_TIMEOUTS = 'db.client.connections.timeouts' + + # Deprecated, use `db.client.connection.count` instead. + # + # @note Stability Level: experimental + # @deprecated Replaced by `db.client.connection.count`. + DB_CLIENT_CONNECTIONS_USAGE = 'db.client.connections.usage' + + # Deprecated, use `db.client.connection.use_time` instead. Note: the unit also changed from `ms` to `s`. + # + # @note Stability Level: experimental + # @deprecated Replaced by `db.client.connection.use_time`. Note: the unit also changed from `ms` to `s`. + DB_CLIENT_CONNECTIONS_USE_TIME = 'db.client.connections.use_time' + + # Deprecated, use `db.client.connection.wait_time` instead. Note: the unit also changed from `ms` to `s`. + # + # @note Stability Level: experimental + # @deprecated Replaced by `db.client.connection.wait_time`. Note: the unit also changed from `ms` to `s`. + DB_CLIENT_CONNECTIONS_WAIT_TIME = 'db.client.connections.wait_time' + + # Duration of database client operations. + # + # @note Stability Level: experimental + DB_CLIENT_OPERATION_DURATION = 'db.client.operation.duration' + + # @!endgroup + end + end + end +end \ No newline at end of file diff --git a/semantic_conventions/lib/opentelemetry/semconv/incubating/deployment.rb b/semantic_conventions/lib/opentelemetry/semconv/incubating/deployment/attributes.rb similarity index 94% rename from semantic_conventions/lib/opentelemetry/semconv/incubating/deployment.rb rename to semantic_conventions/lib/opentelemetry/semconv/incubating/deployment/attributes.rb index b2a30b42ce..59a1124269 100644 --- a/semantic_conventions/lib/opentelemetry/semconv/incubating/deployment.rb +++ b/semantic_conventions/lib/opentelemetry/semconv/incubating/deployment/attributes.rb @@ -35,12 +35,14 @@ module DEPLOYMENT # - `service.name=frontend`, `deployment.environment=staging`. # # @note Stability Level: experimental + # + # @example Sample Values + # staging + # production + # DEPLOYMENT_ENVIRONMENT = 'deployment.environment' # @!endgroup - - # @!group Metric Names - # @!endgroup end end end diff --git a/semantic_conventions/lib/opentelemetry/semconv/incubating/destination.rb b/semantic_conventions/lib/opentelemetry/semconv/incubating/destination/attributes.rb similarity index 88% rename from semantic_conventions/lib/opentelemetry/semconv/incubating/destination.rb rename to semantic_conventions/lib/opentelemetry/semconv/incubating/destination/attributes.rb index 1123a0a14c..6c92a2b797 100644 --- a/semantic_conventions/lib/opentelemetry/semconv/incubating/destination.rb +++ b/semantic_conventions/lib/opentelemetry/semconv/incubating/destination/attributes.rb @@ -29,17 +29,25 @@ module DESTINATION # When observed from the source side, and when communicating through an intermediary, `destination.address` SHOULD represent the destination address behind any intermediaries, for example proxies, if it's available. # # @note Stability Level: experimental + # + # @example Sample Values + # destination.example.com + # 10.1.2.80 + # /tmp/my.sock + # DESTINATION_ADDRESS = 'destination.address' # Destination port number # # @note Stability Level: experimental + # + # @example Sample Values + # 3389 + # 2888 + # DESTINATION_PORT = 'destination.port' # @!endgroup - - # @!group Metric Names - # @!endgroup end end end diff --git a/semantic_conventions/lib/opentelemetry/semconv/incubating/device.rb b/semantic_conventions/lib/opentelemetry/semconv/incubating/device/attributes.rb similarity index 88% rename from semantic_conventions/lib/opentelemetry/semconv/incubating/device.rb rename to semantic_conventions/lib/opentelemetry/semconv/incubating/device/attributes.rb index bf5519eee9..abbc368cc8 100644 --- a/semantic_conventions/lib/opentelemetry/semconv/incubating/device.rb +++ b/semantic_conventions/lib/opentelemetry/semconv/incubating/device/attributes.rb @@ -29,6 +29,10 @@ module DEVICE # 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. # # @note Stability Level: experimental + # + # @example Sample Values + # 2ab2916d-a51f-4ac8-80ee-45ac31a28092 + # DEVICE_ID = 'device.id' # The name of the device manufacturer @@ -36,6 +40,11 @@ module DEVICE # The Android OS provides this field via [Build](https://developer.android.com/reference/android/os/Build#MANUFACTURER). iOS apps SHOULD hardcode the value `Apple`. # # @note Stability Level: experimental + # + # @example Sample Values + # Apple + # Samsung + # DEVICE_MANUFACTURER = 'device.manufacturer' # The model identifier for the device @@ -43,6 +52,11 @@ module DEVICE # 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. # # @note Stability Level: experimental + # + # @example Sample Values + # iPhone3,4 + # SM-G920F + # DEVICE_MODEL_IDENTIFIER = 'device.model.identifier' # The marketing name for the device model @@ -50,12 +64,14 @@ module DEVICE # It's recommended this value represents a human-readable version of the device model rather than a machine-readable alternative. # # @note Stability Level: experimental + # + # @example Sample Values + # iPhone 6s Plus + # Samsung Galaxy S6 + # DEVICE_MODEL_NAME = 'device.model.name' # @!endgroup - - # @!group Metric Names - # @!endgroup end end end diff --git a/semantic_conventions/lib/opentelemetry/semconv/incubating/disk.rb b/semantic_conventions/lib/opentelemetry/semconv/incubating/disk/attributes.rb similarity index 94% rename from semantic_conventions/lib/opentelemetry/semconv/incubating/disk.rb rename to semantic_conventions/lib/opentelemetry/semconv/incubating/disk/attributes.rb index 670436e794..c040fb8e32 100644 --- a/semantic_conventions/lib/opentelemetry/semconv/incubating/disk.rb +++ b/semantic_conventions/lib/opentelemetry/semconv/incubating/disk/attributes.rb @@ -27,12 +27,13 @@ module DISK # The disk IO operation direction. # # @note Stability Level: experimental + # + # @example Sample Values + # read + # DISK_IO_DIRECTION = 'disk.io.direction' # @!endgroup - - # @!group Metric Names - # @!endgroup end end end diff --git a/semantic_conventions/lib/opentelemetry/semconv/incubating/dns.rb b/semantic_conventions/lib/opentelemetry/semconv/incubating/dns/attributes.rb similarity index 92% rename from semantic_conventions/lib/opentelemetry/semconv/incubating/dns.rb rename to semantic_conventions/lib/opentelemetry/semconv/incubating/dns/attributes.rb index 937bf2e52e..cc2c0cce2b 100644 --- a/semantic_conventions/lib/opentelemetry/semconv/incubating/dns.rb +++ b/semantic_conventions/lib/opentelemetry/semconv/incubating/dns/attributes.rb @@ -29,12 +29,14 @@ module DNS # If the name field contains non-printable characters (below 32 or above 126), those characters should be represented as escaped base 10 integers (\DDD). Back slashes and quotes should be escaped. Tabs, carriage returns, and line feeds should be converted to \t, \r, and \n respectively. # # @note Stability Level: experimental + # + # @example Sample Values + # www.example.com + # opentelemetry.io + # DNS_QUESTION_NAME = 'dns.question.name' # @!endgroup - - # @!group Metric Names - # @!endgroup end end end diff --git a/semantic_conventions/lib/opentelemetry/semconv/incubating/dns/metrics.rb b/semantic_conventions/lib/opentelemetry/semconv/incubating/dns/metrics.rb new file mode 100644 index 0000000000..726f68c183 --- /dev/null +++ b/semantic_conventions/lib/opentelemetry/semconv/incubating/dns/metrics.rb @@ -0,0 +1,36 @@ +# 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 DNS + # @!group Metrics Names + + # Measures the time taken to perform a DNS lookup. + # + # @note Stability Level: experimental + DNS_LOOKUP_DURATION = 'dns.lookup.duration' + + # @!endgroup + end + end + end +end \ No newline at end of file diff --git a/semantic_conventions/lib/opentelemetry/semconv/incubating/enduser.rb b/semantic_conventions/lib/opentelemetry/semconv/incubating/enduser/attributes.rb similarity index 89% rename from semantic_conventions/lib/opentelemetry/semconv/incubating/enduser.rb rename to semantic_conventions/lib/opentelemetry/semconv/incubating/enduser/attributes.rb index b961e5168b..234786671b 100644 --- a/semantic_conventions/lib/opentelemetry/semconv/incubating/enduser.rb +++ b/semantic_conventions/lib/opentelemetry/semconv/incubating/enduser/attributes.rb @@ -27,22 +27,31 @@ module ENDUSER # 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. # # @note Stability Level: experimental + # + # @example Sample Values + # username + # ENDUSER_ID = 'enduser.id' # Actual/assumed role the client is making the request under extracted from token or application security context. # # @note Stability Level: experimental + # + # @example Sample Values + # admin + # ENDUSER_ROLE = 'enduser.role' # 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). # # @note Stability Level: experimental + # + # @example Sample Values + # read:message, write:files + # ENDUSER_SCOPE = 'enduser.scope' # @!endgroup - - # @!group Metric Names - # @!endgroup end end end diff --git a/semantic_conventions/lib/opentelemetry/semconv/incubating/error.rb b/semantic_conventions/lib/opentelemetry/semconv/incubating/error/attributes.rb similarity index 91% rename from semantic_conventions/lib/opentelemetry/semconv/incubating/error.rb rename to semantic_conventions/lib/opentelemetry/semconv/incubating/error/attributes.rb index 1a086a262b..1e97e3a0f8 100644 --- a/semantic_conventions/lib/opentelemetry/semconv/incubating/error.rb +++ b/semantic_conventions/lib/opentelemetry/semconv/incubating/error/attributes.rb @@ -48,13 +48,17 @@ module ERROR # # @note Stability Level: stable # - # @deprecated Now available in the stable namespace at {OpenTelemetry::SemConv::Error::ERROR_TYPE}. + # @example Sample Values + # timeout + # java.net.UnknownHostException + # server_certificate_invalid + # 500 + # + # + # @deprecated Now available in the stable namespace at {OpenTelemetry::SemConv::ERROR::ERROR_TYPE}. ERROR_TYPE = 'error.type' # @!endgroup - - # @!group Metric Names - # @!endgroup end end end diff --git a/semantic_conventions/lib/opentelemetry/semconv/incubating/event.rb b/semantic_conventions/lib/opentelemetry/semconv/incubating/event/attributes.rb similarity index 92% rename from semantic_conventions/lib/opentelemetry/semconv/incubating/event.rb rename to semantic_conventions/lib/opentelemetry/semconv/incubating/event/attributes.rb index 8d0a2bd0be..8fbd0ec478 100644 --- a/semantic_conventions/lib/opentelemetry/semconv/incubating/event.rb +++ b/semantic_conventions/lib/opentelemetry/semconv/incubating/event/attributes.rb @@ -29,12 +29,14 @@ module EVENT # Event names are subject to the same rules as [attribute names](https://github.com/open-telemetry/opentelemetry-specification/tree/v1.33.0/specification/common/attribute-naming.md). Notably, event names are namespaced to avoid collisions and provide a clean separation of semantics for events in separate domains like browser, mobile, and kubernetes. # # @note Stability Level: experimental + # + # @example Sample Values + # browser.mouse.click + # device.app.lifecycle + # EVENT_NAME = 'event.name' # @!endgroup - - # @!group Metric Names - # @!endgroup end end end diff --git a/semantic_conventions/lib/opentelemetry/semconv/exception.rb b/semantic_conventions/lib/opentelemetry/semconv/incubating/exception/attributes.rb similarity index 73% rename from semantic_conventions/lib/opentelemetry/semconv/exception.rb rename to semantic_conventions/lib/opentelemetry/semconv/incubating/exception/attributes.rb index 7f52ed152e..f4b83230af 100644 --- a/semantic_conventions/lib/opentelemetry/semconv/exception.rb +++ b/semantic_conventions/lib/opentelemetry/semconv/incubating/exception/attributes.rb @@ -20,6 +20,7 @@ module OpenTelemetry module SemConv + module Incubating module EXCEPTION # @!group Attribute Names @@ -43,27 +44,47 @@ module EXCEPTION # clear whether the exception will escape. # # @note Stability Level: stable + # + # @deprecated Now available in the stable namespace at {OpenTelemetry::SemConv::EXCEPTION::EXCEPTION_ESCAPED}. 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 - - # @!group Metric Names - # @!endgroup end end + end end \ No newline at end of file diff --git a/semantic_conventions/lib/opentelemetry/semconv/incubating/faas.rb b/semantic_conventions/lib/opentelemetry/semconv/incubating/faas/attributes.rb similarity index 86% rename from semantic_conventions/lib/opentelemetry/semconv/incubating/faas.rb rename to semantic_conventions/lib/opentelemetry/semconv/incubating/faas/attributes.rb index ac25103c55..daa0927afa 100644 --- a/semantic_conventions/lib/opentelemetry/semconv/incubating/faas.rb +++ b/semantic_conventions/lib/opentelemetry/semconv/incubating/faas/attributes.rb @@ -32,16 +32,30 @@ module FAAS # 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: experimental + # + # @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: experimental + # + # @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: experimental + # + # @example Sample Values + # myFile.txt + # myTableName + # FAAS_DOCUMENT_NAME = 'faas.document.name' # Describes the type of the operation that was performed on the data. @@ -52,6 +66,10 @@ module FAAS # 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: experimental + # + # @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. @@ -59,11 +77,19 @@ module FAAS # - **AWS Lambda:** Use the (full) log stream name. # # @note Stability Level: experimental + # + # @example Sample Values + # 2021/06/28/[$LATEST]2f399eb14537447da05ab2a2e39309de + # FAAS_INSTANCE = 'faas.instance' # The invocation ID of the current function invocation. # # @note Stability Level: experimental + # + # @example Sample Values + # af9d5aa4-a685-4c5f-a22b-444f80b3cc28 + # FAAS_INVOCATION_ID = 'faas.invocation_id' # The name of the invoked function. @@ -71,6 +97,10 @@ module FAAS # SHOULD be equal to the `faas.name` resource attribute of the invoked function. # # @note Stability Level: experimental + # + # @example Sample Values + # my-function + # FAAS_INVOKED_NAME = 'faas.invoked_name' # The cloud provider of the invoked function. @@ -85,6 +115,10 @@ module FAAS # SHOULD be equal to the `cloud.region` resource attribute of the invoked function. # # @note Stability Level: experimental + # + # @example Sample Values + # eu-central-1 + # FAAS_INVOKED_REGION = 'faas.invoked_region' # The amount of memory available to the serverless function converted to Bytes. @@ -92,6 +126,10 @@ module FAAS # 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: experimental + # + # @example Sample Values + # 134217728 + # FAAS_MAX_MEMORY = 'faas.max_memory' # The name of the single function that this runtime instance executes. @@ -114,11 +152,20 @@ module FAAS # a TracerProvider (see also the `cloud.resource_id` attribute). # # @note Stability Level: experimental + # + # @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: experimental + # + # @example Sample Values + # 2020-01-23T13:47:06Z + # FAAS_TIME = 'faas.time' # Type of the trigger which caused this function invocation. @@ -139,12 +186,14 @@ module FAAS # - **Azure Functions:** Not applicable. Do not set this attribute. # # @note Stability Level: experimental + # + # @example Sample Values + # 26 + # pinkfroid-00002 + # FAAS_VERSION = 'faas.version' # @!endgroup - - # @!group Metric Names - # @!endgroup end end end diff --git a/semantic_conventions/lib/opentelemetry/semconv/incubating/faas/metrics.rb b/semantic_conventions/lib/opentelemetry/semconv/incubating/faas/metrics.rb new file mode 100644 index 0000000000..a9c765a90b --- /dev/null +++ b/semantic_conventions/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: experimental + FAAS_COLDSTARTS = 'faas.coldstarts' + + # Distribution of CPU usage per invocation + # + # @note Stability Level: experimental + FAAS_CPU_USAGE = 'faas.cpu_usage' + + # Number of invocation errors + # + # @note Stability Level: experimental + FAAS_ERRORS = 'faas.errors' + + # Measures the duration of the function's initialization, such as a cold start + # + # @note Stability Level: experimental + FAAS_INIT_DURATION = 'faas.init_duration' + + # Number of successful invocations + # + # @note Stability Level: experimental + FAAS_INVOCATIONS = 'faas.invocations' + + # Measures the duration of the function's logic execution + # + # @note Stability Level: experimental + FAAS_INVOKE_DURATION = 'faas.invoke_duration' + + # Distribution of max memory usage per invocation + # + # @note Stability Level: experimental + FAAS_MEM_USAGE = 'faas.mem_usage' + + # Distribution of net I/O usage per invocation + # + # @note Stability Level: experimental + FAAS_NET_IO = 'faas.net_io' + + # Number of invocation timeouts + # + # @note Stability Level: experimental + FAAS_TIMEOUTS = 'faas.timeouts' + + # @!endgroup + end + end + end +end \ No newline at end of file diff --git a/semantic_conventions/lib/opentelemetry/semconv/incubating/feature_flag.rb b/semantic_conventions/lib/opentelemetry/semconv/incubating/feature_flag/attributes.rb similarity index 89% rename from semantic_conventions/lib/opentelemetry/semconv/incubating/feature_flag.rb rename to semantic_conventions/lib/opentelemetry/semconv/incubating/feature_flag/attributes.rb index fd3cbd2fa0..097e3b361b 100644 --- a/semantic_conventions/lib/opentelemetry/semconv/incubating/feature_flag.rb +++ b/semantic_conventions/lib/opentelemetry/semconv/incubating/feature_flag/attributes.rb @@ -27,11 +27,19 @@ module FEATURE_FLAG # The unique identifier of the feature flag. # # @note Stability Level: experimental + # + # @example Sample Values + # logo-color + # FEATURE_FLAG_KEY = 'feature_flag.key' # The name of the service provider that performs the flag evaluation. # # @note Stability Level: experimental + # + # @example Sample Values + # Flag Manager + # FEATURE_FLAG_PROVIDER_NAME = 'feature_flag.provider_name' # SHOULD be a semantic identifier for a value. If one is unavailable, a stringified version of the value can be used. @@ -46,12 +54,15 @@ module FEATURE_FLAG # should be determined by the implementer. # # @note Stability Level: experimental + # + # @example Sample Values + # red + # true + # on + # FEATURE_FLAG_VARIANT = 'feature_flag.variant' # @!endgroup - - # @!group Metric Names - # @!endgroup end end end diff --git a/semantic_conventions/lib/opentelemetry/semconv/incubating/file.rb b/semantic_conventions/lib/opentelemetry/semconv/incubating/file/attributes.rb similarity index 83% rename from semantic_conventions/lib/opentelemetry/semconv/incubating/file.rb rename to semantic_conventions/lib/opentelemetry/semconv/incubating/file/attributes.rb index cbaf84b84c..6a00dee8ea 100644 --- a/semantic_conventions/lib/opentelemetry/semconv/incubating/file.rb +++ b/semantic_conventions/lib/opentelemetry/semconv/incubating/file/attributes.rb @@ -27,6 +27,11 @@ module FILE # Directory where the file is located. It should include the drive letter, when appropriate. # # @note Stability Level: experimental + # + # @example Sample Values + # /home/user + # C:\Program Files\MyApp + # FILE_DIRECTORY = 'file.directory' # File extension, excluding the leading dot. @@ -34,16 +39,30 @@ module FILE # When the file name has multiple extensions (example.tar.gz), only the last one should be captured ("gz", not "tar.gz"). # # @note Stability Level: experimental + # + # @example Sample Values + # png + # gz + # FILE_EXTENSION = 'file.extension' # Name of the file including the extension, without the directory. # # @note Stability Level: experimental + # + # @example Sample Values + # example.png + # FILE_NAME = 'file.name' # Full path to the file, including the file name. It should include the drive letter, when appropriate. # # @note Stability Level: experimental + # + # @example Sample Values + # /home/alice/example.png + # C:\Program Files\MyApp\myapp.exe + # FILE_PATH = 'file.path' # File size in bytes. @@ -52,9 +71,6 @@ module FILE FILE_SIZE = 'file.size' # @!endgroup - - # @!group Metric Names - # @!endgroup end end end diff --git a/semantic_conventions/lib/opentelemetry/semconv/incubating/gcp.rb b/semantic_conventions/lib/opentelemetry/semconv/incubating/gcp/attributes.rb similarity index 85% rename from semantic_conventions/lib/opentelemetry/semconv/incubating/gcp.rb rename to semantic_conventions/lib/opentelemetry/semconv/incubating/gcp/attributes.rb index fffb38033f..30096e2a5c 100644 --- a/semantic_conventions/lib/opentelemetry/semconv/incubating/gcp.rb +++ b/semantic_conventions/lib/opentelemetry/semconv/incubating/gcp/attributes.rb @@ -27,27 +27,44 @@ module GCP # The name of the Cloud Run [execution](https://cloud.google.com/run/docs/managing/job-executions) being run for the Job, as set by the [`CLOUD_RUN_EXECUTION`](https://cloud.google.com/run/docs/container-contract#jobs-env-vars) environment variable. # # @note Stability Level: experimental + # + # @example Sample Values + # job-name-xxxx + # sample-job-mdw84 + # GCP_CLOUD_RUN_JOB_EXECUTION = 'gcp.cloud_run.job.execution' # The index for a task within an execution as provided by the [`CLOUD_RUN_TASK_INDEX`](https://cloud.google.com/run/docs/container-contract#jobs-env-vars) environment variable. # # @note Stability Level: experimental + # + # @example Sample Values + # 0 + # 1 + # GCP_CLOUD_RUN_JOB_TASK_INDEX = 'gcp.cloud_run.job.task_index' # The hostname of a GCE instance. This is the full value of the default or [custom hostname](https://cloud.google.com/compute/docs/instances/custom-hostname-vm). # # @note Stability Level: experimental + # + # @example Sample Values + # my-host1234.example.com + # sample-vm.us-west1-b.c.my-project.internal + # GCP_GCE_INSTANCE_HOSTNAME = 'gcp.gce.instance.hostname' # The instance name of a GCE instance. This is the value provided by `host.name`, the visible name of the instance in the Cloud Console UI, and the prefix for the default hostname of the instance as defined by the [default internal DNS name](https://cloud.google.com/compute/docs/internal-dns#instance-fully-qualified-domain-names). # # @note Stability Level: experimental + # + # @example Sample Values + # instance-1 + # my-vm-name + # GCP_GCE_INSTANCE_NAME = 'gcp.gce.instance.name' # @!endgroup - - # @!group Metric Names - # @!endgroup end end end diff --git a/semantic_conventions/lib/opentelemetry/semconv/incubating/gen_ai.rb b/semantic_conventions/lib/opentelemetry/semconv/incubating/gen_ai/attributes.rb similarity index 79% rename from semantic_conventions/lib/opentelemetry/semconv/incubating/gen_ai.rb rename to semantic_conventions/lib/opentelemetry/semconv/incubating/gen_ai/attributes.rb index c700616391..959414076b 100644 --- a/semantic_conventions/lib/opentelemetry/semconv/incubating/gen_ai.rb +++ b/semantic_conventions/lib/opentelemetry/semconv/incubating/gen_ai/attributes.rb @@ -29,6 +29,10 @@ module GEN_AI # It's RECOMMENDED to format completions as JSON string matching [OpenAI messages format](https://platform.openai.com/docs/guides/text-generation) # # @note Stability Level: experimental + # + # @example Sample Values + # [{'role': 'assistant', 'content': 'The capital of France is Paris.'}] + # GEN_AI_COMPLETION = 'gen_ai.completion' # The full prompt sent to an LLM. @@ -36,41 +40,73 @@ module GEN_AI # It's RECOMMENDED to format prompts as JSON string matching [OpenAI messages format](https://platform.openai.com/docs/guides/text-generation) # # @note Stability Level: experimental + # + # @example Sample Values + # [{'role': 'user', 'content': 'What is the capital of France?'}] + # GEN_AI_PROMPT = 'gen_ai.prompt' # The maximum number of tokens the LLM generates for a request. # # @note Stability Level: experimental + # + # @example Sample Values + # 100 + # GEN_AI_REQUEST_MAX_TOKENS = 'gen_ai.request.max_tokens' # The name of the LLM a request is being made to. # # @note Stability Level: experimental + # + # @example Sample Values + # gpt-4 + # GEN_AI_REQUEST_MODEL = 'gen_ai.request.model' # The temperature setting for the LLM request. # # @note Stability Level: experimental + # + # @example Sample Values + # 0.0 + # GEN_AI_REQUEST_TEMPERATURE = 'gen_ai.request.temperature' # The top_p sampling setting for the LLM request. # # @note Stability Level: experimental + # + # @example Sample Values + # 1.0 + # GEN_AI_REQUEST_TOP_P = 'gen_ai.request.top_p' # Array of reasons the model stopped generating tokens, corresponding to each generation received. # # @note Stability Level: experimental + # + # @example Sample Values + # stop + # GEN_AI_RESPONSE_FINISH_REASONS = 'gen_ai.response.finish_reasons' # The unique identifier for the completion. # # @note Stability Level: experimental + # + # @example Sample Values + # chatcmpl-123 + # GEN_AI_RESPONSE_ID = 'gen_ai.response.id' # The name of the LLM a response was generated from. # # @note Stability Level: experimental + # + # @example Sample Values + # gpt-4-0613 + # GEN_AI_RESPONSE_MODEL = 'gen_ai.response.model' # The Generative AI product as identified by the client instrumentation. @@ -78,22 +114,31 @@ module GEN_AI # The actual GenAI product may differ from the one identified by the client. For example, when using OpenAI client libraries to communicate with Mistral, the `gen_ai.system` is set to `openai` based on the instrumentation's best knowledge. # # @note Stability Level: experimental + # + # @example Sample Values + # openai + # GEN_AI_SYSTEM = 'gen_ai.system' # The number of tokens used in the LLM response (completion). # # @note Stability Level: experimental + # + # @example Sample Values + # 180 + # GEN_AI_USAGE_COMPLETION_TOKENS = 'gen_ai.usage.completion_tokens' # The number of tokens used in the LLM prompt. # # @note Stability Level: experimental + # + # @example Sample Values + # 100 + # GEN_AI_USAGE_PROMPT_TOKENS = 'gen_ai.usage.prompt_tokens' # @!endgroup - - # @!group Metric Names - # @!endgroup end end end diff --git a/semantic_conventions/lib/opentelemetry/semconv/incubating/graphql.rb b/semantic_conventions/lib/opentelemetry/semconv/incubating/graphql/attributes.rb similarity index 83% rename from semantic_conventions/lib/opentelemetry/semconv/incubating/graphql.rb rename to semantic_conventions/lib/opentelemetry/semconv/incubating/graphql/attributes.rb index c7c9fbb0ee..3d5f2184dc 100644 --- a/semantic_conventions/lib/opentelemetry/semconv/incubating/graphql.rb +++ b/semantic_conventions/lib/opentelemetry/semconv/incubating/graphql/attributes.rb @@ -29,22 +29,33 @@ module GRAPHQL # The value may be sanitized to exclude sensitive information. # # @note Stability Level: experimental + # + # @example Sample Values + # query findBookById { bookById(id: ?) { name } } + # GRAPHQL_DOCUMENT = 'graphql.document' # The name of the operation being executed. # # @note Stability Level: experimental + # + # @example Sample Values + # findBookById + # GRAPHQL_OPERATION_NAME = 'graphql.operation.name' # The type of the operation being executed. # # @note Stability Level: experimental + # + # @example Sample Values + # query + # mutation + # subscription + # GRAPHQL_OPERATION_TYPE = 'graphql.operation.type' # @!endgroup - - # @!group Metric Names - # @!endgroup end end end diff --git a/semantic_conventions/lib/opentelemetry/semconv/incubating/heroku.rb b/semantic_conventions/lib/opentelemetry/semconv/incubating/heroku/attributes.rb similarity index 83% rename from semantic_conventions/lib/opentelemetry/semconv/incubating/heroku.rb rename to semantic_conventions/lib/opentelemetry/semconv/incubating/heroku/attributes.rb index 84ad504a0e..45f869b213 100644 --- a/semantic_conventions/lib/opentelemetry/semconv/incubating/heroku.rb +++ b/semantic_conventions/lib/opentelemetry/semconv/incubating/heroku/attributes.rb @@ -27,22 +27,31 @@ module HEROKU # Unique identifier for the application # # @note Stability Level: experimental + # + # @example Sample Values + # 2daa2797-e42b-4624-9322-ec3f968df4da + # HEROKU_APP_ID = 'heroku.app.id' # Commit hash for the current release # # @note Stability Level: experimental + # + # @example Sample Values + # e6134959463efd8966b20e75b913cafe3f5ec + # HEROKU_RELEASE_COMMIT = 'heroku.release.commit' # Time and date the release was created # # @note Stability Level: experimental + # + # @example Sample Values + # 2022-10-23T18:00:42Z + # HEROKU_RELEASE_CREATION_TIMESTAMP = 'heroku.release.creation_timestamp' # @!endgroup - - # @!group Metric Names - # @!endgroup end end end diff --git a/semantic_conventions/lib/opentelemetry/semconv/incubating/host.rb b/semantic_conventions/lib/opentelemetry/semconv/incubating/host/attributes.rb similarity index 78% rename from semantic_conventions/lib/opentelemetry/semconv/incubating/host.rb rename to semantic_conventions/lib/opentelemetry/semconv/incubating/host/attributes.rb index 0ac67ccd74..856f260f0f 100644 --- a/semantic_conventions/lib/opentelemetry/semconv/incubating/host.rb +++ b/semantic_conventions/lib/opentelemetry/semconv/incubating/host/attributes.rb @@ -32,26 +32,49 @@ module HOST # The amount of level 2 memory cache available to the processor (in Bytes). # # @note Stability Level: experimental + # + # @example Sample Values + # 12288000 + # HOST_CPU_CACHE_L2_SIZE = 'host.cpu.cache.l2.size' # Family or generation of the CPU. # # @note Stability Level: experimental + # + # @example Sample Values + # 6 + # PA-RISC 1.1e + # HOST_CPU_FAMILY = 'host.cpu.family' # Model identifier. It provides more granular information about the CPU, distinguishing it from other CPUs within the same family. # # @note Stability Level: experimental + # + # @example Sample Values + # 6 + # 9000/778/B180L + # HOST_CPU_MODEL_ID = 'host.cpu.model.id' # Model designation of the processor. # # @note Stability Level: experimental + # + # @example Sample Values + # 11th Gen Intel(R) Core(TM) i7-1185G7 @ 3.00GHz + # HOST_CPU_MODEL_NAME = 'host.cpu.model.name' # Stepping or core revisions. # # @note Stability Level: experimental + # + # @example Sample Values + # 1 + # r1p1 + # HOST_CPU_STEPPING = 'host.cpu.stepping' # Processor manufacturer identifier. A maximum 12-character string. @@ -59,26 +82,47 @@ module HOST # [CPUID](https://wiki.osdev.org/CPUID) command returns the vendor ID string in EBX, EDX and ECX registers. Writing these to memory in this order results in a 12-character string. # # @note Stability Level: experimental + # + # @example Sample Values + # GenuineIntel + # HOST_CPU_VENDOR_ID = 'host.cpu.vendor.id' # Unique host ID. For Cloud, this must be the instance_id assigned by the cloud provider. For non-containerized systems, this should be the `machine-id`. See the table below for the sources to use to determine the `machine-id` based on operating system. # # @note Stability Level: experimental + # + # @example Sample Values + # fdbf79e8af94cb7f9e8df36789187052 + # HOST_ID = 'host.id' # VM image ID or host OS image ID. For Cloud, this value is from the provider. # # @note Stability Level: experimental + # + # @example Sample Values + # ami-07b06b442921831e5 + # HOST_IMAGE_ID = 'host.image.id' # Name of the VM image or OS install the host was instantiated from. # # @note Stability Level: experimental + # + # @example Sample Values + # infra-ami-eks-worker-node-7d4ec78312 + # CentOS-8-x86_64-1905 + # HOST_IMAGE_NAME = 'host.image.name' # The version string of the VM image or host OS as defined in [Version Attributes](/docs/resource/README.md#version-attributes). # # @note Stability Level: experimental + # + # @example Sample Values + # 0.1 + # HOST_IMAGE_VERSION = 'host.image.version' # Available IP addresses of the host, excluding loopback interfaces. @@ -86,6 +130,11 @@ module HOST # IPv4 Addresses MUST be specified in dotted-quad notation. IPv6 addresses MUST be specified in the [RFC 5952](https://www.rfc-editor.org/rfc/rfc5952.html) format. # # @note Stability Level: experimental + # + # @example Sample Values + # 192.168.1.140 + # fe80::abc2:4a28:737a:609e + # HOST_IP = 'host.ip' # Available MAC addresses of the host, excluding loopback interfaces. @@ -93,22 +142,32 @@ module HOST # MAC Addresses MUST be represented in [IEEE RA hexadecimal form](https://standards.ieee.org/wp-content/uploads/import/documents/tutorials/eui.pdf): as hyphen-separated octets in uppercase hexadecimal form from most to least significant. # # @note Stability Level: experimental + # + # @example Sample Values + # AC-DE-48-23-45-67 + # AC-DE-48-23-45-67-01-9F + # HOST_MAC = 'host.mac' # 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. # # @note Stability Level: experimental + # + # @example Sample Values + # opentelemetry-test + # HOST_NAME = 'host.name' # Type of host. For Cloud, this must be the machine type. # # @note Stability Level: experimental + # + # @example Sample Values + # n1-standard-1 + # HOST_TYPE = 'host.type' # @!endgroup - - # @!group Metric Names - # @!endgroup end end end diff --git a/semantic_conventions/lib/opentelemetry/semconv/incubating/http.rb b/semantic_conventions/lib/opentelemetry/semconv/incubating/http/attributes.rb similarity index 77% rename from semantic_conventions/lib/opentelemetry/semconv/incubating/http.rb rename to semantic_conventions/lib/opentelemetry/semconv/incubating/http/attributes.rb index 98a93beddc..efb1f46aac 100644 --- a/semantic_conventions/lib/opentelemetry/semconv/incubating/http.rb +++ b/semantic_conventions/lib/opentelemetry/semconv/incubating/http/attributes.rb @@ -27,12 +27,21 @@ module HTTP # Deprecated, use `client.address` instead. # # @note Stability Level: experimental + # + # @example Sample Values + # 83.164.160.102 + # # @deprecated Replaced by `client.address`. HTTP_CLIENT_IP = 'http.client_ip' # State of the HTTP connection in the HTTP connection pool. # # @note Stability Level: experimental + # + # @example Sample Values + # active + # idle + # HTTP_CONNECTION_STATE = 'http.connection.state' # Deprecated, use `network.protocol.name` instead. @@ -44,20 +53,40 @@ module HTTP # Deprecated, use one of `server.address`, `client.address` or `http.request.header.host` instead, depending on the usage. # # @note Stability Level: experimental + # + # @example Sample Values + # www.example.org + # # @deprecated Replaced by one of `server.address`, `client.address` or `http.request.header.host`, depending on the usage. HTTP_HOST = 'http.host' # Deprecated, use `http.request.method` instead. # # @note Stability Level: experimental + # + # @example Sample Values + # GET + # POST + # HEAD + # # @deprecated Replaced by `http.request.method`. HTTP_METHOD = 'http.method' # The size of the request payload body in bytes. This is the number of bytes transferred excluding headers and is often, but not always, present as the [Content-Length](https://www.rfc-editor.org/rfc/rfc9110.html#field.content-length) header. For requests using transport encoding, this should be the compressed size. # # @note Stability Level: experimental + # + # @example Sample Values + # 3495 + # HTTP_REQUEST_BODY_SIZE = 'http.request.body.size' + # Must be called with a key for the full attribute name. See notes below about the expectations + # for the state of the key. + # + # @example Usage + # HTTP_REQUEST_HEADER_LAMBDA.call('some-cool-key') #=> 'http.request.header.some-cool-key' + # # HTTP request headers, `` being the normalized HTTP Header name (lowercase), the value being the header values. # # Instrumentations SHOULD require an explicit configuration of which headers are to be captured. Including all request headers can be a security risk - explicit configuration helps avoid leaking sensitive information. @@ -66,7 +95,12 @@ module HTTP # # @note Stability Level: stable # - # @deprecated Now available in the stable namespace at {OpenTelemetry::SemConv::Http::HTTP_REQUEST_HEADER_LAMBDA}. + # @example Sample Values + # http.request.header.content-type=["application/json"] + # http.request.header.x-forwarded-for=["1.2.3.4", "1.2.3.5"] + # + # + # @deprecated Now available in the stable namespace at {OpenTelemetry::SemConv::HTTP::HTTP_REQUEST_HEADER_LAMBDA}. HTTP_REQUEST_HEADER_LAMBDA = ->(key) { "http.request.header.#{key}" } # HTTP request method. @@ -88,14 +122,26 @@ module HTTP # # @note Stability Level: stable # - # @deprecated Now available in the stable namespace at {OpenTelemetry::SemConv::Http::HTTP_REQUEST_METHOD}. + # @example Sample Values + # GET + # POST + # HEAD + # + # + # @deprecated Now available in the stable namespace at {OpenTelemetry::SemConv::HTTP::HTTP_REQUEST_METHOD}. HTTP_REQUEST_METHOD = 'http.request.method' # Original HTTP method sent by the client in the request line. # # @note Stability Level: stable # - # @deprecated Now available in the stable namespace at {OpenTelemetry::SemConv::Http::HTTP_REQUEST_METHOD_ORIGINAL}. + # @example Sample Values + # GeT + # ACL + # foo + # + # + # @deprecated Now available in the stable namespace at {OpenTelemetry::SemConv::HTTP::HTTP_REQUEST_METHOD_ORIGINAL}. HTTP_REQUEST_METHOD_ORIGINAL = 'http.request.method_original' # The ordinal number of request resending attempt (for any reason, including redirects). @@ -104,31 +150,57 @@ module HTTP # # @note Stability Level: stable # - # @deprecated Now available in the stable namespace at {OpenTelemetry::SemConv::Http::HTTP_REQUEST_RESEND_COUNT}. + # @example Sample Values + # 3 + # + # + # @deprecated Now available in the stable namespace at {OpenTelemetry::SemConv::HTTP::HTTP_REQUEST_RESEND_COUNT}. HTTP_REQUEST_RESEND_COUNT = 'http.request.resend_count' # The total size of the request in bytes. This should be the total number of bytes sent over the wire, including the request line (HTTP/1.1), framing (HTTP/2 and HTTP/3), headers, and request body if any. # # @note Stability Level: experimental + # + # @example Sample Values + # 1437 + # HTTP_REQUEST_SIZE = 'http.request.size' # Deprecated, use `http.request.header.content-length` instead. # # @note Stability Level: experimental + # + # @example Sample Values + # 3495 + # # @deprecated Replaced by `http.request.header.content-length`. HTTP_REQUEST_CONTENT_LENGTH = 'http.request_content_length' # Deprecated, use `http.request.body.size` instead. # # @note Stability Level: experimental + # + # @example Sample Values + # 5493 + # # @deprecated Replaced by `http.request.body.size`. HTTP_REQUEST_CONTENT_LENGTH_UNCOMPRESSED = 'http.request_content_length_uncompressed' # The size of the response payload body in bytes. This is the number of bytes transferred excluding headers and is often, but not always, present as the [Content-Length](https://www.rfc-editor.org/rfc/rfc9110.html#field.content-length) header. For requests using transport encoding, this should be the compressed size. # # @note Stability Level: experimental + # + # @example Sample Values + # 3495 + # HTTP_RESPONSE_BODY_SIZE = 'http.response.body.size' + # Must be called with a key for the full attribute name. See notes below about the expectations + # for the state of the key. + # + # @example Usage + # HTTP_RESPONSE_HEADER_LAMBDA.call('some-cool-key') #=> 'http.response.header.some-cool-key' + # # HTTP response headers, `` being the normalized HTTP Header name (lowercase), the value being the header values. # # Instrumentations SHOULD require an explicit configuration of which headers are to be captured. Including all response headers can be a security risk - explicit configuration helps avoid leaking sensitive information. @@ -137,30 +209,51 @@ module HTTP # # @note Stability Level: stable # - # @deprecated Now available in the stable namespace at {OpenTelemetry::SemConv::Http::HTTP_RESPONSE_HEADER_LAMBDA}. + # @example Sample Values + # http.response.header.content-type=["application/json"] + # http.response.header.my-custom-header=["abc", "def"] + # + # + # @deprecated Now available in the stable namespace at {OpenTelemetry::SemConv::HTTP::HTTP_RESPONSE_HEADER_LAMBDA}. HTTP_RESPONSE_HEADER_LAMBDA = ->(key) { "http.response.header.#{key}" } # The total size of the response in bytes. This should be the total number of bytes sent over the wire, including the status line (HTTP/1.1), framing (HTTP/2 and HTTP/3), headers, and response body and trailers if any. # # @note Stability Level: experimental + # + # @example Sample Values + # 1437 + # HTTP_RESPONSE_SIZE = 'http.response.size' # [HTTP response status code](https://tools.ietf.org/html/rfc7231#section-6). # # @note Stability Level: stable # - # @deprecated Now available in the stable namespace at {OpenTelemetry::SemConv::Http::HTTP_RESPONSE_STATUS_CODE}. + # @example Sample Values + # 200 + # + # + # @deprecated Now available in the stable namespace at {OpenTelemetry::SemConv::HTTP::HTTP_RESPONSE_STATUS_CODE}. HTTP_RESPONSE_STATUS_CODE = 'http.response.status_code' # Deprecated, use `http.response.header.content-length` instead. # # @note Stability Level: experimental + # + # @example Sample Values + # 3495 + # # @deprecated Replaced by `http.response.header.content-length`. HTTP_RESPONSE_CONTENT_LENGTH = 'http.response_content_length' # Deprecated, use `http.response.body.size` instead. # # @note Stability Level: experimental + # + # @example Sample Values + # 5493 + # # @deprecated Replace by `http.response.body.size`. HTTP_RESPONSE_CONTENT_LENGTH_UNCOMPRESSED = 'http.response_content_length_uncompressed' @@ -171,49 +264,77 @@ module HTTP # # @note Stability Level: stable # - # @deprecated Now available in the stable namespace at {OpenTelemetry::SemConv::Http::HTTP_ROUTE}. + # @example Sample Values + # /users/:userID? + # {controller}/{action}/{id?} + # + # + # @deprecated Now available in the stable namespace at {OpenTelemetry::SemConv::HTTP::HTTP_ROUTE}. HTTP_ROUTE = 'http.route' # Deprecated, use `url.scheme` instead. # # @note Stability Level: experimental + # + # @example Sample Values + # http + # https + # # @deprecated Replaced by `url.scheme` instead. HTTP_SCHEME = 'http.scheme' # Deprecated, use `server.address` instead. # # @note Stability Level: experimental + # + # @example Sample Values + # example.com + # # @deprecated Replaced by `server.address`. HTTP_SERVER_NAME = 'http.server_name' # Deprecated, use `http.response.status_code` instead. # # @note Stability Level: experimental + # + # @example Sample Values + # 200 + # # @deprecated Replaced by `http.response.status_code`. HTTP_STATUS_CODE = 'http.status_code' # Deprecated, use `url.path` and `url.query` instead. # # @note Stability Level: experimental + # + # @example Sample Values + # /search?q=OpenTelemetry#SemConv + # # @deprecated Split to `url.path` and `url.query. HTTP_TARGET = 'http.target' # Deprecated, use `url.full` instead. # # @note Stability Level: experimental + # + # @example Sample Values + # https://www.foo.bar/search?q=OpenTelemetry#SemConv + # # @deprecated Replaced by `url.full`. HTTP_URL = 'http.url' # Deprecated, use `user_agent.original` instead. # # @note Stability Level: experimental + # + # @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 + # # @deprecated Replaced by `user_agent.original`. HTTP_USER_AGENT = 'http.user_agent' # @!endgroup - - # @!group Metric Names - # @!endgroup end end end diff --git a/semantic_conventions/lib/opentelemetry/semconv/incubating/http/metrics.rb b/semantic_conventions/lib/opentelemetry/semconv/incubating/http/metrics.rb new file mode 100644 index 0000000000..73ac8a73d0 --- /dev/null +++ b/semantic_conventions/lib/opentelemetry/semconv/incubating/http/metrics.rb @@ -0,0 +1,93 @@ +# 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 HTTP + # @!group Metrics Names + + # Number of active HTTP requests. + # + # @note Stability Level: experimental + HTTP_CLIENT_ACTIVE_REQUESTS = 'http.client.active_requests' + + # The duration of the successfully established outbound HTTP connections. + # + # @note Stability Level: experimental + HTTP_CLIENT_CONNECTION_DURATION = 'http.client.connection.duration' + + # Number of outbound HTTP connections that are currently active or idle on the client. + # + # @note Stability Level: experimental + HTTP_CLIENT_OPEN_CONNECTIONS = 'http.client.open_connections' + + # Size of HTTP client request bodies. + # + # The size of the request payload body in bytes. This is the number of bytes transferred excluding headers and is often, but not always, present as the [Content-Length](https://www.rfc-editor.org/rfc/rfc9110.html#field.content-length) header. For requests using transport encoding, this should be the compressed size. + # + # @note Stability Level: experimental + HTTP_CLIENT_REQUEST_BODY_SIZE = 'http.client.request.body.size' + + # Duration of HTTP client requests. + # + # @note Stability Level: stable + # + # @deprecated Now available in the stable namespace at {OpenTelemetry::SemConv::HTTP::HTTP_CLIENT_REQUEST_DURATION}. + HTTP_CLIENT_REQUEST_DURATION = 'http.client.request.duration' + + # Size of HTTP client response bodies. + # + # The size of the response payload body in bytes. This is the number of bytes transferred excluding headers and is often, but not always, present as the [Content-Length](https://www.rfc-editor.org/rfc/rfc9110.html#field.content-length) header. For requests using transport encoding, this should be the compressed size. + # + # @note Stability Level: experimental + HTTP_CLIENT_RESPONSE_BODY_SIZE = 'http.client.response.body.size' + + # Number of active HTTP server requests. + # + # @note Stability Level: experimental + HTTP_SERVER_ACTIVE_REQUESTS = 'http.server.active_requests' + + # Size of HTTP server request bodies. + # + # The size of the request payload body in bytes. This is the number of bytes transferred excluding headers and is often, but not always, present as the [Content-Length](https://www.rfc-editor.org/rfc/rfc9110.html#field.content-length) header. For requests using transport encoding, this should be the compressed size. + # + # @note Stability Level: experimental + HTTP_SERVER_REQUEST_BODY_SIZE = 'http.server.request.body.size' + + # Duration of HTTP server requests. + # + # @note Stability Level: stable + # + # @deprecated Now available in the stable namespace at {OpenTelemetry::SemConv::HTTP::HTTP_SERVER_REQUEST_DURATION}. + HTTP_SERVER_REQUEST_DURATION = 'http.server.request.duration' + + # Size of HTTP server response bodies. + # + # The size of the response payload body in bytes. This is the number of bytes transferred excluding headers and is often, but not always, present as the [Content-Length](https://www.rfc-editor.org/rfc/rfc9110.html#field.content-length) header. For requests using transport encoding, this should be the compressed size. + # + # @note Stability Level: experimental + HTTP_SERVER_RESPONSE_BODY_SIZE = 'http.server.response.body.size' + + # @!endgroup + end + end + end +end \ No newline at end of file diff --git a/semantic_conventions/lib/opentelemetry/semconv/incubating/ios.rb b/semantic_conventions/lib/opentelemetry/semconv/incubating/ios/attributes.rb similarity index 96% rename from semantic_conventions/lib/opentelemetry/semconv/incubating/ios.rb rename to semantic_conventions/lib/opentelemetry/semconv/incubating/ios/attributes.rb index a6fd6348e1..a6832aa5e1 100644 --- a/semantic_conventions/lib/opentelemetry/semconv/incubating/ios.rb +++ b/semantic_conventions/lib/opentelemetry/semconv/incubating/ios/attributes.rb @@ -33,9 +33,6 @@ module IOS IOS_STATE = 'ios.state' # @!endgroup - - # @!group Metric Names - # @!endgroup end end end diff --git a/semantic_conventions/lib/opentelemetry/semconv/incubating/jvm.rb b/semantic_conventions/lib/opentelemetry/semconv/incubating/jvm/attributes.rb similarity index 78% rename from semantic_conventions/lib/opentelemetry/semconv/incubating/jvm.rb rename to semantic_conventions/lib/opentelemetry/semconv/incubating/jvm/attributes.rb index 0a60c8fa8e..175071e730 100644 --- a/semantic_conventions/lib/opentelemetry/semconv/incubating/jvm.rb +++ b/semantic_conventions/lib/opentelemetry/semconv/incubating/jvm/attributes.rb @@ -29,6 +29,11 @@ module JVM # Pool names are generally obtained via [BufferPoolMXBean#getName()](https://docs.oracle.com/en/java/javase/11/docs/api/java.management/java/lang/management/BufferPoolMXBean.html#getName()). # # @note Stability Level: experimental + # + # @example Sample Values + # mapped + # direct + # JVM_BUFFER_POOL_NAME = 'jvm.buffer.pool.name' # Name of the garbage collector action. @@ -37,7 +42,12 @@ module JVM # # @note Stability Level: stable # - # @deprecated Now available in the stable namespace at {OpenTelemetry::SemConv::Jvm::JVM_GC_ACTION}. + # @example Sample Values + # end of minor GC + # end of major GC + # + # + # @deprecated Now available in the stable namespace at {OpenTelemetry::SemConv::JVM::JVM_GC_ACTION}. JVM_GC_ACTION = 'jvm.gc.action' # Name of the garbage collector. @@ -46,7 +56,12 @@ module JVM # # @note Stability Level: stable # - # @deprecated Now available in the stable namespace at {OpenTelemetry::SemConv::Jvm::JVM_GC_NAME}. + # @example Sample Values + # G1 Young Generation + # G1 Old Generation + # + # + # @deprecated Now available in the stable namespace at {OpenTelemetry::SemConv::JVM::JVM_GC_NAME}. JVM_GC_NAME = 'jvm.gc.name' # Name of the memory pool. @@ -55,34 +70,47 @@ module JVM # # @note Stability Level: stable # - # @deprecated Now available in the stable namespace at {OpenTelemetry::SemConv::Jvm::JVM_MEMORY_POOL_NAME}. + # @example Sample Values + # G1 Old Gen + # G1 Eden space + # G1 Survivor Space + # + # + # @deprecated Now available in the stable namespace at {OpenTelemetry::SemConv::JVM::JVM_MEMORY_POOL_NAME}. JVM_MEMORY_POOL_NAME = 'jvm.memory.pool.name' # The type of memory. # # @note Stability Level: stable # - # @deprecated Now available in the stable namespace at {OpenTelemetry::SemConv::Jvm::JVM_MEMORY_TYPE}. + # @example Sample Values + # heap + # non_heap + # + # + # @deprecated Now available in the stable namespace at {OpenTelemetry::SemConv::JVM::JVM_MEMORY_TYPE}. JVM_MEMORY_TYPE = 'jvm.memory.type' # Whether the thread is daemon or not. # # @note Stability Level: stable # - # @deprecated Now available in the stable namespace at {OpenTelemetry::SemConv::Jvm::JVM_THREAD_DAEMON}. + # @deprecated Now available in the stable namespace at {OpenTelemetry::SemConv::JVM::JVM_THREAD_DAEMON}. JVM_THREAD_DAEMON = 'jvm.thread.daemon' # State of the thread. # # @note Stability Level: stable # - # @deprecated Now available in the stable namespace at {OpenTelemetry::SemConv::Jvm::JVM_THREAD_STATE}. + # @example Sample Values + # runnable + # blocked + # + # + # @deprecated Now available in the stable namespace at {OpenTelemetry::SemConv::JVM::JVM_THREAD_STATE}. JVM_THREAD_STATE = 'jvm.thread.state' # @!endgroup - - # @!group Metric Names - # @!endgroup end end end diff --git a/semantic_conventions/lib/opentelemetry/semconv/incubating/jvm/metrics.rb b/semantic_conventions/lib/opentelemetry/semconv/incubating/jvm/metrics.rb new file mode 100644 index 0000000000..99a5c5566b --- /dev/null +++ b/semantic_conventions/lib/opentelemetry/semconv/incubating/jvm/metrics.rb @@ -0,0 +1,151 @@ +# 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 JVM + # @!group Metrics Names + + # Number of buffers in the pool. + # + # @note Stability Level: experimental + JVM_BUFFER_COUNT = 'jvm.buffer.count' + + # Measure of total memory capacity of buffers. + # + # @note Stability Level: experimental + JVM_BUFFER_MEMORY_LIMIT = 'jvm.buffer.memory.limit' + + # Measure of memory used by buffers. + # + # @note Stability Level: experimental + JVM_BUFFER_MEMORY_USAGE = 'jvm.buffer.memory.usage' + + # Number of classes currently loaded. + # + # @note Stability Level: stable + # + # @deprecated Now available in the stable namespace at {OpenTelemetry::SemConv::JVM::JVM_CLASS_COUNT}. + JVM_CLASS_COUNT = 'jvm.class.count' + + # Number of classes loaded since JVM start. + # + # @note Stability Level: stable + # + # @deprecated Now available in the stable namespace at {OpenTelemetry::SemConv::JVM::JVM_CLASS_LOADED}. + JVM_CLASS_LOADED = 'jvm.class.loaded' + + # Number of classes unloaded since JVM start. + # + # @note Stability Level: stable + # + # @deprecated Now available in the stable namespace at {OpenTelemetry::SemConv::JVM::JVM_CLASS_UNLOADED}. + JVM_CLASS_UNLOADED = 'jvm.class.unloaded' + + # Number of processors available to the Java virtual machine. + # + # @note Stability Level: stable + # + # @deprecated Now available in the stable namespace at {OpenTelemetry::SemConv::JVM::JVM_CPU_COUNT}. + JVM_CPU_COUNT = 'jvm.cpu.count' + + # Recent CPU utilization for the process as reported by the JVM. + # + # The value range is [0.0,1.0]. This utilization is not defined as being for the specific interval since last measurement (unlike `system.cpu.utilization`). [Reference](https://docs.oracle.com/en/java/javase/17/docs/api/jdk.management/com/sun/management/OperatingSystemMXBean.html#getProcessCpuLoad()). + # + # @note Stability Level: stable + # + # @deprecated Now available in the stable namespace at {OpenTelemetry::SemConv::JVM::JVM_CPU_RECENT_UTILIZATION}. + JVM_CPU_RECENT_UTILIZATION = 'jvm.cpu.recent_utilization' + + # CPU time used by the process as reported by the JVM. + # + # @note Stability Level: stable + # + # @deprecated Now available in the stable namespace at {OpenTelemetry::SemConv::JVM::JVM_CPU_TIME}. + JVM_CPU_TIME = 'jvm.cpu.time' + + # Duration of JVM garbage collection actions. + # + # @note Stability Level: stable + # + # @deprecated Now available in the stable namespace at {OpenTelemetry::SemConv::JVM::JVM_GC_DURATION}. + JVM_GC_DURATION = 'jvm.gc.duration' + + # Measure of memory committed. + # + # @note Stability Level: stable + # + # @deprecated Now available in the stable namespace at {OpenTelemetry::SemConv::JVM::JVM_MEMORY_COMMITTED}. + JVM_MEMORY_COMMITTED = 'jvm.memory.committed' + + # Measure of initial memory requested. + # + # @note Stability Level: experimental + JVM_MEMORY_INIT = 'jvm.memory.init' + + # Measure of max obtainable memory. + # + # @note Stability Level: stable + # + # @deprecated Now available in the stable namespace at {OpenTelemetry::SemConv::JVM::JVM_MEMORY_LIMIT}. + JVM_MEMORY_LIMIT = 'jvm.memory.limit' + + # Measure of memory used. + # + # @note Stability Level: stable + # + # @deprecated Now available in the stable namespace at {OpenTelemetry::SemConv::JVM::JVM_MEMORY_USED}. + JVM_MEMORY_USED = 'jvm.memory.used' + + # Measure of memory used, as measured after the most recent garbage collection event on this pool. + # + # @note Stability Level: stable + # + # @deprecated Now available in the stable namespace at {OpenTelemetry::SemConv::JVM::JVM_MEMORY_USED_AFTER_LAST_GC}. + JVM_MEMORY_USED_AFTER_LAST_GC = 'jvm.memory.used_after_last_gc' + + # Average CPU load of the whole system for the last minute as reported by the JVM. + # + # The value range is [0,n], where n is the number of CPU cores - or a negative number if the value is not available. This utilization is not defined as being for the specific interval since last measurement (unlike `system.cpu.utilization`). [Reference](https://docs.oracle.com/en/java/javase/17/docs/api/java.management/java/lang/management/OperatingSystemMXBean.html#getSystemLoadAverage()). + # + # @note Stability Level: experimental + JVM_SYSTEM_CPU_LOAD_1M = 'jvm.system.cpu.load_1m' + + # Recent CPU utilization for the whole system as reported by the JVM. + # + # The value range is [0.0,1.0]. This utilization is not defined as being for the specific interval since last measurement (unlike `system.cpu.utilization`). [Reference](https://docs.oracle.com/en/java/javase/17/docs/api/jdk.management/com/sun/management/OperatingSystemMXBean.html#getCpuLoad()). + # + # @note Stability Level: experimental + JVM_SYSTEM_CPU_UTILIZATION = 'jvm.system.cpu.utilization' + + # Number of executing platform threads. + # + # @note Stability Level: stable + # + # @deprecated Now available in the stable namespace at {OpenTelemetry::SemConv::JVM::JVM_THREAD_COUNT}. + JVM_THREAD_COUNT = 'jvm.thread.count' + + # @!endgroup + end + end + end +end \ No newline at end of file diff --git a/semantic_conventions/lib/opentelemetry/semconv/incubating/k8s.rb b/semantic_conventions/lib/opentelemetry/semconv/incubating/k8s/attributes.rb similarity index 67% rename from semantic_conventions/lib/opentelemetry/semconv/incubating/k8s.rb rename to semantic_conventions/lib/opentelemetry/semconv/incubating/k8s/attributes.rb index 896bbe3739..46b3011b0e 100644 --- a/semantic_conventions/lib/opentelemetry/semconv/incubating/k8s.rb +++ b/semantic_conventions/lib/opentelemetry/semconv/incubating/k8s/attributes.rb @@ -27,6 +27,10 @@ module K8S # The name of the cluster. # # @note Stability Level: experimental + # + # @example Sample Values + # opentelemetry-cluster + # K8S_CLUSTER_NAME = 'k8s.cluster.name' # A pseudo-ID for the cluster, set to the UID of the `kube-system` namespace. @@ -55,11 +59,19 @@ module K8S # conflict. # # @note Stability Level: experimental + # + # @example Sample Values + # 218fc5a9-a5f1-4b54-aa05-46717d0ab26d + # K8S_CLUSTER_UID = 'k8s.cluster.uid' # The name of the Container from Pod specification, must be unique within a Pod. Container runtime usually uses different globally unique name (`container.name`). # # @note Stability Level: experimental + # + # @example Sample Values + # redis + # K8S_CONTAINER_NAME = 'k8s.container.name' # Number of times the container was restarted. This attribute can be used to identify a particular container (running or stopped) within a container spec. @@ -70,113 +82,217 @@ module K8S # Last terminated reason of the Container. # # @note Stability Level: experimental + # + # @example Sample Values + # Evicted + # Error + # K8S_CONTAINER_STATUS_LAST_TERMINATED_REASON = 'k8s.container.status.last_terminated_reason' # The name of the CronJob. # # @note Stability Level: experimental + # + # @example Sample Values + # opentelemetry + # K8S_CRONJOB_NAME = 'k8s.cronjob.name' # The UID of the CronJob. # # @note Stability Level: experimental + # + # @example Sample Values + # 275ecb36-5aa8-4c2a-9c47-d8bb681b9aff + # K8S_CRONJOB_UID = 'k8s.cronjob.uid' # The name of the DaemonSet. # # @note Stability Level: experimental + # + # @example Sample Values + # opentelemetry + # K8S_DAEMONSET_NAME = 'k8s.daemonset.name' # The UID of the DaemonSet. # # @note Stability Level: experimental + # + # @example Sample Values + # 275ecb36-5aa8-4c2a-9c47-d8bb681b9aff + # K8S_DAEMONSET_UID = 'k8s.daemonset.uid' # The name of the Deployment. # # @note Stability Level: experimental + # + # @example Sample Values + # opentelemetry + # K8S_DEPLOYMENT_NAME = 'k8s.deployment.name' # The UID of the Deployment. # # @note Stability Level: experimental + # + # @example Sample Values + # 275ecb36-5aa8-4c2a-9c47-d8bb681b9aff + # K8S_DEPLOYMENT_UID = 'k8s.deployment.uid' # The name of the Job. # # @note Stability Level: experimental + # + # @example Sample Values + # opentelemetry + # K8S_JOB_NAME = 'k8s.job.name' # The UID of the Job. # # @note Stability Level: experimental + # + # @example Sample Values + # 275ecb36-5aa8-4c2a-9c47-d8bb681b9aff + # K8S_JOB_UID = 'k8s.job.uid' # The name of the namespace that the pod is running in. # # @note Stability Level: experimental + # + # @example Sample Values + # default + # K8S_NAMESPACE_NAME = 'k8s.namespace.name' # The name of the Node. # # @note Stability Level: experimental + # + # @example Sample Values + # node-1 + # K8S_NODE_NAME = 'k8s.node.name' # The UID of the Node. # # @note Stability Level: experimental + # + # @example Sample Values + # 1eb3a0c6-0477-4080-a9cb-0cb7db65c6a2 + # K8S_NODE_UID = 'k8s.node.uid' + # Must be called with a key for the full attribute name. See notes below about the expectations + # for the state of the key. + # + # @example Usage + # K8S_POD_ANNOTATION_LAMBDA.call('some-cool-key') #=> 'k8s.pod.annotation.some-cool-key' + # # The annotation key-value pairs placed on the Pod, the `` being the annotation name, the value being the annotation value. # # @note Stability Level: experimental + # + # @example Sample Values + # k8s.pod.annotation.kubernetes.io/enforce-mountable-secrets=true + # k8s.pod.annotation.mycompany.io/arch=x64 + # k8s.pod.annotation.data= + # K8S_POD_ANNOTATION_LAMBDA = ->(key) { "k8s.pod.annotation.#{key}" } + # Must be called with a key for the full attribute name. See notes below about the expectations + # for the state of the key. + # + # @example Usage + # K8S_POD_LABEL_LAMBDA.call('some-cool-key') #=> 'k8s.pod.label.some-cool-key' + # # The label key-value pairs placed on the Pod, the `` being the label name, the value being the label value. # # @note Stability Level: experimental + # + # @example Sample Values + # k8s.pod.label.app=my-app + # k8s.pod.label.mycompany.io/arch=x64 + # k8s.pod.label.data= + # K8S_POD_LABEL_LAMBDA = ->(key) { "k8s.pod.label.#{key}" } + # Must be called with a key for the full attribute name. See notes below about the expectations + # for the state of the key. + # + # @example Usage + # K8S_POD_LABELS_LAMBDA.call('some-cool-key') #=> 'k8s.pod.labels.some-cool-key' + # # Deprecated, use `k8s.pod.label` instead. # # @note Stability Level: experimental + # + # @example Sample Values + # k8s.pod.label.app=my-app + # # @deprecated Replaced by `k8s.pod.label`. K8S_POD_LABELS_LAMBDA = ->(key) { "k8s.pod.labels.#{key}" } # The name of the Pod. # # @note Stability Level: experimental + # + # @example Sample Values + # opentelemetry-pod-autoconf + # K8S_POD_NAME = 'k8s.pod.name' # The UID of the Pod. # # @note Stability Level: experimental + # + # @example Sample Values + # 275ecb36-5aa8-4c2a-9c47-d8bb681b9aff + # K8S_POD_UID = 'k8s.pod.uid' # The name of the ReplicaSet. # # @note Stability Level: experimental + # + # @example Sample Values + # opentelemetry + # K8S_REPLICASET_NAME = 'k8s.replicaset.name' # The UID of the ReplicaSet. # # @note Stability Level: experimental + # + # @example Sample Values + # 275ecb36-5aa8-4c2a-9c47-d8bb681b9aff + # K8S_REPLICASET_UID = 'k8s.replicaset.uid' # The name of the StatefulSet. # # @note Stability Level: experimental + # + # @example Sample Values + # opentelemetry + # K8S_STATEFULSET_NAME = 'k8s.statefulset.name' # The UID of the StatefulSet. # # @note Stability Level: experimental + # + # @example Sample Values + # 275ecb36-5aa8-4c2a-9c47-d8bb681b9aff + # K8S_STATEFULSET_UID = 'k8s.statefulset.uid' # @!endgroup - - # @!group Metric Names - # @!endgroup end end end diff --git a/semantic_conventions/lib/opentelemetry/semconv/incubating/kestrel/metrics.rb b/semantic_conventions/lib/opentelemetry/semconv/incubating/kestrel/metrics.rb new file mode 100644 index 0000000000..8089543e31 --- /dev/null +++ b/semantic_conventions/lib/opentelemetry/semconv/incubating/kestrel/metrics.rb @@ -0,0 +1,106 @@ +# 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 KESTREL + # @!group Metrics Names + + # Number of connections that are currently active on the server. + # + # Meter name: `Microsoft.AspNetCore.Server.Kestrel`; Added in: ASP.NET Core 8.0 + # + # @note Stability Level: stable + # + # @deprecated Now available in the stable namespace at {OpenTelemetry::SemConv::KESTREL::KESTREL_ACTIVE_CONNECTIONS}. + KESTREL_ACTIVE_CONNECTIONS = 'kestrel.active_connections' + + # Number of TLS handshakes that are currently in progress on the server. + # + # Meter name: `Microsoft.AspNetCore.Server.Kestrel`; Added in: ASP.NET Core 8.0 + # + # @note Stability Level: stable + # + # @deprecated Now available in the stable namespace at {OpenTelemetry::SemConv::KESTREL::KESTREL_ACTIVE_TLS_HANDSHAKES}. + KESTREL_ACTIVE_TLS_HANDSHAKES = 'kestrel.active_tls_handshakes' + + # The duration of connections on the server. + # + # Meter name: `Microsoft.AspNetCore.Server.Kestrel`; Added in: ASP.NET Core 8.0 + # + # @note Stability Level: stable + # + # @deprecated Now available in the stable namespace at {OpenTelemetry::SemConv::KESTREL::KESTREL_CONNECTION_DURATION}. + KESTREL_CONNECTION_DURATION = 'kestrel.connection.duration' + + # Number of connections that are currently queued and are waiting to start. + # + # Meter name: `Microsoft.AspNetCore.Server.Kestrel`; Added in: ASP.NET Core 8.0 + # + # @note Stability Level: stable + # + # @deprecated Now available in the stable namespace at {OpenTelemetry::SemConv::KESTREL::KESTREL_QUEUED_CONNECTIONS}. + KESTREL_QUEUED_CONNECTIONS = 'kestrel.queued_connections' + + # Number of HTTP requests on multiplexed connections (HTTP/2 and HTTP/3) that are currently queued and are waiting to start. + # + # Meter name: `Microsoft.AspNetCore.Server.Kestrel`; Added in: ASP.NET Core 8.0 + # + # @note Stability Level: stable + # + # @deprecated Now available in the stable namespace at {OpenTelemetry::SemConv::KESTREL::KESTREL_QUEUED_REQUESTS}. + KESTREL_QUEUED_REQUESTS = 'kestrel.queued_requests' + + # Number of connections rejected by the server. + # + # Connections are rejected when the currently active count exceeds the value configured with `MaxConcurrentConnections`. + # Meter name: `Microsoft.AspNetCore.Server.Kestrel`; Added in: ASP.NET Core 8.0 + # + # @note Stability Level: stable + # + # @deprecated Now available in the stable namespace at {OpenTelemetry::SemConv::KESTREL::KESTREL_REJECTED_CONNECTIONS}. + KESTREL_REJECTED_CONNECTIONS = 'kestrel.rejected_connections' + + # The duration of TLS handshakes on the server. + # + # Meter name: `Microsoft.AspNetCore.Server.Kestrel`; Added in: ASP.NET Core 8.0 + # + # @note Stability Level: stable + # + # @deprecated Now available in the stable namespace at {OpenTelemetry::SemConv::KESTREL::KESTREL_TLS_HANDSHAKE_DURATION}. + KESTREL_TLS_HANDSHAKE_DURATION = 'kestrel.tls_handshake.duration' + + # Number of connections that are currently upgraded (WebSockets). . + # + # The counter only tracks HTTP/1.1 connections. + # + # Meter name: `Microsoft.AspNetCore.Server.Kestrel`; Added in: ASP.NET Core 8.0 + # + # @note Stability Level: stable + # + # @deprecated Now available in the stable namespace at {OpenTelemetry::SemConv::KESTREL::KESTREL_UPGRADED_CONNECTIONS}. + KESTREL_UPGRADED_CONNECTIONS = 'kestrel.upgraded_connections' + + # @!endgroup + end + end + end +end \ No newline at end of file diff --git a/semantic_conventions/lib/opentelemetry/semconv/incubating/log.rb b/semantic_conventions/lib/opentelemetry/semconv/incubating/log/attributes.rb similarity index 85% rename from semantic_conventions/lib/opentelemetry/semconv/incubating/log.rb rename to semantic_conventions/lib/opentelemetry/semconv/incubating/log/attributes.rb index 207621e5cb..f463461269 100644 --- a/semantic_conventions/lib/opentelemetry/semconv/incubating/log.rb +++ b/semantic_conventions/lib/opentelemetry/semconv/incubating/log/attributes.rb @@ -27,21 +27,37 @@ module LOG # The basename of the file. # # @note Stability Level: experimental + # + # @example Sample Values + # audit.log + # LOG_FILE_NAME = 'log.file.name' # The basename of the file, with symlinks resolved. # # @note Stability Level: experimental + # + # @example Sample Values + # uuid.log + # LOG_FILE_NAME_RESOLVED = 'log.file.name_resolved' # The full path to the file. # # @note Stability Level: experimental + # + # @example Sample Values + # /var/log/mysql/audit.log + # LOG_FILE_PATH = 'log.file.path' # The full path to the file, with symlinks resolved. # # @note Stability Level: experimental + # + # @example Sample Values + # /var/lib/docker/uuid.log + # LOG_FILE_PATH_RESOLVED = 'log.file.path_resolved' # The stream associated with the log. See below for a list of well-known values. @@ -55,12 +71,13 @@ module LOG # The id MAY be an [Universally Unique Lexicographically Sortable Identifier (ULID)](https://github.com/ulid/spec), but other identifiers (e.g. UUID) may be used as needed. # # @note Stability Level: experimental + # + # @example Sample Values + # 01ARZ3NDEKTSV4RRFFQ69G5FAV + # LOG_RECORD_UID = 'log.record.uid' # @!endgroup - - # @!group Metric Names - # @!endgroup end end end diff --git a/semantic_conventions/lib/opentelemetry/semconv/incubating/message.rb b/semantic_conventions/lib/opentelemetry/semconv/incubating/message/attributes.rb similarity index 97% rename from semantic_conventions/lib/opentelemetry/semconv/incubating/message.rb rename to semantic_conventions/lib/opentelemetry/semconv/incubating/message/attributes.rb index e3115f696d..b8b7bb9caa 100644 --- a/semantic_conventions/lib/opentelemetry/semconv/incubating/message.rb +++ b/semantic_conventions/lib/opentelemetry/semconv/incubating/message/attributes.rb @@ -49,9 +49,6 @@ module MESSAGE MESSAGE_UNCOMPRESSED_SIZE = 'message.uncompressed_size' # @!endgroup - - # @!group Metric Names - # @!endgroup end end end diff --git a/semantic_conventions/lib/opentelemetry/semconv/incubating/messaging.rb b/semantic_conventions/lib/opentelemetry/semconv/incubating/messaging/attributes.rb similarity index 83% rename from semantic_conventions/lib/opentelemetry/semconv/incubating/messaging.rb rename to semantic_conventions/lib/opentelemetry/semconv/incubating/messaging/attributes.rb index b01e62e7ec..ae39af9b9c 100644 --- a/semantic_conventions/lib/opentelemetry/semconv/incubating/messaging.rb +++ b/semantic_conventions/lib/opentelemetry/semconv/incubating/messaging/attributes.rb @@ -29,11 +29,22 @@ module MESSAGING # Instrumentations SHOULD NOT set `messaging.batch.message_count` on spans that operate with a single message. When a messaging client library supports both batch and single-message API for the same operation, instrumentations SHOULD use `messaging.batch.message_count` for batching APIs and SHOULD NOT use it for single-message APIs. # # @note Stability Level: experimental + # + # @example Sample Values + # 0 + # 1 + # 2 + # MESSAGING_BATCH_MESSAGE_COUNT = 'messaging.batch.message_count' # A unique identifier for the client that consumes or produces a message. # # @note Stability Level: experimental + # + # @example Sample Values + # client-5 + # myhost@8742@s8083jm + # MESSAGING_CLIENT_ID = 'messaging.client.id' # A boolean that is true if the message destination is anonymous (could be unnamed or have auto-generated name). @@ -47,11 +58,20 @@ module MESSAGING # the broker doesn't have such notion, the destination name SHOULD uniquely identify the broker. # # @note Stability Level: experimental + # + # @example Sample Values + # MyQueue + # MyTopic + # MESSAGING_DESTINATION_NAME = 'messaging.destination.name' # The identifier of the partition messages are sent to or received from, unique within the `messaging.destination.name`. # # @note Stability Level: experimental + # + # @example Sample Values + # 1 + # MESSAGING_DESTINATION_PARTITION_ID = 'messaging.destination.partition.id' # Low cardinality representation of the messaging destination name @@ -59,6 +79,10 @@ module MESSAGING # Destination names could be constructed from templates. An example would be a destination name involving a user name or product id. Although the destination name in this case is of high cardinality, the underlying template is of low cardinality and can be effectively used for grouping and aggregation. # # @note Stability Level: experimental + # + # @example Sample Values + # /customers/{customerId} + # MESSAGING_DESTINATION_TEMPLATE = 'messaging.destination.template' # A boolean that is true if the message destination is temporary and might not exist anymore after messages are processed. @@ -77,46 +101,83 @@ module MESSAGING # the broker doesn't have such notion, the original destination name SHOULD uniquely identify the broker. # # @note Stability Level: experimental + # + # @example Sample Values + # MyQueue + # MyTopic + # MESSAGING_DESTINATION_PUBLISH_NAME = 'messaging.destination_publish.name' # The name of the consumer group the event consumer is associated with. # # @note Stability Level: experimental + # + # @example Sample Values + # indexer + # MESSAGING_EVENTHUBS_CONSUMER_GROUP = 'messaging.eventhubs.consumer.group' # The UTC epoch seconds at which the message has been accepted and stored in the entity. # # @note Stability Level: experimental + # + # @example Sample Values + # 1701393730 + # MESSAGING_EVENTHUBS_MESSAGE_ENQUEUED_TIME = 'messaging.eventhubs.message.enqueued_time' # The ack deadline in seconds set for the modify ack deadline request. # # @note Stability Level: experimental + # + # @example Sample Values + # 10 + # MESSAGING_GCP_PUBSUB_MESSAGE_ACK_DEADLINE = 'messaging.gcp_pubsub.message.ack_deadline' # The ack id for a given message. # # @note Stability Level: experimental + # + # @example Sample Values + # ack_id + # MESSAGING_GCP_PUBSUB_MESSAGE_ACK_ID = 'messaging.gcp_pubsub.message.ack_id' # The delivery attempt for a given message. # # @note Stability Level: experimental + # + # @example Sample Values + # 2 + # MESSAGING_GCP_PUBSUB_MESSAGE_DELIVERY_ATTEMPT = 'messaging.gcp_pubsub.message.delivery_attempt' # The ordering key for a given message. If the attribute is not present, the message does not have an ordering key. # # @note Stability Level: experimental + # + # @example Sample Values + # ordering_key + # MESSAGING_GCP_PUBSUB_MESSAGE_ORDERING_KEY = 'messaging.gcp_pubsub.message.ordering_key' # Name of the Kafka Consumer Group that is handling the message. Only applies to consumers, not producers. # # @note Stability Level: experimental + # + # @example Sample Values + # my-group + # MESSAGING_KAFKA_CONSUMER_GROUP = 'messaging.kafka.consumer.group' # Deprecated, use `messaging.destination.partition.id` instead. # # @note Stability Level: experimental + # + # @example Sample Values + # 2 + # # @deprecated Replaced by `messaging.destination.partition.id`. MESSAGING_KAFKA_DESTINATION_PARTITION = 'messaging.kafka.destination.partition' @@ -125,11 +186,19 @@ module MESSAGING # 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. # # @note Stability Level: experimental + # + # @example Sample Values + # myKey + # MESSAGING_KAFKA_MESSAGE_KEY = 'messaging.kafka.message.key' # The offset of a record in the corresponding Kafka partition. # # @note Stability Level: experimental + # + # @example Sample Values + # 42 + # MESSAGING_KAFKA_MESSAGE_OFFSET = 'messaging.kafka.message.offset' # A boolean that is true if the message is a tombstone. @@ -143,11 +212,19 @@ module MESSAGING # body size should be used. # # @note Stability Level: experimental + # + # @example Sample Values + # 1439 + # MESSAGING_MESSAGE_BODY_SIZE = 'messaging.message.body.size' # The conversation ID identifying the conversation to which the message belongs, represented as a string. Sometimes called "Correlation ID". # # @note Stability Level: experimental + # + # @example Sample Values + # MyConversationId + # MESSAGING_MESSAGE_CONVERSATION_ID = 'messaging.message.conversation_id' # The size of the message body and metadata in bytes. @@ -156,22 +233,42 @@ module MESSAGING # size should be used. # # @note Stability Level: experimental + # + # @example Sample Values + # 2738 + # MESSAGING_MESSAGE_ENVELOPE_SIZE = 'messaging.message.envelope.size' # A value used by the messaging system as an identifier for the message, represented as a string. # # @note Stability Level: experimental + # + # @example Sample Values + # 452a7c7c7c7048c2f887f61572b18fc2 + # MESSAGING_MESSAGE_ID = 'messaging.message.id' # Deprecated, use `messaging.operation.type` instead. # # @note Stability Level: experimental + # + # @example Sample Values + # publish + # create + # process + # # @deprecated Replaced by `messaging.operation.type`. MESSAGING_OPERATION = 'messaging.operation' # The system-specific name of the messaging operation. # # @note Stability Level: experimental + # + # @example Sample Values + # ack + # nack + # send + # MESSAGING_OPERATION_NAME = 'messaging.operation.name' # A string identifying the type of the messaging operation. @@ -184,16 +281,28 @@ module MESSAGING # RabbitMQ message routing key. # # @note Stability Level: experimental + # + # @example Sample Values + # myKey + # MESSAGING_RABBITMQ_DESTINATION_ROUTING_KEY = 'messaging.rabbitmq.destination.routing_key' # RabbitMQ message delivery tag # # @note Stability Level: experimental + # + # @example Sample Values + # 123 + # MESSAGING_RABBITMQ_MESSAGE_DELIVERY_TAG = 'messaging.rabbitmq.message.delivery_tag' # Name of the RocketMQ producer/consumer group that is handling the message. The client type is identified by the SpanKind. # # @note Stability Level: experimental + # + # @example Sample Values + # myConsumerGroup + # MESSAGING_ROCKETMQ_CLIENT_GROUP = 'messaging.rocketmq.client_group' # Model of message consumption. This only applies to consumer spans. @@ -204,26 +313,47 @@ module MESSAGING # The delay time level for delay message, which determines the message delay time. # # @note Stability Level: experimental + # + # @example Sample Values + # 3 + # MESSAGING_ROCKETMQ_MESSAGE_DELAY_TIME_LEVEL = 'messaging.rocketmq.message.delay_time_level' # The timestamp in milliseconds that the delay message is expected to be delivered to consumer. # # @note Stability Level: experimental + # + # @example Sample Values + # 1665987217045 + # MESSAGING_ROCKETMQ_MESSAGE_DELIVERY_TIMESTAMP = 'messaging.rocketmq.message.delivery_timestamp' # It is essential for FIFO message. Messages that belong to the same message group are always processed one by one within the same consumer group. # # @note Stability Level: experimental + # + # @example Sample Values + # myMessageGroup + # MESSAGING_ROCKETMQ_MESSAGE_GROUP = 'messaging.rocketmq.message.group' # Key(s) of message, another way to mark message besides message id. # # @note Stability Level: experimental + # + # @example Sample Values + # keyA + # keyB + # MESSAGING_ROCKETMQ_MESSAGE_KEYS = 'messaging.rocketmq.message.keys' # The secondary classifier of message besides topic. # # @note Stability Level: experimental + # + # @example Sample Values + # tagA + # MESSAGING_ROCKETMQ_MESSAGE_TAG = 'messaging.rocketmq.message.tag' # Type of message. @@ -234,11 +364,19 @@ module MESSAGING # Namespace of RocketMQ resources, resources in different namespaces are individual. # # @note Stability Level: experimental + # + # @example Sample Values + # myNamespace + # MESSAGING_ROCKETMQ_NAMESPACE = 'messaging.rocketmq.namespace' # The name of the subscription in the topic messages are received from. # # @note Stability Level: experimental + # + # @example Sample Values + # mySubscription + # MESSAGING_SERVICEBUS_DESTINATION_SUBSCRIPTION_NAME = 'messaging.servicebus.destination.subscription_name' # Describes the [settlement type](https://learn.microsoft.com/azure/service-bus-messaging/message-transfers-locks-settlement#peeklock). @@ -249,11 +387,19 @@ module MESSAGING # Number of deliveries that have been attempted for this message. # # @note Stability Level: experimental + # + # @example Sample Values + # 2 + # MESSAGING_SERVICEBUS_MESSAGE_DELIVERY_COUNT = 'messaging.servicebus.message.delivery_count' # The UTC epoch seconds at which the message has been accepted and stored in the entity. # # @note Stability Level: experimental + # + # @example Sample Values + # 1701393730 + # MESSAGING_SERVICEBUS_MESSAGE_ENQUEUED_TIME = 'messaging.servicebus.message.enqueued_time' # The messaging system as identified by the client instrumentation. @@ -264,9 +410,6 @@ module MESSAGING MESSAGING_SYSTEM = 'messaging.system' # @!endgroup - - # @!group Metric Names - # @!endgroup end end end diff --git a/semantic_conventions/lib/opentelemetry/semconv/incubating/messaging/metrics.rb b/semantic_conventions/lib/opentelemetry/semconv/incubating/messaging/metrics.rb new file mode 100644 index 0000000000..dce21bcbf8 --- /dev/null +++ b/semantic_conventions/lib/opentelemetry/semconv/incubating/messaging/metrics.rb @@ -0,0 +1,61 @@ +# 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 MESSAGING + # @!group Metrics Names + + # Measures the duration of process operation. + # + # @note Stability Level: experimental + MESSAGING_PROCESS_DURATION = 'messaging.process.duration' + + # Measures the number of processed messages. + # + # @note Stability Level: experimental + MESSAGING_PROCESS_MESSAGES = 'messaging.process.messages' + + # Measures the duration of publish operation. + # + # @note Stability Level: experimental + MESSAGING_PUBLISH_DURATION = 'messaging.publish.duration' + + # Measures the number of published messages. + # + # @note Stability Level: experimental + MESSAGING_PUBLISH_MESSAGES = 'messaging.publish.messages' + + # Measures the duration of receive operation. + # + # @note Stability Level: experimental + MESSAGING_RECEIVE_DURATION = 'messaging.receive.duration' + + # Measures the number of received messages. + # + # @note Stability Level: experimental + MESSAGING_RECEIVE_MESSAGES = 'messaging.receive.messages' + + # @!endgroup + end + end + end +end \ No newline at end of file diff --git a/semantic_conventions/lib/opentelemetry/semconv/incubating/net.rb b/semantic_conventions/lib/opentelemetry/semconv/incubating/net/attributes.rb similarity index 82% rename from semantic_conventions/lib/opentelemetry/semconv/incubating/net.rb rename to semantic_conventions/lib/opentelemetry/semconv/incubating/net/attributes.rb index 5473cf71d5..0a751bfad1 100644 --- a/semantic_conventions/lib/opentelemetry/semconv/incubating/net.rb +++ b/semantic_conventions/lib/opentelemetry/semconv/incubating/net/attributes.rb @@ -27,48 +27,82 @@ module NET # Deprecated, use `network.local.address`. # # @note Stability Level: experimental + # + # @example Sample Values + # 192.168.0.1 + # # @deprecated Replaced by `network.local.address`. NET_HOST_IP = 'net.host.ip' # Deprecated, use `server.address`. # # @note Stability Level: experimental + # + # @example Sample Values + # example.com + # # @deprecated Replaced by `server.address`. NET_HOST_NAME = 'net.host.name' # Deprecated, use `server.port`. # # @note Stability Level: experimental + # + # @example Sample Values + # 8080 + # # @deprecated Replaced by `server.port`. NET_HOST_PORT = 'net.host.port' # Deprecated, use `network.peer.address`. # # @note Stability Level: experimental + # + # @example Sample Values + # 127.0.0.1 + # # @deprecated Replaced by `network.peer.address`. NET_PEER_IP = 'net.peer.ip' # Deprecated, use `server.address` on client spans and `client.address` on server spans. # # @note Stability Level: experimental + # + # @example Sample Values + # example.com + # # @deprecated Replaced by `server.address` on client spans and `client.address` on server spans. NET_PEER_NAME = 'net.peer.name' # Deprecated, use `server.port` on client spans and `client.port` on server spans. # # @note Stability Level: experimental + # + # @example Sample Values + # 8080 + # # @deprecated Replaced by `server.port` on client spans and `client.port` on server spans. NET_PEER_PORT = 'net.peer.port' # Deprecated, use `network.protocol.name`. # # @note Stability Level: experimental + # + # @example Sample Values + # amqp + # http + # mqtt + # # @deprecated Replaced by `network.protocol.name`. NET_PROTOCOL_NAME = 'net.protocol.name' # Deprecated, use `network.protocol.version`. # # @note Stability Level: experimental + # + # @example Sample Values + # 3.1.1 + # # @deprecated Replaced by `network.protocol.version`. NET_PROTOCOL_VERSION = 'net.protocol.version' @@ -81,30 +115,50 @@ module NET # Deprecated, use `network.local.address`. # # @note Stability Level: experimental + # + # @example Sample Values + # /var/my.sock + # # @deprecated Replaced by `network.local.address`. NET_SOCK_HOST_ADDR = 'net.sock.host.addr' # Deprecated, use `network.local.port`. # # @note Stability Level: experimental + # + # @example Sample Values + # 8080 + # # @deprecated Replaced by `network.local.port`. NET_SOCK_HOST_PORT = 'net.sock.host.port' # Deprecated, use `network.peer.address`. # # @note Stability Level: experimental + # + # @example Sample Values + # 192.168.0.1 + # # @deprecated Replaced by `network.peer.address`. NET_SOCK_PEER_ADDR = 'net.sock.peer.addr' # Deprecated, no replacement at this time. # # @note Stability Level: experimental + # + # @example Sample Values + # /var/my.sock + # # @deprecated Removed. NET_SOCK_PEER_NAME = 'net.sock.peer.name' # Deprecated, use `network.peer.port`. # # @note Stability Level: experimental + # + # @example Sample Values + # 65531 + # # @deprecated Replaced by `network.peer.port`. NET_SOCK_PEER_PORT = 'net.sock.peer.port' @@ -115,9 +169,6 @@ module NET NET_TRANSPORT = 'net.transport' # @!endgroup - - # @!group Metric Names - # @!endgroup end end end diff --git a/semantic_conventions/lib/opentelemetry/semconv/incubating/network.rb b/semantic_conventions/lib/opentelemetry/semconv/incubating/network/attributes.rb similarity index 76% rename from semantic_conventions/lib/opentelemetry/semconv/incubating/network.rb rename to semantic_conventions/lib/opentelemetry/semconv/incubating/network/attributes.rb index f07fa46a28..d94b6ebdc9 100644 --- a/semantic_conventions/lib/opentelemetry/semconv/incubating/network.rb +++ b/semantic_conventions/lib/opentelemetry/semconv/incubating/network/attributes.rb @@ -27,64 +27,110 @@ module NETWORK # The ISO 3166-1 alpha-2 2-character country code associated with the mobile carrier network. # # @note Stability Level: experimental + # + # @example Sample Values + # DE + # NETWORK_CARRIER_ICC = 'network.carrier.icc' # The mobile carrier country code. # # @note Stability Level: experimental + # + # @example Sample Values + # 310 + # NETWORK_CARRIER_MCC = 'network.carrier.mcc' # The mobile carrier network code. # # @note Stability Level: experimental + # + # @example Sample Values + # 001 + # NETWORK_CARRIER_MNC = 'network.carrier.mnc' # The name of the mobile carrier. # # @note Stability Level: experimental + # + # @example Sample Values + # sprint + # NETWORK_CARRIER_NAME = 'network.carrier.name' # This describes more details regarding the connection.type. It may be the type of cell technology connection, but it could be used for describing details about a wifi connection. # # @note Stability Level: experimental + # + # @example Sample Values + # LTE + # NETWORK_CONNECTION_SUBTYPE = 'network.connection.subtype' # The internet connection type. # # @note Stability Level: experimental + # + # @example Sample Values + # wifi + # NETWORK_CONNECTION_TYPE = 'network.connection.type' # The network IO operation direction. # # @note Stability Level: experimental + # + # @example Sample Values + # transmit + # NETWORK_IO_DIRECTION = 'network.io.direction' # Local address of the network connection - IP address or Unix domain socket name. # # @note Stability Level: stable # - # @deprecated Now available in the stable namespace at {OpenTelemetry::SemConv::Network::NETWORK_LOCAL_ADDRESS}. + # @example Sample Values + # 10.1.2.80 + # /tmp/my.sock + # + # + # @deprecated Now available in the stable namespace at {OpenTelemetry::SemConv::NETWORK::NETWORK_LOCAL_ADDRESS}. NETWORK_LOCAL_ADDRESS = 'network.local.address' # Local port number of the network connection. # # @note Stability Level: stable # - # @deprecated Now available in the stable namespace at {OpenTelemetry::SemConv::Network::NETWORK_LOCAL_PORT}. + # @example Sample Values + # 65123 + # + # + # @deprecated Now available in the stable namespace at {OpenTelemetry::SemConv::NETWORK::NETWORK_LOCAL_PORT}. NETWORK_LOCAL_PORT = 'network.local.port' # Peer address of the network connection - IP address or Unix domain socket name. # # @note Stability Level: stable # - # @deprecated Now available in the stable namespace at {OpenTelemetry::SemConv::Network::NETWORK_PEER_ADDRESS}. + # @example Sample Values + # 10.1.2.80 + # /tmp/my.sock + # + # + # @deprecated Now available in the stable namespace at {OpenTelemetry::SemConv::NETWORK::NETWORK_PEER_ADDRESS}. NETWORK_PEER_ADDRESS = 'network.peer.address' # Peer port number of the network connection. # # @note Stability Level: stable # - # @deprecated Now available in the stable namespace at {OpenTelemetry::SemConv::Network::NETWORK_PEER_PORT}. + # @example Sample Values + # 65123 + # + # + # @deprecated Now available in the stable namespace at {OpenTelemetry::SemConv::NETWORK::NETWORK_PEER_PORT}. NETWORK_PEER_PORT = 'network.peer.port' # [OSI application layer](https://osi-model.com/application-layer/) or non-OSI equivalent. @@ -93,7 +139,13 @@ module NETWORK # # @note Stability Level: stable # - # @deprecated Now available in the stable namespace at {OpenTelemetry::SemConv::Network::NETWORK_PROTOCOL_NAME}. + # @example Sample Values + # amqp + # http + # mqtt + # + # + # @deprecated Now available in the stable namespace at {OpenTelemetry::SemConv::NETWORK::NETWORK_PROTOCOL_NAME}. NETWORK_PROTOCOL_NAME = 'network.protocol.name' # The actual version of the protocol used for network communication. @@ -102,7 +154,12 @@ module NETWORK # # @note Stability Level: stable # - # @deprecated Now available in the stable namespace at {OpenTelemetry::SemConv::Network::NETWORK_PROTOCOL_VERSION}. + # @example Sample Values + # 1.1 + # 2 + # + # + # @deprecated Now available in the stable namespace at {OpenTelemetry::SemConv::NETWORK::NETWORK_PROTOCOL_VERSION}. NETWORK_PROTOCOL_VERSION = 'network.protocol.version' # [OSI transport layer](https://osi-model.com/transport-layer/) or [inter-process communication method](https://wikipedia.org/wiki/Inter-process_communication). @@ -115,7 +172,12 @@ module NETWORK # # @note Stability Level: stable # - # @deprecated Now available in the stable namespace at {OpenTelemetry::SemConv::Network::NETWORK_TRANSPORT}. + # @example Sample Values + # tcp + # udp + # + # + # @deprecated Now available in the stable namespace at {OpenTelemetry::SemConv::NETWORK::NETWORK_TRANSPORT}. NETWORK_TRANSPORT = 'network.transport' # [OSI network layer](https://osi-model.com/network-layer/) or non-OSI equivalent. @@ -124,13 +186,15 @@ module NETWORK # # @note Stability Level: stable # - # @deprecated Now available in the stable namespace at {OpenTelemetry::SemConv::Network::NETWORK_TYPE}. + # @example Sample Values + # ipv4 + # ipv6 + # + # + # @deprecated Now available in the stable namespace at {OpenTelemetry::SemConv::NETWORK::NETWORK_TYPE}. NETWORK_TYPE = 'network.type' # @!endgroup - - # @!group Metric Names - # @!endgroup end end end diff --git a/semantic_conventions/lib/opentelemetry/semconv/incubating/oci.rb b/semantic_conventions/lib/opentelemetry/semconv/incubating/oci/attributes.rb similarity index 92% rename from semantic_conventions/lib/opentelemetry/semconv/incubating/oci.rb rename to semantic_conventions/lib/opentelemetry/semconv/incubating/oci/attributes.rb index 0b597ddea7..2c352c45bc 100644 --- a/semantic_conventions/lib/opentelemetry/semconv/incubating/oci.rb +++ b/semantic_conventions/lib/opentelemetry/semconv/incubating/oci/attributes.rb @@ -30,12 +30,13 @@ module OCI # An example can be found in [Example Image Manifest](https://docs.docker.com/registry/spec/manifest-v2-2/#example-image-manifest). # # @note Stability Level: experimental + # + # @example Sample Values + # sha256:e4ca62c0d62f3e886e684806dfe9d4e0cda60d54986898173c1083856cfda0f4 + # OCI_MANIFEST_DIGEST = 'oci.manifest.digest' # @!endgroup - - # @!group Metric Names - # @!endgroup end end end diff --git a/semantic_conventions/lib/opentelemetry/semconv/incubating/opentracing.rb b/semantic_conventions/lib/opentelemetry/semconv/incubating/opentracing/attributes.rb similarity index 95% rename from semantic_conventions/lib/opentelemetry/semconv/incubating/opentracing.rb rename to semantic_conventions/lib/opentelemetry/semconv/incubating/opentracing/attributes.rb index f7baf15387..db03890980 100644 --- a/semantic_conventions/lib/opentelemetry/semconv/incubating/opentracing.rb +++ b/semantic_conventions/lib/opentelemetry/semconv/incubating/opentracing/attributes.rb @@ -32,9 +32,6 @@ module OPENTRACING OPENTRACING_REF_TYPE = 'opentracing.ref_type' # @!endgroup - - # @!group Metric Names - # @!endgroup end end end diff --git a/semantic_conventions/lib/opentelemetry/semconv/incubating/os.rb b/semantic_conventions/lib/opentelemetry/semconv/incubating/os/attributes.rb similarity index 80% rename from semantic_conventions/lib/opentelemetry/semconv/incubating/os.rb rename to semantic_conventions/lib/opentelemetry/semconv/incubating/os/attributes.rb index e84ad39552..fd75efa363 100644 --- a/semantic_conventions/lib/opentelemetry/semconv/incubating/os.rb +++ b/semantic_conventions/lib/opentelemetry/semconv/incubating/os/attributes.rb @@ -27,16 +27,33 @@ module OS # Unique identifier for a particular build or compilation of the operating system. # # @note Stability Level: experimental + # + # @example Sample Values + # TQ3C.230805.001.B2 + # 20E247 + # 22621 + # OS_BUILD_ID = 'os.build_id' # Human readable (not intended to be parsed) OS version information, like e.g. reported by `ver` or `lsb_release -a` commands. # # @note Stability Level: experimental + # + # @example Sample Values + # Microsoft Windows [Version 10.0.18363.778] + # Ubuntu 18.04.1 LTS + # OS_DESCRIPTION = 'os.description' # Human readable operating system name. # # @note Stability Level: experimental + # + # @example Sample Values + # iOS + # Android + # Ubuntu + # OS_NAME = 'os.name' # The operating system type. @@ -47,12 +64,14 @@ module OS # The version string of the operating system as defined in [Version Attributes](/docs/resource/README.md#version-attributes). # # @note Stability Level: experimental + # + # @example Sample Values + # 14.2.1 + # 18.04.1 + # OS_VERSION = 'os.version' # @!endgroup - - # @!group Metric Names - # @!endgroup end end end diff --git a/semantic_conventions/lib/opentelemetry/semconv/incubating/otel.rb b/semantic_conventions/lib/opentelemetry/semconv/incubating/otel/attributes.rb similarity index 79% rename from semantic_conventions/lib/opentelemetry/semconv/incubating/otel.rb rename to semantic_conventions/lib/opentelemetry/semconv/incubating/otel/attributes.rb index 7852abdd89..2ddb7e019b 100644 --- a/semantic_conventions/lib/opentelemetry/semconv/incubating/otel.rb +++ b/semantic_conventions/lib/opentelemetry/semconv/incubating/otel/attributes.rb @@ -25,10 +25,18 @@ module OTEL # @!group Attribute Names # @note Stability Level: experimental + # + # @example Sample Values + # io.opentelemetry.contrib.mongodb + # # @deprecated use the `otel.scope.name` attribute. OTEL_LIBRARY_NAME = 'otel.library.name' # @note Stability Level: experimental + # + # @example Sample Values + # 1.0.0 + # # @deprecated use the `otel.scope.version` attribute. OTEL_LIBRARY_VERSION = 'otel.library.version' @@ -36,34 +44,43 @@ module OTEL # # @note Stability Level: stable # - # @deprecated Now available in the stable namespace at {OpenTelemetry::SemConv::Otel::OTEL_SCOPE_NAME}. + # @example Sample Values + # io.opentelemetry.contrib.mongodb + # + # + # @deprecated Now available in the stable namespace at {OpenTelemetry::SemConv::OTEL::OTEL_SCOPE_NAME}. OTEL_SCOPE_NAME = 'otel.scope.name' # The version of the instrumentation scope - (`InstrumentationScope.Version` in OTLP). # # @note Stability Level: stable # - # @deprecated Now available in the stable namespace at {OpenTelemetry::SemConv::Otel::OTEL_SCOPE_VERSION}. + # @example Sample Values + # 1.0.0 + # + # + # @deprecated Now available in the stable namespace at {OpenTelemetry::SemConv::OTEL::OTEL_SCOPE_VERSION}. OTEL_SCOPE_VERSION = 'otel.scope.version' # Name of the code, either "OK" or "ERROR". MUST NOT be set if the status code is UNSET. # # @note Stability Level: stable # - # @deprecated Now available in the stable namespace at {OpenTelemetry::SemConv::Otel::OTEL_STATUS_CODE}. + # @deprecated Now available in the stable namespace at {OpenTelemetry::SemConv::OTEL::OTEL_STATUS_CODE}. OTEL_STATUS_CODE = 'otel.status_code' # Description of the Status if it has a value, otherwise not set. # # @note Stability Level: stable # - # @deprecated Now available in the stable namespace at {OpenTelemetry::SemConv::Otel::OTEL_STATUS_DESCRIPTION}. + # @example Sample Values + # resource not found + # + # + # @deprecated Now available in the stable namespace at {OpenTelemetry::SemConv::OTEL::OTEL_STATUS_DESCRIPTION}. OTEL_STATUS_DESCRIPTION = 'otel.status_description' # @!endgroup - - # @!group Metric Names - # @!endgroup end end end diff --git a/semantic_conventions/lib/opentelemetry/semconv/incubating/other.rb b/semantic_conventions/lib/opentelemetry/semconv/incubating/other/attributes.rb similarity index 94% rename from semantic_conventions/lib/opentelemetry/semconv/incubating/other.rb rename to semantic_conventions/lib/opentelemetry/semconv/incubating/other/attributes.rb index c12f396b1d..5491d64dfd 100644 --- a/semantic_conventions/lib/opentelemetry/semconv/incubating/other.rb +++ b/semantic_conventions/lib/opentelemetry/semconv/incubating/other/attributes.rb @@ -27,13 +27,14 @@ module OTHER # Deprecated, use `db.client.connections.state` instead. # # @note Stability Level: experimental + # + # @example Sample Values + # idle + # # @deprecated Replaced by `db.client.connections.state`. STATE = 'state' # @!endgroup - - # @!group Metric Names - # @!endgroup end end end diff --git a/semantic_conventions/lib/opentelemetry/semconv/incubating/peer.rb b/semantic_conventions/lib/opentelemetry/semconv/incubating/peer/attributes.rb similarity index 94% rename from semantic_conventions/lib/opentelemetry/semconv/incubating/peer.rb rename to semantic_conventions/lib/opentelemetry/semconv/incubating/peer/attributes.rb index 24ff342ce3..c17b7ff08b 100644 --- a/semantic_conventions/lib/opentelemetry/semconv/incubating/peer.rb +++ b/semantic_conventions/lib/opentelemetry/semconv/incubating/peer/attributes.rb @@ -27,12 +27,13 @@ module PEER # The [`service.name`](/docs/resource/README.md#service) of the remote service. SHOULD be equal to the actual `service.name` resource attribute of the remote service if any. # # @note Stability Level: experimental + # + # @example Sample Values + # AuthTokenCache + # PEER_SERVICE = 'peer.service' # @!endgroup - - # @!group Metric Names - # @!endgroup end end end diff --git a/semantic_conventions/lib/opentelemetry/semconv/incubating/pool.rb b/semantic_conventions/lib/opentelemetry/semconv/incubating/pool/attributes.rb similarity index 93% rename from semantic_conventions/lib/opentelemetry/semconv/incubating/pool.rb rename to semantic_conventions/lib/opentelemetry/semconv/incubating/pool/attributes.rb index 0c3751ebeb..de358236f7 100644 --- a/semantic_conventions/lib/opentelemetry/semconv/incubating/pool.rb +++ b/semantic_conventions/lib/opentelemetry/semconv/incubating/pool/attributes.rb @@ -27,13 +27,14 @@ module POOL # Deprecated, use `db.client.connections.pool.name` instead. # # @note Stability Level: experimental + # + # @example Sample Values + # myDataSource + # # @deprecated Replaced by `db.client.connections.pool.name`. POOL_NAME = 'pool.name' # @!endgroup - - # @!group Metric Names - # @!endgroup end end end diff --git a/semantic_conventions/lib/opentelemetry/semconv/incubating/process.rb b/semantic_conventions/lib/opentelemetry/semconv/incubating/process/attributes.rb similarity index 80% rename from semantic_conventions/lib/opentelemetry/semconv/incubating/process.rb rename to semantic_conventions/lib/opentelemetry/semconv/incubating/process/attributes.rb index 90c565f1d7..deb163d54f 100644 --- a/semantic_conventions/lib/opentelemetry/semconv/incubating/process.rb +++ b/semantic_conventions/lib/opentelemetry/semconv/incubating/process/attributes.rb @@ -27,16 +27,29 @@ module PROCESS # 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`. # # @note Stability Level: experimental + # + # @example Sample Values + # cmd/otelcol + # PROCESS_COMMAND = 'process.command' # 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`. # # @note Stability Level: experimental + # + # @example Sample Values + # cmd/otecol + # --config=config.yaml + # PROCESS_COMMAND_ARGS = 'process.command_args' # 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. # # @note Stability Level: experimental + # + # @example Sample Values + # C:\cmd\otecol --config="my directory\config.yaml" + # PROCESS_COMMAND_LINE = 'process.command_line' # Specifies whether the context switches for this data point were voluntary or involuntary. @@ -52,31 +65,55 @@ module PROCESS # The date and time the process was created, in ISO 8601 format. # # @note Stability Level: experimental + # + # @example Sample Values + # 2023-11-21T09:25:34.853Z + # PROCESS_CREATION_TIME = 'process.creation.time' # 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`. # # @note Stability Level: experimental + # + # @example Sample Values + # otelcol + # PROCESS_EXECUTABLE_NAME = 'process.executable.name' # 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`. # # @note Stability Level: experimental + # + # @example Sample Values + # /usr/bin/cmd/otelcol + # PROCESS_EXECUTABLE_PATH = 'process.executable.path' # The exit code of the process. # # @note Stability Level: experimental + # + # @example Sample Values + # 127 + # PROCESS_EXIT_CODE = 'process.exit.code' # The date and time the process exited, in ISO 8601 format. # # @note Stability Level: experimental + # + # @example Sample Values + # 2023-11-21T09:26:12.315Z + # PROCESS_EXIT_TIME = 'process.exit.time' # The PID of the process's group leader. This is also the process group ID (PGID) of the process. # # @note Stability Level: experimental + # + # @example Sample Values + # 23 + # PROCESS_GROUP_LEADER_PID = 'process.group_leader.pid' # Whether the process is connected to an interactive shell. @@ -87,6 +124,10 @@ module PROCESS # The username of the user that owns the process. # # @note Stability Level: experimental + # + # @example Sample Values + # root + # PROCESS_OWNER = 'process.owner' # The type of page fault for this data point. Type `major` is for major/hard page faults, and `minor` is for minor/soft page faults. @@ -97,61 +138,109 @@ module PROCESS # Parent Process identifier (PPID). # # @note Stability Level: experimental + # + # @example Sample Values + # 111 + # PROCESS_PARENT_PID = 'process.parent_pid' # Process identifier (PID). # # @note Stability Level: experimental + # + # @example Sample Values + # 1234 + # PROCESS_PID = 'process.pid' # The real user ID (RUID) of the process. # # @note Stability Level: experimental + # + # @example Sample Values + # 1000 + # PROCESS_REAL_USER_ID = 'process.real_user.id' # The username of the real user of the process. # # @note Stability Level: experimental + # + # @example Sample Values + # operator + # PROCESS_REAL_USER_NAME = 'process.real_user.name' # An additional description about the runtime of the process, for example a specific vendor customization of the runtime environment. # # @note Stability Level: experimental + # + # @example Sample Values + # Eclipse OpenJ9 Eclipse OpenJ9 VM openj9-0.21.0 + # PROCESS_RUNTIME_DESCRIPTION = 'process.runtime.description' # The name of the runtime of this process. For compiled native binaries, this SHOULD be the name of the compiler. # # @note Stability Level: experimental + # + # @example Sample Values + # OpenJDK Runtime Environment + # PROCESS_RUNTIME_NAME = 'process.runtime.name' # The version of the runtime of this process, as returned by the runtime without modification. # # @note Stability Level: experimental + # + # @example Sample Values + # 14.0.2 + # PROCESS_RUNTIME_VERSION = 'process.runtime.version' # The saved user ID (SUID) of the process. # # @note Stability Level: experimental + # + # @example Sample Values + # 1002 + # PROCESS_SAVED_USER_ID = 'process.saved_user.id' # The username of the saved user. # # @note Stability Level: experimental + # + # @example Sample Values + # operator + # PROCESS_SAVED_USER_NAME = 'process.saved_user.name' # The PID of the process's session leader. This is also the session ID (SID) of the process. # # @note Stability Level: experimental + # + # @example Sample Values + # 14 + # PROCESS_SESSION_LEADER_PID = 'process.session_leader.pid' # The effective user ID (EUID) of the process. # # @note Stability Level: experimental + # + # @example Sample Values + # 1001 + # PROCESS_USER_ID = 'process.user.id' # The username of the effective user of the process. # # @note Stability Level: experimental + # + # @example Sample Values + # root + # PROCESS_USER_NAME = 'process.user.name' # Virtual process identifier. @@ -159,12 +248,13 @@ module PROCESS # The process ID within a PID namespace. This is not necessarily unique across all processes on the host but it is unique within the process namespace that the process exists within. # # @note Stability Level: experimental + # + # @example Sample Values + # 12 + # PROCESS_VPID = 'process.vpid' # @!endgroup - - # @!group Metric Names - # @!endgroup end end end diff --git a/semantic_conventions/lib/opentelemetry/semconv/incubating/process/metrics.rb b/semantic_conventions/lib/opentelemetry/semconv/incubating/process/metrics.rb new file mode 100644 index 0000000000..28ac401352 --- /dev/null +++ b/semantic_conventions/lib/opentelemetry/semconv/incubating/process/metrics.rb @@ -0,0 +1,81 @@ +# 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 PROCESS + # @!group Metrics Names + + # Number of times the process has been context switched. + # + # @note Stability Level: experimental + PROCESS_CONTEXT_SWITCHES = 'process.context_switches' + + # Total CPU seconds broken down by different states. + # + # @note Stability Level: experimental + PROCESS_CPU_TIME = 'process.cpu.time' + + # Difference in process.cpu.time since the last measurement, divided by the elapsed time and number of CPUs available to the process. + # + # @note Stability Level: experimental + PROCESS_CPU_UTILIZATION = 'process.cpu.utilization' + + # Disk bytes transferred. + # + # @note Stability Level: experimental + PROCESS_DISK_IO = 'process.disk.io' + + # The amount of physical memory in use. + # + # @note Stability Level: experimental + PROCESS_MEMORY_USAGE = 'process.memory.usage' + + # The amount of committed virtual memory. + # + # @note Stability Level: experimental + PROCESS_MEMORY_VIRTUAL = 'process.memory.virtual' + + # Network bytes transferred. + # + # @note Stability Level: experimental + PROCESS_NETWORK_IO = 'process.network.io' + + # Number of file descriptors in use by the process. + # + # @note Stability Level: experimental + PROCESS_OPEN_FILE_DESCRIPTOR_COUNT = 'process.open_file_descriptor.count' + + # Number of page faults the process has made. + # + # @note Stability Level: experimental + PROCESS_PAGING_FAULTS = 'process.paging.faults' + + # Process threads count. + # + # @note Stability Level: experimental + PROCESS_THREAD_COUNT = 'process.thread.count' + + # @!endgroup + end + end + end +end \ No newline at end of file diff --git a/semantic_conventions/lib/opentelemetry/semconv/incubating/rpc.rb b/semantic_conventions/lib/opentelemetry/semconv/incubating/rpc/attributes.rb similarity index 75% rename from semantic_conventions/lib/opentelemetry/semconv/incubating/rpc.rb rename to semantic_conventions/lib/opentelemetry/semconv/incubating/rpc/attributes.rb index 40a9fa8378..4bc87beff4 100644 --- a/semantic_conventions/lib/opentelemetry/semconv/incubating/rpc.rb +++ b/semantic_conventions/lib/opentelemetry/semconv/incubating/rpc/attributes.rb @@ -29,32 +29,72 @@ module RPC # @note Stability Level: experimental RPC_CONNECT_RPC_ERROR_CODE = 'rpc.connect_rpc.error_code' + # Must be called with a key for the full attribute name. See notes below about the expectations + # for the state of the key. + # + # @example Usage + # RPC_CONNECT_RPC_REQUEST_METADATA_LAMBDA.call('some-cool-key') #=> 'rpc.connect_rpc.request.metadata.some-cool-key' + # # Connect request metadata, `` being the normalized Connect Metadata key (lowercase), the value being the metadata values. # # Instrumentations SHOULD require an explicit configuration of which metadata values are to be captured. Including all request metadata values can be a security risk - explicit configuration helps avoid leaking sensitive information. # # @note Stability Level: experimental + # + # @example Sample Values + # rpc.request.metadata.my-custom-metadata-attribute=["1.2.3.4", "1.2.3.5"] + # RPC_CONNECT_RPC_REQUEST_METADATA_LAMBDA = ->(key) { "rpc.connect_rpc.request.metadata.#{key}" } + # Must be called with a key for the full attribute name. See notes below about the expectations + # for the state of the key. + # + # @example Usage + # RPC_CONNECT_RPC_RESPONSE_METADATA_LAMBDA.call('some-cool-key') #=> 'rpc.connect_rpc.response.metadata.some-cool-key' + # # Connect response metadata, `` being the normalized Connect Metadata key (lowercase), the value being the metadata values. # # Instrumentations SHOULD require an explicit configuration of which metadata values are to be captured. Including all response metadata values can be a security risk - explicit configuration helps avoid leaking sensitive information. # # @note Stability Level: experimental + # + # @example Sample Values + # rpc.response.metadata.my-custom-metadata-attribute=["attribute_value"] + # RPC_CONNECT_RPC_RESPONSE_METADATA_LAMBDA = ->(key) { "rpc.connect_rpc.response.metadata.#{key}" } + # Must be called with a key for the full attribute name. See notes below about the expectations + # for the state of the key. + # + # @example Usage + # RPC_GRPC_REQUEST_METADATA_LAMBDA.call('some-cool-key') #=> 'rpc.grpc.request.metadata.some-cool-key' + # # gRPC request metadata, `` being the normalized gRPC Metadata key (lowercase), the value being the metadata values. # # Instrumentations SHOULD require an explicit configuration of which metadata values are to be captured. Including all request metadata values can be a security risk - explicit configuration helps avoid leaking sensitive information. # # @note Stability Level: experimental + # + # @example Sample Values + # rpc.grpc.request.metadata.my-custom-metadata-attribute=["1.2.3.4", "1.2.3.5"] + # RPC_GRPC_REQUEST_METADATA_LAMBDA = ->(key) { "rpc.grpc.request.metadata.#{key}" } + # Must be called with a key for the full attribute name. See notes below about the expectations + # for the state of the key. + # + # @example Usage + # RPC_GRPC_RESPONSE_METADATA_LAMBDA.call('some-cool-key') #=> 'rpc.grpc.response.metadata.some-cool-key' + # # gRPC response metadata, `` being the normalized gRPC Metadata key (lowercase), the value being the metadata values. # # Instrumentations SHOULD require an explicit configuration of which metadata values are to be captured. Including all response metadata values can be a security risk - explicit configuration helps avoid leaking sensitive information. # # @note Stability Level: experimental + # + # @example Sample Values + # rpc.grpc.response.metadata.my-custom-metadata-attribute=["attribute_value"] + # RPC_GRPC_RESPONSE_METADATA_LAMBDA = ->(key) { "rpc.grpc.response.metadata.#{key}" } # The [numeric status code](https://github.com/grpc/grpc/blob/v1.33.2/doc/statuscodes.md) of the gRPC request. @@ -65,21 +105,42 @@ module RPC # `error.code` property of response if it is an error response. # # @note Stability Level: experimental + # + # @example Sample Values + # -32700 + # 100 + # RPC_JSONRPC_ERROR_CODE = 'rpc.jsonrpc.error_code' # `error.message` property of response if it is an error response. # # @note Stability Level: experimental + # + # @example Sample Values + # Parse error + # User already exists + # RPC_JSONRPC_ERROR_MESSAGE = 'rpc.jsonrpc.error_message' # `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. # # @note Stability Level: experimental + # + # @example Sample Values + # 10 + # request-7 + # + # RPC_JSONRPC_REQUEST_ID = 'rpc.jsonrpc.request_id' # Protocol version as in `jsonrpc` property of request/response. Since JSON-RPC 1.0 doesn't specify this, the value can be omitted. # # @note Stability Level: experimental + # + # @example Sample Values + # 2.0 + # 1.0 + # RPC_JSONRPC_VERSION = 'rpc.jsonrpc.version' # Compressed size of the message in bytes. @@ -109,6 +170,10 @@ module RPC # This is the logical name of the method from the RPC interface perspective, which can be different from the name of any implementing method/function. The `code.function` attribute may be used to store the latter (e.g., method actually executing the call on the server side, RPC client stub method on the client side). # # @note Stability Level: experimental + # + # @example Sample Values + # exampleMethod + # RPC_METHOD = 'rpc.method' # The full (logical) name of the service being called, including its package name, if applicable. @@ -116,6 +181,10 @@ module RPC # This is the logical name of the service from the RPC interface perspective, which can be different from the name of any implementing class. The `code.namespace` attribute may be used to store the latter (despite the attribute name, it may include a class name; e.g., class with method actually executing the call on the server side, RPC client stub class on the client side). # # @note Stability Level: experimental + # + # @example Sample Values + # myservice.EchoService + # RPC_SERVICE = 'rpc.service' # A string identifying the remoting system. See below for a list of well-known identifiers. @@ -124,9 +193,6 @@ module RPC RPC_SYSTEM = 'rpc.system' # @!endgroup - - # @!group Metric Names - # @!endgroup end end end diff --git a/semantic_conventions/lib/opentelemetry/semconv/incubating/rpc/metrics.rb b/semantic_conventions/lib/opentelemetry/semconv/incubating/rpc/metrics.rb new file mode 100644 index 0000000000..78ad217ae9 --- /dev/null +++ b/semantic_conventions/lib/opentelemetry/semconv/incubating/rpc/metrics.rb @@ -0,0 +1,115 @@ +# 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 RPC + # @!group Metrics Names + + # Measures the duration of outbound RPC. + # + # While streaming RPCs may record this metric as start-of-batch + # to end-of-batch, it's hard to interpret in practice. + # + # **Streaming**: N/A. + # + # @note Stability Level: experimental + RPC_CLIENT_DURATION = 'rpc.client.duration' + + # Measures the size of RPC request messages (uncompressed). + # + # **Streaming**: Recorded per message in a streaming batch + # + # @note Stability Level: experimental + RPC_CLIENT_REQUEST_SIZE = 'rpc.client.request.size' + + # Measures the number of messages received per RPC. + # + # Should be 1 for all non-streaming RPCs. + # + # **Streaming**: This metric is required for server and client streaming RPCs + # + # @note Stability Level: experimental + RPC_CLIENT_REQUESTS_PER_RPC = 'rpc.client.requests_per_rpc' + + # Measures the size of RPC response messages (uncompressed). + # + # **Streaming**: Recorded per response in a streaming batch + # + # @note Stability Level: experimental + RPC_CLIENT_RESPONSE_SIZE = 'rpc.client.response.size' + + # Measures the number of messages sent per RPC. + # + # Should be 1 for all non-streaming RPCs. + # + # **Streaming**: This metric is required for server and client streaming RPCs + # + # @note Stability Level: experimental + RPC_CLIENT_RESPONSES_PER_RPC = 'rpc.client.responses_per_rpc' + + # Measures the duration of inbound RPC. + # + # While streaming RPCs may record this metric as start-of-batch + # to end-of-batch, it's hard to interpret in practice. + # + # **Streaming**: N/A. + # + # @note Stability Level: experimental + RPC_SERVER_DURATION = 'rpc.server.duration' + + # Measures the size of RPC request messages (uncompressed). + # + # **Streaming**: Recorded per message in a streaming batch + # + # @note Stability Level: experimental + RPC_SERVER_REQUEST_SIZE = 'rpc.server.request.size' + + # Measures the number of messages received per RPC. + # + # Should be 1 for all non-streaming RPCs. + # + # **Streaming** : This metric is required for server and client streaming RPCs + # + # @note Stability Level: experimental + RPC_SERVER_REQUESTS_PER_RPC = 'rpc.server.requests_per_rpc' + + # Measures the size of RPC response messages (uncompressed). + # + # **Streaming**: Recorded per response in a streaming batch + # + # @note Stability Level: experimental + RPC_SERVER_RESPONSE_SIZE = 'rpc.server.response.size' + + # Measures the number of messages sent per RPC. + # + # Should be 1 for all non-streaming RPCs. + # + # **Streaming**: This metric is required for server and client streaming RPCs + # + # @note Stability Level: experimental + RPC_SERVER_RESPONSES_PER_RPC = 'rpc.server.responses_per_rpc' + + # @!endgroup + end + end + end +end \ No newline at end of file diff --git a/semantic_conventions/lib/opentelemetry/semconv/incubating/server.rb b/semantic_conventions/lib/opentelemetry/semconv/incubating/server/attributes.rb similarity index 85% rename from semantic_conventions/lib/opentelemetry/semconv/incubating/server.rb rename to semantic_conventions/lib/opentelemetry/semconv/incubating/server/attributes.rb index 33c142784c..d436015fc7 100644 --- a/semantic_conventions/lib/opentelemetry/semconv/incubating/server.rb +++ b/semantic_conventions/lib/opentelemetry/semconv/incubating/server/attributes.rb @@ -30,7 +30,13 @@ module SERVER # # @note Stability Level: stable # - # @deprecated Now available in the stable namespace at {OpenTelemetry::SemConv::Server::SERVER_ADDRESS}. + # @example Sample Values + # example.com + # 10.1.2.80 + # /tmp/my.sock + # + # + # @deprecated Now available in the stable namespace at {OpenTelemetry::SemConv::SERVER::SERVER_ADDRESS}. SERVER_ADDRESS = 'server.address' # Server port number. @@ -39,13 +45,16 @@ module SERVER # # @note Stability Level: stable # - # @deprecated Now available in the stable namespace at {OpenTelemetry::SemConv::Server::SERVER_PORT}. + # @example Sample Values + # 80 + # 8080 + # 443 + # + # + # @deprecated Now available in the stable namespace at {OpenTelemetry::SemConv::SERVER::SERVER_PORT}. SERVER_PORT = 'server.port' # @!endgroup - - # @!group Metric Names - # @!endgroup end end end diff --git a/semantic_conventions/lib/opentelemetry/semconv/incubating/service.rb b/semantic_conventions/lib/opentelemetry/semconv/incubating/service/attributes.rb similarity index 92% rename from semantic_conventions/lib/opentelemetry/semconv/incubating/service.rb rename to semantic_conventions/lib/opentelemetry/semconv/incubating/service/attributes.rb index 51241bddaa..09919ca5ac 100644 --- a/semantic_conventions/lib/opentelemetry/semconv/incubating/service.rb +++ b/semantic_conventions/lib/opentelemetry/semconv/incubating/service/attributes.rb @@ -54,6 +54,10 @@ module SERVICE # port. # # @note Stability Level: experimental + # + # @example Sample Values + # 627cc493-f310-47de-96bd-71410b7dec09 + # SERVICE_INSTANCE_ID = 'service.instance.id' # Logical name of the service. @@ -62,7 +66,11 @@ module SERVICE # # @note Stability Level: stable # - # @deprecated Now available in the stable namespace at {OpenTelemetry::SemConv::Service::SERVICE_NAME}. + # @example Sample Values + # shoppingcart + # + # + # @deprecated Now available in the stable namespace at {OpenTelemetry::SemConv::SERVICE::SERVICE_NAME}. SERVICE_NAME = 'service.name' # A namespace for `service.name`. @@ -70,19 +78,25 @@ module SERVICE # 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. # # @note Stability Level: experimental + # + # @example Sample Values + # Shop + # SERVICE_NAMESPACE = 'service.namespace' # The version string of the service API or implementation. The format is not defined by these conventions. # # @note Stability Level: stable # - # @deprecated Now available in the stable namespace at {OpenTelemetry::SemConv::Service::SERVICE_VERSION}. + # @example Sample Values + # 2.0.0 + # a01dbef8a + # + # + # @deprecated Now available in the stable namespace at {OpenTelemetry::SemConv::SERVICE::SERVICE_VERSION}. SERVICE_VERSION = 'service.version' # @!endgroup - - # @!group Metric Names - # @!endgroup end end end diff --git a/semantic_conventions/lib/opentelemetry/semconv/incubating/session.rb b/semantic_conventions/lib/opentelemetry/semconv/incubating/session/attributes.rb similarity index 86% rename from semantic_conventions/lib/opentelemetry/semconv/incubating/session.rb rename to semantic_conventions/lib/opentelemetry/semconv/incubating/session/attributes.rb index a6bf8b741b..ede9869c49 100644 --- a/semantic_conventions/lib/opentelemetry/semconv/incubating/session.rb +++ b/semantic_conventions/lib/opentelemetry/semconv/incubating/session/attributes.rb @@ -27,17 +27,22 @@ module SESSION # A unique id to identify a session. # # @note Stability Level: experimental + # + # @example Sample Values + # 00112233-4455-6677-8899-aabbccddeeff + # SESSION_ID = 'session.id' # The previous `session.id` for this user, when known. # # @note Stability Level: experimental + # + # @example Sample Values + # 00112233-4455-6677-8899-aabbccddeeff + # SESSION_PREVIOUS_ID = 'session.previous_id' # @!endgroup - - # @!group Metric Names - # @!endgroup end end end diff --git a/semantic_conventions/lib/opentelemetry/semconv/incubating/signalr.rb b/semantic_conventions/lib/opentelemetry/semconv/incubating/signalr/attributes.rb similarity index 82% rename from semantic_conventions/lib/opentelemetry/semconv/incubating/signalr.rb rename to semantic_conventions/lib/opentelemetry/semconv/incubating/signalr/attributes.rb index 4a17b2853f..f08d4883c0 100644 --- a/semantic_conventions/lib/opentelemetry/semconv/incubating/signalr.rb +++ b/semantic_conventions/lib/opentelemetry/semconv/incubating/signalr/attributes.rb @@ -28,20 +28,27 @@ module SIGNALR # # @note Stability Level: stable # - # @deprecated Now available in the stable namespace at {OpenTelemetry::SemConv::Signalr::SIGNALR_CONNECTION_STATUS}. + # @example Sample Values + # app_shutdown + # timeout + # + # + # @deprecated Now available in the stable namespace at {OpenTelemetry::SemConv::SIGNALR::SIGNALR_CONNECTION_STATUS}. SIGNALR_CONNECTION_STATUS = 'signalr.connection.status' # [SignalR transport type](https://github.com/dotnet/aspnetcore/blob/main/src/SignalR/docs/specs/TransportProtocols.md) # # @note Stability Level: stable # - # @deprecated Now available in the stable namespace at {OpenTelemetry::SemConv::Signalr::SIGNALR_TRANSPORT}. + # @example Sample Values + # web_sockets + # long_polling + # + # + # @deprecated Now available in the stable namespace at {OpenTelemetry::SemConv::SIGNALR::SIGNALR_TRANSPORT}. SIGNALR_TRANSPORT = 'signalr.transport' # @!endgroup - - # @!group Metric Names - # @!endgroup end end end diff --git a/semantic_conventions/lib/opentelemetry/semconv/incubating/signalr/metrics.rb b/semantic_conventions/lib/opentelemetry/semconv/incubating/signalr/metrics.rb new file mode 100644 index 0000000000..cda3d1c12f --- /dev/null +++ b/semantic_conventions/lib/opentelemetry/semconv/incubating/signalr/metrics.rb @@ -0,0 +1,49 @@ +# 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 SIGNALR + # @!group Metrics Names + + # Number of connections that are currently active on the server. + # + # Meter name: `Microsoft.AspNetCore.Http.Connections`; Added in: ASP.NET Core 8.0 + # + # @note Stability Level: stable + # + # @deprecated Now available in the stable namespace at {OpenTelemetry::SemConv::SIGNALR::SIGNALR_SERVER_ACTIVE_CONNECTIONS}. + SIGNALR_SERVER_ACTIVE_CONNECTIONS = 'signalr.server.active_connections' + + # The duration of connections on the server. + # + # Meter name: `Microsoft.AspNetCore.Http.Connections`; Added in: ASP.NET Core 8.0 + # + # @note Stability Level: stable + # + # @deprecated Now available in the stable namespace at {OpenTelemetry::SemConv::SIGNALR::SIGNALR_SERVER_CONNECTION_DURATION}. + SIGNALR_SERVER_CONNECTION_DURATION = 'signalr.server.connection.duration' + + # @!endgroup + end + end + end +end \ No newline at end of file diff --git a/semantic_conventions/lib/opentelemetry/semconv/incubating/source.rb b/semantic_conventions/lib/opentelemetry/semconv/incubating/source/attributes.rb similarity index 87% rename from semantic_conventions/lib/opentelemetry/semconv/incubating/source.rb rename to semantic_conventions/lib/opentelemetry/semconv/incubating/source/attributes.rb index 6c6c00220a..0026253c68 100644 --- a/semantic_conventions/lib/opentelemetry/semconv/incubating/source.rb +++ b/semantic_conventions/lib/opentelemetry/semconv/incubating/source/attributes.rb @@ -29,17 +29,25 @@ module SOURCE # When observed from the destination side, and when communicating through an intermediary, `source.address` SHOULD represent the source address behind any intermediaries, for example proxies, if it's available. # # @note Stability Level: experimental + # + # @example Sample Values + # source.example.com + # 10.1.2.80 + # /tmp/my.sock + # SOURCE_ADDRESS = 'source.address' # Source port number # # @note Stability Level: experimental + # + # @example Sample Values + # 3389 + # 2888 + # SOURCE_PORT = 'source.port' # @!endgroup - - # @!group Metric Names - # @!endgroup end end end diff --git a/semantic_conventions/lib/opentelemetry/semconv/incubating/system.rb b/semantic_conventions/lib/opentelemetry/semconv/incubating/system/attributes.rb similarity index 76% rename from semantic_conventions/lib/opentelemetry/semconv/incubating/system.rb rename to semantic_conventions/lib/opentelemetry/semconv/incubating/system/attributes.rb index 56dfc04bd0..ced3e02678 100644 --- a/semantic_conventions/lib/opentelemetry/semconv/incubating/system.rb +++ b/semantic_conventions/lib/opentelemetry/semconv/incubating/system/attributes.rb @@ -27,78 +27,133 @@ module SYSTEM # The logical CPU number [0..n-1] # # @note Stability Level: experimental + # + # @example Sample Values + # 1 + # SYSTEM_CPU_LOGICAL_NUMBER = 'system.cpu.logical_number' # The state of the CPU # # @note Stability Level: experimental + # + # @example Sample Values + # idle + # interrupt + # SYSTEM_CPU_STATE = 'system.cpu.state' # The device identifier # # @note Stability Level: experimental + # + # @example Sample Values + # (identifier) + # SYSTEM_DEVICE = 'system.device' # The filesystem mode # # @note Stability Level: experimental + # + # @example Sample Values + # rw, ro + # SYSTEM_FILESYSTEM_MODE = 'system.filesystem.mode' # The filesystem mount path # # @note Stability Level: experimental + # + # @example Sample Values + # /mnt/data + # SYSTEM_FILESYSTEM_MOUNTPOINT = 'system.filesystem.mountpoint' # The filesystem state # # @note Stability Level: experimental + # + # @example Sample Values + # used + # SYSTEM_FILESYSTEM_STATE = 'system.filesystem.state' # The filesystem type # # @note Stability Level: experimental + # + # @example Sample Values + # ext4 + # SYSTEM_FILESYSTEM_TYPE = 'system.filesystem.type' # The memory state # # @note Stability Level: experimental + # + # @example Sample Values + # free + # cached + # SYSTEM_MEMORY_STATE = 'system.memory.state' # A stateless protocol MUST NOT set this attribute # # @note Stability Level: experimental + # + # @example Sample Values + # close_wait + # SYSTEM_NETWORK_STATE = 'system.network.state' # The paging access direction # # @note Stability Level: experimental + # + # @example Sample Values + # in + # SYSTEM_PAGING_DIRECTION = 'system.paging.direction' # The memory paging state # # @note Stability Level: experimental + # + # @example Sample Values + # free + # SYSTEM_PAGING_STATE = 'system.paging.state' # The memory paging type # # @note Stability Level: experimental + # + # @example Sample Values + # minor + # SYSTEM_PAGING_TYPE = 'system.paging.type' # The process state, e.g., [Linux Process State Codes](https://man7.org/linux/man-pages/man1/ps.1.html#PROCESS_STATE_CODES) # # @note Stability Level: experimental + # + # @example Sample Values + # running + # SYSTEM_PROCESS_STATUS = 'system.process.status' # Deprecated, use `system.process.status` instead. # # @note Stability Level: experimental + # + # @example Sample Values + # running + # # @deprecated Replaced by `system.process.status`. SYSTEM_PROCESSES_STATUS = 'system.processes.status' # @!endgroup - - # @!group Metric Names - # @!endgroup end end end diff --git a/semantic_conventions/lib/opentelemetry/semconv/incubating/system/metrics.rb b/semantic_conventions/lib/opentelemetry/semconv/incubating/system/metrics.rb new file mode 100644 index 0000000000..a7b11ce65d --- /dev/null +++ b/semantic_conventions/lib/opentelemetry/semconv/incubating/system/metrics.rb @@ -0,0 +1,185 @@ +# 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 SYSTEM + # @!group Metrics Names + + # Reports the current frequency of the CPU in Hz + # + # @note Stability Level: experimental + SYSTEM_CPU_FREQUENCY = 'system.cpu.frequency' + + # Reports the number of logical (virtual) processor cores created by the operating system to manage multitasking + # + # @note Stability Level: experimental + SYSTEM_CPU_LOGICAL_COUNT = 'system.cpu.logical.count' + + # Reports the number of actual physical processor cores on the hardware + # + # @note Stability Level: experimental + SYSTEM_CPU_PHYSICAL_COUNT = 'system.cpu.physical.count' + + # Seconds each logical CPU spent on each mode + # + # @note Stability Level: experimental + SYSTEM_CPU_TIME = 'system.cpu.time' + + # Difference in system.cpu.time since the last measurement, divided by the elapsed time and number of logical CPUs + # + # @note Stability Level: experimental + SYSTEM_CPU_UTILIZATION = 'system.cpu.utilization' + + # @note Stability Level: experimental + SYSTEM_DISK_IO = 'system.disk.io' + + # Time disk spent activated + # + # The real elapsed time ("wall clock") used in the I/O path (time from operations running in parallel are not counted). Measured as: + # + # - Linux: Field 13 from [procfs-diskstats](https://www.kernel.org/doc/Documentation/ABI/testing/procfs-diskstats) + # - Windows: The complement of + # ["Disk% Idle Time"](https://learn.microsoft.com/archive/blogs/askcore/windows-performance-monitor-disk-counters-explained#windows-performance-monitor-disk-counters-explained) + # performance counter: `uptime * (100 - "Disk\% Idle Time") / 100` + # + # @note Stability Level: experimental + SYSTEM_DISK_IO_TIME = 'system.disk.io_time' + + # @note Stability Level: experimental + SYSTEM_DISK_MERGED = 'system.disk.merged' + + # Sum of the time each operation took to complete + # + # Because it is the sum of time each request took, parallel-issued requests each contribute to make the count grow. Measured as: + # + # - Linux: Fields 7 & 11 from [procfs-diskstats](https://www.kernel.org/doc/Documentation/ABI/testing/procfs-diskstats) + # - Windows: "Avg. Disk sec/Read" perf counter multiplied by "Disk Reads/sec" perf counter (similar for Writes) + # + # @note Stability Level: experimental + SYSTEM_DISK_OPERATION_TIME = 'system.disk.operation_time' + + # @note Stability Level: experimental + SYSTEM_DISK_OPERATIONS = 'system.disk.operations' + + # @note Stability Level: experimental + SYSTEM_FILESYSTEM_USAGE = 'system.filesystem.usage' + + # @note Stability Level: experimental + SYSTEM_FILESYSTEM_UTILIZATION = 'system.filesystem.utilization' + + # An estimate of how much memory is available for starting new applications, without causing swapping + # + # This is an alternative to `system.memory.usage` metric with `state=free`. + # Linux starting from 3.14 exports "available" memory. It takes "free" memory as a baseline, and then factors in kernel-specific values. + # This is supposed to be more accurate than just "free" memory. + # For reference, see the calculations [here](https://superuser.com/a/980821). + # See also `MemAvailable` in [/proc/meminfo](https://man7.org/linux/man-pages/man5/proc.5.html). + # + # @note Stability Level: experimental + SYSTEM_LINUX_MEMORY_AVAILABLE = 'system.linux.memory.available' + + # Total memory available in the system. + # + # Its value SHOULD equal the sum of `system.memory.state` over all states. + # + # @note Stability Level: experimental + SYSTEM_MEMORY_LIMIT = 'system.memory.limit' + + # Shared memory used (mostly by tmpfs). + # + # Equivalent of `shared` from [`free` command](https://man7.org/linux/man-pages/man1/free.1.html) or + # `Shmem` from [`/proc/meminfo`](https://man7.org/linux/man-pages/man5/proc.5.html)" + # + # @note Stability Level: experimental + SYSTEM_MEMORY_SHARED = 'system.memory.shared' + + # Reports memory in use by state. + # + # The sum over all `system.memory.state` values SHOULD equal the total memory + # available on the system, that is `system.memory.limit`. + # + # @note Stability Level: experimental + SYSTEM_MEMORY_USAGE = 'system.memory.usage' + + # @note Stability Level: experimental + SYSTEM_MEMORY_UTILIZATION = 'system.memory.utilization' + + # @note Stability Level: experimental + SYSTEM_NETWORK_CONNECTIONS = 'system.network.connections' + + # Count of packets that are dropped or discarded even though there was no error + # + # Measured as: + # + # - Linux: the `drop` column in `/proc/dev/net` ([source](https://web.archive.org/web/20180321091318/http://www.onlamp.com/pub/a/linux/2000/11/16/LinuxAdmin.html)) + # - Windows: [`InDiscards`/`OutDiscards`](https://docs.microsoft.com/windows/win32/api/netioapi/ns-netioapi-mib_if_row2) + # from [`GetIfEntry2`](https://docs.microsoft.com/windows/win32/api/netioapi/nf-netioapi-getifentry2) + # + # @note Stability Level: experimental + SYSTEM_NETWORK_DROPPED = 'system.network.dropped' + + # Count of network errors detected + # + # Measured as: + # + # - Linux: the `errs` column in `/proc/dev/net` ([source](https://web.archive.org/web/20180321091318/http://www.onlamp.com/pub/a/linux/2000/11/16/LinuxAdmin.html)). + # - Windows: [`InErrors`/`OutErrors`](https://docs.microsoft.com/windows/win32/api/netioapi/ns-netioapi-mib_if_row2) + # from [`GetIfEntry2`](https://docs.microsoft.com/windows/win32/api/netioapi/nf-netioapi-getifentry2). + # + # @note Stability Level: experimental + SYSTEM_NETWORK_ERRORS = 'system.network.errors' + + # @note Stability Level: experimental + SYSTEM_NETWORK_IO = 'system.network.io' + + # @note Stability Level: experimental + SYSTEM_NETWORK_PACKETS = 'system.network.packets' + + # @note Stability Level: experimental + SYSTEM_PAGING_FAULTS = 'system.paging.faults' + + # @note Stability Level: experimental + SYSTEM_PAGING_OPERATIONS = 'system.paging.operations' + + # Unix swap or windows pagefile usage + # + # @note Stability Level: experimental + SYSTEM_PAGING_USAGE = 'system.paging.usage' + + # @note Stability Level: experimental + SYSTEM_PAGING_UTILIZATION = 'system.paging.utilization' + + # Total number of processes in each state + # + # @note Stability Level: experimental + SYSTEM_PROCESS_COUNT = 'system.process.count' + + # Total number of processes created over uptime of the host + # + # @note Stability Level: experimental + SYSTEM_PROCESS_CREATED = 'system.process.created' + + # @!endgroup + end + end + end +end \ No newline at end of file diff --git a/semantic_conventions/lib/opentelemetry/semconv/incubating/telemetry.rb b/semantic_conventions/lib/opentelemetry/semconv/incubating/telemetry/attributes.rb similarity index 85% rename from semantic_conventions/lib/opentelemetry/semconv/incubating/telemetry.rb rename to semantic_conventions/lib/opentelemetry/semconv/incubating/telemetry/attributes.rb index 8307589f46..de3c4fff4f 100644 --- a/semantic_conventions/lib/opentelemetry/semconv/incubating/telemetry.rb +++ b/semantic_conventions/lib/opentelemetry/semconv/incubating/telemetry/attributes.rb @@ -30,18 +30,26 @@ module TELEMETRY # a string starting with `opentelemetry-`, e.g. `opentelemetry-java-instrumentation`. # # @note Stability Level: experimental + # + # @example Sample Values + # parts-unlimited-java + # TELEMETRY_DISTRO_NAME = 'telemetry.distro.name' # The version string of the auto instrumentation agent or distribution, if used. # # @note Stability Level: experimental + # + # @example Sample Values + # 1.2.3 + # TELEMETRY_DISTRO_VERSION = 'telemetry.distro.version' # The language of the telemetry SDK. # # @note Stability Level: stable # - # @deprecated Now available in the stable namespace at {OpenTelemetry::SemConv::Telemetry::TELEMETRY_SDK_LANGUAGE}. + # @deprecated Now available in the stable namespace at {OpenTelemetry::SemConv::TELEMETRY::TELEMETRY_SDK_LANGUAGE}. TELEMETRY_SDK_LANGUAGE = 'telemetry.sdk.language' # The name of the telemetry SDK as defined above. @@ -55,20 +63,25 @@ module TELEMETRY # # @note Stability Level: stable # - # @deprecated Now available in the stable namespace at {OpenTelemetry::SemConv::Telemetry::TELEMETRY_SDK_NAME}. + # @example Sample Values + # opentelemetry + # + # + # @deprecated Now available in the stable namespace at {OpenTelemetry::SemConv::TELEMETRY::TELEMETRY_SDK_NAME}. TELEMETRY_SDK_NAME = 'telemetry.sdk.name' # The version string of the telemetry SDK. # # @note Stability Level: stable # - # @deprecated Now available in the stable namespace at {OpenTelemetry::SemConv::Telemetry::TELEMETRY_SDK_VERSION}. + # @example Sample Values + # 1.2.3 + # + # + # @deprecated Now available in the stable namespace at {OpenTelemetry::SemConv::TELEMETRY::TELEMETRY_SDK_VERSION}. TELEMETRY_SDK_VERSION = 'telemetry.sdk.version' # @!endgroup - - # @!group Metric Names - # @!endgroup end end end diff --git a/semantic_conventions/lib/opentelemetry/semconv/incubating/thread.rb b/semantic_conventions/lib/opentelemetry/semconv/incubating/thread/attributes.rb similarity index 90% rename from semantic_conventions/lib/opentelemetry/semconv/incubating/thread.rb rename to semantic_conventions/lib/opentelemetry/semconv/incubating/thread/attributes.rb index f93ed3f1c1..d9cdd01411 100644 --- a/semantic_conventions/lib/opentelemetry/semconv/incubating/thread.rb +++ b/semantic_conventions/lib/opentelemetry/semconv/incubating/thread/attributes.rb @@ -27,17 +27,22 @@ module THREAD # Current "managed" thread ID (as opposed to OS thread ID). # # @note Stability Level: experimental + # + # @example Sample Values + # 42 + # THREAD_ID = 'thread.id' # Current thread name. # # @note Stability Level: experimental + # + # @example Sample Values + # main + # THREAD_NAME = 'thread.name' # @!endgroup - - # @!group Metric Names - # @!endgroup end end end diff --git a/semantic_conventions/lib/opentelemetry/semconv/incubating/tls.rb b/semantic_conventions/lib/opentelemetry/semconv/incubating/tls/attributes.rb similarity index 76% rename from semantic_conventions/lib/opentelemetry/semconv/incubating/tls.rb rename to semantic_conventions/lib/opentelemetry/semconv/incubating/tls/attributes.rb index 6d29ea5c53..3dc83323c0 100644 --- a/semantic_conventions/lib/opentelemetry/semconv/incubating/tls.rb +++ b/semantic_conventions/lib/opentelemetry/semconv/incubating/tls/attributes.rb @@ -29,81 +29,147 @@ module TLS # The values allowed for `tls.cipher` MUST be one of the `Descriptions` of the [registered TLS Cipher Suits](https://www.iana.org/assignments/tls-parameters/tls-parameters.xhtml#table-tls-parameters-4). # # @note Stability Level: experimental + # + # @example Sample Values + # TLS_RSA_WITH_3DES_EDE_CBC_SHA + # TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256 + # TLS_CIPHER = 'tls.cipher' # PEM-encoded stand-alone certificate offered by the client. This is usually mutually-exclusive of `client.certificate_chain` since this value also exists in that list. # # @note Stability Level: experimental + # + # @example Sample Values + # MII... + # TLS_CLIENT_CERTIFICATE = 'tls.client.certificate' # Array of PEM-encoded certificates that make up the certificate chain offered by the client. This is usually mutually-exclusive of `client.certificate` since that value should be the first certificate in the chain. # # @note Stability Level: experimental + # + # @example Sample Values + # MII... + # MI... + # TLS_CLIENT_CERTIFICATE_CHAIN = 'tls.client.certificate_chain' # Certificate fingerprint using the MD5 digest of DER-encoded version of certificate offered by the client. For consistency with other hash values, this value should be formatted as an uppercase hash. # # @note Stability Level: experimental + # + # @example Sample Values + # 0F76C7F2C55BFD7D8E8B8F4BFBF0C9EC + # TLS_CLIENT_HASH_MD5 = 'tls.client.hash.md5' # Certificate fingerprint using the SHA1 digest of DER-encoded version of certificate offered by the client. For consistency with other hash values, this value should be formatted as an uppercase hash. # # @note Stability Level: experimental + # + # @example Sample Values + # 9E393D93138888D288266C2D915214D1D1CCEB2A + # TLS_CLIENT_HASH_SHA1 = 'tls.client.hash.sha1' # Certificate fingerprint using the SHA256 digest of DER-encoded version of certificate offered by the client. For consistency with other hash values, this value should be formatted as an uppercase hash. # # @note Stability Level: experimental + # + # @example Sample Values + # 0687F666A054EF17A08E2F2162EAB4CBC0D265E1D7875BE74BF3C712CA92DAF0 + # TLS_CLIENT_HASH_SHA256 = 'tls.client.hash.sha256' # Distinguished name of [subject](https://datatracker.ietf.org/doc/html/rfc5280#section-4.1.2.6) of the issuer of the x.509 certificate presented by the client. # # @note Stability Level: experimental + # + # @example Sample Values + # CN=Example Root CA, OU=Infrastructure Team, DC=example, DC=com + # TLS_CLIENT_ISSUER = 'tls.client.issuer' # A hash that identifies clients based on how they perform an SSL/TLS handshake. # # @note Stability Level: experimental + # + # @example Sample Values + # d4e5b18d6b55c71272893221c96ba240 + # TLS_CLIENT_JA3 = 'tls.client.ja3' # Date/Time indicating when client certificate is no longer considered valid. # # @note Stability Level: experimental + # + # @example Sample Values + # 2021-01-01T00:00:00.000Z + # TLS_CLIENT_NOT_AFTER = 'tls.client.not_after' # Date/Time indicating when client certificate is first considered valid. # # @note Stability Level: experimental + # + # @example Sample Values + # 1970-01-01T00:00:00.000Z + # TLS_CLIENT_NOT_BEFORE = 'tls.client.not_before' # Also called an SNI, this tells the server which hostname to which the client is attempting to connect to. # # @note Stability Level: experimental + # + # @example Sample Values + # opentelemetry.io + # TLS_CLIENT_SERVER_NAME = 'tls.client.server_name' # Distinguished name of subject of the x.509 certificate presented by the client. # # @note Stability Level: experimental + # + # @example Sample Values + # CN=myclient, OU=Documentation Team, DC=example, DC=com + # TLS_CLIENT_SUBJECT = 'tls.client.subject' # Array of ciphers offered by the client during the client hello. # # @note Stability Level: experimental + # + # @example Sample Values + # "TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384", "TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384", "..." + # TLS_CLIENT_SUPPORTED_CIPHERS = 'tls.client.supported_ciphers' # String indicating the curve used for the given cipher, when applicable # # @note Stability Level: experimental + # + # @example Sample Values + # secp256r1 + # TLS_CURVE = 'tls.curve' # Boolean flag indicating if the TLS negotiation was successful and transitioned to an encrypted tunnel. # # @note Stability Level: experimental + # + # @example Sample Values + # true + # TLS_ESTABLISHED = 'tls.established' # String indicating the protocol being tunneled. Per the values in the [IANA registry](https://www.iana.org/assignments/tls-extensiontype-values/tls-extensiontype-values.xhtml#alpn-protocol-ids), this string should be lower case. # # @note Stability Level: experimental + # + # @example Sample Values + # http/1.1 + # TLS_NEXT_PROTOCOL = 'tls.next_protocol' # Normalized lowercase protocol name parsed from original string of the negotiated [SSL/TLS protocol version](https://www.openssl.org/docs/man1.1.1/man3/SSL_get_version.html#RETURN-VALUES) @@ -114,67 +180,114 @@ module TLS # Numeric part of the version parsed from the original string of the negotiated [SSL/TLS protocol version](https://www.openssl.org/docs/man1.1.1/man3/SSL_get_version.html#RETURN-VALUES) # # @note Stability Level: experimental + # + # @example Sample Values + # 1.2 + # 3 + # TLS_PROTOCOL_VERSION = 'tls.protocol.version' # Boolean flag indicating if this TLS connection was resumed from an existing TLS negotiation. # # @note Stability Level: experimental + # + # @example Sample Values + # true + # TLS_RESUMED = 'tls.resumed' # PEM-encoded stand-alone certificate offered by the server. This is usually mutually-exclusive of `server.certificate_chain` since this value also exists in that list. # # @note Stability Level: experimental + # + # @example Sample Values + # MII... + # TLS_SERVER_CERTIFICATE = 'tls.server.certificate' # Array of PEM-encoded certificates that make up the certificate chain offered by the server. This is usually mutually-exclusive of `server.certificate` since that value should be the first certificate in the chain. # # @note Stability Level: experimental + # + # @example Sample Values + # MII... + # MI... + # TLS_SERVER_CERTIFICATE_CHAIN = 'tls.server.certificate_chain' # Certificate fingerprint using the MD5 digest of DER-encoded version of certificate offered by the server. For consistency with other hash values, this value should be formatted as an uppercase hash. # # @note Stability Level: experimental + # + # @example Sample Values + # 0F76C7F2C55BFD7D8E8B8F4BFBF0C9EC + # TLS_SERVER_HASH_MD5 = 'tls.server.hash.md5' # Certificate fingerprint using the SHA1 digest of DER-encoded version of certificate offered by the server. For consistency with other hash values, this value should be formatted as an uppercase hash. # # @note Stability Level: experimental + # + # @example Sample Values + # 9E393D93138888D288266C2D915214D1D1CCEB2A + # TLS_SERVER_HASH_SHA1 = 'tls.server.hash.sha1' # Certificate fingerprint using the SHA256 digest of DER-encoded version of certificate offered by the server. For consistency with other hash values, this value should be formatted as an uppercase hash. # # @note Stability Level: experimental + # + # @example Sample Values + # 0687F666A054EF17A08E2F2162EAB4CBC0D265E1D7875BE74BF3C712CA92DAF0 + # TLS_SERVER_HASH_SHA256 = 'tls.server.hash.sha256' # Distinguished name of [subject](https://datatracker.ietf.org/doc/html/rfc5280#section-4.1.2.6) of the issuer of the x.509 certificate presented by the client. # # @note Stability Level: experimental + # + # @example Sample Values + # CN=Example Root CA, OU=Infrastructure Team, DC=example, DC=com + # TLS_SERVER_ISSUER = 'tls.server.issuer' # A hash that identifies servers based on how they perform an SSL/TLS handshake. # # @note Stability Level: experimental + # + # @example Sample Values + # d4e5b18d6b55c71272893221c96ba240 + # TLS_SERVER_JA3S = 'tls.server.ja3s' # Date/Time indicating when server certificate is no longer considered valid. # # @note Stability Level: experimental + # + # @example Sample Values + # 2021-01-01T00:00:00.000Z + # TLS_SERVER_NOT_AFTER = 'tls.server.not_after' # Date/Time indicating when server certificate is first considered valid. # # @note Stability Level: experimental + # + # @example Sample Values + # 1970-01-01T00:00:00.000Z + # TLS_SERVER_NOT_BEFORE = 'tls.server.not_before' # Distinguished name of subject of the x.509 certificate presented by the server. # # @note Stability Level: experimental + # + # @example Sample Values + # CN=myserver, OU=Documentation Team, DC=example, DC=com + # TLS_SERVER_SUBJECT = 'tls.server.subject' # @!endgroup - - # @!group Metric Names - # @!endgroup end end end diff --git a/semantic_conventions/lib/opentelemetry/semconv/incubating/url.rb b/semantic_conventions/lib/opentelemetry/semconv/incubating/url/attributes.rb similarity index 81% rename from semantic_conventions/lib/opentelemetry/semconv/incubating/url.rb rename to semantic_conventions/lib/opentelemetry/semconv/incubating/url/attributes.rb index d1b01a0764..70610c36ee 100644 --- a/semantic_conventions/lib/opentelemetry/semconv/incubating/url.rb +++ b/semantic_conventions/lib/opentelemetry/semconv/incubating/url/attributes.rb @@ -29,6 +29,13 @@ module URL # 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: experimental + # + # @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. @@ -36,13 +43,22 @@ module URL # 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: experimental + # + # @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 # - # @deprecated Now available in the stable namespace at {OpenTelemetry::SemConv::Url::URL_FRAGMENT}. + # @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) @@ -53,7 +69,12 @@ module URL # # @note Stability Level: stable # - # @deprecated Now available in the stable namespace at {OpenTelemetry::SemConv::Url::URL_FULL}. + # @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. @@ -62,6 +83,11 @@ module URL # `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: experimental + # + # @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 @@ -70,12 +96,20 @@ module URL # # @note Stability Level: stable # - # @deprecated Now available in the stable namespace at {OpenTelemetry::SemConv::Url::URL_PATH}. + # @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: experimental + # + # @example Sample Values + # 443 + # URL_PORT = 'url.port' # The [URI query](https://www.rfc-editor.org/rfc/rfc3986#section-3.4) component @@ -84,7 +118,11 @@ module URL # # @note Stability Level: stable # - # @deprecated Now available in the stable namespace at {OpenTelemetry::SemConv::Url::URL_QUERY}. + # @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. @@ -92,13 +130,24 @@ module URL # This value can be determined precisely with the [public suffix list](http://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: experimental + # + # @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 # - # @deprecated Now available in the stable namespace at {OpenTelemetry::SemConv::Url::URL_SCHEME}. + # @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. @@ -106,11 +155,22 @@ module URL # 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: experimental + # + # @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: experimental + # + # @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`. @@ -118,12 +178,14 @@ module URL # This value can be determined precisely with the [public suffix list](http://publicsuffix.org). # # @note Stability Level: experimental + # + # @example Sample Values + # com + # co.uk + # URL_TOP_LEVEL_DOMAIN = 'url.top_level_domain' # @!endgroup - - # @!group Metric Names - # @!endgroup end end end diff --git a/semantic_conventions/lib/opentelemetry/semconv/incubating/user_agent.rb b/semantic_conventions/lib/opentelemetry/semconv/incubating/user_agent/attributes.rb similarity index 81% rename from semantic_conventions/lib/opentelemetry/semconv/incubating/user_agent.rb rename to semantic_conventions/lib/opentelemetry/semconv/incubating/user_agent/attributes.rb index 338695f25b..69f3455482 100644 --- a/semantic_conventions/lib/opentelemetry/semconv/incubating/user_agent.rb +++ b/semantic_conventions/lib/opentelemetry/semconv/incubating/user_agent/attributes.rb @@ -29,13 +29,24 @@ module USER_AGENT # [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: experimental + # + # @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 # - # @deprecated Now available in the stable namespace at {OpenTelemetry::SemConv::UserAgent::USER_AGENT_ORIGINAL}. + # @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' # Version of the user-agent extracted from original. Usually refers to the browser's version @@ -43,12 +54,14 @@ module USER_AGENT # [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: experimental + # + # @example Sample Values + # 14.1.2 + # 1.0.0 + # USER_AGENT_VERSION = 'user_agent.version' # @!endgroup - - # @!group Metric Names - # @!endgroup end end end diff --git a/semantic_conventions/lib/opentelemetry/semconv/incubating/webengine.rb b/semantic_conventions/lib/opentelemetry/semconv/incubating/webengine/attributes.rb similarity index 84% rename from semantic_conventions/lib/opentelemetry/semconv/incubating/webengine.rb rename to semantic_conventions/lib/opentelemetry/semconv/incubating/webengine/attributes.rb index 05f6fef153..b86056d3e2 100644 --- a/semantic_conventions/lib/opentelemetry/semconv/incubating/webengine.rb +++ b/semantic_conventions/lib/opentelemetry/semconv/incubating/webengine/attributes.rb @@ -27,22 +27,31 @@ module WEBENGINE # Additional description of the web engine (e.g. detailed version and edition information). # # @note Stability Level: experimental + # + # @example Sample Values + # WildFly Full 21.0.0.Final (WildFly Core 13.0.1.Final) - 2.2.2.Final + # WEBENGINE_DESCRIPTION = 'webengine.description' # The name of the web engine. # # @note Stability Level: experimental + # + # @example Sample Values + # WildFly + # WEBENGINE_NAME = 'webengine.name' # The version of the web engine. # # @note Stability Level: experimental + # + # @example Sample Values + # 21.0.0 + # WEBENGINE_VERSION = 'webengine.version' # @!endgroup - - # @!group Metric Names - # @!endgroup end end end diff --git a/semantic_conventions/lib/opentelemetry/semconv/jvm.rb b/semantic_conventions/lib/opentelemetry/semconv/jvm/attributes.rb similarity index 82% rename from semantic_conventions/lib/opentelemetry/semconv/jvm.rb rename to semantic_conventions/lib/opentelemetry/semconv/jvm/attributes.rb index 1bf54d467f..ec0a984f0e 100644 --- a/semantic_conventions/lib/opentelemetry/semconv/jvm.rb +++ b/semantic_conventions/lib/opentelemetry/semconv/jvm/attributes.rb @@ -28,6 +28,11 @@ module JVM # Garbage collector action is generally obtained via [GarbageCollectionNotificationInfo#getGcAction()](https://docs.oracle.com/en/java/javase/11/docs/api/jdk.management/com/sun/management/GarbageCollectionNotificationInfo.html#getGcAction()). # # @note Stability Level: stable + # + # @example Sample Values + # end of minor GC + # end of major GC + # JVM_GC_ACTION = 'jvm.gc.action' # Name of the garbage collector. @@ -35,6 +40,11 @@ module JVM # Garbage collector name is generally obtained via [GarbageCollectionNotificationInfo#getGcName()](https://docs.oracle.com/en/java/javase/11/docs/api/jdk.management/com/sun/management/GarbageCollectionNotificationInfo.html#getGcName()). # # @note Stability Level: stable + # + # @example Sample Values + # G1 Young Generation + # G1 Old Generation + # JVM_GC_NAME = 'jvm.gc.name' # Name of the memory pool. @@ -42,11 +52,22 @@ module JVM # Pool names are generally obtained via [MemoryPoolMXBean#getName()](https://docs.oracle.com/en/java/javase/11/docs/api/java.management/java/lang/management/MemoryPoolMXBean.html#getName()). # # @note Stability Level: stable + # + # @example Sample Values + # G1 Old Gen + # G1 Eden space + # G1 Survivor Space + # JVM_MEMORY_POOL_NAME = 'jvm.memory.pool.name' # The type of memory. # # @note Stability Level: stable + # + # @example Sample Values + # heap + # non_heap + # JVM_MEMORY_TYPE = 'jvm.memory.type' # Whether the thread is daemon or not. @@ -57,12 +78,14 @@ module JVM # State of the thread. # # @note Stability Level: stable + # + # @example Sample Values + # runnable + # blocked + # JVM_THREAD_STATE = 'jvm.thread.state' # @!endgroup - - # @!group Metric Names - # @!endgroup end end end \ No newline at end of file diff --git a/semantic_conventions/lib/opentelemetry/semconv/jvm/metrics.rb b/semantic_conventions/lib/opentelemetry/semconv/jvm/metrics.rb new file mode 100644 index 0000000000..31843b05ed --- /dev/null +++ b/semantic_conventions/lib/opentelemetry/semconv/jvm/metrics.rb @@ -0,0 +1,91 @@ +# 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 JVM + # @!group Metrics Names + + # Number of classes currently loaded. + # + # @note Stability Level: stable + JVM_CLASS_COUNT = 'jvm.class.count' + + # Number of classes loaded since JVM start. + # + # @note Stability Level: stable + JVM_CLASS_LOADED = 'jvm.class.loaded' + + # Number of classes unloaded since JVM start. + # + # @note Stability Level: stable + JVM_CLASS_UNLOADED = 'jvm.class.unloaded' + + # Number of processors available to the Java virtual machine. + # + # @note Stability Level: stable + JVM_CPU_COUNT = 'jvm.cpu.count' + + # Recent CPU utilization for the process as reported by the JVM. + # + # The value range is [0.0,1.0]. This utilization is not defined as being for the specific interval since last measurement (unlike `system.cpu.utilization`). [Reference](https://docs.oracle.com/en/java/javase/17/docs/api/jdk.management/com/sun/management/OperatingSystemMXBean.html#getProcessCpuLoad()). + # + # @note Stability Level: stable + JVM_CPU_RECENT_UTILIZATION = 'jvm.cpu.recent_utilization' + + # CPU time used by the process as reported by the JVM. + # + # @note Stability Level: stable + JVM_CPU_TIME = 'jvm.cpu.time' + + # Duration of JVM garbage collection actions. + # + # @note Stability Level: stable + JVM_GC_DURATION = 'jvm.gc.duration' + + # Measure of memory committed. + # + # @note Stability Level: stable + JVM_MEMORY_COMMITTED = 'jvm.memory.committed' + + # Measure of max obtainable memory. + # + # @note Stability Level: stable + JVM_MEMORY_LIMIT = 'jvm.memory.limit' + + # Measure of memory used. + # + # @note Stability Level: stable + JVM_MEMORY_USED = 'jvm.memory.used' + + # Measure of memory used, as measured after the most recent garbage collection event on this pool. + # + # @note Stability Level: stable + JVM_MEMORY_USED_AFTER_LAST_GC = 'jvm.memory.used_after_last_gc' + + # Number of executing platform threads. + # + # @note Stability Level: stable + JVM_THREAD_COUNT = 'jvm.thread.count' + + # @!endgroup + end + end +end \ No newline at end of file diff --git a/semantic_conventions/lib/opentelemetry/semconv/kestrel/metrics.rb b/semantic_conventions/lib/opentelemetry/semconv/kestrel/metrics.rb new file mode 100644 index 0000000000..863b5e3340 --- /dev/null +++ b/semantic_conventions/lib/opentelemetry/semconv/kestrel/metrics.rb @@ -0,0 +1,88 @@ +# 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 KESTREL + # @!group Metrics Names + + # Number of connections that are currently active on the server. + # + # Meter name: `Microsoft.AspNetCore.Server.Kestrel`; Added in: ASP.NET Core 8.0 + # + # @note Stability Level: stable + KESTREL_ACTIVE_CONNECTIONS = 'kestrel.active_connections' + + # Number of TLS handshakes that are currently in progress on the server. + # + # Meter name: `Microsoft.AspNetCore.Server.Kestrel`; Added in: ASP.NET Core 8.0 + # + # @note Stability Level: stable + KESTREL_ACTIVE_TLS_HANDSHAKES = 'kestrel.active_tls_handshakes' + + # The duration of connections on the server. + # + # Meter name: `Microsoft.AspNetCore.Server.Kestrel`; Added in: ASP.NET Core 8.0 + # + # @note Stability Level: stable + KESTREL_CONNECTION_DURATION = 'kestrel.connection.duration' + + # Number of connections that are currently queued and are waiting to start. + # + # Meter name: `Microsoft.AspNetCore.Server.Kestrel`; Added in: ASP.NET Core 8.0 + # + # @note Stability Level: stable + KESTREL_QUEUED_CONNECTIONS = 'kestrel.queued_connections' + + # Number of HTTP requests on multiplexed connections (HTTP/2 and HTTP/3) that are currently queued and are waiting to start. + # + # Meter name: `Microsoft.AspNetCore.Server.Kestrel`; Added in: ASP.NET Core 8.0 + # + # @note Stability Level: stable + KESTREL_QUEUED_REQUESTS = 'kestrel.queued_requests' + + # Number of connections rejected by the server. + # + # Connections are rejected when the currently active count exceeds the value configured with `MaxConcurrentConnections`. + # Meter name: `Microsoft.AspNetCore.Server.Kestrel`; Added in: ASP.NET Core 8.0 + # + # @note Stability Level: stable + KESTREL_REJECTED_CONNECTIONS = 'kestrel.rejected_connections' + + # The duration of TLS handshakes on the server. + # + # Meter name: `Microsoft.AspNetCore.Server.Kestrel`; Added in: ASP.NET Core 8.0 + # + # @note Stability Level: stable + KESTREL_TLS_HANDSHAKE_DURATION = 'kestrel.tls_handshake.duration' + + # Number of connections that are currently upgraded (WebSockets). . + # + # The counter only tracks HTTP/1.1 connections. + # + # Meter name: `Microsoft.AspNetCore.Server.Kestrel`; Added in: ASP.NET Core 8.0 + # + # @note Stability Level: stable + KESTREL_UPGRADED_CONNECTIONS = 'kestrel.upgraded_connections' + + # @!endgroup + end + end +end \ No newline at end of file diff --git a/semantic_conventions/lib/opentelemetry/semconv/network.rb b/semantic_conventions/lib/opentelemetry/semconv/network/attributes.rb similarity index 83% rename from semantic_conventions/lib/opentelemetry/semconv/network.rb rename to semantic_conventions/lib/opentelemetry/semconv/network/attributes.rb index a9d4041fc2..d5d138d28c 100644 --- a/semantic_conventions/lib/opentelemetry/semconv/network.rb +++ b/semantic_conventions/lib/opentelemetry/semconv/network/attributes.rb @@ -26,21 +26,39 @@ module NETWORK # Local address of the network connection - IP address or Unix domain socket name. # # @note Stability Level: stable + # + # @example Sample Values + # 10.1.2.80 + # /tmp/my.sock + # NETWORK_LOCAL_ADDRESS = 'network.local.address' # Local port number of the network connection. # # @note Stability Level: stable + # + # @example Sample Values + # 65123 + # NETWORK_LOCAL_PORT = 'network.local.port' # Peer address of the network connection - IP address or Unix domain socket name. # # @note Stability Level: stable + # + # @example Sample Values + # 10.1.2.80 + # /tmp/my.sock + # NETWORK_PEER_ADDRESS = 'network.peer.address' # Peer port number of the network connection. # # @note Stability Level: stable + # + # @example Sample Values + # 65123 + # NETWORK_PEER_PORT = 'network.peer.port' # [OSI application layer](https://osi-model.com/application-layer/) or non-OSI equivalent. @@ -48,6 +66,12 @@ module NETWORK # The value SHOULD be normalized to lowercase. # # @note Stability Level: stable + # + # @example Sample Values + # amqp + # http + # mqtt + # NETWORK_PROTOCOL_NAME = 'network.protocol.name' # The actual version of the protocol used for network communication. @@ -55,6 +79,11 @@ module NETWORK # If protocol version is subject to negotiation (for example using [ALPN](https://www.rfc-editor.org/rfc/rfc7301.html)), this attribute SHOULD be set to the negotiated version. If the actual protocol version is not known, this attribute SHOULD NOT be set. # # @note Stability Level: stable + # + # @example Sample Values + # 1.1 + # 2 + # NETWORK_PROTOCOL_VERSION = 'network.protocol.version' # [OSI transport layer](https://osi-model.com/transport-layer/) or [inter-process communication method](https://wikipedia.org/wiki/Inter-process_communication). @@ -66,6 +95,11 @@ module NETWORK # different processes could be listening on TCP port 12345 and UDP port 12345. # # @note Stability Level: stable + # + # @example Sample Values + # tcp + # udp + # NETWORK_TRANSPORT = 'network.transport' # [OSI network layer](https://osi-model.com/network-layer/) or non-OSI equivalent. @@ -73,12 +107,14 @@ module NETWORK # The value SHOULD be normalized to lowercase. # # @note Stability Level: stable + # + # @example Sample Values + # ipv4 + # ipv6 + # NETWORK_TYPE = 'network.type' # @!endgroup - - # @!group Metric Names - # @!endgroup end end end \ No newline at end of file diff --git a/semantic_conventions/lib/opentelemetry/semconv/otel.rb b/semantic_conventions/lib/opentelemetry/semconv/otel/attributes.rb similarity index 87% rename from semantic_conventions/lib/opentelemetry/semconv/otel.rb rename to semantic_conventions/lib/opentelemetry/semconv/otel/attributes.rb index 2d83fd08c1..b6453597a3 100644 --- a/semantic_conventions/lib/opentelemetry/semconv/otel.rb +++ b/semantic_conventions/lib/opentelemetry/semconv/otel/attributes.rb @@ -26,11 +26,19 @@ module OTEL # The name of the instrumentation scope - (`InstrumentationScope.Name` in OTLP). # # @note Stability Level: stable + # + # @example Sample Values + # io.opentelemetry.contrib.mongodb + # OTEL_SCOPE_NAME = 'otel.scope.name' # The version of the instrumentation scope - (`InstrumentationScope.Version` in OTLP). # # @note Stability Level: stable + # + # @example Sample Values + # 1.0.0 + # OTEL_SCOPE_VERSION = 'otel.scope.version' # Name of the code, either "OK" or "ERROR". MUST NOT be set if the status code is UNSET. @@ -41,12 +49,13 @@ module OTEL # Description of the Status if it has a value, otherwise not set. # # @note Stability Level: stable + # + # @example Sample Values + # resource not found + # OTEL_STATUS_DESCRIPTION = 'otel.status_description' # @!endgroup - - # @!group Metric Names - # @!endgroup end end end \ No newline at end of file diff --git a/semantic_conventions/lib/opentelemetry/semconv/server.rb b/semantic_conventions/lib/opentelemetry/semconv/server/attributes.rb similarity index 88% rename from semantic_conventions/lib/opentelemetry/semconv/server.rb rename to semantic_conventions/lib/opentelemetry/semconv/server/attributes.rb index 43343cca59..e4920d38d4 100644 --- a/semantic_conventions/lib/opentelemetry/semconv/server.rb +++ b/semantic_conventions/lib/opentelemetry/semconv/server/attributes.rb @@ -28,6 +28,12 @@ module SERVER # When observed from the client side, and when communicating through an intermediary, `server.address` SHOULD represent the server address behind any intermediaries, for example proxies, if it's available. # # @note Stability Level: stable + # + # @example Sample Values + # example.com + # 10.1.2.80 + # /tmp/my.sock + # SERVER_ADDRESS = 'server.address' # Server port number. @@ -35,12 +41,15 @@ module SERVER # When observed from the client side, and when communicating through an intermediary, `server.port` SHOULD represent the server port behind any intermediaries, for example proxies, if it's available. # # @note Stability Level: stable + # + # @example Sample Values + # 80 + # 8080 + # 443 + # SERVER_PORT = 'server.port' # @!endgroup - - # @!group Metric Names - # @!endgroup end end end \ No newline at end of file diff --git a/semantic_conventions/lib/opentelemetry/semconv/service.rb b/semantic_conventions/lib/opentelemetry/semconv/service/attributes.rb similarity index 90% rename from semantic_conventions/lib/opentelemetry/semconv/service.rb rename to semantic_conventions/lib/opentelemetry/semconv/service/attributes.rb index 7d8fd31e4b..1ee8ee4f43 100644 --- a/semantic_conventions/lib/opentelemetry/semconv/service.rb +++ b/semantic_conventions/lib/opentelemetry/semconv/service/attributes.rb @@ -28,17 +28,23 @@ module SERVICE # MUST be the same for all instances of horizontally scaled services. If the value was not specified, SDKs MUST fallback to `unknown_service:` concatenated with [`process.executable.name`](process.md), e.g. `unknown_service:bash`. If `process.executable.name` is not available, the value MUST be set to `unknown_service`. # # @note Stability Level: stable + # + # @example Sample Values + # shoppingcart + # SERVICE_NAME = 'service.name' # The version string of the service API or implementation. The format is not defined by these conventions. # # @note Stability Level: stable + # + # @example Sample Values + # 2.0.0 + # a01dbef8a + # SERVICE_VERSION = 'service.version' # @!endgroup - - # @!group Metric Names - # @!endgroup end end end \ No newline at end of file diff --git a/semantic_conventions/lib/opentelemetry/semconv/signalr.rb b/semantic_conventions/lib/opentelemetry/semconv/signalr/attributes.rb similarity index 87% rename from semantic_conventions/lib/opentelemetry/semconv/signalr.rb rename to semantic_conventions/lib/opentelemetry/semconv/signalr/attributes.rb index 715212e97c..8f22e05c14 100644 --- a/semantic_conventions/lib/opentelemetry/semconv/signalr.rb +++ b/semantic_conventions/lib/opentelemetry/semconv/signalr/attributes.rb @@ -26,17 +26,24 @@ module SIGNALR # SignalR HTTP connection closure status. # # @note Stability Level: stable + # + # @example Sample Values + # app_shutdown + # timeout + # SIGNALR_CONNECTION_STATUS = 'signalr.connection.status' # [SignalR transport type](https://github.com/dotnet/aspnetcore/blob/main/src/SignalR/docs/specs/TransportProtocols.md) # # @note Stability Level: stable + # + # @example Sample Values + # web_sockets + # long_polling + # SIGNALR_TRANSPORT = 'signalr.transport' # @!endgroup - - # @!group Metric Names - # @!endgroup end end end \ No newline at end of file diff --git a/semantic_conventions/lib/opentelemetry/semconv/signalr/metrics.rb b/semantic_conventions/lib/opentelemetry/semconv/signalr/metrics.rb new file mode 100644 index 0000000000..b4afb90341 --- /dev/null +++ b/semantic_conventions/lib/opentelemetry/semconv/signalr/metrics.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 SIGNALR + # @!group Metrics Names + + # Number of connections that are currently active on the server. + # + # Meter name: `Microsoft.AspNetCore.Http.Connections`; Added in: ASP.NET Core 8.0 + # + # @note Stability Level: stable + SIGNALR_SERVER_ACTIVE_CONNECTIONS = 'signalr.server.active_connections' + + # The duration of connections on the server. + # + # Meter name: `Microsoft.AspNetCore.Http.Connections`; Added in: ASP.NET Core 8.0 + # + # @note Stability Level: stable + SIGNALR_SERVER_CONNECTION_DURATION = 'signalr.server.connection.duration' + + # @!endgroup + end + end +end \ No newline at end of file diff --git a/semantic_conventions/lib/opentelemetry/semconv/telemetry.rb b/semantic_conventions/lib/opentelemetry/semconv/telemetry/attributes.rb similarity index 93% rename from semantic_conventions/lib/opentelemetry/semconv/telemetry.rb rename to semantic_conventions/lib/opentelemetry/semconv/telemetry/attributes.rb index 8fdca7bc02..ffd30e6bb8 100644 --- a/semantic_conventions/lib/opentelemetry/semconv/telemetry.rb +++ b/semantic_conventions/lib/opentelemetry/semconv/telemetry/attributes.rb @@ -38,17 +38,22 @@ module TELEMETRY # All custom identifiers SHOULD be stable across different versions of an implementation. # # @note Stability Level: stable + # + # @example Sample Values + # opentelemetry + # TELEMETRY_SDK_NAME = 'telemetry.sdk.name' # The version string of the telemetry SDK. # # @note Stability Level: stable + # + # @example Sample Values + # 1.2.3 + # TELEMETRY_SDK_VERSION = 'telemetry.sdk.version' # @!endgroup - - # @!group Metric Names - # @!endgroup end end end \ No newline at end of file diff --git a/semantic_conventions/lib/opentelemetry/semconv/url.rb b/semantic_conventions/lib/opentelemetry/semconv/url/attributes.rb similarity index 86% rename from semantic_conventions/lib/opentelemetry/semconv/url.rb rename to semantic_conventions/lib/opentelemetry/semconv/url/attributes.rb index 3acdd31049..5f7287f289 100644 --- a/semantic_conventions/lib/opentelemetry/semconv/url.rb +++ b/semantic_conventions/lib/opentelemetry/semconv/url/attributes.rb @@ -26,6 +26,10 @@ module URL # The [URI fragment](https://www.rfc-editor.org/rfc/rfc3986#section-3.5) component # # @note Stability Level: stable + # + # @example Sample Values + # SemConv + # URL_FRAGMENT = 'url.fragment' # Absolute URL describing a network resource according to [RFC3986](https://www.rfc-editor.org/rfc/rfc3986) @@ -35,6 +39,11 @@ module URL # `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. # # @note Stability Level: stable + # + # @example Sample Values + # https://www.foo.bar/search?q=OpenTelemetry#SemConv + # //localhost + # URL_FULL = 'url.full' # The [URI path](https://www.rfc-editor.org/rfc/rfc3986#section-3.3) component @@ -42,6 +51,10 @@ module URL # Sensitive content provided in `url.path` SHOULD be scrubbed when instrumentations can identify it. # # @note Stability Level: stable + # + # @example Sample Values + # /search + # URL_PATH = 'url.path' # The [URI query](https://www.rfc-editor.org/rfc/rfc3986#section-3.4) component @@ -49,17 +62,24 @@ module URL # Sensitive content provided in `url.query` SHOULD be scrubbed when instrumentations can identify it. # # @note Stability Level: stable + # + # @example Sample Values + # q=OpenTelemetry + # URL_QUERY = 'url.query' # 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 + # URL_SCHEME = 'url.scheme' # @!endgroup - - # @!group Metric Names - # @!endgroup end end end \ No newline at end of file diff --git a/semantic_conventions/lib/opentelemetry/semconv/user_agent.rb b/semantic_conventions/lib/opentelemetry/semconv/user_agent/attributes.rb similarity index 78% rename from semantic_conventions/lib/opentelemetry/semconv/user_agent.rb rename to semantic_conventions/lib/opentelemetry/semconv/user_agent/attributes.rb index b85a09473e..216e51700d 100644 --- a/semantic_conventions/lib/opentelemetry/semconv/user_agent.rb +++ b/semantic_conventions/lib/opentelemetry/semconv/user_agent/attributes.rb @@ -26,12 +26,15 @@ module USER_AGENT # 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 + # USER_AGENT_ORIGINAL = 'user_agent.original' # @!endgroup - - # @!group Metric Names - # @!endgroup end end end \ No newline at end of file diff --git a/semantic_conventions/templates/registry/ruby/attributes.j2 b/semantic_conventions/templates/registry/ruby/attributes.j2 index 4e7b8f7cd3..6320d204e5 100644 --- a/semantic_conventions/templates/registry/ruby/attributes.j2 +++ b/semantic_conventions/templates/registry/ruby/attributes.j2 @@ -26,29 +26,44 @@ module OpenTelemetry {%- set attr_const_name = attribute.name | screaming_snake_case %} {%- if attribute.type is template_type %} {%- set attr_const_name = attr_const_name ~ "_LAMBDA" %} + # Must be called with a key for the full attribute name. See notes below about the expectations + # for the state of the key. + # + # @example Usage + # {{ attr_const_name }}.call('some-cool-key') #=> '{{ attribute.name }}.some-cool-key' + # + {%- endif %} + {%- if attribute.type is template_type %} {%- endif %} {{ [attribute.brief, concat_if("\n", attribute.note), concat_if("\n@note Stability Level: ", attribute.stability), ] | comment(indent=6) }} - {%- if attribute is deprecated %} + {%- if attribute.examples %} + # + # @example Sample Values + {%- if attribute.examples is sequence %} + {%- for example in attribute.examples %} + # {{ example }} + {%- endfor %} + {%- else %} + # {{ attribute.examples }} + {%- endif %} + # + {%- endif %} + {%- if attribute is deprecated %} {{ concat_if("\n@deprecated ", attribute.deprecated) | comment(indent=6)}} - {%- elif attribute is stable and params.incubating %} + {%- elif attribute is stable and params.incubating %} # - # @deprecated Now available in the stable namespace at {OpenTelemetry::SemConv::{{ ctx.root_namespace | pascal_case }}::{{ attr_const_name }}}. - {%- endif %} - {%- if attribute.fqn not in excluded_attributes %} - {%- if attribute.type is template_type %} + # @deprecated Now available in the stable namespace at {OpenTelemetry::SemConv::{{ ctx.root_namespace | screaming_snake_case }}::{{ attr_const_name }}}. + {%- endif %} + {%- if attribute.type is template_type %} {{ attr_const_name }} = ->(key) { "{{ attribute.name }}.#{key}" } - {%- else %} + {%- else %} {{ attr_const_name }} = '{{ attribute.name }}' - {%- endif %} - {%- endif %} + {%- endif %} {% endfor %} # @!endgroup - - # @!group Metric Names - # @!endgroup end {%- if params.incubating %} end diff --git a/semantic_conventions/templates/registry/ruby/metrics.j2 b/semantic_conventions/templates/registry/ruby/metrics.j2 new file mode 100644 index 0000000000..daae481081 --- /dev/null +++ b/semantic_conventions/templates/registry/ruby/metrics.j2 @@ -0,0 +1,52 @@ +{#- +# 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. +#} +{%- import 'common.j2' as common -%} +{{- common.file_header() }} + +module OpenTelemetry + module SemConv + {%- if params.incubating %} + module Incubating + {%- endif %} + module {{ ctx.root_namespace | screaming_snake_case }} + # @!group Metrics Names + {% for attribute in ctx.metrics %} + {%- set attr_const_name = attribute.metric_name | screaming_snake_case %} + {%- if attribute.type is template_type %} + {%- set attr_const_name = attr_const_name ~ "_LAMBDA" %} + {%- endif %} + {{ [attribute.brief, + concat_if("\n", attribute.note), + concat_if("\n@note Stability Level: ", attribute.stability), + ] | comment(indent=6) }} + {%- if attribute is deprecated %} + {{ concat_if("\n@deprecated ", attribute.deprecated) | comment(indent=6)}} + {%- elif attribute is stable and params.incubating %} + # + # @deprecated Now available in the stable namespace at {OpenTelemetry::SemConv::{{ ctx.root_namespace | screaming_snake_case }}::{{ attr_const_name }}}. + {%- endif %} + {%- if attribute.type is template_type %} + {{ attr_const_name }} = ->(key) { "{{ attribute.metric_name }}.#{key}" } + {%- else %} + {{ attr_const_name }} = '{{ attribute.metric_name }}' + {%- endif %} + {% endfor %} + # @!endgroup + end + {%- if params.incubating %} + end + {%- endif %} + end +end diff --git a/semantic_conventions/templates/registry/ruby/weaver.yaml b/semantic_conventions/templates/registry/ruby/weaver.yaml index c6e9fbe497..18913a5f40 100644 --- a/semantic_conventions/templates/registry/ruby/weaver.yaml +++ b/semantic_conventions/templates/registry/ruby/weaver.yaml @@ -12,7 +12,16 @@ templates: "exclude_stability": ["experimental", "deprecated"], "exclude_deprecated": false }) - file_name: "{{ctx.root_namespace | snake_case}}.rb" + file_name: "{{ctx.root_namespace | snake_case}}/attributes.rb" + - template: metrics.j2 + application_mode: each + filter: > + semconv_grouped_metrics({ + "exclude_root_namespace": $excluded_namespaces, + "exclude_stability": ["experimental", "deprecated"], + "exclude_deprecated": false + }) + file_name: "{{ctx.root_namespace | snake_case}}/metrics.rb" # incubating - pattern: attributes.j2 application_mode: each @@ -22,7 +31,18 @@ templates: "exclude_stability": [], "exclude_deprecated": false }) - file_name: "incubating/{{ctx.root_namespace | snake_case}}.rb" + file_name: "incubating/{{ctx.root_namespace | snake_case}}/attributes.rb" + params: + incubating: true + - pattern: metrics.j2 + application_mode: each + filter: > + semconv_grouped_metrics({ + "exclude_root_namespace": $excluded_namespaces, + "exclude_stability": [], + "exclude_deprecated": false + }) + file_name: "incubating/{{ctx.root_namespace | snake_case}}/metrics.rb" params: incubating: true From 3b6d76ab445a22b25012d0e8047bd5402516ab35 Mon Sep 17 00:00:00 2001 From: Robb Kidd Date: Tue, 17 Sep 2024 19:23:39 -0400 Subject: [PATCH 16/17] generate rollup/barrel requires for each root namespace --- semantic_conventions/Rakefile | 45 ++++++++++++++++++- .../lib/opentelemetry/semconv/aspnetcore.rb | 22 +++++++++ .../lib/opentelemetry/semconv/client.rb | 21 +++++++++ .../lib/opentelemetry/semconv/error.rb | 21 +++++++++ .../lib/opentelemetry/semconv/exception.rb | 21 +++++++++ .../lib/opentelemetry/semconv/http.rb | 22 +++++++++ .../semconv/incubating/android.rb | 21 +++++++++ .../semconv/incubating/aspnetcore.rb | 22 +++++++++ .../opentelemetry/semconv/incubating/aws.rb | 21 +++++++++ .../semconv/incubating/browser.rb | 21 +++++++++ .../semconv/incubating/client.rb | 21 +++++++++ .../opentelemetry/semconv/incubating/cloud.rb | 21 +++++++++ .../semconv/incubating/cloudevents.rb | 21 +++++++++ .../opentelemetry/semconv/incubating/code.rb | 21 +++++++++ .../semconv/incubating/container.rb | 22 +++++++++ .../opentelemetry/semconv/incubating/db.rb | 22 +++++++++ .../semconv/incubating/deployment.rb | 21 +++++++++ .../semconv/incubating/destination.rb | 21 +++++++++ .../semconv/incubating/device.rb | 21 +++++++++ .../opentelemetry/semconv/incubating/disk.rb | 21 +++++++++ .../opentelemetry/semconv/incubating/dns.rb | 22 +++++++++ .../semconv/incubating/enduser.rb | 21 +++++++++ .../opentelemetry/semconv/incubating/error.rb | 21 +++++++++ .../opentelemetry/semconv/incubating/event.rb | 21 +++++++++ .../semconv/incubating/exception.rb | 21 +++++++++ .../opentelemetry/semconv/incubating/faas.rb | 22 +++++++++ .../semconv/incubating/feature_flag.rb | 21 +++++++++ .../opentelemetry/semconv/incubating/file.rb | 21 +++++++++ .../opentelemetry/semconv/incubating/gcp.rb | 21 +++++++++ .../semconv/incubating/gen_ai.rb | 21 +++++++++ .../semconv/incubating/graphql.rb | 21 +++++++++ .../semconv/incubating/heroku.rb | 21 +++++++++ .../opentelemetry/semconv/incubating/host.rb | 21 +++++++++ .../opentelemetry/semconv/incubating/http.rb | 22 +++++++++ .../opentelemetry/semconv/incubating/ios.rb | 21 +++++++++ .../opentelemetry/semconv/incubating/jvm.rb | 22 +++++++++ .../opentelemetry/semconv/incubating/k8s.rb | 21 +++++++++ .../semconv/incubating/kestrel.rb | 21 +++++++++ .../opentelemetry/semconv/incubating/log.rb | 21 +++++++++ .../semconv/incubating/message.rb | 21 +++++++++ .../semconv/incubating/messaging.rb | 22 +++++++++ .../opentelemetry/semconv/incubating/net.rb | 21 +++++++++ .../semconv/incubating/network.rb | 21 +++++++++ .../opentelemetry/semconv/incubating/oci.rb | 21 +++++++++ .../semconv/incubating/opentracing.rb | 21 +++++++++ .../opentelemetry/semconv/incubating/os.rb | 21 +++++++++ .../opentelemetry/semconv/incubating/otel.rb | 21 +++++++++ .../opentelemetry/semconv/incubating/other.rb | 21 +++++++++ .../opentelemetry/semconv/incubating/peer.rb | 21 +++++++++ .../opentelemetry/semconv/incubating/pool.rb | 21 +++++++++ .../semconv/incubating/process.rb | 22 +++++++++ .../opentelemetry/semconv/incubating/rpc.rb | 22 +++++++++ .../semconv/incubating/server.rb | 21 +++++++++ .../semconv/incubating/service.rb | 21 +++++++++ .../semconv/incubating/session.rb | 21 +++++++++ .../semconv/incubating/signalr.rb | 22 +++++++++ .../semconv/incubating/source.rb | 21 +++++++++ .../semconv/incubating/system.rb | 22 +++++++++ .../semconv/incubating/telemetry.rb | 21 +++++++++ .../semconv/incubating/thread.rb | 21 +++++++++ .../opentelemetry/semconv/incubating/tls.rb | 21 +++++++++ .../opentelemetry/semconv/incubating/url.rb | 21 +++++++++ .../semconv/incubating/user_agent.rb | 21 +++++++++ .../semconv/incubating/webengine.rb | 21 +++++++++ .../lib/opentelemetry/semconv/jvm.rb | 22 +++++++++ .../lib/opentelemetry/semconv/kestrel.rb | 21 +++++++++ .../lib/opentelemetry/semconv/network.rb | 21 +++++++++ .../lib/opentelemetry/semconv/otel.rb | 21 +++++++++ .../lib/opentelemetry/semconv/server.rb | 21 +++++++++ .../lib/opentelemetry/semconv/service.rb | 21 +++++++++ .../lib/opentelemetry/semconv/signalr.rb | 22 +++++++++ .../lib/opentelemetry/semconv/telemetry.rb | 21 +++++++++ .../lib/opentelemetry/semconv/url.rb | 21 +++++++++ .../lib/opentelemetry/semconv/user_agent.rb | 21 +++++++++ 74 files changed, 1593 insertions(+), 1 deletion(-) create mode 100644 semantic_conventions/lib/opentelemetry/semconv/aspnetcore.rb create mode 100644 semantic_conventions/lib/opentelemetry/semconv/client.rb create mode 100644 semantic_conventions/lib/opentelemetry/semconv/error.rb create mode 100644 semantic_conventions/lib/opentelemetry/semconv/exception.rb create mode 100644 semantic_conventions/lib/opentelemetry/semconv/http.rb create mode 100644 semantic_conventions/lib/opentelemetry/semconv/incubating/android.rb create mode 100644 semantic_conventions/lib/opentelemetry/semconv/incubating/aspnetcore.rb create mode 100644 semantic_conventions/lib/opentelemetry/semconv/incubating/aws.rb create mode 100644 semantic_conventions/lib/opentelemetry/semconv/incubating/browser.rb create mode 100644 semantic_conventions/lib/opentelemetry/semconv/incubating/client.rb create mode 100644 semantic_conventions/lib/opentelemetry/semconv/incubating/cloud.rb create mode 100644 semantic_conventions/lib/opentelemetry/semconv/incubating/cloudevents.rb create mode 100644 semantic_conventions/lib/opentelemetry/semconv/incubating/code.rb create mode 100644 semantic_conventions/lib/opentelemetry/semconv/incubating/container.rb create mode 100644 semantic_conventions/lib/opentelemetry/semconv/incubating/db.rb create mode 100644 semantic_conventions/lib/opentelemetry/semconv/incubating/deployment.rb create mode 100644 semantic_conventions/lib/opentelemetry/semconv/incubating/destination.rb create mode 100644 semantic_conventions/lib/opentelemetry/semconv/incubating/device.rb create mode 100644 semantic_conventions/lib/opentelemetry/semconv/incubating/disk.rb create mode 100644 semantic_conventions/lib/opentelemetry/semconv/incubating/dns.rb create mode 100644 semantic_conventions/lib/opentelemetry/semconv/incubating/enduser.rb create mode 100644 semantic_conventions/lib/opentelemetry/semconv/incubating/error.rb create mode 100644 semantic_conventions/lib/opentelemetry/semconv/incubating/event.rb create mode 100644 semantic_conventions/lib/opentelemetry/semconv/incubating/exception.rb create mode 100644 semantic_conventions/lib/opentelemetry/semconv/incubating/faas.rb create mode 100644 semantic_conventions/lib/opentelemetry/semconv/incubating/feature_flag.rb create mode 100644 semantic_conventions/lib/opentelemetry/semconv/incubating/file.rb create mode 100644 semantic_conventions/lib/opentelemetry/semconv/incubating/gcp.rb create mode 100644 semantic_conventions/lib/opentelemetry/semconv/incubating/gen_ai.rb create mode 100644 semantic_conventions/lib/opentelemetry/semconv/incubating/graphql.rb create mode 100644 semantic_conventions/lib/opentelemetry/semconv/incubating/heroku.rb create mode 100644 semantic_conventions/lib/opentelemetry/semconv/incubating/host.rb create mode 100644 semantic_conventions/lib/opentelemetry/semconv/incubating/http.rb create mode 100644 semantic_conventions/lib/opentelemetry/semconv/incubating/ios.rb create mode 100644 semantic_conventions/lib/opentelemetry/semconv/incubating/jvm.rb create mode 100644 semantic_conventions/lib/opentelemetry/semconv/incubating/k8s.rb create mode 100644 semantic_conventions/lib/opentelemetry/semconv/incubating/kestrel.rb create mode 100644 semantic_conventions/lib/opentelemetry/semconv/incubating/log.rb create mode 100644 semantic_conventions/lib/opentelemetry/semconv/incubating/message.rb create mode 100644 semantic_conventions/lib/opentelemetry/semconv/incubating/messaging.rb create mode 100644 semantic_conventions/lib/opentelemetry/semconv/incubating/net.rb create mode 100644 semantic_conventions/lib/opentelemetry/semconv/incubating/network.rb create mode 100644 semantic_conventions/lib/opentelemetry/semconv/incubating/oci.rb create mode 100644 semantic_conventions/lib/opentelemetry/semconv/incubating/opentracing.rb create mode 100644 semantic_conventions/lib/opentelemetry/semconv/incubating/os.rb create mode 100644 semantic_conventions/lib/opentelemetry/semconv/incubating/otel.rb create mode 100644 semantic_conventions/lib/opentelemetry/semconv/incubating/other.rb create mode 100644 semantic_conventions/lib/opentelemetry/semconv/incubating/peer.rb create mode 100644 semantic_conventions/lib/opentelemetry/semconv/incubating/pool.rb create mode 100644 semantic_conventions/lib/opentelemetry/semconv/incubating/process.rb create mode 100644 semantic_conventions/lib/opentelemetry/semconv/incubating/rpc.rb create mode 100644 semantic_conventions/lib/opentelemetry/semconv/incubating/server.rb create mode 100644 semantic_conventions/lib/opentelemetry/semconv/incubating/service.rb create mode 100644 semantic_conventions/lib/opentelemetry/semconv/incubating/session.rb create mode 100644 semantic_conventions/lib/opentelemetry/semconv/incubating/signalr.rb create mode 100644 semantic_conventions/lib/opentelemetry/semconv/incubating/source.rb create mode 100644 semantic_conventions/lib/opentelemetry/semconv/incubating/system.rb create mode 100644 semantic_conventions/lib/opentelemetry/semconv/incubating/telemetry.rb create mode 100644 semantic_conventions/lib/opentelemetry/semconv/incubating/thread.rb create mode 100644 semantic_conventions/lib/opentelemetry/semconv/incubating/tls.rb create mode 100644 semantic_conventions/lib/opentelemetry/semconv/incubating/url.rb create mode 100644 semantic_conventions/lib/opentelemetry/semconv/incubating/user_agent.rb create mode 100644 semantic_conventions/lib/opentelemetry/semconv/incubating/webengine.rb create mode 100644 semantic_conventions/lib/opentelemetry/semconv/jvm.rb create mode 100644 semantic_conventions/lib/opentelemetry/semconv/kestrel.rb create mode 100644 semantic_conventions/lib/opentelemetry/semconv/network.rb create mode 100644 semantic_conventions/lib/opentelemetry/semconv/otel.rb create mode 100644 semantic_conventions/lib/opentelemetry/semconv/server.rb create mode 100644 semantic_conventions/lib/opentelemetry/semconv/service.rb create mode 100644 semantic_conventions/lib/opentelemetry/semconv/signalr.rb create mode 100644 semantic_conventions/lib/opentelemetry/semconv/telemetry.rb create mode 100644 semantic_conventions/lib/opentelemetry/semconv/url.rb create mode 100644 semantic_conventions/lib/opentelemetry/semconv/user_agent.rb diff --git a/semantic_conventions/Rakefile b/semantic_conventions/Rakefile index 20f0de5148..2b3fb24155 100644 --- a/semantic_conventions/Rakefile +++ b/semantic_conventions/Rakefile @@ -1,8 +1,22 @@ # frozen_string_literal: true +COPYRIGHT_NOTICE = <<~COPYRIGHT_NOTICE # 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 +COPYRIGHT_NOTICE require 'bundler/gem_tasks' require 'rake/testtask' @@ -30,6 +44,8 @@ else task default: %i[generate test rubocop yard] end +task generate: %i[update_gem_version generate_semconv generate_require_rollups] + SPEC_VERSION = '1.26.0' OTEL_WEAVER_VERSION = 'v0.9.2' semconv_source_dir = Pathname.new('./tmp/semconvrepo') @@ -48,7 +64,7 @@ task check_out_semconv_version: [semconv_source_dir] do end end -task generate: %i[update_gem_version check_out_semconv_version] do +task generate_semconv: %i[check_out_semconv_version] do puts "\n+++ Removing previously generated semantic conventions code.\n" semconv_output_dir .glob('**/*.rb') @@ -69,6 +85,33 @@ task generate: %i[update_gem_version check_out_semconv_version] do DOCKER_COMMAND end +task :generate_require_rollups do + puts "\n+++ Generating rollup/barrel files for semconv namespaces.\n" + + Rake::FileList[ # find all the generated semconv files + semconv_output_dir + "**" + "attributes.rb", + semconv_output_dir + "**" + "metrics.rb", + ] + .pathmap("%d") # turn the list into the parent directories (root_namespaces) + .uniq # remove duplicates + .each do |namespace_dir| # in each directory, write out a file to require the generated signal names + directory = Pathname.new(namespace_dir) + rollup_filename = directory.dirname + "#{directory.basename}.rb" + File.open(rollup_filename, "w") do |rollup| + rollup << <<~FILE_HEADER + # frozen_string_literal: true + + #{COPYRIGHT_NOTICE} + # This file was autogenerated. Do not edit it by hand. + + FILE_HEADER + rollup << "require_relative './#{directory.basename}/attributes.rb'\n" if File.exist?(directory + "attributes.rb") + rollup << "require_relative './#{directory.basename}/metrics.rb'\n" if File.exist?(directory + "metrics.rb") + end + puts "✅ Generated file \"#{rollup_filename}\"" + end +end + task :update_gem_version do puts "\n+++ Updating gem version to #{SPEC_VERSION}\n" sh %(sed -i.bak "s/VERSION = '.*'/VERSION = '#{SPEC_VERSION}'/g" lib/opentelemetry/semantic_conventions/version.rb) diff --git a/semantic_conventions/lib/opentelemetry/semconv/aspnetcore.rb b/semantic_conventions/lib/opentelemetry/semconv/aspnetcore.rb new file mode 100644 index 0000000000..692dd5fdcc --- /dev/null +++ b/semantic_conventions/lib/opentelemetry/semconv/aspnetcore.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 './aspnetcore/attributes.rb' +require_relative './aspnetcore/metrics.rb' diff --git a/semantic_conventions/lib/opentelemetry/semconv/client.rb b/semantic_conventions/lib/opentelemetry/semconv/client.rb new file mode 100644 index 0000000000..bb3b880802 --- /dev/null +++ b/semantic_conventions/lib/opentelemetry/semconv/client.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 './client/attributes.rb' diff --git a/semantic_conventions/lib/opentelemetry/semconv/error.rb b/semantic_conventions/lib/opentelemetry/semconv/error.rb new file mode 100644 index 0000000000..ec2d98aa53 --- /dev/null +++ b/semantic_conventions/lib/opentelemetry/semconv/error.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 './error/attributes.rb' diff --git a/semantic_conventions/lib/opentelemetry/semconv/exception.rb b/semantic_conventions/lib/opentelemetry/semconv/exception.rb new file mode 100644 index 0000000000..36742f1b86 --- /dev/null +++ b/semantic_conventions/lib/opentelemetry/semconv/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.rb' diff --git a/semantic_conventions/lib/opentelemetry/semconv/http.rb b/semantic_conventions/lib/opentelemetry/semconv/http.rb new file mode 100644 index 0000000000..c7bf1c9ad4 --- /dev/null +++ b/semantic_conventions/lib/opentelemetry/semconv/http.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 './http/attributes.rb' +require_relative './http/metrics.rb' diff --git a/semantic_conventions/lib/opentelemetry/semconv/incubating/android.rb b/semantic_conventions/lib/opentelemetry/semconv/incubating/android.rb new file mode 100644 index 0000000000..44a649968a --- /dev/null +++ b/semantic_conventions/lib/opentelemetry/semconv/incubating/android.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 './android/attributes.rb' diff --git a/semantic_conventions/lib/opentelemetry/semconv/incubating/aspnetcore.rb b/semantic_conventions/lib/opentelemetry/semconv/incubating/aspnetcore.rb new file mode 100644 index 0000000000..692dd5fdcc --- /dev/null +++ b/semantic_conventions/lib/opentelemetry/semconv/incubating/aspnetcore.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 './aspnetcore/attributes.rb' +require_relative './aspnetcore/metrics.rb' diff --git a/semantic_conventions/lib/opentelemetry/semconv/incubating/aws.rb b/semantic_conventions/lib/opentelemetry/semconv/incubating/aws.rb new file mode 100644 index 0000000000..0ac8f71b69 --- /dev/null +++ b/semantic_conventions/lib/opentelemetry/semconv/incubating/aws.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 './aws/attributes.rb' diff --git a/semantic_conventions/lib/opentelemetry/semconv/incubating/browser.rb b/semantic_conventions/lib/opentelemetry/semconv/incubating/browser.rb new file mode 100644 index 0000000000..9f94ca330b --- /dev/null +++ b/semantic_conventions/lib/opentelemetry/semconv/incubating/browser.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 './browser/attributes.rb' diff --git a/semantic_conventions/lib/opentelemetry/semconv/incubating/client.rb b/semantic_conventions/lib/opentelemetry/semconv/incubating/client.rb new file mode 100644 index 0000000000..bb3b880802 --- /dev/null +++ b/semantic_conventions/lib/opentelemetry/semconv/incubating/client.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 './client/attributes.rb' diff --git a/semantic_conventions/lib/opentelemetry/semconv/incubating/cloud.rb b/semantic_conventions/lib/opentelemetry/semconv/incubating/cloud.rb new file mode 100644 index 0000000000..14dc8e1f33 --- /dev/null +++ b/semantic_conventions/lib/opentelemetry/semconv/incubating/cloud.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 './cloud/attributes.rb' diff --git a/semantic_conventions/lib/opentelemetry/semconv/incubating/cloudevents.rb b/semantic_conventions/lib/opentelemetry/semconv/incubating/cloudevents.rb new file mode 100644 index 0000000000..c3399f777b --- /dev/null +++ b/semantic_conventions/lib/opentelemetry/semconv/incubating/cloudevents.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 './cloudevents/attributes.rb' diff --git a/semantic_conventions/lib/opentelemetry/semconv/incubating/code.rb b/semantic_conventions/lib/opentelemetry/semconv/incubating/code.rb new file mode 100644 index 0000000000..096889e022 --- /dev/null +++ b/semantic_conventions/lib/opentelemetry/semconv/incubating/code.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 './code/attributes.rb' diff --git a/semantic_conventions/lib/opentelemetry/semconv/incubating/container.rb b/semantic_conventions/lib/opentelemetry/semconv/incubating/container.rb new file mode 100644 index 0000000000..58eec6a451 --- /dev/null +++ b/semantic_conventions/lib/opentelemetry/semconv/incubating/container.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 './container/attributes.rb' +require_relative './container/metrics.rb' diff --git a/semantic_conventions/lib/opentelemetry/semconv/incubating/db.rb b/semantic_conventions/lib/opentelemetry/semconv/incubating/db.rb new file mode 100644 index 0000000000..2035c379c4 --- /dev/null +++ b/semantic_conventions/lib/opentelemetry/semconv/incubating/db.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 './db/attributes.rb' +require_relative './db/metrics.rb' diff --git a/semantic_conventions/lib/opentelemetry/semconv/incubating/deployment.rb b/semantic_conventions/lib/opentelemetry/semconv/incubating/deployment.rb new file mode 100644 index 0000000000..0155e7f340 --- /dev/null +++ b/semantic_conventions/lib/opentelemetry/semconv/incubating/deployment.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 './deployment/attributes.rb' diff --git a/semantic_conventions/lib/opentelemetry/semconv/incubating/destination.rb b/semantic_conventions/lib/opentelemetry/semconv/incubating/destination.rb new file mode 100644 index 0000000000..94a2ee0ad2 --- /dev/null +++ b/semantic_conventions/lib/opentelemetry/semconv/incubating/destination.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 './destination/attributes.rb' diff --git a/semantic_conventions/lib/opentelemetry/semconv/incubating/device.rb b/semantic_conventions/lib/opentelemetry/semconv/incubating/device.rb new file mode 100644 index 0000000000..724fbcec1a --- /dev/null +++ b/semantic_conventions/lib/opentelemetry/semconv/incubating/device.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 './device/attributes.rb' diff --git a/semantic_conventions/lib/opentelemetry/semconv/incubating/disk.rb b/semantic_conventions/lib/opentelemetry/semconv/incubating/disk.rb new file mode 100644 index 0000000000..461cfb8597 --- /dev/null +++ b/semantic_conventions/lib/opentelemetry/semconv/incubating/disk.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 './disk/attributes.rb' diff --git a/semantic_conventions/lib/opentelemetry/semconv/incubating/dns.rb b/semantic_conventions/lib/opentelemetry/semconv/incubating/dns.rb new file mode 100644 index 0000000000..1b1f51f758 --- /dev/null +++ b/semantic_conventions/lib/opentelemetry/semconv/incubating/dns.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 './dns/attributes.rb' +require_relative './dns/metrics.rb' diff --git a/semantic_conventions/lib/opentelemetry/semconv/incubating/enduser.rb b/semantic_conventions/lib/opentelemetry/semconv/incubating/enduser.rb new file mode 100644 index 0000000000..7d591eaaba --- /dev/null +++ b/semantic_conventions/lib/opentelemetry/semconv/incubating/enduser.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 './enduser/attributes.rb' diff --git a/semantic_conventions/lib/opentelemetry/semconv/incubating/error.rb b/semantic_conventions/lib/opentelemetry/semconv/incubating/error.rb new file mode 100644 index 0000000000..ec2d98aa53 --- /dev/null +++ b/semantic_conventions/lib/opentelemetry/semconv/incubating/error.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 './error/attributes.rb' diff --git a/semantic_conventions/lib/opentelemetry/semconv/incubating/event.rb b/semantic_conventions/lib/opentelemetry/semconv/incubating/event.rb new file mode 100644 index 0000000000..ed80ec9397 --- /dev/null +++ b/semantic_conventions/lib/opentelemetry/semconv/incubating/event.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 './event/attributes.rb' diff --git a/semantic_conventions/lib/opentelemetry/semconv/incubating/exception.rb b/semantic_conventions/lib/opentelemetry/semconv/incubating/exception.rb new file mode 100644 index 0000000000..36742f1b86 --- /dev/null +++ b/semantic_conventions/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.rb' diff --git a/semantic_conventions/lib/opentelemetry/semconv/incubating/faas.rb b/semantic_conventions/lib/opentelemetry/semconv/incubating/faas.rb new file mode 100644 index 0000000000..989fc65cca --- /dev/null +++ b/semantic_conventions/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.rb' +require_relative './faas/metrics.rb' diff --git a/semantic_conventions/lib/opentelemetry/semconv/incubating/feature_flag.rb b/semantic_conventions/lib/opentelemetry/semconv/incubating/feature_flag.rb new file mode 100644 index 0000000000..e2534e63b1 --- /dev/null +++ b/semantic_conventions/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.rb' diff --git a/semantic_conventions/lib/opentelemetry/semconv/incubating/file.rb b/semantic_conventions/lib/opentelemetry/semconv/incubating/file.rb new file mode 100644 index 0000000000..7639cba895 --- /dev/null +++ b/semantic_conventions/lib/opentelemetry/semconv/incubating/file.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 './file/attributes.rb' diff --git a/semantic_conventions/lib/opentelemetry/semconv/incubating/gcp.rb b/semantic_conventions/lib/opentelemetry/semconv/incubating/gcp.rb new file mode 100644 index 0000000000..1d6cde1325 --- /dev/null +++ b/semantic_conventions/lib/opentelemetry/semconv/incubating/gcp.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 './gcp/attributes.rb' diff --git a/semantic_conventions/lib/opentelemetry/semconv/incubating/gen_ai.rb b/semantic_conventions/lib/opentelemetry/semconv/incubating/gen_ai.rb new file mode 100644 index 0000000000..878cae3572 --- /dev/null +++ b/semantic_conventions/lib/opentelemetry/semconv/incubating/gen_ai.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 './gen_ai/attributes.rb' diff --git a/semantic_conventions/lib/opentelemetry/semconv/incubating/graphql.rb b/semantic_conventions/lib/opentelemetry/semconv/incubating/graphql.rb new file mode 100644 index 0000000000..55bc495665 --- /dev/null +++ b/semantic_conventions/lib/opentelemetry/semconv/incubating/graphql.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 './graphql/attributes.rb' diff --git a/semantic_conventions/lib/opentelemetry/semconv/incubating/heroku.rb b/semantic_conventions/lib/opentelemetry/semconv/incubating/heroku.rb new file mode 100644 index 0000000000..e0c2d3790b --- /dev/null +++ b/semantic_conventions/lib/opentelemetry/semconv/incubating/heroku.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 './heroku/attributes.rb' diff --git a/semantic_conventions/lib/opentelemetry/semconv/incubating/host.rb b/semantic_conventions/lib/opentelemetry/semconv/incubating/host.rb new file mode 100644 index 0000000000..0a2d8638d0 --- /dev/null +++ b/semantic_conventions/lib/opentelemetry/semconv/incubating/host.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 './host/attributes.rb' diff --git a/semantic_conventions/lib/opentelemetry/semconv/incubating/http.rb b/semantic_conventions/lib/opentelemetry/semconv/incubating/http.rb new file mode 100644 index 0000000000..c7bf1c9ad4 --- /dev/null +++ b/semantic_conventions/lib/opentelemetry/semconv/incubating/http.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 './http/attributes.rb' +require_relative './http/metrics.rb' diff --git a/semantic_conventions/lib/opentelemetry/semconv/incubating/ios.rb b/semantic_conventions/lib/opentelemetry/semconv/incubating/ios.rb new file mode 100644 index 0000000000..f953a65fce --- /dev/null +++ b/semantic_conventions/lib/opentelemetry/semconv/incubating/ios.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 './ios/attributes.rb' diff --git a/semantic_conventions/lib/opentelemetry/semconv/incubating/jvm.rb b/semantic_conventions/lib/opentelemetry/semconv/incubating/jvm.rb new file mode 100644 index 0000000000..16d1b4c14a --- /dev/null +++ b/semantic_conventions/lib/opentelemetry/semconv/incubating/jvm.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 './jvm/attributes.rb' +require_relative './jvm/metrics.rb' diff --git a/semantic_conventions/lib/opentelemetry/semconv/incubating/k8s.rb b/semantic_conventions/lib/opentelemetry/semconv/incubating/k8s.rb new file mode 100644 index 0000000000..6c82b6f12b --- /dev/null +++ b/semantic_conventions/lib/opentelemetry/semconv/incubating/k8s.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 './k8s/attributes.rb' diff --git a/semantic_conventions/lib/opentelemetry/semconv/incubating/kestrel.rb b/semantic_conventions/lib/opentelemetry/semconv/incubating/kestrel.rb new file mode 100644 index 0000000000..665a7d012f --- /dev/null +++ b/semantic_conventions/lib/opentelemetry/semconv/incubating/kestrel.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 './kestrel/metrics.rb' diff --git a/semantic_conventions/lib/opentelemetry/semconv/incubating/log.rb b/semantic_conventions/lib/opentelemetry/semconv/incubating/log.rb new file mode 100644 index 0000000000..949df0fa17 --- /dev/null +++ b/semantic_conventions/lib/opentelemetry/semconv/incubating/log.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 './log/attributes.rb' diff --git a/semantic_conventions/lib/opentelemetry/semconv/incubating/message.rb b/semantic_conventions/lib/opentelemetry/semconv/incubating/message.rb new file mode 100644 index 0000000000..2a38843541 --- /dev/null +++ b/semantic_conventions/lib/opentelemetry/semconv/incubating/message.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 './message/attributes.rb' diff --git a/semantic_conventions/lib/opentelemetry/semconv/incubating/messaging.rb b/semantic_conventions/lib/opentelemetry/semconv/incubating/messaging.rb new file mode 100644 index 0000000000..b98074d9fd --- /dev/null +++ b/semantic_conventions/lib/opentelemetry/semconv/incubating/messaging.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 './messaging/attributes.rb' +require_relative './messaging/metrics.rb' diff --git a/semantic_conventions/lib/opentelemetry/semconv/incubating/net.rb b/semantic_conventions/lib/opentelemetry/semconv/incubating/net.rb new file mode 100644 index 0000000000..b1edc6d13d --- /dev/null +++ b/semantic_conventions/lib/opentelemetry/semconv/incubating/net.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 './net/attributes.rb' diff --git a/semantic_conventions/lib/opentelemetry/semconv/incubating/network.rb b/semantic_conventions/lib/opentelemetry/semconv/incubating/network.rb new file mode 100644 index 0000000000..3408fbfa0c --- /dev/null +++ b/semantic_conventions/lib/opentelemetry/semconv/incubating/network.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 './network/attributes.rb' diff --git a/semantic_conventions/lib/opentelemetry/semconv/incubating/oci.rb b/semantic_conventions/lib/opentelemetry/semconv/incubating/oci.rb new file mode 100644 index 0000000000..89f0d5bbfa --- /dev/null +++ b/semantic_conventions/lib/opentelemetry/semconv/incubating/oci.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 './oci/attributes.rb' diff --git a/semantic_conventions/lib/opentelemetry/semconv/incubating/opentracing.rb b/semantic_conventions/lib/opentelemetry/semconv/incubating/opentracing.rb new file mode 100644 index 0000000000..1378fe1d35 --- /dev/null +++ b/semantic_conventions/lib/opentelemetry/semconv/incubating/opentracing.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 './opentracing/attributes.rb' diff --git a/semantic_conventions/lib/opentelemetry/semconv/incubating/os.rb b/semantic_conventions/lib/opentelemetry/semconv/incubating/os.rb new file mode 100644 index 0000000000..8275e6a326 --- /dev/null +++ b/semantic_conventions/lib/opentelemetry/semconv/incubating/os.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 './os/attributes.rb' diff --git a/semantic_conventions/lib/opentelemetry/semconv/incubating/otel.rb b/semantic_conventions/lib/opentelemetry/semconv/incubating/otel.rb new file mode 100644 index 0000000000..6565bf7a7f --- /dev/null +++ b/semantic_conventions/lib/opentelemetry/semconv/incubating/otel.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 './otel/attributes.rb' diff --git a/semantic_conventions/lib/opentelemetry/semconv/incubating/other.rb b/semantic_conventions/lib/opentelemetry/semconv/incubating/other.rb new file mode 100644 index 0000000000..f8f9b26abb --- /dev/null +++ b/semantic_conventions/lib/opentelemetry/semconv/incubating/other.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 './other/attributes.rb' diff --git a/semantic_conventions/lib/opentelemetry/semconv/incubating/peer.rb b/semantic_conventions/lib/opentelemetry/semconv/incubating/peer.rb new file mode 100644 index 0000000000..2cf627b348 --- /dev/null +++ b/semantic_conventions/lib/opentelemetry/semconv/incubating/peer.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 './peer/attributes.rb' diff --git a/semantic_conventions/lib/opentelemetry/semconv/incubating/pool.rb b/semantic_conventions/lib/opentelemetry/semconv/incubating/pool.rb new file mode 100644 index 0000000000..47aa00c174 --- /dev/null +++ b/semantic_conventions/lib/opentelemetry/semconv/incubating/pool.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 './pool/attributes.rb' diff --git a/semantic_conventions/lib/opentelemetry/semconv/incubating/process.rb b/semantic_conventions/lib/opentelemetry/semconv/incubating/process.rb new file mode 100644 index 0000000000..165e8fe449 --- /dev/null +++ b/semantic_conventions/lib/opentelemetry/semconv/incubating/process.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 './process/attributes.rb' +require_relative './process/metrics.rb' diff --git a/semantic_conventions/lib/opentelemetry/semconv/incubating/rpc.rb b/semantic_conventions/lib/opentelemetry/semconv/incubating/rpc.rb new file mode 100644 index 0000000000..7c698bc961 --- /dev/null +++ b/semantic_conventions/lib/opentelemetry/semconv/incubating/rpc.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 './rpc/attributes.rb' +require_relative './rpc/metrics.rb' diff --git a/semantic_conventions/lib/opentelemetry/semconv/incubating/server.rb b/semantic_conventions/lib/opentelemetry/semconv/incubating/server.rb new file mode 100644 index 0000000000..0a40fa3d8e --- /dev/null +++ b/semantic_conventions/lib/opentelemetry/semconv/incubating/server.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 './server/attributes.rb' diff --git a/semantic_conventions/lib/opentelemetry/semconv/incubating/service.rb b/semantic_conventions/lib/opentelemetry/semconv/incubating/service.rb new file mode 100644 index 0000000000..d6893ee358 --- /dev/null +++ b/semantic_conventions/lib/opentelemetry/semconv/incubating/service.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 './service/attributes.rb' diff --git a/semantic_conventions/lib/opentelemetry/semconv/incubating/session.rb b/semantic_conventions/lib/opentelemetry/semconv/incubating/session.rb new file mode 100644 index 0000000000..7756064445 --- /dev/null +++ b/semantic_conventions/lib/opentelemetry/semconv/incubating/session.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 './session/attributes.rb' diff --git a/semantic_conventions/lib/opentelemetry/semconv/incubating/signalr.rb b/semantic_conventions/lib/opentelemetry/semconv/incubating/signalr.rb new file mode 100644 index 0000000000..248b2a5d6f --- /dev/null +++ b/semantic_conventions/lib/opentelemetry/semconv/incubating/signalr.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 './signalr/attributes.rb' +require_relative './signalr/metrics.rb' diff --git a/semantic_conventions/lib/opentelemetry/semconv/incubating/source.rb b/semantic_conventions/lib/opentelemetry/semconv/incubating/source.rb new file mode 100644 index 0000000000..0df0788611 --- /dev/null +++ b/semantic_conventions/lib/opentelemetry/semconv/incubating/source.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 './source/attributes.rb' diff --git a/semantic_conventions/lib/opentelemetry/semconv/incubating/system.rb b/semantic_conventions/lib/opentelemetry/semconv/incubating/system.rb new file mode 100644 index 0000000000..190c8ae7f2 --- /dev/null +++ b/semantic_conventions/lib/opentelemetry/semconv/incubating/system.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 './system/attributes.rb' +require_relative './system/metrics.rb' diff --git a/semantic_conventions/lib/opentelemetry/semconv/incubating/telemetry.rb b/semantic_conventions/lib/opentelemetry/semconv/incubating/telemetry.rb new file mode 100644 index 0000000000..03cec8064c --- /dev/null +++ b/semantic_conventions/lib/opentelemetry/semconv/incubating/telemetry.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 './telemetry/attributes.rb' diff --git a/semantic_conventions/lib/opentelemetry/semconv/incubating/thread.rb b/semantic_conventions/lib/opentelemetry/semconv/incubating/thread.rb new file mode 100644 index 0000000000..475effd1c4 --- /dev/null +++ b/semantic_conventions/lib/opentelemetry/semconv/incubating/thread.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 './thread/attributes.rb' diff --git a/semantic_conventions/lib/opentelemetry/semconv/incubating/tls.rb b/semantic_conventions/lib/opentelemetry/semconv/incubating/tls.rb new file mode 100644 index 0000000000..e364eefae9 --- /dev/null +++ b/semantic_conventions/lib/opentelemetry/semconv/incubating/tls.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 './tls/attributes.rb' diff --git a/semantic_conventions/lib/opentelemetry/semconv/incubating/url.rb b/semantic_conventions/lib/opentelemetry/semconv/incubating/url.rb new file mode 100644 index 0000000000..f994903190 --- /dev/null +++ b/semantic_conventions/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.rb' diff --git a/semantic_conventions/lib/opentelemetry/semconv/incubating/user_agent.rb b/semantic_conventions/lib/opentelemetry/semconv/incubating/user_agent.rb new file mode 100644 index 0000000000..8cc1eb814e --- /dev/null +++ b/semantic_conventions/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.rb' diff --git a/semantic_conventions/lib/opentelemetry/semconv/incubating/webengine.rb b/semantic_conventions/lib/opentelemetry/semconv/incubating/webengine.rb new file mode 100644 index 0000000000..3eda56b000 --- /dev/null +++ b/semantic_conventions/lib/opentelemetry/semconv/incubating/webengine.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 './webengine/attributes.rb' diff --git a/semantic_conventions/lib/opentelemetry/semconv/jvm.rb b/semantic_conventions/lib/opentelemetry/semconv/jvm.rb new file mode 100644 index 0000000000..16d1b4c14a --- /dev/null +++ b/semantic_conventions/lib/opentelemetry/semconv/jvm.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 './jvm/attributes.rb' +require_relative './jvm/metrics.rb' diff --git a/semantic_conventions/lib/opentelemetry/semconv/kestrel.rb b/semantic_conventions/lib/opentelemetry/semconv/kestrel.rb new file mode 100644 index 0000000000..665a7d012f --- /dev/null +++ b/semantic_conventions/lib/opentelemetry/semconv/kestrel.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 './kestrel/metrics.rb' diff --git a/semantic_conventions/lib/opentelemetry/semconv/network.rb b/semantic_conventions/lib/opentelemetry/semconv/network.rb new file mode 100644 index 0000000000..3408fbfa0c --- /dev/null +++ b/semantic_conventions/lib/opentelemetry/semconv/network.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 './network/attributes.rb' diff --git a/semantic_conventions/lib/opentelemetry/semconv/otel.rb b/semantic_conventions/lib/opentelemetry/semconv/otel.rb new file mode 100644 index 0000000000..6565bf7a7f --- /dev/null +++ b/semantic_conventions/lib/opentelemetry/semconv/otel.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 './otel/attributes.rb' diff --git a/semantic_conventions/lib/opentelemetry/semconv/server.rb b/semantic_conventions/lib/opentelemetry/semconv/server.rb new file mode 100644 index 0000000000..0a40fa3d8e --- /dev/null +++ b/semantic_conventions/lib/opentelemetry/semconv/server.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 './server/attributes.rb' diff --git a/semantic_conventions/lib/opentelemetry/semconv/service.rb b/semantic_conventions/lib/opentelemetry/semconv/service.rb new file mode 100644 index 0000000000..d6893ee358 --- /dev/null +++ b/semantic_conventions/lib/opentelemetry/semconv/service.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 './service/attributes.rb' diff --git a/semantic_conventions/lib/opentelemetry/semconv/signalr.rb b/semantic_conventions/lib/opentelemetry/semconv/signalr.rb new file mode 100644 index 0000000000..248b2a5d6f --- /dev/null +++ b/semantic_conventions/lib/opentelemetry/semconv/signalr.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 './signalr/attributes.rb' +require_relative './signalr/metrics.rb' diff --git a/semantic_conventions/lib/opentelemetry/semconv/telemetry.rb b/semantic_conventions/lib/opentelemetry/semconv/telemetry.rb new file mode 100644 index 0000000000..03cec8064c --- /dev/null +++ b/semantic_conventions/lib/opentelemetry/semconv/telemetry.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 './telemetry/attributes.rb' diff --git a/semantic_conventions/lib/opentelemetry/semconv/url.rb b/semantic_conventions/lib/opentelemetry/semconv/url.rb new file mode 100644 index 0000000000..f994903190 --- /dev/null +++ b/semantic_conventions/lib/opentelemetry/semconv/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.rb' diff --git a/semantic_conventions/lib/opentelemetry/semconv/user_agent.rb b/semantic_conventions/lib/opentelemetry/semconv/user_agent.rb new file mode 100644 index 0000000000..8cc1eb814e --- /dev/null +++ b/semantic_conventions/lib/opentelemetry/semconv/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.rb' From 570873484965281bddf99671b996464b6fa6d396 Mon Sep 17 00:00:00 2001 From: Robb Kidd Date: Tue, 17 Sep 2024 19:26:38 -0400 Subject: [PATCH 17/17] extract clean of generated code into separate task --- semantic_conventions/Rakefile | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/semantic_conventions/Rakefile b/semantic_conventions/Rakefile index 2b3fb24155..550ccf7ed7 100644 --- a/semantic_conventions/Rakefile +++ b/semantic_conventions/Rakefile @@ -64,12 +64,14 @@ task check_out_semconv_version: [semconv_source_dir] do end end -task generate_semconv: %i[check_out_semconv_version] do +task :clean_generated_code do puts "\n+++ Removing previously generated semantic conventions code.\n" semconv_output_dir .glob('**/*.rb') .then { |files| FileUtils.rm(files) } +end +task generate_semconv: %i[check_out_semconv_version clean_generated_code] do puts "\n+++ Generating semantic conventions code.\n" sh <<~DOCKER_COMMAND docker run --rm \ @@ -85,7 +87,7 @@ task generate_semconv: %i[check_out_semconv_version] do DOCKER_COMMAND end -task :generate_require_rollups do +task generate_require_rollups: %i[generate_semconv] do puts "\n+++ Generating rollup/barrel files for semconv namespaces.\n" Rake::FileList[ # find all the generated semconv files