Debian Codegraph @

semconv/v1.5.0/resource.go

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