Debian Codegraph @

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