Debian Codegraph @

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