Debian Codegraph @

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