| 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.25.0" |
| 7 |
|
| 8 |
import "go.opentelemetry.io/otel/attribute" |
| 9 |
|
| 10 |
// Resources used by AWS Elastic Container Service (ECS). |
| 11 |
const ( |
| 12 |
// AWSECSTaskIDKey is the attribute Key conforming to the "aws.ecs.task.id" |
| 13 |
// semantic conventions. It represents the ID of a running ECS task. The ID |
| 14 |
// MUST be extracted from `task.arn`. |
| 15 |
// |
| 16 |
// Type: string |
| 17 |
// RequirementLevel: ConditionallyRequired (If and only if `task.arn` is |
| 18 |
// populated.) |
| 19 |
// Stability: experimental |
| 20 |
// Examples: '10838bed-421f-43ef-870a-f43feacbbb5b', |
| 21 |
// '23ebb8ac-c18f-46c6-8bbe-d55d0e37cfbd' |
| 22 |
AWSECSTaskIDKey = attribute.Key("aws.ecs.task.id") |
| 23 |
|
| 24 |
// AWSECSClusterARNKey is the attribute Key conforming to the |
| 25 |
// "aws.ecs.cluster.arn" semantic conventions. It represents the ARN of an |
| 26 |
// [ECS |
| 27 |
// cluster](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/clusters.html). |
| 28 |
// |
| 29 |
// Type: string |
| 30 |
// RequirementLevel: Optional |
| 31 |
// Stability: experimental |
| 32 |
// Examples: 'arn:aws:ecs:us-west-2:123456789123:cluster/my-cluster' |
| 33 |
AWSECSClusterARNKey = attribute.Key("aws.ecs.cluster.arn") |
| 34 |
|
| 35 |
// AWSECSContainerARNKey is the attribute Key conforming to the |
| 36 |
// "aws.ecs.container.arn" semantic conventions. It represents the Amazon |
| 37 |
// Resource Name (ARN) of an [ECS container |
| 38 |
// instance](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ECS_instances.html). |
| 39 |
// |
| 40 |
// Type: string |
| 41 |
// RequirementLevel: Optional |
| 42 |
// Stability: experimental |
| 43 |
// Examples: |
| 44 |
// 'arn:aws:ecs:us-west-1:123456789123:container/32624152-9086-4f0e-acae-1a75b14fe4d9' |
| 45 |
AWSECSContainerARNKey = attribute.Key("aws.ecs.container.arn") |
| 46 |
|
| 47 |
// AWSECSLaunchtypeKey is the attribute Key conforming to the |
| 48 |
// "aws.ecs.launchtype" semantic conventions. It represents the [launch |
| 49 |
// type](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/launch_types.html) |
| 50 |
// for an ECS task. |
| 51 |
// |
| 52 |
// Type: Enum |
| 53 |
// RequirementLevel: Optional |
| 54 |
// Stability: experimental |
| 55 |
AWSECSLaunchtypeKey = attribute.Key("aws.ecs.launchtype") |
| 56 |
|
| 57 |
// AWSECSTaskARNKey is the attribute Key conforming to the |
| 58 |
// "aws.ecs.task.arn" semantic conventions. It represents the ARN of a |
| 59 |
// running [ECS |
| 60 |
// task](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-account-settings.html#ecs-resource-ids). |
| 61 |
// |
| 62 |
// Type: string |
| 63 |
// RequirementLevel: Optional |
| 64 |
// Stability: experimental |
| 65 |
// Examples: |
| 66 |
// 'arn:aws:ecs:us-west-1:123456789123:task/10838bed-421f-43ef-870a-f43feacbbb5b', |
| 67 |
// 'arn:aws:ecs:us-west-1:123456789123:task/my-cluster/task-id/23ebb8ac-c18f-46c6-8bbe-d55d0e37cfbd' |
| 68 |
AWSECSTaskARNKey = attribute.Key("aws.ecs.task.arn") |
| 69 |
|
| 70 |
// AWSECSTaskFamilyKey is the attribute Key conforming to the |
| 71 |
// "aws.ecs.task.family" semantic conventions. It represents the family |
| 72 |
// name of the [ECS task |
| 73 |
// definition](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task_definitions.html) |
| 74 |
// used to create the ECS task. |
| 75 |
// |
| 76 |
// Type: string |
| 77 |
// RequirementLevel: Optional |
| 78 |
// Stability: experimental |
| 79 |
// Examples: 'opentelemetry-family' |
| 80 |
AWSECSTaskFamilyKey = attribute.Key("aws.ecs.task.family") |
| 81 |
|
| 82 |
// AWSECSTaskRevisionKey is the attribute Key conforming to the |
| 83 |
// "aws.ecs.task.revision" semantic conventions. It represents the revision |
| 84 |
// for the task definition used to create the ECS task. |
| 85 |
// |
| 86 |
// Type: string |
| 87 |
// RequirementLevel: Optional |
| 88 |
// Stability: experimental |
| 89 |
// Examples: '8', '26' |
| 90 |
AWSECSTaskRevisionKey = attribute.Key("aws.ecs.task.revision") |
| 91 |
) |
| 92 |
|
| 93 |
var ( |
| 94 |
// ec2 |
| 95 |
AWSECSLaunchtypeEC2 = AWSECSLaunchtypeKey.String("ec2") |
| 96 |
// fargate |
| 97 |
AWSECSLaunchtypeFargate = AWSECSLaunchtypeKey.String("fargate") |
| 98 |
) |
| 99 |
|
| 100 |
// AWSECSTaskID returns an attribute KeyValue conforming to the |
| 101 |
// "aws.ecs.task.id" semantic conventions. It represents the ID of a running |
| 102 |
// ECS task. The ID MUST be extracted from `task.arn`. |
| 103 |
func AWSECSTaskID(val string) attribute.KeyValue { |
| 104 |
return AWSECSTaskIDKey.String(val) |
| 105 |
} |
| 106 |
|
| 107 |
// AWSECSClusterARN returns an attribute KeyValue conforming to the |
| 108 |
// "aws.ecs.cluster.arn" semantic conventions. It represents the ARN of an [ECS |
| 109 |
// cluster](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/clusters.html). |
| 110 |
func AWSECSClusterARN(val string) attribute.KeyValue { |
| 111 |
return AWSECSClusterARNKey.String(val) |
| 112 |
} |
| 113 |
|
| 114 |
// AWSECSContainerARN returns an attribute KeyValue conforming to the |
| 115 |
// "aws.ecs.container.arn" semantic conventions. It represents the Amazon |
| 116 |
// Resource Name (ARN) of an [ECS container |
| 117 |
// instance](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ECS_instances.html). |
| 118 |
func AWSECSContainerARN(val string) attribute.KeyValue { |
| 119 |
return AWSECSContainerARNKey.String(val) |
| 120 |
} |
| 121 |
|
| 122 |
// AWSECSTaskARN returns an attribute KeyValue conforming to the |
| 123 |
// "aws.ecs.task.arn" semantic conventions. It represents the ARN of a running |
| 124 |
// [ECS |
| 125 |
// task](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-account-settings.html#ecs-resource-ids). |
| 126 |
func AWSECSTaskARN(val string) attribute.KeyValue { |
| 127 |
return AWSECSTaskARNKey.String(val) |
| 128 |
} |
| 129 |
|
| 130 |
// AWSECSTaskFamily returns an attribute KeyValue conforming to the |
| 131 |
// "aws.ecs.task.family" semantic conventions. It represents the family name of |
| 132 |
// the [ECS task |
| 133 |
// definition](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task_definitions.html) |
| 134 |
// used to create the ECS task. |
| 135 |
func AWSECSTaskFamily(val string) attribute.KeyValue { |
| 136 |
return AWSECSTaskFamilyKey.String(val) |
| 137 |
} |
| 138 |
|
| 139 |
// AWSECSTaskRevision returns an attribute KeyValue conforming to the |
| 140 |
// "aws.ecs.task.revision" semantic conventions. It represents the revision for |
| 141 |
// the task definition used to create the ECS task. |
| 142 |
func AWSECSTaskRevision(val string) attribute.KeyValue { |
| 143 |
return AWSECSTaskRevisionKey.String(val) |
| 144 |
} |
| 145 |
|
| 146 |
// Resources used by AWS Elastic Kubernetes Service (EKS). |
| 147 |
const ( |
| 148 |
// AWSEKSClusterARNKey is the attribute Key conforming to the |
| 149 |
// "aws.eks.cluster.arn" semantic conventions. It represents the ARN of an |
| 150 |
// EKS cluster. |
| 151 |
// |
| 152 |
// Type: string |
| 153 |
// RequirementLevel: Optional |
| 154 |
// Stability: experimental |
| 155 |
// Examples: 'arn:aws:ecs:us-west-2:123456789123:cluster/my-cluster' |
| 156 |
AWSEKSClusterARNKey = attribute.Key("aws.eks.cluster.arn") |
| 157 |
) |
| 158 |
|
| 159 |
// AWSEKSClusterARN returns an attribute KeyValue conforming to the |
| 160 |
// "aws.eks.cluster.arn" semantic conventions. It represents the ARN of an EKS |
| 161 |
// cluster. |
| 162 |
func AWSEKSClusterARN(val string) attribute.KeyValue { |
| 163 |
return AWSEKSClusterARNKey.String(val) |
| 164 |
} |
| 165 |
|
| 166 |
// Resources specific to Amazon Web Services. |
| 167 |
const ( |
| 168 |
// AWSLogGroupARNsKey is the attribute Key conforming to the |
| 169 |
// "aws.log.group.arns" semantic conventions. It represents the Amazon |
| 170 |
// Resource Name(s) (ARN) of the AWS log group(s). |
| 171 |
// |
| 172 |
// Type: string[] |
| 173 |
// RequirementLevel: Optional |
| 174 |
// Stability: experimental |
| 175 |
// Examples: |
| 176 |
// 'arn:aws:logs:us-west-1:123456789012:log-group:/aws/my/group:*' |
| 177 |
// Note: See the [log group ARN format |
| 178 |
// documentation](https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/iam-access-control-overview-cwl.html#CWL_ARN_Format). |
| 179 |
AWSLogGroupARNsKey = attribute.Key("aws.log.group.arns") |
| 180 |
|
| 181 |
// AWSLogGroupNamesKey is the attribute Key conforming to the |
| 182 |
// "aws.log.group.names" semantic conventions. It represents the name(s) of |
| 183 |
// the AWS log group(s) an application is writing to. |
| 184 |
// |
| 185 |
// Type: string[] |
| 186 |
// RequirementLevel: Optional |
| 187 |
// Stability: experimental |
| 188 |
// Examples: '/aws/lambda/my-function', 'opentelemetry-service' |
| 189 |
// Note: Multiple log groups must be supported for cases like |
| 190 |
// multi-container applications, where a single application has sidecar |
| 191 |
// containers, and each write to their own log group. |
| 192 |
AWSLogGroupNamesKey = attribute.Key("aws.log.group.names") |
| 193 |
|
| 194 |
// AWSLogStreamARNsKey is the attribute Key conforming to the |
| 195 |
// "aws.log.stream.arns" semantic conventions. It represents the ARN(s) of |
| 196 |
// the AWS log stream(s). |
| 197 |
// |
| 198 |
// Type: string[] |
| 199 |
// RequirementLevel: Optional |
| 200 |
// Stability: experimental |
| 201 |
// Examples: |
| 202 |
// 'arn:aws:logs:us-west-1:123456789012:log-group:/aws/my/group:log-stream:logs/main/10838bed-421f-43ef-870a-f43feacbbb5b' |
| 203 |
// Note: See the [log stream ARN format |
| 204 |
// documentation](https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/iam-access-control-overview-cwl.html#CWL_ARN_Format). |
| 205 |
// One log group can contain several log streams, so these ARNs necessarily |
| 206 |
// identify both a log group and a log stream. |
| 207 |
AWSLogStreamARNsKey = attribute.Key("aws.log.stream.arns") |
| 208 |
|
| 209 |
// AWSLogStreamNamesKey is the attribute Key conforming to the |
| 210 |
// "aws.log.stream.names" semantic conventions. It represents the name(s) |
| 211 |
// of the AWS log stream(s) an application is writing to. |
| 212 |
// |
| 213 |
// Type: string[] |
| 214 |
// RequirementLevel: Optional |
| 215 |
// Stability: experimental |
| 216 |
// Examples: 'logs/main/10838bed-421f-43ef-870a-f43feacbbb5b' |
| 217 |
AWSLogStreamNamesKey = attribute.Key("aws.log.stream.names") |
| 218 |
) |
| 219 |
|
| 220 |
// AWSLogGroupARNs returns an attribute KeyValue conforming to the |
| 221 |
// "aws.log.group.arns" semantic conventions. It represents the Amazon Resource |
| 222 |
// Name(s) (ARN) of the AWS log group(s). |
| 223 |
func AWSLogGroupARNs(val ...string) attribute.KeyValue { |
| 224 |
return AWSLogGroupARNsKey.StringSlice(val) |
| 225 |
} |
| 226 |
|
| 227 |
// AWSLogGroupNames returns an attribute KeyValue conforming to the |
| 228 |
// "aws.log.group.names" semantic conventions. It represents the name(s) of the |
| 229 |
// AWS log group(s) an application is writing to. |
| 230 |
func AWSLogGroupNames(val ...string) attribute.KeyValue { |
| 231 |
return AWSLogGroupNamesKey.StringSlice(val) |
| 232 |
} |
| 233 |
|
| 234 |
// AWSLogStreamARNs returns an attribute KeyValue conforming to the |
| 235 |
// "aws.log.stream.arns" semantic conventions. It represents the ARN(s) of the |
| 236 |
// AWS log stream(s). |
| 237 |
func AWSLogStreamARNs(val ...string) attribute.KeyValue { |
| 238 |
return AWSLogStreamARNsKey.StringSlice(val) |
| 239 |
} |
| 240 |
|
| 241 |
// AWSLogStreamNames returns an attribute KeyValue conforming to the |
| 242 |
// "aws.log.stream.names" semantic conventions. It represents the name(s) of |
| 243 |
// the AWS log stream(s) an application is writing to. |
| 244 |
func AWSLogStreamNames(val ...string) attribute.KeyValue { |
| 245 |
return AWSLogStreamNamesKey.StringSlice(val) |
| 246 |
} |
| 247 |
|
| 248 |
// Heroku dyno metadata |
| 249 |
const ( |
| 250 |
// HerokuAppIDKey is the attribute Key conforming to the "heroku.app.id" |
| 251 |
// semantic conventions. It represents the unique identifier for the |
| 252 |
// application |
| 253 |
// |
| 254 |
// Type: string |
| 255 |
// RequirementLevel: Optional |
| 256 |
// Stability: experimental |
| 257 |
// Examples: '2daa2797-e42b-4624-9322-ec3f968df4da' |
| 258 |
HerokuAppIDKey = attribute.Key("heroku.app.id") |
| 259 |
|
| 260 |
// HerokuReleaseCommitKey is the attribute Key conforming to the |
| 261 |
// "heroku.release.commit" semantic conventions. It represents the commit |
| 262 |
// hash for the current release |
| 263 |
// |
| 264 |
// Type: string |
| 265 |
// RequirementLevel: Optional |
| 266 |
// Stability: experimental |
| 267 |
// Examples: 'e6134959463efd8966b20e75b913cafe3f5ec' |
| 268 |
HerokuReleaseCommitKey = attribute.Key("heroku.release.commit") |
| 269 |
|
| 270 |
// HerokuReleaseCreationTimestampKey is the attribute Key conforming to the |
| 271 |
// "heroku.release.creation_timestamp" semantic conventions. It represents |
| 272 |
// the time and date the release was created |
| 273 |
// |
| 274 |
// Type: string |
| 275 |
// RequirementLevel: Optional |
| 276 |
// Stability: experimental |
| 277 |
// Examples: '2022-10-23T18:00:42Z' |
| 278 |
HerokuReleaseCreationTimestampKey = attribute.Key("heroku.release.creation_timestamp") |
| 279 |
) |
| 280 |
|
| 281 |
// HerokuAppID returns an attribute KeyValue conforming to the |
| 282 |
// "heroku.app.id" semantic conventions. It represents the unique identifier |
| 283 |
// for the application |
| 284 |
func HerokuAppID(val string) attribute.KeyValue { |
| 285 |
return HerokuAppIDKey.String(val) |
| 286 |
} |
| 287 |
|
| 288 |
// HerokuReleaseCommit returns an attribute KeyValue conforming to the |
| 289 |
// "heroku.release.commit" semantic conventions. It represents the commit hash |
| 290 |
// for the current release |
| 291 |
func HerokuReleaseCommit(val string) attribute.KeyValue { |
| 292 |
return HerokuReleaseCommitKey.String(val) |
| 293 |
} |
| 294 |
|
| 295 |
// HerokuReleaseCreationTimestamp returns an attribute KeyValue conforming |
| 296 |
// to the "heroku.release.creation_timestamp" semantic conventions. It |
| 297 |
// represents the time and date the release was created |
| 298 |
func HerokuReleaseCreationTimestamp(val string) attribute.KeyValue { |
| 299 |
return HerokuReleaseCreationTimestampKey.String(val) |
| 300 |
} |
| 301 |
|
| 302 |
// Resource describing the packaged software running the application code. Web |
| 303 |
// engines are typically executed using process.runtime. |
| 304 |
const ( |
| 305 |
// WebEngineNameKey is the attribute Key conforming to the "webengine.name" |
| 306 |
// semantic conventions. It represents the name of the web engine. |
| 307 |
// |
| 308 |
// Type: string |
| 309 |
// RequirementLevel: Required |
| 310 |
// Stability: experimental |
| 311 |
// Examples: 'WildFly' |
| 312 |
WebEngineNameKey = attribute.Key("webengine.name") |
| 313 |
|
| 314 |
// WebEngineDescriptionKey is the attribute Key conforming to the |
| 315 |
// "webengine.description" semantic conventions. It represents the |
| 316 |
// additional description of the web engine (e.g. detailed version and |
| 317 |
// edition information). |
| 318 |
// |
| 319 |
// Type: string |
| 320 |
// RequirementLevel: Optional |
| 321 |
// Stability: experimental |
| 322 |
// Examples: 'WildFly Full 21.0.0.Final (WildFly Core 13.0.1.Final) - |
| 323 |
// 2.2.2.Final' |
| 324 |
WebEngineDescriptionKey = attribute.Key("webengine.description") |
| 325 |
|
| 326 |
// WebEngineVersionKey is the attribute Key conforming to the |
| 327 |
// "webengine.version" semantic conventions. It represents the version of |
| 328 |
// the web engine. |
| 329 |
// |
| 330 |
// Type: string |
| 331 |
// RequirementLevel: Optional |
| 332 |
// Stability: experimental |
| 333 |
// Examples: '21.0.0' |
| 334 |
WebEngineVersionKey = attribute.Key("webengine.version") |
| 335 |
) |
| 336 |
|
| 337 |
// WebEngineName returns an attribute KeyValue conforming to the |
| 338 |
// "webengine.name" semantic conventions. It represents the name of the web |
| 339 |
// engine. |
| 340 |
func WebEngineName(val string) attribute.KeyValue { |
| 341 |
return WebEngineNameKey.String(val) |
| 342 |
} |
| 343 |
|
| 344 |
// WebEngineDescription returns an attribute KeyValue conforming to the |
| 345 |
// "webengine.description" semantic conventions. It represents the additional |
| 346 |
// description of the web engine (e.g. detailed version and edition |
| 347 |
// information). |
| 348 |
func WebEngineDescription(val string) attribute.KeyValue { |
| 349 |
return WebEngineDescriptionKey.String(val) |
| 350 |
} |
| 351 |
|
| 352 |
// WebEngineVersion returns an attribute KeyValue conforming to the |
| 353 |
// "webengine.version" semantic conventions. It represents the version of the |
| 354 |
// web engine. |
| 355 |
func WebEngineVersion(val string) attribute.KeyValue { |
| 356 |
return WebEngineVersionKey.String(val) |
| 357 |
} |
| 358 |
|
| 359 |
// Attributes used by non-OTLP exporters to represent OpenTelemetry Scope's |
| 360 |
// concepts. |
| 361 |
const ( |
| 362 |
// OTelScopeNameKey is the attribute Key conforming to the |
| 363 |
// "otel.scope.name" semantic conventions. It represents the name of the |
| 364 |
// instrumentation scope - (`InstrumentationScope.Name` in OTLP). |
| 365 |
// |
| 366 |
// Type: string |
| 367 |
// RequirementLevel: Optional |
| 368 |
// Stability: stable |
| 369 |
// Examples: 'io.opentelemetry.contrib.mongodb' |
| 370 |
OTelScopeNameKey = attribute.Key("otel.scope.name") |
| 371 |
|
| 372 |
// OTelScopeVersionKey is the attribute Key conforming to the |
| 373 |
// "otel.scope.version" semantic conventions. It represents the version of |
| 374 |
// the instrumentation scope - (`InstrumentationScope.Version` in OTLP). |
| 375 |
// |
| 376 |
// Type: string |
| 377 |
// RequirementLevel: Optional |
| 378 |
// Stability: stable |
| 379 |
// Examples: '1.0.0' |
| 380 |
OTelScopeVersionKey = attribute.Key("otel.scope.version") |
| 381 |
) |
| 382 |
|
| 383 |
// OTelScopeName returns an attribute KeyValue conforming to the |
| 384 |
// "otel.scope.name" semantic conventions. It represents the name of the |
| 385 |
// instrumentation scope - (`InstrumentationScope.Name` in OTLP). |
| 386 |
func OTelScopeName(val string) attribute.KeyValue { |
| 387 |
return OTelScopeNameKey.String(val) |
| 388 |
} |
| 389 |
|
| 390 |
// OTelScopeVersion returns an attribute KeyValue conforming to the |
| 391 |
// "otel.scope.version" semantic conventions. It represents the version of the |
| 392 |
// instrumentation scope - (`InstrumentationScope.Version` in OTLP). |
| 393 |
func OTelScopeVersion(val string) attribute.KeyValue { |
| 394 |
return OTelScopeVersionKey.String(val) |
| 395 |
} |
| 396 |
|
| 397 |
// Span attributes used by non-OTLP exporters to represent OpenTelemetry |
| 398 |
// Scope's concepts. |
| 399 |
const ( |
| 400 |
// OTelLibraryNameKey is the attribute Key conforming to the |
| 401 |
// "otel.library.name" semantic conventions. It represents the none |
| 402 |
// |
| 403 |
// Type: string |
| 404 |
// RequirementLevel: Optional |
| 405 |
// Stability: experimental |
| 406 |
// Examples: 'io.opentelemetry.contrib.mongodb' |
| 407 |
OTelLibraryNameKey = attribute.Key("otel.library.name") |
| 408 |
|
| 409 |
// OTelLibraryVersionKey is the attribute Key conforming to the |
| 410 |
// "otel.library.version" semantic conventions. It represents the none |
| 411 |
// |
| 412 |
// Type: string |
| 413 |
// RequirementLevel: Optional |
| 414 |
// Stability: experimental |
| 415 |
// Examples: '1.0.0' |
| 416 |
OTelLibraryVersionKey = attribute.Key("otel.library.version") |
| 417 |
) |
| 418 |
|
| 419 |
// OTelLibraryName returns an attribute KeyValue conforming to the |
| 420 |
// "otel.library.name" semantic conventions. It represents the none |
| 421 |
func OTelLibraryName(val string) attribute.KeyValue { |
| 422 |
return OTelLibraryNameKey.String(val) |
| 423 |
} |
| 424 |
|
| 425 |
// OTelLibraryVersion returns an attribute KeyValue conforming to the |
| 426 |
// "otel.library.version" semantic conventions. It represents the none |
| 427 |
func OTelLibraryVersion(val string) attribute.KeyValue { |
| 428 |
return OTelLibraryVersionKey.String(val) |
| 429 |
} |