...

Source file src/go.opentelemetry.io/otel/semconv/v1.6.1/resource.go

Documentation: go.opentelemetry.io/otel/semconv/v1.6.1

     1  // Copyright The OpenTelemetry Authors
     2  //
     3  // Licensed under the Apache License, Version 2.0 (the "License");
     4  // you may not use this file except in compliance with the License.
     5  // You may obtain a copy of the License at
     6  //
     7  //     http://www.apache.org/licenses/LICENSE-2.0
     8  //
     9  // Unless required by applicable law or agreed to in writing, software
    10  // distributed under the License is distributed on an "AS IS" BASIS,
    11  // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
    12  // See the License for the specific language governing permissions and
    13  // limitations under the License.
    14  
    15  // Code generated from semantic convention specification. DO NOT EDIT.
    16  
    17  package semconv // import "go.opentelemetry.io/otel/semconv/v1.6.1"
    18  
    19  import "go.opentelemetry.io/otel/attribute"
    20  
    21  // A cloud environment (e.g. GCP, Azure, AWS)
    22  const (
    23  	// Name of the cloud provider.
    24  	//
    25  	// Type: Enum
    26  	// Required: No
    27  	// Stability: stable
    28  	CloudProviderKey = attribute.Key("cloud.provider")
    29  	// The cloud account ID the resource is assigned to.
    30  	//
    31  	// Type: string
    32  	// Required: No
    33  	// Stability: stable
    34  	// Examples: '111111111111', 'opentelemetry'
    35  	CloudAccountIDKey = attribute.Key("cloud.account.id")
    36  	// The geographical region the resource is running. Refer to your provider's docs
    37  	// to see the available regions, for example [Alibaba Cloud
    38  	// regions](https://www.alibabacloud.com/help/doc-detail/40654.htm), [AWS
    39  	// regions](https://aws.amazon.com/about-aws/global-infrastructure/regions_az/),
    40  	// [Azure regions](https://azure.microsoft.com/en-us/global-
    41  	// infrastructure/geographies/), or [Google Cloud
    42  	// regions](https://cloud.google.com/about/locations).
    43  	//
    44  	// Type: string
    45  	// Required: No
    46  	// Stability: stable
    47  	// Examples: 'us-central1', 'us-east-1'
    48  	CloudRegionKey = attribute.Key("cloud.region")
    49  	// Cloud regions often have multiple, isolated locations known as zones to
    50  	// increase availability. Availability zone represents the zone where the resource
    51  	// is running.
    52  	//
    53  	// Type: string
    54  	// Required: No
    55  	// Stability: stable
    56  	// Examples: 'us-east-1c'
    57  	// Note: Availability zones are called "zones" on Alibaba Cloud and Google Cloud.
    58  	CloudAvailabilityZoneKey = attribute.Key("cloud.availability_zone")
    59  	// The cloud platform in use.
    60  	//
    61  	// Type: Enum
    62  	// Required: No
    63  	// Stability: stable
    64  	// Note: The prefix of the service SHOULD match the one specified in
    65  	// `cloud.provider`.
    66  	CloudPlatformKey = attribute.Key("cloud.platform")
    67  )
    68  
    69  var (
    70  	// Alibaba Cloud
    71  	CloudProviderAlibabaCloud = CloudProviderKey.String("alibaba_cloud")
    72  	// Amazon Web Services
    73  	CloudProviderAWS = CloudProviderKey.String("aws")
    74  	// Microsoft Azure
    75  	CloudProviderAzure = CloudProviderKey.String("azure")
    76  	// Google Cloud Platform
    77  	CloudProviderGCP = CloudProviderKey.String("gcp")
    78  )
    79  
    80  var (
    81  	// Alibaba Cloud Elastic Compute Service
    82  	CloudPlatformAlibabaCloudECS = CloudPlatformKey.String("alibaba_cloud_ecs")
    83  	// Alibaba Cloud Function Compute
    84  	CloudPlatformAlibabaCloudFc = CloudPlatformKey.String("alibaba_cloud_fc")
    85  	// AWS Elastic Compute Cloud
    86  	CloudPlatformAWSEC2 = CloudPlatformKey.String("aws_ec2")
    87  	// AWS Elastic Container Service
    88  	CloudPlatformAWSECS = CloudPlatformKey.String("aws_ecs")
    89  	// AWS Elastic Kubernetes Service
    90  	CloudPlatformAWSEKS = CloudPlatformKey.String("aws_eks")
    91  	// AWS Lambda
    92  	CloudPlatformAWSLambda = CloudPlatformKey.String("aws_lambda")
    93  	// AWS Elastic Beanstalk
    94  	CloudPlatformAWSElasticBeanstalk = CloudPlatformKey.String("aws_elastic_beanstalk")
    95  	// Azure Virtual Machines
    96  	CloudPlatformAzureVM = CloudPlatformKey.String("azure_vm")
    97  	// Azure Container Instances
    98  	CloudPlatformAzureContainerInstances = CloudPlatformKey.String("azure_container_instances")
    99  	// Azure Kubernetes Service
   100  	CloudPlatformAzureAKS = CloudPlatformKey.String("azure_aks")
   101  	// Azure Functions
   102  	CloudPlatformAzureFunctions = CloudPlatformKey.String("azure_functions")
   103  	// Azure App Service
   104  	CloudPlatformAzureAppService = CloudPlatformKey.String("azure_app_service")
   105  	// Google Cloud Compute Engine (GCE)
   106  	CloudPlatformGCPComputeEngine = CloudPlatformKey.String("gcp_compute_engine")
   107  	// Google Cloud Run
   108  	CloudPlatformGCPCloudRun = CloudPlatformKey.String("gcp_cloud_run")
   109  	// Google Cloud Kubernetes Engine (GKE)
   110  	CloudPlatformGCPKubernetesEngine = CloudPlatformKey.String("gcp_kubernetes_engine")
   111  	// Google Cloud Functions (GCF)
   112  	CloudPlatformGCPCloudFunctions = CloudPlatformKey.String("gcp_cloud_functions")
   113  	// Google Cloud App Engine (GAE)
   114  	CloudPlatformGCPAppEngine = CloudPlatformKey.String("gcp_app_engine")
   115  )
   116  
   117  // Resources used by AWS Elastic Container Service (ECS).
   118  const (
   119  	// The Amazon Resource Name (ARN) of an [ECS container instance](https://docs.aws.
   120  	// amazon.com/AmazonECS/latest/developerguide/ECS_instances.html).
   121  	//
   122  	// Type: string
   123  	// Required: No
   124  	// Stability: stable
   125  	// Examples: 'arn:aws:ecs:us-
   126  	// west-1:123456789123:container/32624152-9086-4f0e-acae-1a75b14fe4d9'
   127  	AWSECSContainerARNKey = attribute.Key("aws.ecs.container.arn")
   128  	// The ARN of an [ECS cluster](https://docs.aws.amazon.com/AmazonECS/latest/develo
   129  	// perguide/clusters.html).
   130  	//
   131  	// Type: string
   132  	// Required: No
   133  	// Stability: stable
   134  	// Examples: 'arn:aws:ecs:us-west-2:123456789123:cluster/my-cluster'
   135  	AWSECSClusterARNKey = attribute.Key("aws.ecs.cluster.arn")
   136  	// The [launch type](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/l
   137  	// aunch_types.html) for an ECS task.
   138  	//
   139  	// Type: Enum
   140  	// Required: No
   141  	// Stability: stable
   142  	AWSECSLaunchtypeKey = attribute.Key("aws.ecs.launchtype")
   143  	// The ARN of an [ECS task definition](https://docs.aws.amazon.com/AmazonECS/lates
   144  	// t/developerguide/task_definitions.html).
   145  	//
   146  	// Type: string
   147  	// Required: No
   148  	// Stability: stable
   149  	// Examples: 'arn:aws:ecs:us-
   150  	// west-1:123456789123:task/10838bed-421f-43ef-870a-f43feacbbb5b'
   151  	AWSECSTaskARNKey = attribute.Key("aws.ecs.task.arn")
   152  	// The task definition family this task definition is a member of.
   153  	//
   154  	// Type: string
   155  	// Required: No
   156  	// Stability: stable
   157  	// Examples: 'opentelemetry-family'
   158  	AWSECSTaskFamilyKey = attribute.Key("aws.ecs.task.family")
   159  	// The revision for this task definition.
   160  	//
   161  	// Type: string
   162  	// Required: No
   163  	// Stability: stable
   164  	// Examples: '8', '26'
   165  	AWSECSTaskRevisionKey = attribute.Key("aws.ecs.task.revision")
   166  )
   167  
   168  var (
   169  	// ec2
   170  	AWSECSLaunchtypeEC2 = AWSECSLaunchtypeKey.String("ec2")
   171  	// fargate
   172  	AWSECSLaunchtypeFargate = AWSECSLaunchtypeKey.String("fargate")
   173  )
   174  
   175  // Resources used by AWS Elastic Kubernetes Service (EKS).
   176  const (
   177  	// The ARN of an EKS cluster.
   178  	//
   179  	// Type: string
   180  	// Required: No
   181  	// Stability: stable
   182  	// Examples: 'arn:aws:ecs:us-west-2:123456789123:cluster/my-cluster'
   183  	AWSEKSClusterARNKey = attribute.Key("aws.eks.cluster.arn")
   184  )
   185  
   186  // Resources specific to Amazon Web Services.
   187  const (
   188  	// The name(s) of the AWS log group(s) an application is writing to.
   189  	//
   190  	// Type: string[]
   191  	// Required: No
   192  	// Stability: stable
   193  	// Examples: '/aws/lambda/my-function', 'opentelemetry-service'
   194  	// Note: Multiple log groups must be supported for cases like multi-container
   195  	// applications, where a single application has sidecar containers, and each write
   196  	// to their own log group.
   197  	AWSLogGroupNamesKey = attribute.Key("aws.log.group.names")
   198  	// The Amazon Resource Name(s) (ARN) of the AWS log group(s).
   199  	//
   200  	// Type: string[]
   201  	// Required: No
   202  	// Stability: stable
   203  	// Examples: 'arn:aws:logs:us-west-1:123456789012:log-group:/aws/my/group:*'
   204  	// Note: See the [log group ARN format
   205  	// documentation](https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/iam-
   206  	// access-control-overview-cwl.html#CWL_ARN_Format).
   207  	AWSLogGroupARNsKey = attribute.Key("aws.log.group.arns")
   208  	// The name(s) of the AWS log stream(s) an application is writing to.
   209  	//
   210  	// Type: string[]
   211  	// Required: No
   212  	// Stability: stable
   213  	// Examples: 'logs/main/10838bed-421f-43ef-870a-f43feacbbb5b'
   214  	AWSLogStreamNamesKey = attribute.Key("aws.log.stream.names")
   215  	// The ARN(s) of the AWS log stream(s).
   216  	//
   217  	// Type: string[]
   218  	// Required: No
   219  	// Stability: stable
   220  	// Examples: 'arn:aws:logs:us-west-1:123456789012:log-group:/aws/my/group:log-
   221  	// stream:logs/main/10838bed-421f-43ef-870a-f43feacbbb5b'
   222  	// Note: See the [log stream ARN format
   223  	// documentation](https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/iam-
   224  	// access-control-overview-cwl.html#CWL_ARN_Format). One log group can contain
   225  	// several log streams, so these ARNs necessarily identify both a log group and a
   226  	// log stream.
   227  	AWSLogStreamARNsKey = attribute.Key("aws.log.stream.arns")
   228  )
   229  
   230  // A container instance.
   231  const (
   232  	// Container name.
   233  	//
   234  	// Type: string
   235  	// Required: No
   236  	// Stability: stable
   237  	// Examples: 'opentelemetry-autoconf'
   238  	ContainerNameKey = attribute.Key("container.name")
   239  	// Container ID. Usually a UUID, as for example used to [identify Docker
   240  	// containers](https://docs.docker.com/engine/reference/run/#container-
   241  	// identification). The UUID might be abbreviated.
   242  	//
   243  	// Type: string
   244  	// Required: No
   245  	// Stability: stable
   246  	// Examples: 'a3bf90e006b2'
   247  	ContainerIDKey = attribute.Key("container.id")
   248  	// The container runtime managing this container.
   249  	//
   250  	// Type: string
   251  	// Required: No
   252  	// Stability: stable
   253  	// Examples: 'docker', 'containerd', 'rkt'
   254  	ContainerRuntimeKey = attribute.Key("container.runtime")
   255  	// Name of the image the container was built on.
   256  	//
   257  	// Type: string
   258  	// Required: No
   259  	// Stability: stable
   260  	// Examples: 'gcr.io/opentelemetry/operator'
   261  	ContainerImageNameKey = attribute.Key("container.image.name")
   262  	// Container image tag.
   263  	//
   264  	// Type: string
   265  	// Required: No
   266  	// Stability: stable
   267  	// Examples: '0.1'
   268  	ContainerImageTagKey = attribute.Key("container.image.tag")
   269  )
   270  
   271  // The software deployment.
   272  const (
   273  	// Name of the [deployment
   274  	// environment](https://en.wikipedia.org/wiki/Deployment_environment) (aka
   275  	// deployment tier).
   276  	//
   277  	// Type: string
   278  	// Required: No
   279  	// Stability: stable
   280  	// Examples: 'staging', 'production'
   281  	DeploymentEnvironmentKey = attribute.Key("deployment.environment")
   282  )
   283  
   284  // The device on which the process represented by this resource is running.
   285  const (
   286  	// A unique identifier representing the device
   287  	//
   288  	// Type: string
   289  	// Required: No
   290  	// Stability: stable
   291  	// Examples: '2ab2916d-a51f-4ac8-80ee-45ac31a28092'
   292  	// Note: The device identifier MUST only be defined using the values outlined
   293  	// below. This value is not an advertising identifier and MUST NOT be used as
   294  	// such. On iOS (Swift or Objective-C), this value MUST be equal to the [vendor id
   295  	// entifier](https://developer.apple.com/documentation/uikit/uidevice/1620059-iden
   296  	// tifierforvendor). On Android (Java or Kotlin), this value MUST be equal to the
   297  	// Firebase Installation ID or a globally unique UUID which is persisted across
   298  	// sessions in your application. More information can be found
   299  	// [here](https://developer.android.com/training/articles/user-data-ids) on best
   300  	// practices and exact implementation details. Caution should be taken when
   301  	// storing personal data or anything which can identify a user. GDPR and data
   302  	// protection laws may apply, ensure you do your own due diligence.
   303  	DeviceIDKey = attribute.Key("device.id")
   304  	// The model identifier for the device
   305  	//
   306  	// Type: string
   307  	// Required: No
   308  	// Stability: stable
   309  	// Examples: 'iPhone3,4', 'SM-G920F'
   310  	// Note: It's recommended this value represents a machine readable version of the
   311  	// model identifier rather than the market or consumer-friendly name of the
   312  	// device.
   313  	DeviceModelIdentifierKey = attribute.Key("device.model.identifier")
   314  	// The marketing name for the device model
   315  	//
   316  	// Type: string
   317  	// Required: No
   318  	// Stability: stable
   319  	// Examples: 'iPhone 6s Plus', 'Samsung Galaxy S6'
   320  	// Note: It's recommended this value represents a human readable version of the
   321  	// device model rather than a machine readable alternative.
   322  	DeviceModelNameKey = attribute.Key("device.model.name")
   323  )
   324  
   325  // A serverless instance.
   326  const (
   327  	// The name of the single function that this runtime instance executes.
   328  	//
   329  	// Type: string
   330  	// Required: Always
   331  	// Stability: stable
   332  	// Examples: 'my-function'
   333  	// Note: This is the name of the function as configured/deployed on the FaaS
   334  	// platform and is usually different from the name of the callback function (which
   335  	// may be stored in the
   336  	// [`code.namespace`/`code.function`](../../trace/semantic_conventions/span-
   337  	// general.md#source-code-attributes) span attributes).
   338  	FaaSNameKey = attribute.Key("faas.name")
   339  	// The unique ID of the single function that this runtime instance executes.
   340  	//
   341  	// Type: string
   342  	// Required: No
   343  	// Stability: stable
   344  	// Examples: 'arn:aws:lambda:us-west-2:123456789012:function:my-function'
   345  	// Note: Depending on the cloud provider, use:
   346  
   347  	// * **AWS Lambda:** The function
   348  	// [ARN](https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-
   349  	// namespaces.html).
   350  	// Take care not to use the "invoked ARN" directly but replace any
   351  	// [alias suffix](https://docs.aws.amazon.com/lambda/latest/dg/configuration-
   352  	// aliases.html) with the resolved function version, as the same runtime instance
   353  	// may be invokable with multiple
   354  	// different aliases.
   355  	// * **GCP:** The [URI of the resource](https://cloud.google.com/iam/docs/full-
   356  	// resource-names)
   357  	// * **Azure:** The [Fully Qualified Resource ID](https://docs.microsoft.com/en-
   358  	// us/rest/api/resources/resources/get-by-id).
   359  
   360  	// On some providers, it may not be possible to determine the full ID at startup,
   361  	// which is why this field cannot be made required. For example, on AWS the
   362  	// account ID
   363  	// part of the ARN is not available without calling another AWS API
   364  	// which may be deemed too slow for a short-running lambda function.
   365  	// As an alternative, consider setting `faas.id` as a span attribute instead.
   366  	FaaSIDKey = attribute.Key("faas.id")
   367  	// The immutable version of the function being executed.
   368  	//
   369  	// Type: string
   370  	// Required: No
   371  	// Stability: stable
   372  	// Examples: '26', 'pinkfroid-00002'
   373  	// Note: Depending on the cloud provider and platform, use:
   374  
   375  	// * **AWS Lambda:** The [function
   376  	// version](https://docs.aws.amazon.com/lambda/latest/dg/configuration-
   377  	// versions.html)
   378  	//   (an integer represented as a decimal string).
   379  	// * **Google Cloud Run:** The
   380  	// [revision](https://cloud.google.com/run/docs/managing/revisions)
   381  	//   (i.e., the function name plus the revision suffix).
   382  	// * **Google Cloud Functions:** The value of the
   383  	//   [`K_REVISION` environment
   384  	// variable](https://cloud.google.com/functions/docs/env-
   385  	// var#runtime_environment_variables_set_automatically).
   386  	// * **Azure Functions:** Not applicable. Do not set this attribute.
   387  	FaaSVersionKey = attribute.Key("faas.version")
   388  	// The execution environment ID as a string, that will be potentially reused for
   389  	// other invocations to the same function/function version.
   390  	//
   391  	// Type: string
   392  	// Required: No
   393  	// Stability: stable
   394  	// Examples: '2021/06/28/[$LATEST]2f399eb14537447da05ab2a2e39309de'
   395  	// Note: * **AWS Lambda:** Use the (full) log stream name.
   396  	FaaSInstanceKey = attribute.Key("faas.instance")
   397  	// The amount of memory available to the serverless function in MiB.
   398  	//
   399  	// Type: int
   400  	// Required: No
   401  	// Stability: stable
   402  	// Examples: 128
   403  	// Note: It's recommended to set this attribute since e.g. too little memory can
   404  	// easily stop a Java AWS Lambda function from working correctly. On AWS Lambda,
   405  	// the environment variable `AWS_LAMBDA_FUNCTION_MEMORY_SIZE` provides this
   406  	// information.
   407  	FaaSMaxMemoryKey = attribute.Key("faas.max_memory")
   408  )
   409  
   410  // A host is defined as a general computing instance.
   411  const (
   412  	// Unique host ID. For Cloud, this must be the instance_id assigned by the cloud
   413  	// provider.
   414  	//
   415  	// Type: string
   416  	// Required: No
   417  	// Stability: stable
   418  	// Examples: 'opentelemetry-test'
   419  	HostIDKey = attribute.Key("host.id")
   420  	// Name of the host. On Unix systems, it may contain what the hostname command
   421  	// returns, or the fully qualified hostname, or another name specified by the
   422  	// user.
   423  	//
   424  	// Type: string
   425  	// Required: No
   426  	// Stability: stable
   427  	// Examples: 'opentelemetry-test'
   428  	HostNameKey = attribute.Key("host.name")
   429  	// Type of host. For Cloud, this must be the machine type.
   430  	//
   431  	// Type: string
   432  	// Required: No
   433  	// Stability: stable
   434  	// Examples: 'n1-standard-1'
   435  	HostTypeKey = attribute.Key("host.type")
   436  	// The CPU architecture the host system is running on.
   437  	//
   438  	// Type: Enum
   439  	// Required: No
   440  	// Stability: stable
   441  	HostArchKey = attribute.Key("host.arch")
   442  	// Name of the VM image or OS install the host was instantiated from.
   443  	//
   444  	// Type: string
   445  	// Required: No
   446  	// Stability: stable
   447  	// Examples: 'infra-ami-eks-worker-node-7d4ec78312', 'CentOS-8-x86_64-1905'
   448  	HostImageNameKey = attribute.Key("host.image.name")
   449  	// VM image ID. For Cloud, this value is from the provider.
   450  	//
   451  	// Type: string
   452  	// Required: No
   453  	// Stability: stable
   454  	// Examples: 'ami-07b06b442921831e5'
   455  	HostImageIDKey = attribute.Key("host.image.id")
   456  	// The version string of the VM image as defined in [Version
   457  	// Attributes](README.md#version-attributes).
   458  	//
   459  	// Type: string
   460  	// Required: No
   461  	// Stability: stable
   462  	// Examples: '0.1'
   463  	HostImageVersionKey = attribute.Key("host.image.version")
   464  )
   465  
   466  var (
   467  	// AMD64
   468  	HostArchAMD64 = HostArchKey.String("amd64")
   469  	// ARM32
   470  	HostArchARM32 = HostArchKey.String("arm32")
   471  	// ARM64
   472  	HostArchARM64 = HostArchKey.String("arm64")
   473  	// Itanium
   474  	HostArchIA64 = HostArchKey.String("ia64")
   475  	// 32-bit PowerPC
   476  	HostArchPPC32 = HostArchKey.String("ppc32")
   477  	// 64-bit PowerPC
   478  	HostArchPPC64 = HostArchKey.String("ppc64")
   479  	// 32-bit x86
   480  	HostArchX86 = HostArchKey.String("x86")
   481  )
   482  
   483  // A Kubernetes Cluster.
   484  const (
   485  	// The name of the cluster.
   486  	//
   487  	// Type: string
   488  	// Required: No
   489  	// Stability: stable
   490  	// Examples: 'opentelemetry-cluster'
   491  	K8SClusterNameKey = attribute.Key("k8s.cluster.name")
   492  )
   493  
   494  // A Kubernetes Node object.
   495  const (
   496  	// The name of the Node.
   497  	//
   498  	// Type: string
   499  	// Required: No
   500  	// Stability: stable
   501  	// Examples: 'node-1'
   502  	K8SNodeNameKey = attribute.Key("k8s.node.name")
   503  	// The UID of the Node.
   504  	//
   505  	// Type: string
   506  	// Required: No
   507  	// Stability: stable
   508  	// Examples: '1eb3a0c6-0477-4080-a9cb-0cb7db65c6a2'
   509  	K8SNodeUIDKey = attribute.Key("k8s.node.uid")
   510  )
   511  
   512  // A Kubernetes Namespace.
   513  const (
   514  	// The name of the namespace that the pod is running in.
   515  	//
   516  	// Type: string
   517  	// Required: No
   518  	// Stability: stable
   519  	// Examples: 'default'
   520  	K8SNamespaceNameKey = attribute.Key("k8s.namespace.name")
   521  )
   522  
   523  // A Kubernetes Pod object.
   524  const (
   525  	// The UID of the Pod.
   526  	//
   527  	// Type: string
   528  	// Required: No
   529  	// Stability: stable
   530  	// Examples: '275ecb36-5aa8-4c2a-9c47-d8bb681b9aff'
   531  	K8SPodUIDKey = attribute.Key("k8s.pod.uid")
   532  	// The name of the Pod.
   533  	//
   534  	// Type: string
   535  	// Required: No
   536  	// Stability: stable
   537  	// Examples: 'opentelemetry-pod-autoconf'
   538  	K8SPodNameKey = attribute.Key("k8s.pod.name")
   539  )
   540  
   541  // A container in a [PodTemplate](https://kubernetes.io/docs/concepts/workloads/pods/#pod-templates).
   542  const (
   543  	// The name of the Container in a Pod template.
   544  	//
   545  	// Type: string
   546  	// Required: No
   547  	// Stability: stable
   548  	// Examples: 'redis'
   549  	K8SContainerNameKey = attribute.Key("k8s.container.name")
   550  )
   551  
   552  // A Kubernetes ReplicaSet object.
   553  const (
   554  	// The UID of the ReplicaSet.
   555  	//
   556  	// Type: string
   557  	// Required: No
   558  	// Stability: stable
   559  	// Examples: '275ecb36-5aa8-4c2a-9c47-d8bb681b9aff'
   560  	K8SReplicaSetUIDKey = attribute.Key("k8s.replicaset.uid")
   561  	// The name of the ReplicaSet.
   562  	//
   563  	// Type: string
   564  	// Required: No
   565  	// Stability: stable
   566  	// Examples: 'opentelemetry'
   567  	K8SReplicaSetNameKey = attribute.Key("k8s.replicaset.name")
   568  )
   569  
   570  // A Kubernetes Deployment object.
   571  const (
   572  	// The UID of the Deployment.
   573  	//
   574  	// Type: string
   575  	// Required: No
   576  	// Stability: stable
   577  	// Examples: '275ecb36-5aa8-4c2a-9c47-d8bb681b9aff'
   578  	K8SDeploymentUIDKey = attribute.Key("k8s.deployment.uid")
   579  	// The name of the Deployment.
   580  	//
   581  	// Type: string
   582  	// Required: No
   583  	// Stability: stable
   584  	// Examples: 'opentelemetry'
   585  	K8SDeploymentNameKey = attribute.Key("k8s.deployment.name")
   586  )
   587  
   588  // A Kubernetes StatefulSet object.
   589  const (
   590  	// The UID of the StatefulSet.
   591  	//
   592  	// Type: string
   593  	// Required: No
   594  	// Stability: stable
   595  	// Examples: '275ecb36-5aa8-4c2a-9c47-d8bb681b9aff'
   596  	K8SStatefulSetUIDKey = attribute.Key("k8s.statefulset.uid")
   597  	// The name of the StatefulSet.
   598  	//
   599  	// Type: string
   600  	// Required: No
   601  	// Stability: stable
   602  	// Examples: 'opentelemetry'
   603  	K8SStatefulSetNameKey = attribute.Key("k8s.statefulset.name")
   604  )
   605  
   606  // A Kubernetes DaemonSet object.
   607  const (
   608  	// The UID of the DaemonSet.
   609  	//
   610  	// Type: string
   611  	// Required: No
   612  	// Stability: stable
   613  	// Examples: '275ecb36-5aa8-4c2a-9c47-d8bb681b9aff'
   614  	K8SDaemonSetUIDKey = attribute.Key("k8s.daemonset.uid")
   615  	// The name of the DaemonSet.
   616  	//
   617  	// Type: string
   618  	// Required: No
   619  	// Stability: stable
   620  	// Examples: 'opentelemetry'
   621  	K8SDaemonSetNameKey = attribute.Key("k8s.daemonset.name")
   622  )
   623  
   624  // A Kubernetes Job object.
   625  const (
   626  	// The UID of the Job.
   627  	//
   628  	// Type: string
   629  	// Required: No
   630  	// Stability: stable
   631  	// Examples: '275ecb36-5aa8-4c2a-9c47-d8bb681b9aff'
   632  	K8SJobUIDKey = attribute.Key("k8s.job.uid")
   633  	// The name of the Job.
   634  	//
   635  	// Type: string
   636  	// Required: No
   637  	// Stability: stable
   638  	// Examples: 'opentelemetry'
   639  	K8SJobNameKey = attribute.Key("k8s.job.name")
   640  )
   641  
   642  // A Kubernetes CronJob object.
   643  const (
   644  	// The UID of the CronJob.
   645  	//
   646  	// Type: string
   647  	// Required: No
   648  	// Stability: stable
   649  	// Examples: '275ecb36-5aa8-4c2a-9c47-d8bb681b9aff'
   650  	K8SCronJobUIDKey = attribute.Key("k8s.cronjob.uid")
   651  	// The name of the CronJob.
   652  	//
   653  	// Type: string
   654  	// Required: No
   655  	// Stability: stable
   656  	// Examples: 'opentelemetry'
   657  	K8SCronJobNameKey = attribute.Key("k8s.cronjob.name")
   658  )
   659  
   660  // The operating system (OS) on which the process represented by this resource is running.
   661  const (
   662  	// The operating system type.
   663  	//
   664  	// Type: Enum
   665  	// Required: Always
   666  	// Stability: stable
   667  	OSTypeKey = attribute.Key("os.type")
   668  	// Human readable (not intended to be parsed) OS version information, like e.g.
   669  	// reported by `ver` or `lsb_release -a` commands.
   670  	//
   671  	// Type: string
   672  	// Required: No
   673  	// Stability: stable
   674  	// Examples: 'Microsoft Windows [Version 10.0.18363.778]', 'Ubuntu 18.04.1 LTS'
   675  	OSDescriptionKey = attribute.Key("os.description")
   676  	// Human readable operating system name.
   677  	//
   678  	// Type: string
   679  	// Required: No
   680  	// Stability: stable
   681  	// Examples: 'iOS', 'Android', 'Ubuntu'
   682  	OSNameKey = attribute.Key("os.name")
   683  	// The version string of the operating system as defined in [Version
   684  	// Attributes](../../resource/semantic_conventions/README.md#version-attributes).
   685  	//
   686  	// Type: string
   687  	// Required: No
   688  	// Stability: stable
   689  	// Examples: '14.2.1', '18.04.1'
   690  	OSVersionKey = attribute.Key("os.version")
   691  )
   692  
   693  var (
   694  	// Microsoft Windows
   695  	OSTypeWindows = OSTypeKey.String("windows")
   696  	// Linux
   697  	OSTypeLinux = OSTypeKey.String("linux")
   698  	// Apple Darwin
   699  	OSTypeDarwin = OSTypeKey.String("darwin")
   700  	// FreeBSD
   701  	OSTypeFreeBSD = OSTypeKey.String("freebsd")
   702  	// NetBSD
   703  	OSTypeNetBSD = OSTypeKey.String("netbsd")
   704  	// OpenBSD
   705  	OSTypeOpenBSD = OSTypeKey.String("openbsd")
   706  	// DragonFly BSD
   707  	OSTypeDragonflyBSD = OSTypeKey.String("dragonflybsd")
   708  	// HP-UX (Hewlett Packard Unix)
   709  	OSTypeHPUX = OSTypeKey.String("hpux")
   710  	// AIX (Advanced Interactive eXecutive)
   711  	OSTypeAIX = OSTypeKey.String("aix")
   712  	// Oracle Solaris
   713  	OSTypeSolaris = OSTypeKey.String("solaris")
   714  	// IBM z/OS
   715  	OSTypeZOS = OSTypeKey.String("z_os")
   716  )
   717  
   718  // An operating system process.
   719  const (
   720  	// Process identifier (PID).
   721  	//
   722  	// Type: int
   723  	// Required: No
   724  	// Stability: stable
   725  	// Examples: 1234
   726  	ProcessPIDKey = attribute.Key("process.pid")
   727  	// The name of the process executable. On Linux based systems, can be set to the
   728  	// `Name` in `proc/[pid]/status`. On Windows, can be set to the base name of
   729  	// `GetProcessImageFileNameW`.
   730  	//
   731  	// Type: string
   732  	// Required: See below
   733  	// Stability: stable
   734  	// Examples: 'otelcol'
   735  	ProcessExecutableNameKey = attribute.Key("process.executable.name")
   736  	// The full path to the process executable. On Linux based systems, can be set to
   737  	// the target of `proc/[pid]/exe`. On Windows, can be set to the result of
   738  	// `GetProcessImageFileNameW`.
   739  	//
   740  	// Type: string
   741  	// Required: See below
   742  	// Stability: stable
   743  	// Examples: '/usr/bin/cmd/otelcol'
   744  	ProcessExecutablePathKey = attribute.Key("process.executable.path")
   745  	// The command used to launch the process (i.e. the command name). On Linux based
   746  	// systems, can be set to the zeroth string in `proc/[pid]/cmdline`. On Windows,
   747  	// can be set to the first parameter extracted from `GetCommandLineW`.
   748  	//
   749  	// Type: string
   750  	// Required: See below
   751  	// Stability: stable
   752  	// Examples: 'cmd/otelcol'
   753  	ProcessCommandKey = attribute.Key("process.command")
   754  	// The full command used to launch the process as a single string representing the
   755  	// full command. On Windows, can be set to the result of `GetCommandLineW`. Do not
   756  	// set this if you have to assemble it just for monitoring; use
   757  	// `process.command_args` instead.
   758  	//
   759  	// Type: string
   760  	// Required: See below
   761  	// Stability: stable
   762  	// Examples: 'C:\\cmd\\otecol --config="my directory\\config.yaml"'
   763  	ProcessCommandLineKey = attribute.Key("process.command_line")
   764  	// All the command arguments (including the command/executable itself) as received
   765  	// by the process. On Linux-based systems (and some other Unixoid systems
   766  	// supporting procfs), can be set according to the list of null-delimited strings
   767  	// extracted from `proc/[pid]/cmdline`. For libc-based executables, this would be
   768  	// the full argv vector passed to `main`.
   769  	//
   770  	// Type: string[]
   771  	// Required: See below
   772  	// Stability: stable
   773  	// Examples: 'cmd/otecol', '--config=config.yaml'
   774  	ProcessCommandArgsKey = attribute.Key("process.command_args")
   775  	// The username of the user that owns the process.
   776  	//
   777  	// Type: string
   778  	// Required: No
   779  	// Stability: stable
   780  	// Examples: 'root'
   781  	ProcessOwnerKey = attribute.Key("process.owner")
   782  )
   783  
   784  // The single (language) runtime instance which is monitored.
   785  const (
   786  	// The name of the runtime of this process. For compiled native binaries, this
   787  	// SHOULD be the name of the compiler.
   788  	//
   789  	// Type: string
   790  	// Required: No
   791  	// Stability: stable
   792  	// Examples: 'OpenJDK Runtime Environment'
   793  	ProcessRuntimeNameKey = attribute.Key("process.runtime.name")
   794  	// The version of the runtime of this process, as returned by the runtime without
   795  	// modification.
   796  	//
   797  	// Type: string
   798  	// Required: No
   799  	// Stability: stable
   800  	// Examples: '14.0.2'
   801  	ProcessRuntimeVersionKey = attribute.Key("process.runtime.version")
   802  	// An additional description about the runtime of the process, for example a
   803  	// specific vendor customization of the runtime environment.
   804  	//
   805  	// Type: string
   806  	// Required: No
   807  	// Stability: stable
   808  	// Examples: 'Eclipse OpenJ9 Eclipse OpenJ9 VM openj9-0.21.0'
   809  	ProcessRuntimeDescriptionKey = attribute.Key("process.runtime.description")
   810  )
   811  
   812  // A service instance.
   813  const (
   814  	// Logical name of the service.
   815  	//
   816  	// Type: string
   817  	// Required: Always
   818  	// Stability: stable
   819  	// Examples: 'shoppingcart'
   820  	// Note: MUST be the same for all instances of horizontally scaled services. If
   821  	// the value was not specified, SDKs MUST fallback to `unknown_service:`
   822  	// concatenated with [`process.executable.name`](process.md#process), e.g.
   823  	// `unknown_service:bash`. If `process.executable.name` is not available, the
   824  	// value MUST be set to `unknown_service`.
   825  	ServiceNameKey = attribute.Key("service.name")
   826  	// A namespace for `service.name`.
   827  	//
   828  	// Type: string
   829  	// Required: No
   830  	// Stability: stable
   831  	// Examples: 'Shop'
   832  	// Note: A string value having a meaning that helps to distinguish a group of
   833  	// services, for example the team name that owns a group of services.
   834  	// `service.name` is expected to be unique within the same namespace. If
   835  	// `service.namespace` is not specified in the Resource then `service.name` is
   836  	// expected to be unique for all services that have no explicit namespace defined
   837  	// (so the empty/unspecified namespace is simply one more valid namespace). Zero-
   838  	// length namespace string is assumed equal to unspecified namespace.
   839  	ServiceNamespaceKey = attribute.Key("service.namespace")
   840  	// The string ID of the service instance.
   841  	//
   842  	// Type: string
   843  	// Required: No
   844  	// Stability: stable
   845  	// Examples: '627cc493-f310-47de-96bd-71410b7dec09'
   846  	// Note: MUST be unique for each instance of the same
   847  	// `service.namespace,service.name` pair (in other words
   848  	// `service.namespace,service.name,service.instance.id` triplet MUST be globally
   849  	// unique). The ID helps to distinguish instances of the same service that exist
   850  	// at the same time (e.g. instances of a horizontally scaled service). It is
   851  	// preferable for the ID to be persistent and stay the same for the lifetime of
   852  	// the service instance, however it is acceptable that the ID is ephemeral and
   853  	// changes during important lifetime events for the service (e.g. service
   854  	// restarts). If the service has no inherent unique ID that can be used as the
   855  	// value of this attribute it is recommended to generate a random Version 1 or
   856  	// Version 4 RFC 4122 UUID (services aiming for reproducible UUIDs may also use
   857  	// Version 5, see RFC 4122 for more recommendations).
   858  	ServiceInstanceIDKey = attribute.Key("service.instance.id")
   859  	// The version string of the service API or implementation.
   860  	//
   861  	// Type: string
   862  	// Required: No
   863  	// Stability: stable
   864  	// Examples: '2.0.0'
   865  	ServiceVersionKey = attribute.Key("service.version")
   866  )
   867  
   868  // The telemetry SDK used to capture data recorded by the instrumentation libraries.
   869  const (
   870  	// The name of the telemetry SDK as defined above.
   871  	//
   872  	// Type: string
   873  	// Required: No
   874  	// Stability: stable
   875  	// Examples: 'opentelemetry'
   876  	TelemetrySDKNameKey = attribute.Key("telemetry.sdk.name")
   877  	// The language of the telemetry SDK.
   878  	//
   879  	// Type: Enum
   880  	// Required: No
   881  	// Stability: stable
   882  	TelemetrySDKLanguageKey = attribute.Key("telemetry.sdk.language")
   883  	// The version string of the telemetry SDK.
   884  	//
   885  	// Type: string
   886  	// Required: No
   887  	// Stability: stable
   888  	// Examples: '1.2.3'
   889  	TelemetrySDKVersionKey = attribute.Key("telemetry.sdk.version")
   890  	// The version string of the auto instrumentation agent, if used.
   891  	//
   892  	// Type: string
   893  	// Required: No
   894  	// Stability: stable
   895  	// Examples: '1.2.3'
   896  	TelemetryAutoVersionKey = attribute.Key("telemetry.auto.version")
   897  )
   898  
   899  var (
   900  	// cpp
   901  	TelemetrySDKLanguageCPP = TelemetrySDKLanguageKey.String("cpp")
   902  	// dotnet
   903  	TelemetrySDKLanguageDotnet = TelemetrySDKLanguageKey.String("dotnet")
   904  	// erlang
   905  	TelemetrySDKLanguageErlang = TelemetrySDKLanguageKey.String("erlang")
   906  	// go
   907  	TelemetrySDKLanguageGo = TelemetrySDKLanguageKey.String("go")
   908  	// java
   909  	TelemetrySDKLanguageJava = TelemetrySDKLanguageKey.String("java")
   910  	// nodejs
   911  	TelemetrySDKLanguageNodejs = TelemetrySDKLanguageKey.String("nodejs")
   912  	// php
   913  	TelemetrySDKLanguagePHP = TelemetrySDKLanguageKey.String("php")
   914  	// python
   915  	TelemetrySDKLanguagePython = TelemetrySDKLanguageKey.String("python")
   916  	// ruby
   917  	TelemetrySDKLanguageRuby = TelemetrySDKLanguageKey.String("ruby")
   918  	// webjs
   919  	TelemetrySDKLanguageWebjs = TelemetrySDKLanguageKey.String("webjs")
   920  )
   921  
   922  // Resource describing the packaged software running the application code. Web engines are typically executed using process.runtime.
   923  const (
   924  	// The name of the web engine.
   925  	//
   926  	// Type: string
   927  	// Required: Always
   928  	// Stability: stable
   929  	// Examples: 'WildFly'
   930  	WebEngineNameKey = attribute.Key("webengine.name")
   931  	// The version of the web engine.
   932  	//
   933  	// Type: string
   934  	// Required: No
   935  	// Stability: stable
   936  	// Examples: '21.0.0'
   937  	WebEngineVersionKey = attribute.Key("webengine.version")
   938  	// Additional description of the web engine (e.g. detailed version and edition
   939  	// information).
   940  	//
   941  	// Type: string
   942  	// Required: No
   943  	// Stability: stable
   944  	// Examples: 'WildFly Full 21.0.0.Final (WildFly Core 13.0.1.Final) - 2.2.2.Final'
   945  	WebEngineDescriptionKey = attribute.Key("webengine.description")
   946  )
   947  

View as plain text