diff --git a/src/OpenTelemetry.SemanticConventions/Attributes/AndroidAttributes.cs b/src/OpenTelemetry.SemanticConventions/Attributes/AndroidAttributes.cs index 87e2bbc526..9cb66d6a2b 100644 --- a/src/OpenTelemetry.SemanticConventions/Attributes/AndroidAttributes.cs +++ b/src/OpenTelemetry.SemanticConventions/Attributes/AndroidAttributes.cs @@ -15,35 +15,35 @@ namespace OpenTelemetry.SemanticConventions; public static class AndroidAttributes { /// - /// Uniquely identifies the framework API revision offered by a version (os.version) of the android operating system. More information can be found here + /// Uniquely identifies the framework API revision offered by a version (os.version) of the android operating system. More information can be found here. /// public const string AttributeAndroidOsApiLevel = "android.os.api_level"; /// - /// Deprecated use the device.app.lifecycle event definition including android.state as a payload field instead + /// Deprecated use the device.app.lifecycle event definition including android.state as a payload field instead. /// /// - /// The Android lifecycle states are defined in Activity lifecycle callbacks, and from which the OS identifiers are derived + /// The Android lifecycle states are defined in Activity lifecycle callbacks, and from which the OS identifiers are derived. /// public const string AttributeAndroidState = "android.state"; /// - /// Deprecated use the device.app.lifecycle event definition including android.state as a payload field instead + /// Deprecated use the device.app.lifecycle event definition including android.state as a payload field instead. /// public static class AndroidStateValues { /// - /// Any time before Activity.onResume() or, if the app has no Activity, Context.startService() has been called in the app for the first time + /// Any time before Activity.onResume() or, if the app has no Activity, Context.startService() has been called in the app for the first time. /// public const string Created = "created"; /// - /// Any time after Activity.onPause() or, if the app has no Activity, Context.stopService() has been called when the app was in the foreground state + /// Any time after Activity.onPause() or, if the app has no Activity, Context.stopService() has been called when the app was in the foreground state. /// public const string Background = "background"; /// - /// Any time after Activity.onResume() or, if the app has no Activity, Context.startService() has been called when the app was in either the created or background states + /// Any time after Activity.onResume() or, if the app has no Activity, Context.startService() has been called when the app was in either the created or background states. /// public const string Foreground = "foreground"; } diff --git a/src/OpenTelemetry.SemanticConventions/Attributes/ArtifactAttributes.cs b/src/OpenTelemetry.SemanticConventions/Attributes/ArtifactAttributes.cs index 04cc367c16..e59cb7da33 100644 --- a/src/OpenTelemetry.SemanticConventions/Attributes/ArtifactAttributes.cs +++ b/src/OpenTelemetry.SemanticConventions/Attributes/ArtifactAttributes.cs @@ -15,33 +15,33 @@ namespace OpenTelemetry.SemanticConventions; public static class ArtifactAttributes { /// - /// The provenance filename of the built attestation which directly relates to the build artifact filename. This filename SHOULD accompany the artifact at publish time. See the SLSA Relationship specification for more information + /// The provenance filename of the built attestation which directly relates to the build artifact filename. This filename SHOULD accompany the artifact at publish time. See the SLSA Relationship specification for more information. /// public const string AttributeArtifactAttestationFilename = "artifact.attestation.filename"; /// - /// The full hash value (see glossary), of the built attestation. Some envelopes in the software attestation space also refer to this as the digest + /// The full hash value (see glossary), of the built attestation. Some envelopes in the software attestation space also refer to this as the digest. /// public const string AttributeArtifactAttestationHash = "artifact.attestation.hash"; /// - /// The id of the build software attestation + /// The id of the build software attestation. /// public const string AttributeArtifactAttestationId = "artifact.attestation.id"; /// - /// The human readable file name of the artifact, typically generated during build and release processes. Often includes the package name and version in the file name + /// The human readable file name of the artifact, typically generated during build and release processes. Often includes the package name and version in the file name. /// /// /// This file name can also act as the Package Name /// in cases where the package ecosystem maps accordingly. /// Additionally, the artifact can be published - /// for others, but that is not a guarantee + /// for others, but that is not a guarantee. /// public const string AttributeArtifactFilename = "artifact.filename"; /// - /// The full hash value (see glossary), often found in checksum.txt on a release of the artifact and used to verify package integrity + /// The full hash value (see glossary), often found in checksum.txt on a release of the artifact and used to verify package integrity. /// /// /// The specific algorithm used to create the cryptographic hash value is @@ -51,17 +51,17 @@ public static class ArtifactAttributes /// that is suitable for the situation and consistent with the /// corresponding attestation. The implementer can then provide the other /// hash values through an additional set of attribute extensions as they - /// deem necessary + /// deem necessary. /// public const string AttributeArtifactHash = "artifact.hash"; /// - /// The Package URL of the package artifact provides a standard way to identify and locate the packaged artifact + /// The Package URL of the package artifact provides a standard way to identify and locate the packaged artifact. /// public const string AttributeArtifactPurl = "artifact.purl"; /// - /// The version of the artifact + /// The version of the artifact. /// public const string AttributeArtifactVersion = "artifact.version"; } diff --git a/src/OpenTelemetry.SemanticConventions/Attributes/AspnetcoreAttributes.cs b/src/OpenTelemetry.SemanticConventions/Attributes/AspnetcoreAttributes.cs index 3166fb95fb..12bc44887a 100644 --- a/src/OpenTelemetry.SemanticConventions/Attributes/AspnetcoreAttributes.cs +++ b/src/OpenTelemetry.SemanticConventions/Attributes/AspnetcoreAttributes.cs @@ -15,104 +15,104 @@ namespace OpenTelemetry.SemanticConventions; public static class AspnetcoreAttributes { /// - /// ASP.NET Core exception middleware handling result + /// ASP.NET Core exception middleware handling result. /// public const string AttributeAspnetcoreDiagnosticsExceptionResult = "aspnetcore.diagnostics.exception.result"; /// - /// Full type name of the IExceptionHandler implementation that handled the exception + /// Full type name of the IExceptionHandler implementation that handled the exception. /// public const string AttributeAspnetcoreDiagnosticsHandlerType = "aspnetcore.diagnostics.handler.type"; /// - /// Rate limiting policy name + /// Rate limiting policy name. /// public const string AttributeAspnetcoreRateLimitingPolicy = "aspnetcore.rate_limiting.policy"; /// - /// Rate-limiting result, shows whether the lease was acquired or contains a rejection reason + /// Rate-limiting result, shows whether the lease was acquired or contains a rejection reason. /// public const string AttributeAspnetcoreRateLimitingResult = "aspnetcore.rate_limiting.result"; /// - /// Flag indicating if request was handled by the application pipeline + /// Flag indicating if request was handled by the application pipeline. /// public const string AttributeAspnetcoreRequestIsUnhandled = "aspnetcore.request.is_unhandled"; /// - /// A value that indicates whether the matched route is a fallback route + /// A value that indicates whether the matched route is a fallback route. /// public const string AttributeAspnetcoreRoutingIsFallback = "aspnetcore.routing.is_fallback"; /// - /// Match result - success or failure + /// Match result - success or failure. /// public const string AttributeAspnetcoreRoutingMatchStatus = "aspnetcore.routing.match_status"; /// - /// ASP.NET Core exception middleware handling result + /// ASP.NET Core exception middleware handling result. /// public static class AspnetcoreDiagnosticsExceptionResultValues { /// - /// Exception was handled by the exception handling middleware + /// Exception was handled by the exception handling middleware. /// public const string Handled = "handled"; /// - /// Exception was not handled by the exception handling middleware + /// Exception was not handled by the exception handling middleware. /// public const string Unhandled = "unhandled"; /// - /// Exception handling was skipped because the response had started + /// Exception handling was skipped because the response had started. /// public const string Skipped = "skipped"; /// - /// Exception handling didn't run because the request was aborted + /// Exception handling didn't run because the request was aborted. /// public const string Aborted = "aborted"; } /// - /// Rate-limiting result, shows whether the lease was acquired or contains a rejection reason + /// Rate-limiting result, shows whether the lease was acquired or contains a rejection reason. /// public static class AspnetcoreRateLimitingResultValues { /// - /// Lease was acquired + /// Lease was acquired. /// public const string Acquired = "acquired"; /// - /// Lease request was rejected by the endpoint limiter + /// Lease request was rejected by the endpoint limiter. /// public const string EndpointLimiter = "endpoint_limiter"; /// - /// Lease request was rejected by the global limiter + /// Lease request was rejected by the global limiter. /// public const string GlobalLimiter = "global_limiter"; /// - /// Lease request was canceled + /// Lease request was canceled. /// public const string RequestCanceled = "request_canceled"; } /// - /// Match result - success or failure + /// Match result - success or failure. /// public static class AspnetcoreRoutingMatchStatusValues { /// - /// Match succeeded + /// Match succeeded. /// public const string Success = "success"; /// - /// Match failed + /// Match failed. /// public const string Failure = "failure"; } diff --git a/src/OpenTelemetry.SemanticConventions/Attributes/AwsAttributes.cs b/src/OpenTelemetry.SemanticConventions/Attributes/AwsAttributes.cs index 02ea3d403c..9ba5b04bd4 100644 --- a/src/OpenTelemetry.SemanticConventions/Attributes/AwsAttributes.cs +++ b/src/OpenTelemetry.SemanticConventions/Attributes/AwsAttributes.cs @@ -15,208 +15,208 @@ namespace OpenTelemetry.SemanticConventions; public static class AwsAttributes { /// - /// The JSON-serialized value of each item in the AttributeDefinitions request field + /// The JSON-serialized value of each item in the AttributeDefinitions request field. /// public const string AttributeAwsDynamodbAttributeDefinitions = "aws.dynamodb.attribute_definitions"; /// - /// The value of the AttributesToGet request parameter + /// The value of the AttributesToGet request parameter. /// public const string AttributeAwsDynamodbAttributesToGet = "aws.dynamodb.attributes_to_get"; /// - /// The value of the ConsistentRead request parameter + /// The value of the ConsistentRead request parameter. /// public const string AttributeAwsDynamodbConsistentRead = "aws.dynamodb.consistent_read"; /// - /// The JSON-serialized value of each item in the ConsumedCapacity response field + /// The JSON-serialized value of each item in the ConsumedCapacity response field. /// public const string AttributeAwsDynamodbConsumedCapacity = "aws.dynamodb.consumed_capacity"; /// - /// The value of the Count response parameter + /// The value of the Count response parameter. /// public const string AttributeAwsDynamodbCount = "aws.dynamodb.count"; /// - /// The value of the ExclusiveStartTableName request parameter + /// The value of the ExclusiveStartTableName request parameter. /// public const string AttributeAwsDynamodbExclusiveStartTable = "aws.dynamodb.exclusive_start_table"; /// - /// The JSON-serialized value of each item in the GlobalSecondaryIndexUpdates request field + /// The JSON-serialized value of each item in the GlobalSecondaryIndexUpdates request field. /// public const string AttributeAwsDynamodbGlobalSecondaryIndexUpdates = "aws.dynamodb.global_secondary_index_updates"; /// - /// The JSON-serialized value of each item of the GlobalSecondaryIndexes request field + /// The JSON-serialized value of each item of the GlobalSecondaryIndexes request field. /// public const string AttributeAwsDynamodbGlobalSecondaryIndexes = "aws.dynamodb.global_secondary_indexes"; /// - /// The value of the IndexName request parameter + /// The value of the IndexName request parameter. /// public const string AttributeAwsDynamodbIndexName = "aws.dynamodb.index_name"; /// - /// The JSON-serialized value of the ItemCollectionMetrics response field + /// The JSON-serialized value of the ItemCollectionMetrics response field. /// public const string AttributeAwsDynamodbItemCollectionMetrics = "aws.dynamodb.item_collection_metrics"; /// - /// The value of the Limit request parameter + /// The value of the Limit request parameter. /// public const string AttributeAwsDynamodbLimit = "aws.dynamodb.limit"; /// - /// The JSON-serialized value of each item of the LocalSecondaryIndexes request field + /// The JSON-serialized value of each item of the LocalSecondaryIndexes request field. /// public const string AttributeAwsDynamodbLocalSecondaryIndexes = "aws.dynamodb.local_secondary_indexes"; /// - /// The value of the ProjectionExpression request parameter + /// The value of the ProjectionExpression request parameter. /// public const string AttributeAwsDynamodbProjection = "aws.dynamodb.projection"; /// - /// The value of the ProvisionedThroughput.ReadCapacityUnits request parameter + /// The value of the ProvisionedThroughput.ReadCapacityUnits request parameter. /// public const string AttributeAwsDynamodbProvisionedReadCapacity = "aws.dynamodb.provisioned_read_capacity"; /// - /// The value of the ProvisionedThroughput.WriteCapacityUnits request parameter + /// The value of the ProvisionedThroughput.WriteCapacityUnits request parameter. /// public const string AttributeAwsDynamodbProvisionedWriteCapacity = "aws.dynamodb.provisioned_write_capacity"; /// - /// The value of the ScanIndexForward request parameter + /// The value of the ScanIndexForward request parameter. /// public const string AttributeAwsDynamodbScanForward = "aws.dynamodb.scan_forward"; /// - /// The value of the ScannedCount response parameter + /// The value of the ScannedCount response parameter. /// public const string AttributeAwsDynamodbScannedCount = "aws.dynamodb.scanned_count"; /// - /// The value of the Segment request parameter + /// The value of the Segment request parameter. /// public const string AttributeAwsDynamodbSegment = "aws.dynamodb.segment"; /// - /// The value of the Select request parameter + /// The value of the Select request parameter. /// public const string AttributeAwsDynamodbSelect = "aws.dynamodb.select"; /// - /// The number of items in the TableNames response parameter + /// The number of items in the TableNames response parameter. /// public const string AttributeAwsDynamodbTableCount = "aws.dynamodb.table_count"; /// - /// The keys in the RequestItems object field + /// The keys in the RequestItems object field. /// public const string AttributeAwsDynamodbTableNames = "aws.dynamodb.table_names"; /// - /// The value of the TotalSegments request parameter + /// The value of the TotalSegments request parameter. /// public const string AttributeAwsDynamodbTotalSegments = "aws.dynamodb.total_segments"; /// - /// The ARN of an ECS cluster + /// The ARN of an ECS cluster. /// public const string AttributeAwsEcsClusterArn = "aws.ecs.cluster.arn"; /// - /// The Amazon Resource Name (ARN) of an ECS container instance + /// The Amazon Resource Name (ARN) of an ECS container instance. /// public const string AttributeAwsEcsContainerArn = "aws.ecs.container.arn"; /// - /// The launch type for an ECS task + /// The launch type for an ECS task. /// public const string AttributeAwsEcsLaunchtype = "aws.ecs.launchtype"; /// - /// The ARN of a running ECS task + /// The ARN of a running ECS task. /// public const string AttributeAwsEcsTaskArn = "aws.ecs.task.arn"; /// - /// The family name of the ECS task definition used to create the ECS task + /// The family name of the ECS task definition used to create the ECS task. /// public const string AttributeAwsEcsTaskFamily = "aws.ecs.task.family"; /// - /// The ID of a running ECS task. The ID MUST be extracted from task.arn + /// The ID of a running ECS task. The ID MUST be extracted from task.arn. /// public const string AttributeAwsEcsTaskId = "aws.ecs.task.id"; /// - /// The revision for the task definition used to create the ECS task + /// The revision for the task definition used to create the ECS task. /// public const string AttributeAwsEcsTaskRevision = "aws.ecs.task.revision"; /// - /// The ARN of an EKS cluster + /// The ARN of an EKS cluster. /// public const string AttributeAwsEksClusterArn = "aws.eks.cluster.arn"; /// - /// The full invoked ARN as provided on the Context passed to the function (Lambda-Runtime-Invoked-Function-Arn header on the /runtime/invocation/next applicable) + /// The full invoked ARN as provided on the Context passed to the function (Lambda-Runtime-Invoked-Function-Arn header on the /runtime/invocation/next applicable). /// /// - /// This may be different from cloud.resource_id if an alias is involved + /// This may be different from cloud.resource_id if an alias is involved. /// public const string AttributeAwsLambdaInvokedArn = "aws.lambda.invoked_arn"; /// - /// The Amazon Resource Name(s) (ARN) of the AWS log group(s) + /// The Amazon Resource Name(s) (ARN) of the AWS log group(s). /// /// - /// See the log group ARN format documentation + /// See the log group ARN format documentation. /// public const string AttributeAwsLogGroupArns = "aws.log.group.arns"; /// - /// The name(s) of the AWS log group(s) an application is writing to + /// The name(s) of the AWS log group(s) an application is writing to. /// /// - /// Multiple log groups must be supported for cases like multi-container applications, where a single application has sidecar containers, and each write to their own log group + /// Multiple log groups must be supported for cases like multi-container applications, where a single application has sidecar containers, and each write to their own log group. /// public const string AttributeAwsLogGroupNames = "aws.log.group.names"; /// - /// The ARN(s) of the AWS log stream(s) + /// The ARN(s) of the AWS log stream(s). /// /// - /// See the log stream ARN format documentation. One log group can contain several log streams, so these ARNs necessarily identify both a log group and a log stream + /// See the log stream ARN format documentation. One log group can contain several log streams, so these ARNs necessarily identify both a log group and a log stream. /// public const string AttributeAwsLogStreamArns = "aws.log.stream.arns"; /// - /// The name(s) of the AWS log stream(s) an application is writing to + /// The name(s) of the AWS log stream(s) an application is writing to. /// public const string AttributeAwsLogStreamNames = "aws.log.stream.names"; /// - /// The AWS request ID as returned in the response headers x-amz-request-id or x-amz-requestid + /// The AWS request ID as returned in the response headers x-amz-request-id or x-amz-requestid. /// public const string AttributeAwsRequestId = "aws.request_id"; /// - /// The S3 bucket name the request refers to. Corresponds to the --bucket parameter of the S3 API operations + /// The S3 bucket name the request refers to. Corresponds to the --bucket parameter of the S3 API operations. /// /// /// The bucket attribute is applicable to all S3 operations that reference a bucket, i.e. that require the bucket name as a mandatory parameter. - /// This applies to almost all S3 operations except list-buckets + /// This applies to almost all S3 operations except list-buckets. /// public const string AttributeAwsS3Bucket = "aws.s3.bucket"; /// - /// The source object (in the form bucket/key) for the copy operation + /// The source object (in the form bucket/key) for the copy operation. /// /// /// The copy_source attribute applies to S3 copy operations and corresponds to the --copy-source parameter @@ -225,23 +225,23 @@ public static class AwsAttributes ///

///

/// public const string AttributeAwsS3CopySource = "aws.s3.copy_source"; /// - /// The delete request container that specifies the objects to be deleted + /// The delete request container that specifies the objects to be deleted. /// /// /// The delete attribute is only applicable to the delete-object operation. /// The delete attribute corresponds to the --delete parameter of the - /// delete-objects operation within the S3 API + /// delete-objects operation within the S3 API. /// public const string AttributeAwsS3Delete = "aws.s3.delete"; /// - /// The S3 object key the request refers to. Corresponds to the --key parameter of the S3 API operations + /// The S3 object key the request refers to. Corresponds to the --key parameter of the S3 API operations. /// /// /// The key attribute is applicable to all object-related S3 operations, i.e. that require the object key as a mandatory parameter. @@ -260,24 +260,24 @@ public static class AwsAttributes ///
  • create-multipart-upload
    • ///
  • list-parts
    • ///
  • upload-part
    • - ///
  • upload-part-copy
    • + ///
  • upload-part-copy.
    • /// ///     public const string AttributeAwsS3Key = "aws.s3.key"; /// - /// The part number of the part being uploaded in a multipart-upload operation. This is a positive integer between 1 and 10,000 + /// The part number of the part being uploaded in a multipart-upload operation. This is a positive integer between 1 and 10,000. /// /// /// The part_number attribute is only applicable to the upload-part /// and upload-part-copy operations. /// The part_number attribute corresponds to the --part-number parameter of the - /// upload-part operation within the S3 API + /// upload-part operation within the S3 API. /// public const string AttributeAwsS3PartNumber = "aws.s3.part_number"; /// - /// Upload ID that identifies the multipart upload + /// Upload ID that identifies the multipart upload. /// /// /// The upload_id attribute applies to S3 multipart-upload operations and corresponds to the --upload-id parameter @@ -289,23 +289,23 @@ public static class AwsAttributes ///
  • complete-multipart-upload
    • ///
  • list-parts
    • ///
  • upload-part
    • - ///
  • upload-part-copy
    • + ///
  • upload-part-copy.
    • /// ///     public const string AttributeAwsS3UploadId = "aws.s3.upload_id"; /// - /// The launch type for an ECS task + /// The launch type for an ECS task. /// public static class AwsEcsLaunchtypeValues { /// - /// ec2 + /// ec2. /// public const string Ec2 = "ec2"; /// - /// fargate + /// fargate. /// public const string Fargate = "fargate"; } diff --git a/src/OpenTelemetry.SemanticConventions/Attributes/AzAttributes.cs b/src/OpenTelemetry.SemanticConventions/Attributes/AzAttributes.cs index c0d96104b7..50a88c4b1f 100644 --- a/src/OpenTelemetry.SemanticConventions/Attributes/AzAttributes.cs +++ b/src/OpenTelemetry.SemanticConventions/Attributes/AzAttributes.cs @@ -15,7 +15,7 @@ namespace OpenTelemetry.SemanticConventions; public static class AzAttributes { /// - /// The unique identifier of the service request. It's generated by the Azure service and returned with the response + /// The unique identifier of the service request. It's generated by the Azure service and returned with the response. /// public const string AttributeAzServiceRequestId = "az.service_request_id"; } diff --git a/src/OpenTelemetry.SemanticConventions/Attributes/BrowserAttributes.cs b/src/OpenTelemetry.SemanticConventions/Attributes/BrowserAttributes.cs index d8a1891593..846e6fd23a 100644 --- a/src/OpenTelemetry.SemanticConventions/Attributes/BrowserAttributes.cs +++ b/src/OpenTelemetry.SemanticConventions/Attributes/BrowserAttributes.cs @@ -15,35 +15,35 @@ namespace OpenTelemetry.SemanticConventions; public static class BrowserAttributes { /// - /// Array of brand name and version separated by a space + /// Array of brand name and version separated by a space. /// /// - /// This value is intended to be taken from the UA client hints API (navigator.userAgentData.brands) + /// This value is intended to be taken from the UA client hints API (navigator.userAgentData.brands). /// public const string AttributeBrowserBrands = "browser.brands"; /// - /// Preferred language of the user using the browser + /// Preferred language of the user using the browser. /// /// - /// This value is intended to be taken from the Navigator API navigator.language + /// This value is intended to be taken from the Navigator API navigator.language. /// public const string AttributeBrowserLanguage = "browser.language"; /// - /// A boolean that is true if the browser is running on a mobile device + /// A boolean that is true if the browser is running on a mobile device. /// /// - /// This value is intended to be taken from the UA client hints API (navigator.userAgentData.mobile). If unavailable, this attribute SHOULD be left unset + /// This value is intended to be taken from the UA client hints API (navigator.userAgentData.mobile). If unavailable, this attribute SHOULD be left unset. /// public const string AttributeBrowserMobile = "browser.mobile"; /// - /// The platform on which the browser is running + /// The platform on which the browser is running. /// /// /// This value is intended to be taken from the UA client hints API (navigator.userAgentData.platform). If unavailable, the legacy navigator.platform API SHOULD NOT be used instead and this attribute SHOULD be left unset in order for the values to be consistent. - /// The list of possible values is defined in the W3C User-Agent Client Hints specification. Note that some (but not all) of these values can overlap with values in the os.type and os.name attributes. However, for consistency, the values in the browser.platform attribute should capture the exact value that the user agent provides + /// The list of possible values is defined in the W3C User-Agent Client Hints specification. Note that some (but not all) of these values can overlap with values in the os.type and os.name attributes. However, for consistency, the values in the browser.platform attribute should capture the exact value that the user agent provides. /// public const string AttributeBrowserPlatform = "browser.platform"; } diff --git a/src/OpenTelemetry.SemanticConventions/Attributes/CicdAttributes.cs b/src/OpenTelemetry.SemanticConventions/Attributes/CicdAttributes.cs index 447fa09887..3af1aed457 100644 --- a/src/OpenTelemetry.SemanticConventions/Attributes/CicdAttributes.cs +++ b/src/OpenTelemetry.SemanticConventions/Attributes/CicdAttributes.cs @@ -15,52 +15,52 @@ namespace OpenTelemetry.SemanticConventions; public static class CicdAttributes { /// - /// The human readable name of the pipeline within a CI/CD system + /// The human readable name of the pipeline within a CI/CD system. /// public const string AttributeCicdPipelineName = "cicd.pipeline.name"; /// - /// The unique identifier of a pipeline run within a CI/CD system + /// The unique identifier of a pipeline run within a CI/CD system. /// public const string AttributeCicdPipelineRunId = "cicd.pipeline.run.id"; /// - /// The human readable name of a task within a pipeline. Task here most closely aligns with a computing process in a pipeline. Other terms for tasks include commands, steps, and procedures + /// The human readable name of a task within a pipeline. Task here most closely aligns with a computing process in a pipeline. Other terms for tasks include commands, steps, and procedures. /// public const string AttributeCicdPipelineTaskName = "cicd.pipeline.task.name"; /// - /// The unique identifier of a task run within a pipeline + /// The unique identifier of a task run within a pipeline. /// public const string AttributeCicdPipelineTaskRunId = "cicd.pipeline.task.run.id"; /// - /// The URL of the pipeline run providing the complete address in order to locate and identify the pipeline run + /// The URL of the pipeline run providing the complete address in order to locate and identify the pipeline run. /// public const string AttributeCicdPipelineTaskRunUrlFull = "cicd.pipeline.task.run.url.full"; /// - /// The type of the task within a pipeline + /// The type of the task within a pipeline. /// public const string AttributeCicdPipelineTaskType = "cicd.pipeline.task.type"; /// - /// The type of the task within a pipeline + /// The type of the task within a pipeline. /// public static class CicdPipelineTaskTypeValues { /// - /// build + /// build. /// public const string Build = "build"; /// - /// test + /// test. /// public const string Test = "test"; /// - /// deploy + /// deploy. /// public const string Deploy = "deploy"; } diff --git a/src/OpenTelemetry.SemanticConventions/Attributes/ClientAttributes.cs b/src/OpenTelemetry.SemanticConventions/Attributes/ClientAttributes.cs index d8aa303707..029524ba8c 100644 --- a/src/OpenTelemetry.SemanticConventions/Attributes/ClientAttributes.cs +++ b/src/OpenTelemetry.SemanticConventions/Attributes/ClientAttributes.cs @@ -15,18 +15,18 @@ namespace OpenTelemetry.SemanticConventions; public static class ClientAttributes { /// - /// Client address - domain name if available without reverse DNS lookup; otherwise, IP address or Unix domain socket name + /// Client address - domain name if available without reverse DNS lookup; otherwise, IP address or Unix domain socket name. /// /// - /// When observed from the server side, and when communicating through an intermediary, client.address SHOULD represent the client address behind any intermediaries, for example proxies, if it's available + /// When observed from the server side, and when communicating through an intermediary, client.address SHOULD represent the client address behind any intermediaries, for example proxies, if it's available. /// public const string AttributeClientAddress = "client.address"; /// - /// Client port number + /// Client port number. /// /// - /// When observed from the server side, and when communicating through an intermediary, client.port SHOULD represent the client port behind any intermediaries, for example proxies, if it's available + /// When observed from the server side, and when communicating through an intermediary, client.port SHOULD represent the client port behind any intermediaries, for example proxies, if it's available. /// public const string AttributeClientPort = "client.port"; } diff --git a/src/OpenTelemetry.SemanticConventions/Attributes/CloudAttributes.cs b/src/OpenTelemetry.SemanticConventions/Attributes/CloudAttributes.cs index 5906c9d812..d8dcd99627 100644 --- a/src/OpenTelemetry.SemanticConventions/Attributes/CloudAttributes.cs +++ b/src/OpenTelemetry.SemanticConventions/Attributes/CloudAttributes.cs @@ -15,41 +15,41 @@ namespace OpenTelemetry.SemanticConventions; public static class CloudAttributes { /// - /// The cloud account ID the resource is assigned to + /// The cloud account ID the resource is assigned to. /// public const string AttributeCloudAccountId = "cloud.account.id"; /// - /// Cloud regions often have multiple, isolated locations known as zones to increase availability. Availability zone represents the zone where the resource is running + /// Cloud regions often have multiple, isolated locations known as zones to increase availability. Availability zone represents the zone where the resource is running. /// /// - /// Availability zones are called "zones" on Alibaba Cloud and Google Cloud + /// Availability zones are called "zones" on Alibaba Cloud and Google Cloud. /// public const string AttributeCloudAvailabilityZone = "cloud.availability_zone"; /// - /// The cloud platform in use + /// The cloud platform in use. /// /// - /// The prefix of the service SHOULD match the one specified in cloud.provider + /// The prefix of the service SHOULD match the one specified in cloud.provider. /// public const string AttributeCloudPlatform = "cloud.platform"; /// - /// Name of the cloud provider + /// Name of the cloud provider. /// public const string AttributeCloudProvider = "cloud.provider"; /// - /// The geographical region the resource is running + /// The geographical region the resource is running. /// /// - /// Refer to your provider's docs to see the available regions, for example Alibaba Cloud regions, AWS regions, Azure regions, Google Cloud regions, or Tencent Cloud regions + /// Refer to your provider's docs to see the available regions, for example Alibaba Cloud regions, AWS regions, Azure regions, Google Cloud regions, or Tencent Cloud regions. /// public const string AttributeCloudRegion = "cloud.region"; /// - /// Cloud provider-specific native identifier of the monitored cloud resource (e.g. an ARN on AWS, a fully qualified resource ID on Azure, a full resource name on GCP) + /// Cloud provider-specific native identifier of the monitored cloud resource (e.g. an ARN on AWS, a fully qualified resource ID on Azure, a full resource name on GCP). /// /// /// On some cloud providers, it may not be possible to determine the full ID at startup, @@ -69,194 +69,194 @@ public static class CloudAttributes /// not the function app, having the form /// /subscriptions//resourceGroups//providers/Microsoft.Web/sites//functions/. /// This means that a span attribute MUST be used, as an Azure function app can host multiple functions that would usually share - /// a TracerProvider + /// a TracerProvider. /// /// public const string AttributeCloudResourceId = "cloud.resource_id"; /// - /// The cloud platform in use + /// The cloud platform in use. /// public static class CloudPlatformValues { /// - /// Alibaba Cloud Elastic Compute Service + /// Alibaba Cloud Elastic Compute Service. /// public const string AlibabaCloudEcs = "alibaba_cloud_ecs"; /// - /// Alibaba Cloud Function Compute + /// Alibaba Cloud Function Compute. /// public const string AlibabaCloudFc = "alibaba_cloud_fc"; /// - /// Red Hat OpenShift on Alibaba Cloud + /// Red Hat OpenShift on Alibaba Cloud. /// public const string AlibabaCloudOpenshift = "alibaba_cloud_openshift"; /// - /// AWS Elastic Compute Cloud + /// AWS Elastic Compute Cloud. /// public const string AwsEc2 = "aws_ec2"; /// - /// AWS Elastic Container Service + /// AWS Elastic Container Service. /// public const string AwsEcs = "aws_ecs"; /// - /// AWS Elastic Kubernetes Service + /// AWS Elastic Kubernetes Service. /// public const string AwsEks = "aws_eks"; /// - /// AWS Lambda + /// AWS Lambda. /// public const string AwsLambda = "aws_lambda"; /// - /// AWS Elastic Beanstalk + /// AWS Elastic Beanstalk. /// public const string AwsElasticBeanstalk = "aws_elastic_beanstalk"; /// - /// AWS App Runner + /// AWS App Runner. /// public const string AwsAppRunner = "aws_app_runner"; /// - /// Red Hat OpenShift on AWS (ROSA) + /// Red Hat OpenShift on AWS (ROSA). /// public const string AwsOpenshift = "aws_openshift"; /// - /// Azure Virtual Machines + /// Azure Virtual Machines. /// public const string AzureVm = "azure_vm"; /// - /// Azure Container Apps + /// Azure Container Apps. /// public const string AzureContainerApps = "azure_container_apps"; /// - /// Azure Container Instances + /// Azure Container Instances. /// public const string AzureContainerInstances = "azure_container_instances"; /// - /// Azure Kubernetes Service + /// Azure Kubernetes Service. /// public const string AzureAks = "azure_aks"; /// - /// Azure Functions + /// Azure Functions. /// public const string AzureFunctions = "azure_functions"; /// - /// Azure App Service + /// Azure App Service. /// public const string AzureAppService = "azure_app_service"; /// - /// Azure Red Hat OpenShift + /// Azure Red Hat OpenShift. /// public const string AzureOpenshift = "azure_openshift"; /// - /// Google Bare Metal Solution (BMS) + /// Google Bare Metal Solution (BMS). /// public const string GcpBareMetalSolution = "gcp_bare_metal_solution"; /// - /// Google Cloud Compute Engine (GCE) + /// Google Cloud Compute Engine (GCE). /// public const string GcpComputeEngine = "gcp_compute_engine"; /// - /// Google Cloud Run + /// Google Cloud Run. /// public const string GcpCloudRun = "gcp_cloud_run"; /// - /// Google Cloud Kubernetes Engine (GKE) + /// Google Cloud Kubernetes Engine (GKE). /// public const string GcpKubernetesEngine = "gcp_kubernetes_engine"; /// - /// Google Cloud Functions (GCF) + /// Google Cloud Functions (GCF). /// public const string GcpCloudFunctions = "gcp_cloud_functions"; /// - /// Google Cloud App Engine (GAE) + /// Google Cloud App Engine (GAE). /// public const string GcpAppEngine = "gcp_app_engine"; /// - /// Red Hat OpenShift on Google Cloud + /// Red Hat OpenShift on Google Cloud. /// public const string GcpOpenshift = "gcp_openshift"; /// - /// Red Hat OpenShift on IBM Cloud + /// Red Hat OpenShift on IBM Cloud. /// public const string IbmCloudOpenshift = "ibm_cloud_openshift"; /// - /// Tencent Cloud Cloud Virtual Machine (CVM) + /// Tencent Cloud Cloud Virtual Machine (CVM). /// public const string TencentCloudCvm = "tencent_cloud_cvm"; /// - /// Tencent Cloud Elastic Kubernetes Service (EKS) + /// Tencent Cloud Elastic Kubernetes Service (EKS). /// public const string TencentCloudEks = "tencent_cloud_eks"; /// - /// Tencent Cloud Serverless Cloud Function (SCF) + /// Tencent Cloud Serverless Cloud Function (SCF). /// public const string TencentCloudScf = "tencent_cloud_scf"; } /// - /// Name of the cloud provider + /// Name of the cloud provider. /// public static class CloudProviderValues { /// - /// Alibaba Cloud + /// Alibaba Cloud. /// public const string AlibabaCloud = "alibaba_cloud"; /// - /// Amazon Web Services + /// Amazon Web Services. /// public const string Aws = "aws"; /// - /// Microsoft Azure + /// Microsoft Azure. /// public const string Azure = "azure"; /// - /// Google Cloud Platform + /// Google Cloud Platform. /// public const string Gcp = "gcp"; /// - /// Heroku Platform as a Service + /// Heroku Platform as a Service. /// public const string Heroku = "heroku"; /// - /// IBM Cloud + /// IBM Cloud. /// public const string IbmCloud = "ibm_cloud"; /// - /// Tencent Cloud + /// Tencent Cloud. /// public const string TencentCloud = "tencent_cloud"; } diff --git a/src/OpenTelemetry.SemanticConventions/Attributes/CloudeventsAttributes.cs b/src/OpenTelemetry.SemanticConventions/Attributes/CloudeventsAttributes.cs index 7c13858791..d334bc1667 100644 --- a/src/OpenTelemetry.SemanticConventions/Attributes/CloudeventsAttributes.cs +++ b/src/OpenTelemetry.SemanticConventions/Attributes/CloudeventsAttributes.cs @@ -15,27 +15,27 @@ namespace OpenTelemetry.SemanticConventions; public static class CloudeventsAttributes { /// - /// The event_id uniquely identifies the event + /// The event_id uniquely identifies the event. /// public const string AttributeCloudeventsEventId = "cloudevents.event_id"; /// - /// The source identifies the context in which an event happened + /// The source identifies the context in which an event happened. /// public const string AttributeCloudeventsEventSource = "cloudevents.event_source"; /// - /// The version of the CloudEvents specification which the event uses + /// The version of the CloudEvents specification which the event uses. /// public const string AttributeCloudeventsEventSpecVersion = "cloudevents.event_spec_version"; /// - /// The subject of the event in the context of the event producer (identified by source) + /// The subject of the event in the context of the event producer (identified by source). /// public const string AttributeCloudeventsEventSubject = "cloudevents.event_subject"; /// - /// The event_type contains a value describing the type of event related to the originating occurrence + /// The event_type contains a value describing the type of event related to the originating occurrence. /// public const string AttributeCloudeventsEventType = "cloudevents.event_type"; } diff --git a/src/OpenTelemetry.SemanticConventions/Attributes/CodeAttributes.cs b/src/OpenTelemetry.SemanticConventions/Attributes/CodeAttributes.cs index 41eee11105..065149dc52 100644 --- a/src/OpenTelemetry.SemanticConventions/Attributes/CodeAttributes.cs +++ b/src/OpenTelemetry.SemanticConventions/Attributes/CodeAttributes.cs @@ -15,32 +15,32 @@ namespace OpenTelemetry.SemanticConventions; public static class CodeAttributes { /// - /// The column number in code.filepath best representing the operation. It SHOULD point within the code unit named in code.function + /// The column number in code.filepath best representing the operation. It SHOULD point within the code unit named in code.function. /// public const string AttributeCodeColumn = "code.column"; /// - /// The source code file name that identifies the code unit as uniquely as possible (preferably an absolute file path) + /// The source code file name that identifies the code unit as uniquely as possible (preferably an absolute file path). /// public const string AttributeCodeFilepath = "code.filepath"; /// - /// The method or function name, or equivalent (usually rightmost part of the code unit's name) + /// The method or function name, or equivalent (usually rightmost part of the code unit's name). /// public const string AttributeCodeFunction = "code.function"; /// - /// The line number in code.filepath best representing the operation. It SHOULD point within the code unit named in code.function + /// The line number in code.filepath best representing the operation. It SHOULD point within the code unit named in code.function. /// public const string AttributeCodeLineno = "code.lineno"; /// - /// The "namespace" within which code.function is defined. Usually the qualified class or module name, such that code.namespace + some separator + code.function form a unique identifier for the code unit + /// The "namespace" within which code.function is defined. Usually the qualified class or module name, such that code.namespace + some separator + code.function form a unique identifier for the code unit. /// public const string AttributeCodeNamespace = "code.namespace"; /// - /// A stacktrace as a string in the natural representation for the language runtime. The representation is to be determined and documented by each language SIG + /// A stacktrace as a string in the natural representation for the language runtime. The representation is to be determined and documented by each language SIG. /// public const string AttributeCodeStacktrace = "code.stacktrace"; } diff --git a/src/OpenTelemetry.SemanticConventions/Attributes/ContainerAttributes.cs b/src/OpenTelemetry.SemanticConventions/Attributes/ContainerAttributes.cs index cd4bd4e3e3..955f1f8e0a 100644 --- a/src/OpenTelemetry.SemanticConventions/Attributes/ContainerAttributes.cs +++ b/src/OpenTelemetry.SemanticConventions/Attributes/ContainerAttributes.cs @@ -15,104 +15,104 @@ namespace OpenTelemetry.SemanticConventions; public static class ContainerAttributes { /// - /// The command used to run the container (i.e. the command name) + /// The command used to run the container (i.e. the command name). /// /// - /// If using embedded credentials or sensitive data, it is recommended to remove them to prevent potential leakage + /// If using embedded credentials or sensitive data, it is recommended to remove them to prevent potential leakage. /// public const string AttributeContainerCommand = "container.command"; /// - /// All the command arguments (including the command/executable itself) run by the container. [2] + /// All the command arguments (including the command/executable itself) run by the container. [2]. /// public const string AttributeContainerCommandArgs = "container.command_args"; /// - /// The full command run by the container as a single string representing the full command. [2] + /// The full command run by the container as a single string representing the full command. [2]. /// public const string AttributeContainerCommandLine = "container.command_line"; /// - /// Deprecated, use cpu.mode instead + /// Deprecated, use cpu.mode instead. /// - [Obsolete("Replaced by cpu.mode")] + [Obsolete("Replaced by cpu.mode.")] public const string AttributeContainerCpuState = "container.cpu.state"; /// - /// Container ID. Usually a UUID, as for example used to identify Docker containers. The UUID might be abbreviated + /// Container ID. Usually a UUID, as for example used to identify Docker containers. The UUID might be abbreviated. /// public const string AttributeContainerId = "container.id"; /// - /// Runtime specific image identifier. Usually a hash algorithm followed by a UUID + /// Runtime specific image identifier. Usually a hash algorithm followed by a UUID. /// /// /// Docker defines a sha256 of the image id; container.image.id corresponds to the Image field from the Docker container inspect API endpoint. /// K8s defines a link to the container registry repository with digest "imageID": "registry.azurecr.io /namespace/service/dockerfile@sha256:bdeabd40c3a8a492eaf9e8e44d0ebbb84bac7ee25ac0cf8a7159d25f62555625". - /// The ID is assigned by the container runtime and can vary in different environments. Consider using oci.manifest.digest if it is important to identify the same image in different environments/runtimes + /// The ID is assigned by the container runtime and can vary in different environments. Consider using oci.manifest.digest if it is important to identify the same image in different environments/runtimes. /// public const string AttributeContainerImageId = "container.image.id"; /// - /// Name of the image the container was built on + /// Name of the image the container was built on. /// public const string AttributeContainerImageName = "container.image.name"; /// - /// Repo digests of the container image as provided by the container runtime + /// Repo digests of the container image as provided by the container runtime. /// /// - /// Docker and CRI report those under the RepoDigests field + /// Docker and CRI report those under the RepoDigests field. /// public const string AttributeContainerImageRepoDigests = "container.image.repo_digests"; /// - /// Container image tags. An example can be found in Docker Image Inspect. Should be only the section of the full name for example from registry.example.com/my-org/my-image: + /// Container image tags. An example can be found in Docker Image Inspect. Should be only the section of the full name for example from registry.example.com/my-org/my-image:. /// public const string AttributeContainerImageTags = "container.image.tags"; /// - /// Container labels, being the label name, the value being the label value + /// Container labels, being the label name, the value being the label value. /// public const string AttributeContainerLabelTemplate = "container.label"; /// - /// Deprecated, use container.label instead + /// Deprecated, use container.label instead. /// - [Obsolete("Replaced by container.label")] + [Obsolete("Replaced by container.label.")] public const string AttributeContainerLabelsTemplate = "container.labels"; /// - /// Container name used by container runtime + /// Container name used by container runtime. /// public const string AttributeContainerName = "container.name"; /// - /// The container runtime managing this container + /// The container runtime managing this container. /// public const string AttributeContainerRuntime = "container.runtime"; /// - /// Deprecated, use cpu.mode instead + /// Deprecated, use cpu.mode instead. /// public static class ContainerCpuStateValues { /// - /// When tasks of the cgroup are in user mode (Linux). When all container processes are in user mode (Windows) + /// When tasks of the cgroup are in user mode (Linux). When all container processes are in user mode (Windows). /// - [Obsolete("Replaced by cpu.mode")] + [Obsolete("Replaced by cpu.mode.")] public const string User = "user"; /// - /// When CPU is used by the system (host OS) + /// When CPU is used by the system (host OS). /// - [Obsolete("Replaced by cpu.mode")] + [Obsolete("Replaced by cpu.mode.")] public const string System = "system"; /// - /// When tasks of the cgroup are in kernel mode (Linux). When all container processes are in kernel mode (Windows) + /// When tasks of the cgroup are in kernel mode (Linux). When all container processes are in kernel mode (Windows). /// - [Obsolete("Replaced by cpu.mode")] + [Obsolete("Replaced by cpu.mode.")] public const string Kernel = "kernel"; } } diff --git a/src/OpenTelemetry.SemanticConventions/Attributes/CpuAttributes.cs b/src/OpenTelemetry.SemanticConventions/Attributes/CpuAttributes.cs index 9e04aee7cf..d5f227e744 100644 --- a/src/OpenTelemetry.SemanticConventions/Attributes/CpuAttributes.cs +++ b/src/OpenTelemetry.SemanticConventions/Attributes/CpuAttributes.cs @@ -15,52 +15,52 @@ namespace OpenTelemetry.SemanticConventions; public static class CpuAttributes { /// - /// The mode of the CPU + /// The mode of the CPU. /// public const string AttributeCpuMode = "cpu.mode"; /// - /// The mode of the CPU + /// The mode of the CPU. /// public static class CpuModeValues { /// - /// user + /// user. /// public const string User = "user"; /// - /// system + /// system. /// public const string System = "system"; /// - /// nice + /// nice. /// public const string Nice = "nice"; /// - /// idle + /// idle. /// public const string Idle = "idle"; /// - /// iowait + /// iowait. /// public const string Iowait = "iowait"; /// - /// interrupt + /// interrupt. /// public const string Interrupt = "interrupt"; /// - /// steal + /// steal. /// public const string Steal = "steal"; /// - /// kernel + /// kernel. /// public const string Kernel = "kernel"; } diff --git a/src/OpenTelemetry.SemanticConventions/Attributes/DbAttributes.cs b/src/OpenTelemetry.SemanticConventions/Attributes/DbAttributes.cs index 7f728af41a..adaef65554 100644 --- a/src/OpenTelemetry.SemanticConventions/Attributes/DbAttributes.cs +++ b/src/OpenTelemetry.SemanticConventions/Attributes/DbAttributes.cs @@ -15,718 +15,718 @@ namespace OpenTelemetry.SemanticConventions; public static class DbAttributes { /// - /// The consistency level of the query. Based on consistency values from CQL + /// The consistency level of the query. Based on consistency values from CQL. /// public const string AttributeDbCassandraConsistencyLevel = "db.cassandra.consistency_level"; /// - /// The data center of the coordinating node for a query + /// The data center of the coordinating node for a query. /// public const string AttributeDbCassandraCoordinatorDc = "db.cassandra.coordinator.dc"; /// - /// The ID of the coordinating node for a query + /// The ID of the coordinating node for a query. /// public const string AttributeDbCassandraCoordinatorId = "db.cassandra.coordinator.id"; /// - /// Whether or not the query is idempotent + /// Whether or not the query is idempotent. /// public const string AttributeDbCassandraIdempotence = "db.cassandra.idempotence"; /// - /// The fetch size used for paging, i.e. how many rows will be returned at once + /// The fetch size used for paging, i.e. how many rows will be returned at once. /// public const string AttributeDbCassandraPageSize = "db.cassandra.page_size"; /// - /// The number of times a query was speculatively executed. Not set or 0 if the query was not executed speculatively + /// The number of times a query was speculatively executed. Not set or 0 if the query was not executed speculatively. /// public const string AttributeDbCassandraSpeculativeExecutionCount = "db.cassandra.speculative_execution_count"; /// - /// Deprecated, use db.collection.name instead + /// Deprecated, use db.collection.name instead. /// - [Obsolete("Replaced by db.collection.name")] + [Obsolete("Replaced by db.collection.name.")] public const string AttributeDbCassandraTable = "db.cassandra.table"; /// - /// The name of the connection pool; unique within the instrumented application. In case the connection pool implementation doesn't provide a name, instrumentation SHOULD use a combination of parameters that would make the name unique, for example, combining attributes server.address, server.port, and db.namespace, formatted as server.address:server.port/db.namespace. Instrumentations that generate connection pool name following different patterns SHOULD document it + /// The name of the connection pool; unique within the instrumented application. In case the connection pool implementation doesn't provide a name, instrumentation SHOULD use a combination of parameters that would make the name unique, for example, combining attributes server.address, server.port, and db.namespace, formatted as server.address:server.port/db.namespace. Instrumentations that generate connection pool name following different patterns SHOULD document it. /// public const string AttributeDbClientConnectionPoolName = "db.client.connection.pool.name"; /// - /// The state of a connection in the pool + /// The state of a connection in the pool. /// public const string AttributeDbClientConnectionState = "db.client.connection.state"; /// - /// Deprecated, use db.client.connection.pool.name instead + /// Deprecated, use db.client.connection.pool.name instead. /// - [Obsolete("Replaced by db.client.connection.pool.name")] + [Obsolete("Replaced by db.client.connection.pool.name.")] public const string AttributeDbClientConnectionsPoolName = "db.client.connections.pool.name"; /// - /// Deprecated, use db.client.connection.state instead + /// Deprecated, use db.client.connection.state instead. /// - [Obsolete("Replaced by db.client.connection.state")] + [Obsolete("Replaced by db.client.connection.state.")] public const string AttributeDbClientConnectionsState = "db.client.connections.state"; /// - /// The name of a collection (table, container) within the database + /// The name of a collection (table, container) within the database. /// /// /// It is RECOMMENDED to capture the value as provided by the application without attempting to do any case normalization. /// If the collection name is parsed from the query text, it SHOULD be the first collection name found in the query and it SHOULD match the value provided in the query text including any schema and database name prefix. - /// For batch operations, if the individual operations are known to have the same collection name then that collection name SHOULD be used, otherwise db.collection.name SHOULD NOT be captured + /// For batch operations, if the individual operations are known to have the same collection name then that collection name SHOULD be used, otherwise db.collection.name SHOULD NOT be captured. /// public const string AttributeDbCollectionName = "db.collection.name"; /// - /// Deprecated, use server.address, server.port attributes instead + /// Deprecated, use server.address, server.port attributes instead. /// - [Obsolete("Replaced by server.address and server.port")] + [Obsolete("Replaced by server.address and server.port.")] public const string AttributeDbConnectionString = "db.connection_string"; /// - /// Unique Cosmos client instance id + /// Unique Cosmos client instance id. /// public const string AttributeDbCosmosdbClientId = "db.cosmosdb.client_id"; /// - /// Cosmos client connection mode + /// Cosmos client connection mode. /// public const string AttributeDbCosmosdbConnectionMode = "db.cosmosdb.connection_mode"; /// - /// Deprecated, use db.collection.name instead + /// Deprecated, use db.collection.name instead. /// - [Obsolete("Replaced by db.collection.name")] + [Obsolete("Replaced by db.collection.name.")] public const string AttributeDbCosmosdbContainer = "db.cosmosdb.container"; /// - /// CosmosDB Operation Type + /// CosmosDB Operation Type. /// public const string AttributeDbCosmosdbOperationType = "db.cosmosdb.operation_type"; /// - /// RU consumed for that operation + /// RU consumed for that operation. /// public const string AttributeDbCosmosdbRequestCharge = "db.cosmosdb.request_charge"; /// - /// Request payload size in bytes + /// Request payload size in bytes. /// public const string AttributeDbCosmosdbRequestContentLength = "db.cosmosdb.request_content_length"; /// - /// Cosmos DB status code + /// Cosmos DB status code. /// public const string AttributeDbCosmosdbStatusCode = "db.cosmosdb.status_code"; /// - /// Cosmos DB sub status code + /// Cosmos DB sub status code. /// public const string AttributeDbCosmosdbSubStatusCode = "db.cosmosdb.sub_status_code"; /// - /// Deprecated, use db.namespace instead + /// Deprecated, use db.namespace instead. /// - [Obsolete("Replaced by db.namespace")] + [Obsolete("Replaced by db.namespace.")] public const string AttributeDbElasticsearchClusterName = "db.elasticsearch.cluster.name"; /// - /// Represents the human-readable identifier of the node/instance to which a request was routed + /// Represents the human-readable identifier of the node/instance to which a request was routed. /// public const string AttributeDbElasticsearchNodeName = "db.elasticsearch.node.name"; /// - /// A dynamic value in the url path + /// A dynamic value in the url path. /// /// - /// Many Elasticsearch url paths allow dynamic values. These SHOULD be recorded in span attributes in the format db.elasticsearch.path_parts., where is the url path part name. The implementation SHOULD reference the elasticsearch schema in order to map the path part values to their names + /// Many Elasticsearch url paths allow dynamic values. These SHOULD be recorded in span attributes in the format db.elasticsearch.path_parts., where is the url path part name. The implementation SHOULD reference the elasticsearch schema in order to map the path part values to their names. /// public const string AttributeDbElasticsearchPathPartsTemplate = "db.elasticsearch.path_parts"; /// - /// Deprecated, no general replacement at this time. For Elasticsearch, use db.elasticsearch.node.name instead + /// Deprecated, no general replacement at this time. For Elasticsearch, use db.elasticsearch.node.name instead. /// - [Obsolete("Deprecated, no general replacement at this time. For Elasticsearch, use db.elasticsearch.node.name instead")] + [Obsolete("Deprecated, no general replacement at this time. For Elasticsearch, use db.elasticsearch.node.name instead.")] public const string AttributeDbInstanceId = "db.instance.id"; /// - /// Removed, no replacement at this time + /// Removed, no replacement at this time. /// - [Obsolete("Removed as not used")] + [Obsolete("Removed as not used.")] public const string AttributeDbJdbcDriverClassname = "db.jdbc.driver_classname"; /// - /// Deprecated, use db.collection.name instead + /// Deprecated, use db.collection.name instead. /// - [Obsolete("Replaced by db.collection.name")] + [Obsolete("Replaced by db.collection.name.")] public const string AttributeDbMongodbCollection = "db.mongodb.collection"; /// - /// Deprecated, SQL Server instance is now populated as a part of db.namespace attribute + /// Deprecated, SQL Server instance is now populated as a part of db.namespace attribute. /// - [Obsolete("Deprecated, no replacement at this time")] + [Obsolete("Deprecated, no replacement at this time.")] public const string AttributeDbMssqlInstanceName = "db.mssql.instance_name"; /// - /// Deprecated, use db.namespace instead + /// Deprecated, use db.namespace instead. /// - [Obsolete("Replaced by db.namespace")] + [Obsolete("Replaced by db.namespace.")] public const string AttributeDbName = "db.name"; /// - /// The name of the database, fully qualified within the server address and port + /// The name of the database, fully qualified within the server address and port. /// /// /// If a database system has multiple namespace components, they SHOULD be concatenated (potentially using database system specific conventions) from most general to most specific namespace component, and more specific namespaces SHOULD NOT be captured without the more general namespaces, to ensure that "startswith" queries for the more general namespaces will be valid. /// Semantic conventions for individual database systems SHOULD document what db.namespace means in the context of that system. - /// It is RECOMMENDED to capture the value as provided by the application without attempting to do any case normalization + /// It is RECOMMENDED to capture the value as provided by the application without attempting to do any case normalization. /// public const string AttributeDbNamespace = "db.namespace"; /// - /// Deprecated, use db.operation.name instead + /// Deprecated, use db.operation.name instead. /// - [Obsolete("Replaced by db.operation.name")] + [Obsolete("Replaced by db.operation.name.")] public const string AttributeDbOperation = "db.operation"; /// - /// The number of queries included in a batch operation + /// The number of queries included in a batch operation. /// /// - /// Operations are only considered batches when they contain two or more operations, and so db.operation.batch.size SHOULD never be 1 + /// Operations are only considered batches when they contain two or more operations, and so db.operation.batch.size SHOULD never be 1. /// public const string AttributeDbOperationBatchSize = "db.operation.batch.size"; /// - /// The name of the operation or command being executed + /// The name of the operation or command being executed. /// /// /// It is RECOMMENDED to capture the value as provided by the application without attempting to do any case normalization. /// If the operation name is parsed from the query text, it SHOULD be the first operation name found in the query. - /// For batch operations, if the individual operations are known to have the same operation name then that operation name SHOULD be used prepended by BATCH , otherwise db.operation.name SHOULD be BATCH or some other database system specific term if more applicable + /// For batch operations, if the individual operations are known to have the same operation name then that operation name SHOULD be used prepended by BATCH , otherwise db.operation.name SHOULD be BATCH or some other database system specific term if more applicable. /// public const string AttributeDbOperationName = "db.operation.name"; /// - /// A query parameter used in db.query.text, with being the parameter name, and the attribute value being a string representation of the parameter value + /// A query parameter used in db.query.text, with being the parameter name, and the attribute value being a string representation of the parameter value. /// /// /// Query parameters should only be captured when db.query.text is parameterized with placeholders. - /// If a parameter has no name and instead is referenced only by index, then SHOULD be the 0-based index + /// If a parameter has no name and instead is referenced only by index, then SHOULD be the 0-based index. /// public const string AttributeDbQueryParameterTemplate = "db.query.parameter"; /// - /// The database query being executed + /// The database query being executed. /// /// /// For sanitization see Sanitization of db.query.text. /// For batch operations, if the individual operations are known to have the same query text then that query text SHOULD be used, otherwise all of the individual query texts SHOULD be concatenated with separator ; or some other database system specific separator if more applicable. - /// Even though parameterized query text can potentially have sensitive data, by using a parameterized query the user is giving a strong signal that any sensitive data will be passed as parameter values, and the benefit to observability of capturing the static part of the query text by default outweighs the risk + /// Even though parameterized query text can potentially have sensitive data, by using a parameterized query the user is giving a strong signal that any sensitive data will be passed as parameter values, and the benefit to observability of capturing the static part of the query text by default outweighs the risk. /// public const string AttributeDbQueryText = "db.query.text"; /// - /// Deprecated, use db.namespace instead + /// Deprecated, use db.namespace instead. /// - [Obsolete("Replaced by db.namespace")] + [Obsolete("Replaced by db.namespace.")] public const string AttributeDbRedisDatabaseIndex = "db.redis.database_index"; /// - /// Deprecated, use db.collection.name instead + /// Deprecated, use db.collection.name instead. /// - [Obsolete("Replaced by db.collection.name")] + [Obsolete("Replaced by db.collection.name.")] public const string AttributeDbSqlTable = "db.sql.table"; /// - /// The database statement being executed + /// The database statement being executed. /// - [Obsolete("Replaced by db.query.text")] + [Obsolete("Replaced by db.query.text.")] public const string AttributeDbStatement = "db.statement"; /// - /// The database management system (DBMS) product as identified by the client instrumentation + /// The database management system (DBMS) product as identified by the client instrumentation. /// /// - /// The actual DBMS may differ from the one identified by the client. For example, when using PostgreSQL client libraries to connect to a CockroachDB, the db.system is set to postgresql based on the instrumentation's best knowledge + /// The actual DBMS may differ from the one identified by the client. For example, when using PostgreSQL client libraries to connect to a CockroachDB, the db.system is set to postgresql based on the instrumentation's best knowledge. /// public const string AttributeDbSystem = "db.system"; /// - /// Deprecated, no replacement at this time + /// Deprecated, no replacement at this time. /// - [Obsolete("No replacement at this time")] + [Obsolete("No replacement at this time.")] public const string AttributeDbUser = "db.user"; /// - /// The consistency level of the query. Based on consistency values from CQL + /// The consistency level of the query. Based on consistency values from CQL. /// public static class DbCassandraConsistencyLevelValues { /// - /// all + /// all. /// public const string All = "all"; /// - /// each_quorum + /// each_quorum. /// public const string EachQuorum = "each_quorum"; /// - /// quorum + /// quorum. /// public const string Quorum = "quorum"; /// - /// local_quorum + /// local_quorum. /// public const string LocalQuorum = "local_quorum"; /// - /// one + /// one. /// public const string One = "one"; /// - /// two + /// two. /// public const string Two = "two"; /// - /// three + /// three. /// public const string Three = "three"; /// - /// local_one + /// local_one. /// public const string LocalOne = "local_one"; /// - /// any + /// any. /// public const string Any = "any"; /// - /// serial + /// serial. /// public const string Serial = "serial"; /// - /// local_serial + /// local_serial. /// public const string LocalSerial = "local_serial"; } /// - /// The state of a connection in the pool + /// The state of a connection in the pool. /// public static class DbClientConnectionStateValues { /// - /// idle + /// idle. /// public const string Idle = "idle"; /// - /// used + /// used. /// public const string Used = "used"; } /// - /// Deprecated, use db.client.connection.state instead + /// Deprecated, use db.client.connection.state instead. /// public static class DbClientConnectionsStateValues { /// - /// idle + /// idle. /// - [Obsolete("Replaced by db.client.connection.state")] + [Obsolete("Replaced by db.client.connection.state.")] public const string Idle = "idle"; /// - /// used + /// used. /// - [Obsolete("Replaced by db.client.connection.state")] + [Obsolete("Replaced by db.client.connection.state.")] public const string Used = "used"; } /// - /// Cosmos client connection mode + /// Cosmos client connection mode. /// public static class DbCosmosdbConnectionModeValues { /// - /// Gateway (HTTP) connections mode + /// Gateway (HTTP) connections mode. /// public const string Gateway = "gateway"; /// - /// Direct connection + /// Direct connection. /// public const string Direct = "direct"; } /// - /// CosmosDB Operation Type + /// CosmosDB Operation Type. /// public static class DbCosmosdbOperationTypeValues { /// - /// invalid + /// invalid. /// public const string Invalid = "Invalid"; /// - /// create + /// create. /// public const string Create = "Create"; /// - /// patch + /// patch. /// public const string Patch = "Patch"; /// - /// read + /// read. /// public const string Read = "Read"; /// - /// read_feed + /// read_feed. /// public const string ReadFeed = "ReadFeed"; /// - /// delete + /// delete. /// public const string Delete = "Delete"; /// - /// replace + /// replace. /// public const string Replace = "Replace"; /// - /// execute + /// execute. /// public const string Execute = "Execute"; /// - /// query + /// query. /// public const string Query = "Query"; /// - /// head + /// head. /// public const string Head = "Head"; /// - /// head_feed + /// head_feed. /// public const string HeadFeed = "HeadFeed"; /// - /// upsert + /// upsert. /// public const string Upsert = "Upsert"; /// - /// batch + /// batch. /// public const string Batch = "Batch"; /// - /// query_plan + /// query_plan. /// public const string QueryPlan = "QueryPlan"; /// - /// execute_javascript + /// execute_javascript. /// public const string ExecuteJavascript = "ExecuteJavaScript"; } /// - /// The database management system (DBMS) product as identified by the client instrumentation + /// The database management system (DBMS) product as identified by the client instrumentation. /// public static class DbSystemValues { /// - /// Some other SQL database. Fallback only. See notes + /// Some other SQL database. Fallback only. See notes. /// public const string OtherSql = "other_sql"; /// - /// Adabas (Adaptable Database System) + /// Adabas (Adaptable Database System). /// public const string Adabas = "adabas"; /// - /// Deprecated, use intersystems_cache instead + /// Deprecated, use intersystems_cache instead. /// public const string Cache = "cache"; /// - /// InterSystems Caché + /// InterSystems Caché. /// public const string IntersystemsCache = "intersystems_cache"; /// - /// Apache Cassandra + /// Apache Cassandra. /// public const string Cassandra = "cassandra"; /// - /// ClickHouse + /// ClickHouse. /// public const string Clickhouse = "clickhouse"; /// - /// Deprecated, use other_sql instead + /// Deprecated, use other_sql instead. /// public const string Cloudscape = "cloudscape"; /// - /// CockroachDB + /// CockroachDB. /// public const string Cockroachdb = "cockroachdb"; /// - /// Deprecated, no replacement at this time + /// Deprecated, no replacement at this time. /// public const string Coldfusion = "coldfusion"; /// - /// Microsoft Azure Cosmos DB + /// Microsoft Azure Cosmos DB. /// public const string Cosmosdb = "cosmosdb"; /// - /// Couchbase + /// Couchbase. /// public const string Couchbase = "couchbase"; /// - /// CouchDB + /// CouchDB. /// public const string Couchdb = "couchdb"; /// - /// IBM Db2 + /// IBM Db2. /// public const string Db2 = "db2"; /// - /// Apache Derby + /// Apache Derby. /// public const string Derby = "derby"; /// - /// Amazon DynamoDB + /// Amazon DynamoDB. /// public const string Dynamodb = "dynamodb"; /// - /// EnterpriseDB + /// EnterpriseDB. /// public const string Edb = "edb"; /// - /// Elasticsearch + /// Elasticsearch. /// public const string Elasticsearch = "elasticsearch"; /// - /// FileMaker + /// FileMaker. /// public const string Filemaker = "filemaker"; /// - /// Firebird + /// Firebird. /// public const string Firebird = "firebird"; /// - /// Deprecated, use other_sql instead + /// Deprecated, use other_sql instead. /// public const string Firstsql = "firstsql"; /// - /// Apache Geode + /// Apache Geode. /// public const string Geode = "geode"; /// - /// H2 + /// H2. /// public const string H2 = "h2"; /// - /// SAP HANA + /// SAP HANA. /// public const string Hanadb = "hanadb"; /// - /// Apache HBase + /// Apache HBase. /// public const string Hbase = "hbase"; /// - /// Apache Hive + /// Apache Hive. /// public const string Hive = "hive"; /// - /// HyperSQL DataBase + /// HyperSQL DataBase. /// public const string Hsqldb = "hsqldb"; /// - /// InfluxDB + /// InfluxDB. /// public const string Influxdb = "influxdb"; /// - /// Informix + /// Informix. /// public const string Informix = "informix"; /// - /// Ingres + /// Ingres. /// public const string Ingres = "ingres"; /// - /// InstantDB + /// InstantDB. /// public const string Instantdb = "instantdb"; /// - /// InterBase + /// InterBase. /// public const string Interbase = "interbase"; /// - /// MariaDB + /// MariaDB. /// public const string Mariadb = "mariadb"; /// - /// SAP MaxDB + /// SAP MaxDB. /// public const string Maxdb = "maxdb"; /// - /// Memcached + /// Memcached. /// public const string Memcached = "memcached"; /// - /// MongoDB + /// MongoDB. /// public const string Mongodb = "mongodb"; /// - /// Microsoft SQL Server + /// Microsoft SQL Server. /// public const string Mssql = "mssql"; /// - /// Deprecated, Microsoft SQL Server Compact is discontinued + /// Deprecated, Microsoft SQL Server Compact is discontinued. /// public const string Mssqlcompact = "mssqlcompact"; /// - /// MySQL + /// MySQL. /// public const string Mysql = "mysql"; /// - /// Neo4j + /// Neo4j. /// public const string Neo4j = "neo4j"; /// - /// Netezza + /// Netezza. /// public const string Netezza = "netezza"; /// - /// OpenSearch + /// OpenSearch. /// public const string Opensearch = "opensearch"; /// - /// Oracle Database + /// Oracle Database. /// public const string Oracle = "oracle"; /// - /// Pervasive PSQL + /// Pervasive PSQL. /// public const string Pervasive = "pervasive"; /// - /// PointBase + /// PointBase. /// public const string Pointbase = "pointbase"; /// - /// PostgreSQL + /// PostgreSQL. /// public const string Postgresql = "postgresql"; /// - /// Progress Database + /// Progress Database. /// public const string Progress = "progress"; /// - /// Redis + /// Redis. /// public const string Redis = "redis"; /// - /// Amazon Redshift + /// Amazon Redshift. /// public const string Redshift = "redshift"; /// - /// Cloud Spanner + /// Cloud Spanner. /// public const string Spanner = "spanner"; /// - /// SQLite + /// SQLite. /// public const string Sqlite = "sqlite"; /// - /// Sybase + /// Sybase. /// public const string Sybase = "sybase"; /// - /// Teradata + /// Teradata. /// public const string Teradata = "teradata"; /// - /// Trino + /// Trino. /// public const string Trino = "trino"; /// - /// Vertica + /// Vertica. /// public const string Vertica = "vertica"; } diff --git a/src/OpenTelemetry.SemanticConventions/Attributes/DeploymentAttributes.cs b/src/OpenTelemetry.SemanticConventions/Attributes/DeploymentAttributes.cs index 7119853d88..692bf8b875 100644 --- a/src/OpenTelemetry.SemanticConventions/Attributes/DeploymentAttributes.cs +++ b/src/OpenTelemetry.SemanticConventions/Attributes/DeploymentAttributes.cs @@ -15,13 +15,13 @@ namespace OpenTelemetry.SemanticConventions; public static class DeploymentAttributes { /// - /// 'Deprecated, use deployment.environment.name instead.' + /// 'Deprecated, use deployment.environment.name instead.'. /// - [Obsolete("Deprecated, use deployment.environment.name instead")] + [Obsolete("Deprecated, use deployment.environment.name instead.")] public const string AttributeDeploymentEnvironment = "deployment.environment"; /// - /// Name of the deployment environment (aka deployment tier) + /// Name of the deployment environment (aka deployment tier). /// /// /// deployment.environment.name does not affect the uniqueness constraints defined through @@ -31,38 +31,38 @@ public static class DeploymentAttributes ///

    ///

    ///     public const string AttributeDeploymentEnvironmentName = "deployment.environment.name"; /// - /// The id of the deployment + /// The id of the deployment. /// public const string AttributeDeploymentId = "deployment.id"; /// - /// The name of the deployment + /// The name of the deployment. /// public const string AttributeDeploymentName = "deployment.name"; /// - /// The status of the deployment + /// The status of the deployment. /// public const string AttributeDeploymentStatus = "deployment.status"; /// - /// The status of the deployment + /// The status of the deployment. /// public static class DeploymentStatusValues { /// - /// failed + /// failed. /// public const string Failed = "failed"; /// - /// succeeded + /// succeeded. /// public const string Succeeded = "succeeded"; } diff --git a/src/OpenTelemetry.SemanticConventions/Attributes/DestinationAttributes.cs b/src/OpenTelemetry.SemanticConventions/Attributes/DestinationAttributes.cs index 41bc27913d..6958b8805c 100644 --- a/src/OpenTelemetry.SemanticConventions/Attributes/DestinationAttributes.cs +++ b/src/OpenTelemetry.SemanticConventions/Attributes/DestinationAttributes.cs @@ -15,15 +15,15 @@ namespace OpenTelemetry.SemanticConventions; public static class DestinationAttributes { /// - /// Destination address - domain name if available without reverse DNS lookup; otherwise, IP address or Unix domain socket name + /// Destination address - domain name if available without reverse DNS lookup; otherwise, IP address or Unix domain socket name. /// /// - /// When observed from the source side, and when communicating through an intermediary, destination.address SHOULD represent the destination address behind any intermediaries, for example proxies, if it's available + /// When observed from the source side, and when communicating through an intermediary, destination.address SHOULD represent the destination address behind any intermediaries, for example proxies, if it's available. /// public const string AttributeDestinationAddress = "destination.address"; /// - /// Destination port number + /// Destination port number. /// public const string AttributeDestinationPort = "destination.port"; } diff --git a/src/OpenTelemetry.SemanticConventions/Attributes/DeviceAttributes.cs b/src/OpenTelemetry.SemanticConventions/Attributes/DeviceAttributes.cs index 04ca99d4ef..b68a08e80e 100644 --- a/src/OpenTelemetry.SemanticConventions/Attributes/DeviceAttributes.cs +++ b/src/OpenTelemetry.SemanticConventions/Attributes/DeviceAttributes.cs @@ -15,34 +15,34 @@ namespace OpenTelemetry.SemanticConventions; public static class DeviceAttributes { /// - /// A unique identifier representing the device + /// A unique identifier representing the device. /// /// - /// The device identifier MUST only be defined using the values outlined below. This value is not an advertising identifier and MUST NOT be used as such. On iOS (Swift or Objective-C), this value MUST be equal to the vendor identifier. On Android (Java or Kotlin), this value MUST be equal to the Firebase Installation ID or a globally unique UUID which is persisted across sessions in your application. More information can be found here on best practices and exact implementation details. Caution should be taken when storing personal data or anything which can identify a user. GDPR and data protection laws may apply, ensure you do your own due diligence + /// The device identifier MUST only be defined using the values outlined below. This value is not an advertising identifier and MUST NOT be used as such. On iOS (Swift or Objective-C), this value MUST be equal to the vendor identifier. On Android (Java or Kotlin), this value MUST be equal to the Firebase Installation ID or a globally unique UUID which is persisted across sessions in your application. More information can be found here on best practices and exact implementation details. Caution should be taken when storing personal data or anything which can identify a user. GDPR and data protection laws may apply, ensure you do your own due diligence. /// public const string AttributeDeviceId = "device.id"; /// - /// The name of the device manufacturer + /// The name of the device manufacturer. /// /// - /// The Android OS provides this field via Build. iOS apps SHOULD hardcode the value Apple + /// The Android OS provides this field via Build. iOS apps SHOULD hardcode the value Apple. /// public const string AttributeDeviceManufacturer = "device.manufacturer"; /// - /// The model identifier for the device + /// The model identifier for the device. /// /// - /// It's recommended this value represents a machine-readable version of the model identifier rather than the market or consumer-friendly name of the device + /// It's recommended this value represents a machine-readable version of the model identifier rather than the market or consumer-friendly name of the device. /// public const string AttributeDeviceModelIdentifier = "device.model.identifier"; /// - /// The marketing name for the device model + /// The marketing name for the device model. /// /// - /// It's recommended this value represents a human-readable version of the device model rather than a machine-readable alternative + /// It's recommended this value represents a human-readable version of the device model rather than a machine-readable alternative. /// public const string AttributeDeviceModelName = "device.model.name"; } diff --git a/src/OpenTelemetry.SemanticConventions/Attributes/DiskAttributes.cs b/src/OpenTelemetry.SemanticConventions/Attributes/DiskAttributes.cs index 14921a8de6..820f933a23 100644 --- a/src/OpenTelemetry.SemanticConventions/Attributes/DiskAttributes.cs +++ b/src/OpenTelemetry.SemanticConventions/Attributes/DiskAttributes.cs @@ -15,22 +15,22 @@ namespace OpenTelemetry.SemanticConventions; public static class DiskAttributes { /// - /// The disk IO operation direction + /// The disk IO operation direction. /// public const string AttributeDiskIoDirection = "disk.io.direction"; /// - /// The disk IO operation direction + /// The disk IO operation direction. /// public static class DiskIoDirectionValues { /// - /// read + /// read. /// public const string Read = "read"; /// - /// write + /// write. /// public const string Write = "write"; } diff --git a/src/OpenTelemetry.SemanticConventions/Attributes/DnsAttributes.cs b/src/OpenTelemetry.SemanticConventions/Attributes/DnsAttributes.cs index 04dbadfd07..a84dace046 100644 --- a/src/OpenTelemetry.SemanticConventions/Attributes/DnsAttributes.cs +++ b/src/OpenTelemetry.SemanticConventions/Attributes/DnsAttributes.cs @@ -15,10 +15,10 @@ namespace OpenTelemetry.SemanticConventions; public static class DnsAttributes { /// - /// The name being queried + /// The name being queried. /// /// - /// If the name field contains non-printable characters (below 32 or above 126), those characters should be represented as escaped base 10 integers (\DDD). Back slashes and quotes should be escaped. Tabs, carriage returns, and line feeds should be converted to \t, \r, and \n respectively + /// If the name field contains non-printable characters (below 32 or above 126), those characters should be represented as escaped base 10 integers (\DDD). Back slashes and quotes should be escaped. Tabs, carriage returns, and line feeds should be converted to \t, \r, and \n respectively. /// public const string AttributeDnsQuestionName = "dns.question.name"; } diff --git a/src/OpenTelemetry.SemanticConventions/Attributes/EnduserAttributes.cs b/src/OpenTelemetry.SemanticConventions/Attributes/EnduserAttributes.cs index de53dabda3..26b493cfa2 100644 --- a/src/OpenTelemetry.SemanticConventions/Attributes/EnduserAttributes.cs +++ b/src/OpenTelemetry.SemanticConventions/Attributes/EnduserAttributes.cs @@ -15,20 +15,20 @@ namespace OpenTelemetry.SemanticConventions; public static class EnduserAttributes { /// - /// Deprecated, use user.id instead + /// Deprecated, use user.id instead. /// - [Obsolete("Replaced by user.id attribute")] + [Obsolete("Replaced by user.id attribute.")] public const string AttributeEnduserId = "enduser.id"; /// - /// Deprecated, use user.roles instead + /// Deprecated, use user.roles instead. /// - [Obsolete("Replaced by user.roles attribute")] + [Obsolete("Replaced by user.roles attribute.")] public const string AttributeEnduserRole = "enduser.role"; /// - /// Deprecated, no replacement at this time + /// Deprecated, no replacement at this time. /// - [Obsolete("Removed")] + [Obsolete("Removed.")] public const string AttributeEnduserScope = "enduser.scope"; } diff --git a/src/OpenTelemetry.SemanticConventions/Attributes/ErrorAttributes.cs b/src/OpenTelemetry.SemanticConventions/Attributes/ErrorAttributes.cs index d8edc109da..c3924017fc 100644 --- a/src/OpenTelemetry.SemanticConventions/Attributes/ErrorAttributes.cs +++ b/src/OpenTelemetry.SemanticConventions/Attributes/ErrorAttributes.cs @@ -15,7 +15,7 @@ namespace OpenTelemetry.SemanticConventions; public static class ErrorAttributes { /// - /// Describes a class of error the operation ended with + /// Describes a class of error the operation ended with. /// /// /// The error.type SHOULD be predictable, and SHOULD have low cardinality. @@ -37,18 +37,18 @@ public static class ErrorAttributes ///

    ///

    ///     public const string AttributeErrorType = "error.type"; /// - /// Describes a class of error the operation ended with + /// Describes a class of error the operation ended with. /// public static class ErrorTypeValues { /// - /// A fallback error value to be used when the instrumentation doesn't define a custom value + /// A fallback error value to be used when the instrumentation doesn't define a custom value. /// public const string Other = "_OTHER"; } diff --git a/src/OpenTelemetry.SemanticConventions/Attributes/EventAttributes.cs b/src/OpenTelemetry.SemanticConventions/Attributes/EventAttributes.cs index 2714806e25..cdf0c4db59 100644 --- a/src/OpenTelemetry.SemanticConventions/Attributes/EventAttributes.cs +++ b/src/OpenTelemetry.SemanticConventions/Attributes/EventAttributes.cs @@ -15,10 +15,10 @@ namespace OpenTelemetry.SemanticConventions; public static class EventAttributes { /// - /// Identifies the class / type of event + /// Identifies the class / type of event. /// /// - /// Event names are subject to the same rules as attribute names. Notably, event names are namespaced to avoid collisions and provide a clean separation of semantics for events in separate domains like browser, mobile, and kubernetes + /// Event names are subject to the same rules as attribute names. Notably, event names are namespaced to avoid collisions and provide a clean separation of semantics for events in separate domains like browser, mobile, and kubernetes. /// public const string AttributeEventName = "event.name"; } diff --git a/src/OpenTelemetry.SemanticConventions/Attributes/ExceptionAttributes.cs b/src/OpenTelemetry.SemanticConventions/Attributes/ExceptionAttributes.cs index 66e71559be..d1d24f7357 100644 --- a/src/OpenTelemetry.SemanticConventions/Attributes/ExceptionAttributes.cs +++ b/src/OpenTelemetry.SemanticConventions/Attributes/ExceptionAttributes.cs @@ -15,7 +15,7 @@ namespace OpenTelemetry.SemanticConventions; public static class ExceptionAttributes { /// - /// SHOULD be set to true if the exception event is recorded at a point where it is known that the exception is escaping the scope of the span + /// SHOULD be set to true if the exception event is recorded at a point where it is known that the exception is escaping the scope of the span. /// /// /// An exception is considered to have escaped (or left) the scope of a span, @@ -33,22 +33,22 @@ public static class ExceptionAttributes /// It follows that an exception may still escape the scope of the span /// even if the exception.escaped attribute was not set or set to false, /// since the event might have been recorded at a time where it was not - /// clear whether the exception will escape + /// clear whether the exception will escape. /// public const string AttributeExceptionEscaped = "exception.escaped"; /// - /// The exception message + /// The exception message. /// public const string AttributeExceptionMessage = "exception.message"; /// - /// A stacktrace as a string in the natural representation for the language runtime. The representation is to be determined and documented by each language SIG + /// A stacktrace as a string in the natural representation for the language runtime. The representation is to be determined and documented by each language SIG. /// public const string AttributeExceptionStacktrace = "exception.stacktrace"; /// - /// The type of the exception (its fully-qualified class name, if applicable). The dynamic type of the exception should be preferred over the static type in languages that support it + /// The type of the exception (its fully-qualified class name, if applicable). The dynamic type of the exception should be preferred over the static type in languages that support it. /// public const string AttributeExceptionType = "exception.type"; } diff --git a/src/OpenTelemetry.SemanticConventions/Attributes/FaasAttributes.cs b/src/OpenTelemetry.SemanticConventions/Attributes/FaasAttributes.cs index 981e1a4a43..688c78976b 100644 --- a/src/OpenTelemetry.SemanticConventions/Attributes/FaasAttributes.cs +++ b/src/OpenTelemetry.SemanticConventions/Attributes/FaasAttributes.cs @@ -15,84 +15,84 @@ namespace OpenTelemetry.SemanticConventions; public static class FaasAttributes { /// - /// A boolean that is true if the serverless function is executed for the first time (aka cold-start) + /// A boolean that is true if the serverless function is executed for the first time (aka cold-start). /// public const string AttributeFaasColdstart = "faas.coldstart"; /// - /// A string containing the schedule period as Cron Expression + /// A string containing the schedule period as Cron Expression. /// public const string AttributeFaasCron = "faas.cron"; /// - /// The name of the source on which the triggering operation was performed. For example, in Cloud Storage or S3 corresponds to the bucket name, and in Cosmos DB to the database name + /// The name of the source on which the triggering operation was performed. For example, in Cloud Storage or S3 corresponds to the bucket name, and in Cosmos DB to the database name. /// public const string AttributeFaasDocumentCollection = "faas.document.collection"; /// - /// The document name/table subjected to the operation. For example, in Cloud Storage or S3 is the name of the file, and in Cosmos DB the table name + /// The document name/table subjected to the operation. For example, in Cloud Storage or S3 is the name of the file, and in Cosmos DB the table name. /// public const string AttributeFaasDocumentName = "faas.document.name"; /// - /// Describes the type of the operation that was performed on the data + /// Describes the type of the operation that was performed on the data. /// public const string AttributeFaasDocumentOperation = "faas.document.operation"; /// - /// A string containing the time when the data was accessed in the ISO 8601 format expressed in UTC + /// A string containing the time when the data was accessed in the ISO 8601 format expressed in UTC. /// public const string AttributeFaasDocumentTime = "faas.document.time"; /// - /// The execution environment ID as a string, that will be potentially reused for other invocations to the same function/function version + /// The execution environment ID as a string, that will be potentially reused for other invocations to the same function/function version. /// /// /// /// public const string AttributeFaasInstance = "faas.instance"; /// - /// The invocation ID of the current function invocation + /// The invocation ID of the current function invocation. /// public const string AttributeFaasInvocationId = "faas.invocation_id"; /// - /// The name of the invoked function + /// The name of the invoked function. /// /// - /// SHOULD be equal to the faas.name resource attribute of the invoked function + /// SHOULD be equal to the faas.name resource attribute of the invoked function. /// public const string AttributeFaasInvokedName = "faas.invoked_name"; /// - /// The cloud provider of the invoked function + /// The cloud provider of the invoked function. /// /// - /// SHOULD be equal to the cloud.provider resource attribute of the invoked function + /// SHOULD be equal to the cloud.provider resource attribute of the invoked function. /// public const string AttributeFaasInvokedProvider = "faas.invoked_provider"; /// - /// The cloud region of the invoked function + /// The cloud region of the invoked function. /// /// - /// SHOULD be equal to the cloud.region resource attribute of the invoked function + /// SHOULD be equal to the cloud.region resource attribute of the invoked function. /// public const string AttributeFaasInvokedRegion = "faas.invoked_region"; /// - /// The amount of memory available to the serverless function converted to Bytes + /// The amount of memory available to the serverless function converted to Bytes. /// /// - /// It's recommended to set this attribute since e.g. too little memory can easily stop a Java AWS Lambda function from working correctly. On AWS Lambda, the environment variable AWS_LAMBDA_FUNCTION_MEMORY_SIZE provides this information (which must be multiplied by 1,048,576) + /// It's recommended to set this attribute since e.g. too little memory can easily stop a Java AWS Lambda function from working correctly. On AWS Lambda, the environment variable AWS_LAMBDA_FUNCTION_MEMORY_SIZE provides this information (which must be multiplied by 1,048,576). /// public const string AttributeFaasMaxMemory = "faas.max_memory"; /// - /// The name of the single function that this runtime instance executes + /// The name of the single function that this runtime instance executes. /// /// /// This is the name of the function as configured/deployed on the FaaS @@ -111,23 +111,23 @@ public static class FaasAttributes /// can also be seen in the resource JSON for the function). /// This means that a span attribute MUST be used, as an Azure function /// app can host multiple functions that would usually share - /// a TracerProvider (see also the cloud.resource_id attribute) + /// a TracerProvider (see also the cloud.resource_id attribute). /// /// public const string AttributeFaasName = "faas.name"; /// - /// A string containing the function invocation time in the ISO 8601 format expressed in UTC + /// A string containing the function invocation time in the ISO 8601 format expressed in UTC. /// public const string AttributeFaasTime = "faas.time"; /// - /// Type of the trigger which caused this function invocation + /// Type of the trigger which caused this function invocation. /// public const string AttributeFaasTrigger = "faas.trigger"; /// - /// The immutable version of the function being executed + /// The immutable version of the function being executed. /// /// /// Depending on the cloud provider and platform, use: @@ -139,90 +139,90 @@ public static class FaasAttributes /// (i.e., the function name plus the revision suffix). ///
  • Google Cloud Functions: The value of the /// K_REVISION environment variable.
    • - ///
  • Azure Functions: Not applicable. Do not set this attribute
    • + ///
  • Azure Functions: Not applicable. Do not set this attribute.
    • /// ///     public const string AttributeFaasVersion = "faas.version"; /// - /// Describes the type of the operation that was performed on the data + /// Describes the type of the operation that was performed on the data. /// public static class FaasDocumentOperationValues { /// - /// When a new object is created + /// When a new object is created. /// public const string Insert = "insert"; /// - /// When an object is modified + /// When an object is modified. /// public const string Edit = "edit"; /// - /// When an object is deleted + /// When an object is deleted. /// public const string Delete = "delete"; } /// - /// The cloud provider of the invoked function + /// The cloud provider of the invoked function. /// public static class FaasInvokedProviderValues { /// - /// Alibaba Cloud + /// Alibaba Cloud. /// public const string AlibabaCloud = "alibaba_cloud"; /// - /// Amazon Web Services + /// Amazon Web Services. /// public const string Aws = "aws"; /// - /// Microsoft Azure + /// Microsoft Azure. /// public const string Azure = "azure"; /// - /// Google Cloud Platform + /// Google Cloud Platform. /// public const string Gcp = "gcp"; /// - /// Tencent Cloud + /// Tencent Cloud. /// public const string TencentCloud = "tencent_cloud"; } /// - /// Type of the trigger which caused this function invocation + /// Type of the trigger which caused this function invocation. /// public static class FaasTriggerValues { /// - /// A response to some data source operation such as a database or filesystem read/write + /// A response to some data source operation such as a database or filesystem read/write. /// public const string Datasource = "datasource"; /// - /// To provide an answer to an inbound HTTP request + /// To provide an answer to an inbound HTTP request. /// public const string Http = "http"; /// - /// A function is set to be executed when messages are sent to a messaging system + /// A function is set to be executed when messages are sent to a messaging system. /// public const string Pubsub = "pubsub"; /// - /// A function is scheduled to be executed regularly + /// A function is scheduled to be executed regularly. /// public const string Timer = "timer"; /// - /// If none of the others apply + /// If none of the others apply. /// public const string Other = "other"; } diff --git a/src/OpenTelemetry.SemanticConventions/Attributes/FeatureFlagAttributes.cs b/src/OpenTelemetry.SemanticConventions/Attributes/FeatureFlagAttributes.cs index b8aee7bdc4..9c56474985 100644 --- a/src/OpenTelemetry.SemanticConventions/Attributes/FeatureFlagAttributes.cs +++ b/src/OpenTelemetry.SemanticConventions/Attributes/FeatureFlagAttributes.cs @@ -15,17 +15,17 @@ namespace OpenTelemetry.SemanticConventions; public static class FeatureFlagAttributes { /// - /// The unique identifier of the feature flag + /// The unique identifier of the feature flag. /// public const string AttributeFeatureFlagKey = "feature_flag.key"; /// - /// The name of the service provider that performs the flag evaluation + /// The name of the service provider that performs the flag evaluation. /// public const string AttributeFeatureFlagProviderName = "feature_flag.provider_name"; /// - /// SHOULD be a semantic identifier for a value. If one is unavailable, a stringified version of the value can be used + /// SHOULD be a semantic identifier for a value. If one is unavailable, a stringified version of the value can be used. /// /// /// A semantic identifier, commonly referred to as a variant, provides a means @@ -35,7 +35,7 @@ public static class FeatureFlagAttributes ///

    /// A stringified version of the value can be used in situations where a /// semantic identifier is unavailable. String representation of the value - /// should be determined by the implementer + /// should be determined by the implementer. /// public const string AttributeFeatureFlagVariant = "feature_flag.variant"; } diff --git a/src/OpenTelemetry.SemanticConventions/Attributes/FileAttributes.cs b/src/OpenTelemetry.SemanticConventions/Attributes/FileAttributes.cs index 1310eae87e..a0c9fd58dd 100644 --- a/src/OpenTelemetry.SemanticConventions/Attributes/FileAttributes.cs +++ b/src/OpenTelemetry.SemanticConventions/Attributes/FileAttributes.cs @@ -15,30 +15,30 @@ namespace OpenTelemetry.SemanticConventions; public static class FileAttributes { ///

    - /// Directory where the file is located. It should include the drive letter, when appropriate + /// Directory where the file is located. It should include the drive letter, when appropriate. /// public const string AttributeFileDirectory = "file.directory"; /// - /// File extension, excluding the leading dot + /// File extension, excluding the leading dot. /// /// - /// When the file name has multiple extensions (example.tar.gz), only the last one should be captured ("gz", not "tar.gz") + /// When the file name has multiple extensions (example.tar.gz), only the last one should be captured ("gz", not "tar.gz"). /// public const string AttributeFileExtension = "file.extension"; /// - /// Name of the file including the extension, without the directory + /// Name of the file including the extension, without the directory. /// public const string AttributeFileName = "file.name"; /// - /// Full path to the file, including the file name. It should include the drive letter, when appropriate + /// Full path to the file, including the file name. It should include the drive letter, when appropriate. /// public const string AttributeFilePath = "file.path"; /// - /// File size in bytes + /// File size in bytes. /// public const string AttributeFileSize = "file.size"; } diff --git a/src/OpenTelemetry.SemanticConventions/Attributes/GcpAttributes.cs b/src/OpenTelemetry.SemanticConventions/Attributes/GcpAttributes.cs index 2dedab1196..001052a0c8 100644 --- a/src/OpenTelemetry.SemanticConventions/Attributes/GcpAttributes.cs +++ b/src/OpenTelemetry.SemanticConventions/Attributes/GcpAttributes.cs @@ -15,30 +15,30 @@ namespace OpenTelemetry.SemanticConventions; public static class GcpAttributes { /// - /// Identifies the Google Cloud service for which the official client library is intended + /// Identifies the Google Cloud service for which the official client library is intended. /// /// - /// Intended to be a stable identifier for Google Cloud client libraries that is uniform across implementation languages. The value should be derived from the canonical service domain for the service; for example, 'foo.googleapis.com' should result in a value of 'foo' + /// Intended to be a stable identifier for Google Cloud client libraries that is uniform across implementation languages. The value should be derived from the canonical service domain for the service; for example, 'foo.googleapis.com' should result in a value of 'foo'. /// public const string AttributeGcpClientService = "gcp.client.service"; /// - /// The name of the Cloud Run execution being run for the Job, as set by the CLOUD_RUN_EXECUTION environment variable + /// The name of the Cloud Run execution being run for the Job, as set by the CLOUD_RUN_EXECUTION environment variable. /// public const string AttributeGcpCloudRunJobExecution = "gcp.cloud_run.job.execution"; /// - /// The index for a task within an execution as provided by the CLOUD_RUN_TASK_INDEX environment variable + /// The index for a task within an execution as provided by the CLOUD_RUN_TASK_INDEX environment variable. /// public const string AttributeGcpCloudRunJobTaskIndex = "gcp.cloud_run.job.task_index"; /// - /// The hostname of a GCE instance. This is the full value of the default or custom hostname + /// The hostname of a GCE instance. This is the full value of the default or custom hostname. /// public const string AttributeGcpGceInstanceHostname = "gcp.gce.instance.hostname"; /// - /// The instance name of a GCE instance. This is the value provided by host.name, the visible name of the instance in the Cloud Console UI, and the prefix for the default hostname of the instance as defined by the default internal DNS name + /// The instance name of a GCE instance. This is the value provided by host.name, the visible name of the instance in the Cloud Console UI, and the prefix for the default hostname of the instance as defined by the default internal DNS name. /// public const string AttributeGcpGceInstanceName = "gcp.gce.instance.name"; } diff --git a/src/OpenTelemetry.SemanticConventions/Attributes/GenAiAttributes.cs b/src/OpenTelemetry.SemanticConventions/Attributes/GenAiAttributes.cs index a100c1f1e3..16bac1669a 100644 --- a/src/OpenTelemetry.SemanticConventions/Attributes/GenAiAttributes.cs +++ b/src/OpenTelemetry.SemanticConventions/Attributes/GenAiAttributes.cs @@ -15,86 +15,86 @@ namespace OpenTelemetry.SemanticConventions; public static class GenAiAttributes { /// - /// The full response received from the GenAI model + /// The full response received from the GenAI model. /// /// - /// It's RECOMMENDED to format completions as JSON string matching OpenAI messages format + /// It's RECOMMENDED to format completions as JSON string matching OpenAI messages format. /// public const string AttributeGenAiCompletion = "gen_ai.completion"; /// - /// The name of the operation being performed + /// The name of the operation being performed. /// /// - /// If one of the predefined values applies, but specific system uses a different name it's RECOMMENDED to document it in the semantic conventions for specific GenAI system and use system-specific name in the instrumentation. If a different name is not documented, instrumentation libraries SHOULD use applicable predefined value + /// If one of the predefined values applies, but specific system uses a different name it's RECOMMENDED to document it in the semantic conventions for specific GenAI system and use system-specific name in the instrumentation. If a different name is not documented, instrumentation libraries SHOULD use applicable predefined value. /// public const string AttributeGenAiOperationName = "gen_ai.operation.name"; /// - /// The full prompt sent to the GenAI model + /// The full prompt sent to the GenAI model. /// /// - /// It's RECOMMENDED to format prompts as JSON string matching OpenAI messages format + /// It's RECOMMENDED to format prompts as JSON string matching OpenAI messages format. /// public const string AttributeGenAiPrompt = "gen_ai.prompt"; /// - /// The frequency penalty setting for the GenAI request + /// The frequency penalty setting for the GenAI request. /// public const string AttributeGenAiRequestFrequencyPenalty = "gen_ai.request.frequency_penalty"; /// - /// The maximum number of tokens the model generates for a request + /// The maximum number of tokens the model generates for a request. /// public const string AttributeGenAiRequestMaxTokens = "gen_ai.request.max_tokens"; /// - /// The name of the GenAI model a request is being made to + /// The name of the GenAI model a request is being made to. /// public const string AttributeGenAiRequestModel = "gen_ai.request.model"; /// - /// The presence penalty setting for the GenAI request + /// The presence penalty setting for the GenAI request. /// public const string AttributeGenAiRequestPresencePenalty = "gen_ai.request.presence_penalty"; /// - /// List of sequences that the model will use to stop generating further tokens + /// List of sequences that the model will use to stop generating further tokens. /// public const string AttributeGenAiRequestStopSequences = "gen_ai.request.stop_sequences"; /// - /// The temperature setting for the GenAI request + /// The temperature setting for the GenAI request. /// public const string AttributeGenAiRequestTemperature = "gen_ai.request.temperature"; /// - /// The top_k sampling setting for the GenAI request + /// The top_k sampling setting for the GenAI request. /// public const string AttributeGenAiRequestTopK = "gen_ai.request.top_k"; /// - /// The top_p sampling setting for the GenAI request + /// The top_p sampling setting for the GenAI request. /// public const string AttributeGenAiRequestTopP = "gen_ai.request.top_p"; /// - /// Array of reasons the model stopped generating tokens, corresponding to each generation received + /// Array of reasons the model stopped generating tokens, corresponding to each generation received. /// public const string AttributeGenAiResponseFinishReasons = "gen_ai.response.finish_reasons"; /// - /// The unique identifier for the completion + /// The unique identifier for the completion. /// public const string AttributeGenAiResponseId = "gen_ai.response.id"; /// - /// The name of the model that generated the response + /// The name of the model that generated the response. /// public const string AttributeGenAiResponseModel = "gen_ai.response.model"; /// - /// The Generative AI product as identified by the client or server instrumentation + /// The Generative AI product as identified by the client or server instrumentation. /// /// /// The gen_ai.system describes a family of GenAI models with specific model identified @@ -105,91 +105,91 @@ public static class GenAiAttributes /// is set to openai based on the instrumentation's best knowledge. ///

    /// For custom model, a custom friendly name SHOULD be used. - /// If none of these options apply, the gen_ai.system SHOULD be set to _OTHER + /// If none of these options apply, the gen_ai.system SHOULD be set to _OTHER. /// public const string AttributeGenAiSystem = "gen_ai.system"; ///

    - /// The type of token being counted + /// The type of token being counted. /// public const string AttributeGenAiTokenType = "gen_ai.token.type"; /// - /// Deprecated, use gen_ai.usage.output_tokens instead + /// Deprecated, use gen_ai.usage.output_tokens instead. /// - [Obsolete("Replaced by gen_ai.usage.output_tokens attribute")] + [Obsolete("Replaced by gen_ai.usage.output_tokens attribute.")] public const string AttributeGenAiUsageCompletionTokens = "gen_ai.usage.completion_tokens"; /// - /// The number of tokens used in the GenAI input (prompt) + /// The number of tokens used in the GenAI input (prompt). /// public const string AttributeGenAiUsageInputTokens = "gen_ai.usage.input_tokens"; /// - /// The number of tokens used in the GenAI response (completion) + /// The number of tokens used in the GenAI response (completion). /// public const string AttributeGenAiUsageOutputTokens = "gen_ai.usage.output_tokens"; /// - /// Deprecated, use gen_ai.usage.input_tokens instead + /// Deprecated, use gen_ai.usage.input_tokens instead. /// - [Obsolete("Replaced by gen_ai.usage.input_tokens attribute")] + [Obsolete("Replaced by gen_ai.usage.input_tokens attribute.")] public const string AttributeGenAiUsagePromptTokens = "gen_ai.usage.prompt_tokens"; /// - /// The name of the operation being performed + /// The name of the operation being performed. /// public static class GenAiOperationNameValues { /// - /// Chat completion operation such as OpenAI Chat API + /// Chat completion operation such as OpenAI Chat API. /// public const string Chat = "chat"; /// - /// Text completions operation such as OpenAI Completions API (Legacy) + /// Text completions operation such as OpenAI Completions API (Legacy). /// public const string TextCompletion = "text_completion"; } /// - /// The Generative AI product as identified by the client or server instrumentation + /// The Generative AI product as identified by the client or server instrumentation. /// public static class GenAiSystemValues { /// - /// OpenAI + /// OpenAI. /// public const string Openai = "openai"; /// - /// Vertex AI + /// Vertex AI. /// public const string VertexAi = "vertex_ai"; /// - /// Anthropic + /// Anthropic. /// public const string Anthropic = "anthropic"; /// - /// Cohere + /// Cohere. /// public const string Cohere = "cohere"; } /// - /// The type of token being counted + /// The type of token being counted. /// public static class GenAiTokenTypeValues { /// - /// Input tokens (prompt, input, etc.) + /// Input tokens (prompt, input, etc.). /// public const string Input = "input"; /// - /// Output tokens (completion, response, etc.) + /// Output tokens (completion, response, etc.). /// public const string Completion = "output"; } diff --git a/src/OpenTelemetry.SemanticConventions/Attributes/GoAttributes.cs b/src/OpenTelemetry.SemanticConventions/Attributes/GoAttributes.cs index 847f8f1df7..6be62a6d5e 100644 --- a/src/OpenTelemetry.SemanticConventions/Attributes/GoAttributes.cs +++ b/src/OpenTelemetry.SemanticConventions/Attributes/GoAttributes.cs @@ -15,22 +15,22 @@ namespace OpenTelemetry.SemanticConventions; public static class GoAttributes { /// - /// The type of memory + /// The type of memory. /// public const string AttributeGoMemoryType = "go.memory.type"; /// - /// The type of memory + /// The type of memory. /// public static class GoMemoryTypeValues { /// - /// Memory allocated from the heap that is reserved for stack space, whether or not it is currently in-use + /// Memory allocated from the heap that is reserved for stack space, whether or not it is currently in-use. /// public const string Stack = "stack"; /// - /// Memory used by the Go runtime, excluding other categories of memory usage described in this enumeration + /// Memory used by the Go runtime, excluding other categories of memory usage described in this enumeration. /// public const string Other = "other"; } diff --git a/src/OpenTelemetry.SemanticConventions/Attributes/GraphqlAttributes.cs b/src/OpenTelemetry.SemanticConventions/Attributes/GraphqlAttributes.cs index b770ad6a73..2cf790dc32 100644 --- a/src/OpenTelemetry.SemanticConventions/Attributes/GraphqlAttributes.cs +++ b/src/OpenTelemetry.SemanticConventions/Attributes/GraphqlAttributes.cs @@ -15,40 +15,40 @@ namespace OpenTelemetry.SemanticConventions; public static class GraphqlAttributes { /// - /// The GraphQL document being executed + /// The GraphQL document being executed. /// /// - /// The value may be sanitized to exclude sensitive information + /// The value may be sanitized to exclude sensitive information. /// public const string AttributeGraphqlDocument = "graphql.document"; /// - /// The name of the operation being executed + /// The name of the operation being executed. /// public const string AttributeGraphqlOperationName = "graphql.operation.name"; /// - /// The type of the operation being executed + /// The type of the operation being executed. /// public const string AttributeGraphqlOperationType = "graphql.operation.type"; /// - /// The type of the operation being executed + /// The type of the operation being executed. /// public static class GraphqlOperationTypeValues { /// - /// GraphQL query + /// GraphQL query. /// public const string Query = "query"; /// - /// GraphQL mutation + /// GraphQL mutation. /// public const string Mutation = "mutation"; /// - /// GraphQL subscription + /// GraphQL subscription. /// public const string Subscription = "subscription"; } diff --git a/src/OpenTelemetry.SemanticConventions/Attributes/HerokuAttributes.cs b/src/OpenTelemetry.SemanticConventions/Attributes/HerokuAttributes.cs index 5d4aea042f..5a5bf23188 100644 --- a/src/OpenTelemetry.SemanticConventions/Attributes/HerokuAttributes.cs +++ b/src/OpenTelemetry.SemanticConventions/Attributes/HerokuAttributes.cs @@ -15,17 +15,17 @@ namespace OpenTelemetry.SemanticConventions; public static class HerokuAttributes { /// - /// Unique identifier for the application + /// Unique identifier for the application. /// public const string AttributeHerokuAppId = "heroku.app.id"; /// - /// Commit hash for the current release + /// Commit hash for the current release. /// public const string AttributeHerokuReleaseCommit = "heroku.release.commit"; /// - /// Time and date the release was created + /// Time and date the release was created. /// public const string AttributeHerokuReleaseCreationTimestamp = "heroku.release.creation_timestamp"; } diff --git a/src/OpenTelemetry.SemanticConventions/Attributes/HostAttributes.cs b/src/OpenTelemetry.SemanticConventions/Attributes/HostAttributes.cs index d4e9506030..288b949243 100644 --- a/src/OpenTelemetry.SemanticConventions/Attributes/HostAttributes.cs +++ b/src/OpenTelemetry.SemanticConventions/Attributes/HostAttributes.cs @@ -15,131 +15,131 @@ namespace OpenTelemetry.SemanticConventions; public static class HostAttributes { /// - /// The CPU architecture the host system is running on + /// The CPU architecture the host system is running on. /// public const string AttributeHostArch = "host.arch"; /// - /// The amount of level 2 memory cache available to the processor (in Bytes) + /// The amount of level 2 memory cache available to the processor (in Bytes). /// public const string AttributeHostCpuCacheL2Size = "host.cpu.cache.l2.size"; /// - /// Family or generation of the CPU + /// Family or generation of the CPU. /// public const string AttributeHostCpuFamily = "host.cpu.family"; /// - /// Model identifier. It provides more granular information about the CPU, distinguishing it from other CPUs within the same family + /// Model identifier. It provides more granular information about the CPU, distinguishing it from other CPUs within the same family. /// public const string AttributeHostCpuModelId = "host.cpu.model.id"; /// - /// Model designation of the processor + /// Model designation of the processor. /// public const string AttributeHostCpuModelName = "host.cpu.model.name"; /// - /// Stepping or core revisions + /// Stepping or core revisions. /// public const string AttributeHostCpuStepping = "host.cpu.stepping"; /// - /// Processor manufacturer identifier. A maximum 12-character string + /// Processor manufacturer identifier. A maximum 12-character string. /// /// - /// CPUID command returns the vendor ID string in EBX, EDX and ECX registers. Writing these to memory in this order results in a 12-character string + /// CPUID command returns the vendor ID string in EBX, EDX and ECX registers. Writing these to memory in this order results in a 12-character string. /// public const string AttributeHostCpuVendorId = "host.cpu.vendor.id"; /// - /// Unique host ID. For Cloud, this must be the instance_id assigned by the cloud provider. For non-containerized systems, this should be the machine-id. See the table below for the sources to use to determine the machine-id based on operating system + /// Unique host ID. For Cloud, this must be the instance_id assigned by the cloud provider. For non-containerized systems, this should be the machine-id. See the table below for the sources to use to determine the machine-id based on operating system. /// public const string AttributeHostId = "host.id"; /// - /// VM image ID or host OS image ID. For Cloud, this value is from the provider + /// VM image ID or host OS image ID. For Cloud, this value is from the provider. /// public const string AttributeHostImageId = "host.image.id"; /// - /// Name of the VM image or OS install the host was instantiated from + /// Name of the VM image or OS install the host was instantiated from. /// public const string AttributeHostImageName = "host.image.name"; /// - /// The version string of the VM image or host OS as defined in Version Attributes + /// The version string of the VM image or host OS as defined in Version Attributes. /// public const string AttributeHostImageVersion = "host.image.version"; /// - /// Available IP addresses of the host, excluding loopback interfaces + /// Available IP addresses of the host, excluding loopback interfaces. /// /// - /// IPv4 Addresses MUST be specified in dotted-quad notation. IPv6 addresses MUST be specified in the RFC 5952 format + /// IPv4 Addresses MUST be specified in dotted-quad notation. IPv6 addresses MUST be specified in the RFC 5952 format. /// public const string AttributeHostIp = "host.ip"; /// - /// Available MAC addresses of the host, excluding loopback interfaces + /// Available MAC addresses of the host, excluding loopback interfaces. /// /// - /// MAC Addresses MUST be represented in IEEE RA hexadecimal form: as hyphen-separated octets in uppercase hexadecimal form from most to least significant + /// MAC Addresses MUST be represented in IEEE RA hexadecimal form: as hyphen-separated octets in uppercase hexadecimal form from most to least significant. /// public const string AttributeHostMac = "host.mac"; /// - /// Name of the host. On Unix systems, it may contain what the hostname command returns, or the fully qualified hostname, or another name specified by the user + /// Name of the host. On Unix systems, it may contain what the hostname command returns, or the fully qualified hostname, or another name specified by the user. /// public const string AttributeHostName = "host.name"; /// - /// Type of host. For Cloud, this must be the machine type + /// Type of host. For Cloud, this must be the machine type. /// public const string AttributeHostType = "host.type"; /// - /// The CPU architecture the host system is running on + /// The CPU architecture the host system is running on. /// public static class HostArchValues { /// - /// AMD64 + /// AMD64. /// public const string Amd64 = "amd64"; /// - /// ARM32 + /// ARM32. /// public const string Arm32 = "arm32"; /// - /// ARM64 + /// ARM64. /// public const string Arm64 = "arm64"; /// - /// Itanium + /// Itanium. /// public const string Ia64 = "ia64"; /// - /// 32-bit PowerPC + /// 32-bit PowerPC. /// public const string Ppc32 = "ppc32"; /// - /// 64-bit PowerPC + /// 64-bit PowerPC. /// public const string Ppc64 = "ppc64"; /// - /// IBM z/Architecture + /// IBM z/Architecture. /// public const string S390x = "s390x"; /// - /// 32-bit x86 + /// 32-bit x86. /// public const string X86 = "x86"; } diff --git a/src/OpenTelemetry.SemanticConventions/Attributes/HttpAttributes.cs b/src/OpenTelemetry.SemanticConventions/Attributes/HttpAttributes.cs index 48dec9fbc1..8e30d56d98 100644 --- a/src/OpenTelemetry.SemanticConventions/Attributes/HttpAttributes.cs +++ b/src/OpenTelemetry.SemanticConventions/Attributes/HttpAttributes.cs @@ -15,51 +15,51 @@ namespace OpenTelemetry.SemanticConventions; public static class HttpAttributes { /// - /// Deprecated, use client.address instead + /// Deprecated, use client.address instead. /// - [Obsolete("Replaced by client.address")] + [Obsolete("Replaced by client.address.")] public const string AttributeHttpClientIp = "http.client_ip"; /// - /// State of the HTTP connection in the HTTP connection pool + /// State of the HTTP connection in the HTTP connection pool. /// public const string AttributeHttpConnectionState = "http.connection.state"; /// - /// Deprecated, use network.protocol.name instead + /// Deprecated, use network.protocol.name instead. /// - [Obsolete("Replaced by network.protocol.name")] + [Obsolete("Replaced by network.protocol.name.")] public const string AttributeHttpFlavor = "http.flavor"; /// - /// Deprecated, use one of server.address, client.address or http.request.header.host instead, depending on the usage + /// Deprecated, use one of server.address, client.address or http.request.header.host instead, depending on the usage. /// - [Obsolete("Replaced by one of server.address, client.address or http.request.header.host, depending on the usage")] + [Obsolete("Replaced by one of server.address, client.address or http.request.header.host, depending on the usage.")] public const string AttributeHttpHost = "http.host"; /// - /// Deprecated, use http.request.method instead + /// Deprecated, use http.request.method instead. /// - [Obsolete("Replaced by http.request.method")] + [Obsolete("Replaced by http.request.method.")] public const string AttributeHttpMethod = "http.method"; /// - /// The size of the request payload body in bytes. This is the number of bytes transferred excluding headers and is often, but not always, present as the Content-Length header. For requests using transport encoding, this should be the compressed size + /// The size of the request payload body in bytes. This is the number of bytes transferred excluding headers and is often, but not always, present as the Content-Length header. For requests using transport encoding, this should be the compressed size. /// public const string AttributeHttpRequestBodySize = "http.request.body.size"; /// - /// HTTP request headers, being the normalized HTTP Header name (lowercase), the value being the header values + /// HTTP request headers, being the normalized HTTP Header name (lowercase), the value being the header values. /// /// /// Instrumentations SHOULD require an explicit configuration of which headers are to be captured. Including all request headers can be a security risk - explicit configuration helps avoid leaking sensitive information. /// The User-Agent header is already captured in the user_agent.original attribute. Users MAY explicitly configure instrumentations to capture them even though it is not recommended. - /// The attribute value MUST consist of either multiple header values as an array of strings or a single-item array containing a possibly comma-concatenated string, depending on the way the HTTP library provides access to headers + /// The attribute value MUST consist of either multiple header values as an array of strings or a single-item array containing a possibly comma-concatenated string, depending on the way the HTTP library provides access to headers. /// public const string AttributeHttpRequestHeaderTemplate = "http.request.header"; /// - /// HTTP request method + /// HTTP request method. /// /// /// HTTP request method value SHOULD be "known" to the instrumentation. @@ -75,232 +75,232 @@ public static class HttpAttributes ///

    /// HTTP method names are case-sensitive and http.request.method attribute value MUST match a known HTTP method name exactly. /// Instrumentations for specific web frameworks that consider HTTP methods to be case insensitive, SHOULD populate a canonical equivalent. - /// Tracing instrumentations that do so, MUST also set http.request.method_original to the original value + /// Tracing instrumentations that do so, MUST also set http.request.method_original to the original value. /// public const string AttributeHttpRequestMethod = "http.request.method"; ///

    - /// Original HTTP method sent by the client in the request line + /// Original HTTP method sent by the client in the request line. /// public const string AttributeHttpRequestMethodOriginal = "http.request.method_original"; /// - /// The ordinal number of request resending attempt (for any reason, including redirects) + /// The ordinal number of request resending attempt (for any reason, including redirects). /// /// - /// The resend count SHOULD be updated each time an HTTP request gets resent by the client, regardless of what was the cause of the resending (e.g. redirection, authorization failure, 503 Server Unavailable, network issues, or any other) + /// The resend count SHOULD be updated each time an HTTP request gets resent by the client, regardless of what was the cause of the resending (e.g. redirection, authorization failure, 503 Server Unavailable, network issues, or any other). /// public const string AttributeHttpRequestResendCount = "http.request.resend_count"; /// - /// The total size of the request in bytes. This should be the total number of bytes sent over the wire, including the request line (HTTP/1.1), framing (HTTP/2 and HTTP/3), headers, and request body if any + /// The total size of the request in bytes. This should be the total number of bytes sent over the wire, including the request line (HTTP/1.1), framing (HTTP/2 and HTTP/3), headers, and request body if any. /// public const string AttributeHttpRequestSize = "http.request.size"; /// - /// Deprecated, use http.request.header.content-length instead + /// Deprecated, use http.request.header.content-length instead. /// - [Obsolete("Replaced by http.request.header.content-length")] + [Obsolete("Replaced by http.request.header.content-length.")] public const string AttributeHttpRequestContentLength = "http.request_content_length"; /// - /// Deprecated, use http.request.body.size instead + /// Deprecated, use http.request.body.size instead. /// - [Obsolete("Replaced by http.request.body.size")] + [Obsolete("Replaced by http.request.body.size.")] public const string AttributeHttpRequestContentLengthUncompressed = "http.request_content_length_uncompressed"; /// - /// The size of the response payload body in bytes. This is the number of bytes transferred excluding headers and is often, but not always, present as the Content-Length header. For requests using transport encoding, this should be the compressed size + /// The size of the response payload body in bytes. This is the number of bytes transferred excluding headers and is often, but not always, present as the Content-Length header. For requests using transport encoding, this should be the compressed size. /// public const string AttributeHttpResponseBodySize = "http.response.body.size"; /// - /// HTTP response headers, being the normalized HTTP Header name (lowercase), the value being the header values + /// HTTP response headers, being the normalized HTTP Header name (lowercase), the value being the header values. /// /// /// Instrumentations SHOULD require an explicit configuration of which headers are to be captured. Including all response headers can be a security risk - explicit configuration helps avoid leaking sensitive information. /// Users MAY explicitly configure instrumentations to capture them even though it is not recommended. - /// The attribute value MUST consist of either multiple header values as an array of strings or a single-item array containing a possibly comma-concatenated string, depending on the way the HTTP library provides access to headers + /// The attribute value MUST consist of either multiple header values as an array of strings or a single-item array containing a possibly comma-concatenated string, depending on the way the HTTP library provides access to headers. /// public const string AttributeHttpResponseHeaderTemplate = "http.response.header"; /// - /// The total size of the response in bytes. This should be the total number of bytes sent over the wire, including the status line (HTTP/1.1), framing (HTTP/2 and HTTP/3), headers, and response body and trailers if any + /// The total size of the response in bytes. This should be the total number of bytes sent over the wire, including the status line (HTTP/1.1), framing (HTTP/2 and HTTP/3), headers, and response body and trailers if any. /// public const string AttributeHttpResponseSize = "http.response.size"; /// - /// HTTP response status code + /// HTTP response status code. /// public const string AttributeHttpResponseStatusCode = "http.response.status_code"; /// - /// Deprecated, use http.response.header.content-length instead + /// Deprecated, use http.response.header.content-length instead. /// - [Obsolete("Replaced by http.response.header.content-length")] + [Obsolete("Replaced by http.response.header.content-length.")] public const string AttributeHttpResponseContentLength = "http.response_content_length"; /// - /// Deprecated, use http.response.body.size instead + /// Deprecated, use http.response.body.size instead. /// - [Obsolete("Replace by http.response.body.size")] + [Obsolete("Replace by http.response.body.size.")] public const string AttributeHttpResponseContentLengthUncompressed = "http.response_content_length_uncompressed"; /// - /// The matched route, that is, the path template in the format used by the respective server framework + /// The matched route, that is, the path template in the format used by the respective server framework. /// /// /// MUST NOT be populated when this is not supported by the HTTP server framework as the route attribute should have low-cardinality and the URI path can NOT substitute it. - /// SHOULD include the application root if there is one + /// SHOULD include the application root if there is one. /// public const string AttributeHttpRoute = "http.route"; /// - /// Deprecated, use url.scheme instead + /// Deprecated, use url.scheme instead. /// - [Obsolete("Replaced by url.scheme instead")] + [Obsolete("Replaced by url.scheme instead.")] public const string AttributeHttpScheme = "http.scheme"; /// - /// Deprecated, use server.address instead + /// Deprecated, use server.address instead. /// - [Obsolete("Replaced by server.address")] + [Obsolete("Replaced by server.address.")] public const string AttributeHttpServerName = "http.server_name"; /// - /// Deprecated, use http.response.status_code instead + /// Deprecated, use http.response.status_code instead. /// - [Obsolete("Replaced by http.response.status_code")] + [Obsolete("Replaced by http.response.status_code.")] public const string AttributeHttpStatusCode = "http.status_code"; /// - /// Deprecated, use url.path and url.query instead + /// Deprecated, use url.path and url.query instead. /// - [Obsolete("Split to url.path and `url.query")] + [Obsolete("Split to url.path and `url.query.")] public const string AttributeHttpTarget = "http.target"; /// - /// Deprecated, use url.full instead + /// Deprecated, use url.full instead. /// - [Obsolete("Replaced by url.full")] + [Obsolete("Replaced by url.full.")] public const string AttributeHttpUrl = "http.url"; /// - /// Deprecated, use user_agent.original instead + /// Deprecated, use user_agent.original instead. /// - [Obsolete("Replaced by user_agent.original")] + [Obsolete("Replaced by user_agent.original.")] public const string AttributeHttpUserAgent = "http.user_agent"; /// - /// State of the HTTP connection in the HTTP connection pool + /// State of the HTTP connection in the HTTP connection pool. /// public static class HttpConnectionStateValues { /// - /// active state + /// active state. /// public const string Active = "active"; /// - /// idle state + /// idle state. /// public const string Idle = "idle"; } /// - /// Deprecated, use network.protocol.name instead + /// Deprecated, use network.protocol.name instead. /// public static class HttpFlavorValues { /// - /// HTTP/1.0 + /// HTTP/1.0. /// - [Obsolete("Replaced by network.protocol.name")] + [Obsolete("Replaced by network.protocol.name.")] public const string Http10 = "1.0"; /// - /// HTTP/1.1 + /// HTTP/1.1. /// - [Obsolete("Replaced by network.protocol.name")] + [Obsolete("Replaced by network.protocol.name.")] public const string Http11 = "1.1"; /// - /// HTTP/2 + /// HTTP/2. /// - [Obsolete("Replaced by network.protocol.name")] + [Obsolete("Replaced by network.protocol.name.")] public const string Http20 = "2.0"; /// - /// HTTP/3 + /// HTTP/3. /// - [Obsolete("Replaced by network.protocol.name")] + [Obsolete("Replaced by network.protocol.name.")] public const string Http30 = "3.0"; /// - /// SPDY protocol + /// SPDY protocol. /// - [Obsolete("Replaced by network.protocol.name")] + [Obsolete("Replaced by network.protocol.name.")] public const string Spdy = "SPDY"; /// - /// QUIC protocol + /// QUIC protocol. /// - [Obsolete("Replaced by network.protocol.name")] + [Obsolete("Replaced by network.protocol.name.")] public const string Quic = "QUIC"; } /// - /// HTTP request method + /// HTTP request method. /// public static class HttpRequestMethodValues { /// - /// CONNECT method + /// CONNECT method. /// public const string Connect = "CONNECT"; /// - /// DELETE method + /// DELETE method. /// public const string Delete = "DELETE"; /// - /// GET method + /// GET method. /// public const string Get = "GET"; /// - /// HEAD method + /// HEAD method. /// public const string Head = "HEAD"; /// - /// OPTIONS method + /// OPTIONS method. /// public const string Options = "OPTIONS"; /// - /// PATCH method + /// PATCH method. /// public const string Patch = "PATCH"; /// - /// POST method + /// POST method. /// public const string Post = "POST"; /// - /// PUT method + /// PUT method. /// public const string Put = "PUT"; /// - /// TRACE method + /// TRACE method. /// public const string Trace = "TRACE"; /// - /// Any HTTP method that the instrumentation has no prior knowledge of + /// Any HTTP method that the instrumentation has no prior knowledge of. /// public const string Other = "_OTHER"; } diff --git a/src/OpenTelemetry.SemanticConventions/Attributes/IosAttributes.cs b/src/OpenTelemetry.SemanticConventions/Attributes/IosAttributes.cs index d8a2b6b686..981fd5a53f 100644 --- a/src/OpenTelemetry.SemanticConventions/Attributes/IosAttributes.cs +++ b/src/OpenTelemetry.SemanticConventions/Attributes/IosAttributes.cs @@ -15,47 +15,47 @@ namespace OpenTelemetry.SemanticConventions; public static class IosAttributes { /// - /// Deprecated use the device.app.lifecycle event definition including ios.state as a payload field instead + /// Deprecated use the device.app.lifecycle event definition including ios.state as a payload field instead. /// /// - /// The iOS lifecycle states are defined in the UIApplicationDelegate documentation, and from which the OS terminology column values are derived + /// The iOS lifecycle states are defined in the UIApplicationDelegate documentation, and from which the OS terminology column values are derived. /// - [Obsolete("Moved to a payload field of device.app.lifecycle")] + [Obsolete("Moved to a payload field of device.app.lifecycle.")] public const string AttributeIosState = "ios.state"; /// - /// Deprecated use the device.app.lifecycle event definition including ios.state as a payload field instead + /// Deprecated use the device.app.lifecycle event definition including ios.state as a payload field instead. /// public static class IosStateValues { /// - /// The app has become active. Associated with UIKit notification applicationDidBecomeActive + /// The app has become active. Associated with UIKit notification applicationDidBecomeActive. /// - [Obsolete("Moved to a payload field of device.app.lifecycle")] + [Obsolete("Moved to a payload field of device.app.lifecycle.")] public const string Active = "active"; /// - /// The app is now inactive. Associated with UIKit notification applicationWillResignActive + /// The app is now inactive. Associated with UIKit notification applicationWillResignActive. /// - [Obsolete("Moved to a payload field of device.app.lifecycle")] + [Obsolete("Moved to a payload field of device.app.lifecycle.")] public const string Inactive = "inactive"; /// - /// The app is now in the background. This value is associated with UIKit notification applicationDidEnterBackground + /// The app is now in the background. This value is associated with UIKit notification applicationDidEnterBackground. /// - [Obsolete("Moved to a payload field of device.app.lifecycle")] + [Obsolete("Moved to a payload field of device.app.lifecycle.")] public const string Background = "background"; /// - /// The app is now in the foreground. This value is associated with UIKit notification applicationWillEnterForeground + /// The app is now in the foreground. This value is associated with UIKit notification applicationWillEnterForeground. /// - [Obsolete("Moved to a payload field of device.app.lifecycle")] + [Obsolete("Moved to a payload field of device.app.lifecycle.")] public const string Foreground = "foreground"; /// - /// The app is about to terminate. Associated with UIKit notification applicationWillTerminate + /// The app is about to terminate. Associated with UIKit notification applicationWillTerminate. /// - [Obsolete("Moved to a payload field of device.app.lifecycle")] + [Obsolete("Moved to a payload field of device.app.lifecycle.")] public const string Terminate = "terminate"; } } diff --git a/src/OpenTelemetry.SemanticConventions/Attributes/JvmAttributes.cs b/src/OpenTelemetry.SemanticConventions/Attributes/JvmAttributes.cs index f51450b140..687d2e4018 100644 --- a/src/OpenTelemetry.SemanticConventions/Attributes/JvmAttributes.cs +++ b/src/OpenTelemetry.SemanticConventions/Attributes/JvmAttributes.cs @@ -15,100 +15,100 @@ namespace OpenTelemetry.SemanticConventions; public static class JvmAttributes { /// - /// Name of the buffer pool + /// Name of the buffer pool. /// /// - /// Pool names are generally obtained via BufferPoolMXBean#getName() + /// Pool names are generally obtained via BufferPoolMXBean#getName(). /// public const string AttributeJvmBufferPoolName = "jvm.buffer.pool.name"; /// - /// Name of the garbage collector action + /// Name of the garbage collector action. /// /// - /// Garbage collector action is generally obtained via GarbageCollectionNotificationInfo#getGcAction() + /// Garbage collector action is generally obtained via GarbageCollectionNotificationInfo#getGcAction(). /// public const string AttributeJvmGcAction = "jvm.gc.action"; /// - /// Name of the garbage collector + /// Name of the garbage collector. /// /// - /// Garbage collector name is generally obtained via GarbageCollectionNotificationInfo#getGcName() + /// Garbage collector name is generally obtained via GarbageCollectionNotificationInfo#getGcName(). /// public const string AttributeJvmGcName = "jvm.gc.name"; /// - /// Name of the memory pool + /// Name of the memory pool. /// /// - /// Pool names are generally obtained via MemoryPoolMXBean#getName() + /// Pool names are generally obtained via MemoryPoolMXBean#getName(). /// public const string AttributeJvmMemoryPoolName = "jvm.memory.pool.name"; /// - /// The type of memory + /// The type of memory. /// public const string AttributeJvmMemoryType = "jvm.memory.type"; /// - /// Whether the thread is daemon or not + /// Whether the thread is daemon or not. /// public const string AttributeJvmThreadDaemon = "jvm.thread.daemon"; /// - /// State of the thread + /// State of the thread. /// public const string AttributeJvmThreadState = "jvm.thread.state"; /// - /// The type of memory + /// The type of memory. /// public static class JvmMemoryTypeValues { /// - /// Heap memory + /// Heap memory. /// public const string Heap = "heap"; /// - /// Non-heap memory + /// Non-heap memory. /// public const string NonHeap = "non_heap"; } /// - /// State of the thread + /// State of the thread. /// public static class JvmThreadStateValues { /// - /// A thread that has not yet started is in this state + /// A thread that has not yet started is in this state. /// public const string New = "new"; /// - /// A thread executing in the Java virtual machine is in this state + /// A thread executing in the Java virtual machine is in this state. /// public const string Runnable = "runnable"; /// - /// A thread that is blocked waiting for a monitor lock is in this state + /// A thread that is blocked waiting for a monitor lock is in this state. /// public const string Blocked = "blocked"; /// - /// A thread that is waiting indefinitely for another thread to perform a particular action is in this state + /// A thread that is waiting indefinitely for another thread to perform a particular action is in this state. /// public const string Waiting = "waiting"; /// - /// A thread that is waiting for another thread to perform an action for up to a specified waiting time is in this state + /// A thread that is waiting for another thread to perform an action for up to a specified waiting time is in this state. /// public const string TimedWaiting = "timed_waiting"; /// - /// A thread that has exited is in this state + /// A thread that has exited is in this state. /// public const string Terminated = "terminated"; } diff --git a/src/OpenTelemetry.SemanticConventions/Attributes/K8sAttributes.cs b/src/OpenTelemetry.SemanticConventions/Attributes/K8sAttributes.cs index e1013adc29..34ae1936b1 100644 --- a/src/OpenTelemetry.SemanticConventions/Attributes/K8sAttributes.cs +++ b/src/OpenTelemetry.SemanticConventions/Attributes/K8sAttributes.cs @@ -15,12 +15,12 @@ namespace OpenTelemetry.SemanticConventions; public static class K8sAttributes { /// - /// The name of the cluster + /// The name of the cluster. /// public const string AttributeK8sClusterName = "k8s.cluster.name"; /// - /// A pseudo-ID for the cluster, set to the UID of the kube-system namespace + /// A pseudo-ID for the cluster, set to the UID of the kube-system namespace. /// /// /// K8s doesn't have support for obtaining a cluster ID. If this is ever @@ -46,123 +46,123 @@ public static class K8sAttributes /// ///

    /// Therefore, UIDs between clusters should be extremely unlikely to - /// conflict + /// conflict. /// public const string AttributeK8sClusterUid = "k8s.cluster.uid"; ///

    - /// The name of the Container from Pod specification, must be unique within a Pod. Container runtime usually uses different globally unique name (container.name) + /// The name of the Container from Pod specification, must be unique within a Pod. Container runtime usually uses different globally unique name (container.name). /// public const string AttributeK8sContainerName = "k8s.container.name"; /// - /// Number of times the container was restarted. This attribute can be used to identify a particular container (running or stopped) within a container spec + /// Number of times the container was restarted. This attribute can be used to identify a particular container (running or stopped) within a container spec. /// public const string AttributeK8sContainerRestartCount = "k8s.container.restart_count"; /// - /// Last terminated reason of the Container + /// Last terminated reason of the Container. /// public const string AttributeK8sContainerStatusLastTerminatedReason = "k8s.container.status.last_terminated_reason"; /// - /// The name of the CronJob + /// The name of the CronJob. /// public const string AttributeK8sCronjobName = "k8s.cronjob.name"; /// - /// The UID of the CronJob + /// The UID of the CronJob. /// public const string AttributeK8sCronjobUid = "k8s.cronjob.uid"; /// - /// The name of the DaemonSet + /// The name of the DaemonSet. /// public const string AttributeK8sDaemonsetName = "k8s.daemonset.name"; /// - /// The UID of the DaemonSet + /// The UID of the DaemonSet. /// public const string AttributeK8sDaemonsetUid = "k8s.daemonset.uid"; /// - /// The name of the Deployment + /// The name of the Deployment. /// public const string AttributeK8sDeploymentName = "k8s.deployment.name"; /// - /// The UID of the Deployment + /// The UID of the Deployment. /// public const string AttributeK8sDeploymentUid = "k8s.deployment.uid"; /// - /// The name of the Job + /// The name of the Job. /// public const string AttributeK8sJobName = "k8s.job.name"; /// - /// The UID of the Job + /// The UID of the Job. /// public const string AttributeK8sJobUid = "k8s.job.uid"; /// - /// The name of the namespace that the pod is running in + /// The name of the namespace that the pod is running in. /// public const string AttributeK8sNamespaceName = "k8s.namespace.name"; /// - /// The name of the Node + /// The name of the Node. /// public const string AttributeK8sNodeName = "k8s.node.name"; /// - /// The UID of the Node + /// The UID of the Node. /// public const string AttributeK8sNodeUid = "k8s.node.uid"; /// - /// The annotation key-value pairs placed on the Pod, the being the annotation name, the value being the annotation value + /// The annotation key-value pairs placed on the Pod, the being the annotation name, the value being the annotation value. /// public const string AttributeK8sPodAnnotationTemplate = "k8s.pod.annotation"; /// - /// The label key-value pairs placed on the Pod, the being the label name, the value being the label value + /// The label key-value pairs placed on the Pod, the being the label name, the value being the label value. /// public const string AttributeK8sPodLabelTemplate = "k8s.pod.label"; /// - /// Deprecated, use k8s.pod.label instead + /// Deprecated, use k8s.pod.label instead. /// - [Obsolete("Replaced by k8s.pod.label")] + [Obsolete("Replaced by k8s.pod.label.")] public const string AttributeK8sPodLabelsTemplate = "k8s.pod.labels"; /// - /// The name of the Pod + /// The name of the Pod. /// public const string AttributeK8sPodName = "k8s.pod.name"; /// - /// The UID of the Pod + /// The UID of the Pod. /// public const string AttributeK8sPodUid = "k8s.pod.uid"; /// - /// The name of the ReplicaSet + /// The name of the ReplicaSet. /// public const string AttributeK8sReplicasetName = "k8s.replicaset.name"; /// - /// The UID of the ReplicaSet + /// The UID of the ReplicaSet. /// public const string AttributeK8sReplicasetUid = "k8s.replicaset.uid"; /// - /// The name of the StatefulSet + /// The name of the StatefulSet. /// public const string AttributeK8sStatefulsetName = "k8s.statefulset.name"; /// - /// The UID of the StatefulSet + /// The UID of the StatefulSet. /// public const string AttributeK8sStatefulsetUid = "k8s.statefulset.uid"; } diff --git a/src/OpenTelemetry.SemanticConventions/Attributes/LinuxAttributes.cs b/src/OpenTelemetry.SemanticConventions/Attributes/LinuxAttributes.cs index a93e9712ca..b15a6e506e 100644 --- a/src/OpenTelemetry.SemanticConventions/Attributes/LinuxAttributes.cs +++ b/src/OpenTelemetry.SemanticConventions/Attributes/LinuxAttributes.cs @@ -15,22 +15,22 @@ namespace OpenTelemetry.SemanticConventions; public static class LinuxAttributes { /// - /// The Linux Slab memory state + /// The Linux Slab memory state. /// public const string AttributeLinuxMemorySlabState = "linux.memory.slab.state"; /// - /// The Linux Slab memory state + /// The Linux Slab memory state. /// public static class LinuxMemorySlabStateValues { /// - /// reclaimable + /// reclaimable. /// public const string Reclaimable = "reclaimable"; /// - /// unreclaimable + /// unreclaimable. /// public const string Unreclaimable = "unreclaimable"; } diff --git a/src/OpenTelemetry.SemanticConventions/Attributes/LogAttributes.cs b/src/OpenTelemetry.SemanticConventions/Attributes/LogAttributes.cs index c0ad17a9ed..6b4dc2714d 100644 --- a/src/OpenTelemetry.SemanticConventions/Attributes/LogAttributes.cs +++ b/src/OpenTelemetry.SemanticConventions/Attributes/LogAttributes.cs @@ -15,59 +15,59 @@ namespace OpenTelemetry.SemanticConventions; public static class LogAttributes { /// - /// The basename of the file + /// The basename of the file. /// public const string AttributeLogFileName = "log.file.name"; /// - /// The basename of the file, with symlinks resolved + /// The basename of the file, with symlinks resolved. /// public const string AttributeLogFileNameResolved = "log.file.name_resolved"; /// - /// The full path to the file + /// The full path to the file. /// public const string AttributeLogFilePath = "log.file.path"; /// - /// The full path to the file, with symlinks resolved + /// The full path to the file, with symlinks resolved. /// public const string AttributeLogFilePathResolved = "log.file.path_resolved"; /// - /// The stream associated with the log. See below for a list of well-known values + /// The stream associated with the log. See below for a list of well-known values. /// public const string AttributeLogIostream = "log.iostream"; /// - /// The complete orignal Log Record + /// The complete orignal Log Record. /// /// - /// This value MAY be added when processing a Log Record which was originally transmitted as a string or equivalent data type AND the Body field of the Log Record does not contain the same value. (e.g. a syslog or a log record read from a file.) + /// This value MAY be added when processing a Log Record which was originally transmitted as a string or equivalent data type AND the Body field of the Log Record does not contain the same value. (e.g. a syslog or a log record read from a file.). /// public const string AttributeLogRecordOriginal = "log.record.original"; /// - /// A unique identifier for the Log Record + /// A unique identifier for the Log Record. /// /// /// If an id is provided, other log records with the same id will be considered duplicates and can be removed safely. This means, that two distinguishable log records MUST have different values. - /// The id MAY be an Universally Unique Lexicographically Sortable Identifier (ULID), but other identifiers (e.g. UUID) may be used as needed + /// The id MAY be an Universally Unique Lexicographically Sortable Identifier (ULID), but other identifiers (e.g. UUID) may be used as needed. /// public const string AttributeLogRecordUid = "log.record.uid"; /// - /// The stream associated with the log. See below for a list of well-known values + /// The stream associated with the log. See below for a list of well-known values. /// public static class LogIostreamValues { /// - /// Logs from stdout stream + /// Logs from stdout stream. /// public const string Stdout = "stdout"; /// - /// Events from stderr stream + /// Events from stderr stream. /// public const string Stderr = "stderr"; } diff --git a/src/OpenTelemetry.SemanticConventions/Attributes/MessageAttributes.cs b/src/OpenTelemetry.SemanticConventions/Attributes/MessageAttributes.cs index af856c42b4..3bf2a05fc7 100644 --- a/src/OpenTelemetry.SemanticConventions/Attributes/MessageAttributes.cs +++ b/src/OpenTelemetry.SemanticConventions/Attributes/MessageAttributes.cs @@ -15,44 +15,44 @@ namespace OpenTelemetry.SemanticConventions; public static class MessageAttributes { /// - /// Deprecated, use rpc.message.compressed_size instead + /// Deprecated, use rpc.message.compressed_size instead. /// - [Obsolete("Replaced by rpc.message.compressed_size")] + [Obsolete("Replaced by rpc.message.compressed_size.")] public const string AttributeMessageCompressedSize = "message.compressed_size"; /// - /// Deprecated, use rpc.message.id instead + /// Deprecated, use rpc.message.id instead. /// - [Obsolete("Replaced by rpc.message.id")] + [Obsolete("Replaced by rpc.message.id.")] public const string AttributeMessageId = "message.id"; /// - /// Deprecated, use rpc.message.type instead + /// Deprecated, use rpc.message.type instead. /// - [Obsolete("Replaced by rpc.message.type")] + [Obsolete("Replaced by rpc.message.type.")] public const string AttributeMessageType = "message.type"; /// - /// Deprecated, use rpc.message.uncompressed_size instead + /// Deprecated, use rpc.message.uncompressed_size instead. /// - [Obsolete("Replaced by rpc.message.uncompressed_size")] + [Obsolete("Replaced by rpc.message.uncompressed_size.")] public const string AttributeMessageUncompressedSize = "message.uncompressed_size"; /// - /// Deprecated, use rpc.message.type instead + /// Deprecated, use rpc.message.type instead. /// public static class MessageTypeValues { /// - /// sent + /// sent. /// - [Obsolete("Replaced by rpc.message.type")] + [Obsolete("Replaced by rpc.message.type.")] public const string Sent = "SENT"; /// - /// received + /// received. /// - [Obsolete("Replaced by rpc.message.type")] + [Obsolete("Replaced by rpc.message.type.")] public const string Received = "RECEIVED"; } } diff --git a/src/OpenTelemetry.SemanticConventions/Attributes/MessagingAttributes.cs b/src/OpenTelemetry.SemanticConventions/Attributes/MessagingAttributes.cs index b3851d2ad3..31baedee43 100644 --- a/src/OpenTelemetry.SemanticConventions/Attributes/MessagingAttributes.cs +++ b/src/OpenTelemetry.SemanticConventions/Attributes/MessagingAttributes.cs @@ -15,438 +15,438 @@ namespace OpenTelemetry.SemanticConventions; public static class MessagingAttributes { /// - /// The number of messages sent, received, or processed in the scope of the batching operation + /// The number of messages sent, received, or processed in the scope of the batching operation. /// /// - /// Instrumentations SHOULD NOT set messaging.batch.message_count on spans that operate with a single message. When a messaging client library supports both batch and single-message API for the same operation, instrumentations SHOULD use messaging.batch.message_count for batching APIs and SHOULD NOT use it for single-message APIs + /// Instrumentations SHOULD NOT set messaging.batch.message_count on spans that operate with a single message. When a messaging client library supports both batch and single-message API for the same operation, instrumentations SHOULD use messaging.batch.message_count for batching APIs and SHOULD NOT use it for single-message APIs. /// public const string AttributeMessagingBatchMessageCount = "messaging.batch.message_count"; /// - /// A unique identifier for the client that consumes or produces a message + /// A unique identifier for the client that consumes or produces a message. /// public const string AttributeMessagingClientId = "messaging.client.id"; /// - /// The name of the consumer group with which a consumer is associated + /// The name of the consumer group with which a consumer is associated. /// /// - /// Semantic conventions for individual messaging systems SHOULD document whether messaging.consumer.group.name is applicable and what it means in the context of that system + /// Semantic conventions for individual messaging systems SHOULD document whether messaging.consumer.group.name is applicable and what it means in the context of that system. /// public const string AttributeMessagingConsumerGroupName = "messaging.consumer.group.name"; /// - /// A boolean that is true if the message destination is anonymous (could be unnamed or have auto-generated name) + /// A boolean that is true if the message destination is anonymous (could be unnamed or have auto-generated name). /// public const string AttributeMessagingDestinationAnonymous = "messaging.destination.anonymous"; /// - /// The message destination name + /// The message destination name. /// /// /// Destination name SHOULD uniquely identify a specific queue, topic or other entity within the broker. If - /// the broker doesn't have such notion, the destination name SHOULD uniquely identify the broker + /// the broker doesn't have such notion, the destination name SHOULD uniquely identify the broker. /// public const string AttributeMessagingDestinationName = "messaging.destination.name"; /// - /// The identifier of the partition messages are sent to or received from, unique within the messaging.destination.name + /// The identifier of the partition messages are sent to or received from, unique within the messaging.destination.name. /// public const string AttributeMessagingDestinationPartitionId = "messaging.destination.partition.id"; /// - /// The name of the destination subscription from which a message is consumed + /// The name of the destination subscription from which a message is consumed. /// /// - /// Semantic conventions for individual messaging systems SHOULD document whether messaging.destination.subscription.name is applicable and what it means in the context of that system + /// Semantic conventions for individual messaging systems SHOULD document whether messaging.destination.subscription.name is applicable and what it means in the context of that system. /// public const string AttributeMessagingDestinationSubscriptionName = "messaging.destination.subscription.name"; /// - /// Low cardinality representation of the messaging destination name + /// Low cardinality representation of the messaging destination name. /// /// - /// Destination names could be constructed from templates. An example would be a destination name involving a user name or product id. Although the destination name in this case is of high cardinality, the underlying template is of low cardinality and can be effectively used for grouping and aggregation + /// Destination names could be constructed from templates. An example would be a destination name involving a user name or product id. Although the destination name in this case is of high cardinality, the underlying template is of low cardinality and can be effectively used for grouping and aggregation. /// public const string AttributeMessagingDestinationTemplate = "messaging.destination.template"; /// - /// A boolean that is true if the message destination is temporary and might not exist anymore after messages are processed + /// A boolean that is true if the message destination is temporary and might not exist anymore after messages are processed. /// public const string AttributeMessagingDestinationTemporary = "messaging.destination.temporary"; /// - /// Deprecated, no replacement at this time + /// Deprecated, no replacement at this time. /// - [Obsolete("No replacement at this time")] + [Obsolete("No replacement at this time.")] public const string AttributeMessagingDestinationPublishAnonymous = "messaging.destination_publish.anonymous"; /// - /// Deprecated, no replacement at this time + /// Deprecated, no replacement at this time. /// - [Obsolete("No replacement at this time")] + [Obsolete("No replacement at this time.")] public const string AttributeMessagingDestinationPublishName = "messaging.destination_publish.name"; /// - /// Deprecated, use messaging.consumer.group.name instead + /// Deprecated, use messaging.consumer.group.name instead. /// - [Obsolete("Replaced by messaging.consumer.group.name")] + [Obsolete("Replaced by messaging.consumer.group.name.")] public const string AttributeMessagingEventhubsConsumerGroup = "messaging.eventhubs.consumer.group"; /// - /// The UTC epoch seconds at which the message has been accepted and stored in the entity + /// The UTC epoch seconds at which the message has been accepted and stored in the entity. /// public const string AttributeMessagingEventhubsMessageEnqueuedTime = "messaging.eventhubs.message.enqueued_time"; /// - /// The ack deadline in seconds set for the modify ack deadline request + /// The ack deadline in seconds set for the modify ack deadline request. /// public const string AttributeMessagingGcpPubsubMessageAckDeadline = "messaging.gcp_pubsub.message.ack_deadline"; /// - /// The ack id for a given message + /// The ack id for a given message. /// public const string AttributeMessagingGcpPubsubMessageAckId = "messaging.gcp_pubsub.message.ack_id"; /// - /// The delivery attempt for a given message + /// The delivery attempt for a given message. /// public const string AttributeMessagingGcpPubsubMessageDeliveryAttempt = "messaging.gcp_pubsub.message.delivery_attempt"; /// - /// The ordering key for a given message. If the attribute is not present, the message does not have an ordering key + /// The ordering key for a given message. If the attribute is not present, the message does not have an ordering key. /// public const string AttributeMessagingGcpPubsubMessageOrderingKey = "messaging.gcp_pubsub.message.ordering_key"; /// - /// Deprecated, use messaging.consumer.group.name instead + /// Deprecated, use messaging.consumer.group.name instead. /// - [Obsolete("Replaced by messaging.consumer.group.name")] + [Obsolete("Replaced by messaging.consumer.group.name.")] public const string AttributeMessagingKafkaConsumerGroup = "messaging.kafka.consumer.group"; /// - /// Deprecated, use messaging.destination.partition.id instead + /// Deprecated, use messaging.destination.partition.id instead. /// - [Obsolete("Replaced by messaging.destination.partition.id")] + [Obsolete("Replaced by messaging.destination.partition.id.")] public const string AttributeMessagingKafkaDestinationPartition = "messaging.kafka.destination.partition"; /// - /// Message keys in Kafka are used for grouping alike messages to ensure they're processed on the same partition. They differ from messaging.message.id in that they're not unique. If the key is null, the attribute MUST NOT be set + /// Message keys in Kafka are used for grouping alike messages to ensure they're processed on the same partition. They differ from messaging.message.id in that they're not unique. If the key is null, the attribute MUST NOT be set. /// /// - /// If the key type is not string, it's string representation has to be supplied for the attribute. If the key has no unambiguous, canonical string form, don't include its value + /// If the key type is not string, it's string representation has to be supplied for the attribute. If the key has no unambiguous, canonical string form, don't include its value. /// public const string AttributeMessagingKafkaMessageKey = "messaging.kafka.message.key"; /// - /// Deprecated, use messaging.kafka.offset instead + /// Deprecated, use messaging.kafka.offset instead. /// - [Obsolete("Replaced by messaging.kafka.offset")] + [Obsolete("Replaced by messaging.kafka.offset.")] public const string AttributeMessagingKafkaMessageOffset = "messaging.kafka.message.offset"; /// - /// A boolean that is true if the message is a tombstone + /// A boolean that is true if the message is a tombstone. /// public const string AttributeMessagingKafkaMessageTombstone = "messaging.kafka.message.tombstone"; /// - /// The offset of a record in the corresponding Kafka partition + /// The offset of a record in the corresponding Kafka partition. /// public const string AttributeMessagingKafkaOffset = "messaging.kafka.offset"; /// - /// The size of the message body in bytes + /// The size of the message body in bytes. /// /// /// This can refer to both the compressed or uncompressed body size. If both sizes are known, the uncompressed - /// body size should be used + /// body size should be used. /// public const string AttributeMessagingMessageBodySize = "messaging.message.body.size"; /// - /// The conversation ID identifying the conversation to which the message belongs, represented as a string. Sometimes called "Correlation ID" + /// The conversation ID identifying the conversation to which the message belongs, represented as a string. Sometimes called "Correlation ID". /// public const string AttributeMessagingMessageConversationId = "messaging.message.conversation_id"; /// - /// The size of the message body and metadata in bytes + /// The size of the message body and metadata in bytes. /// /// /// This can refer to both the compressed or uncompressed size. If both sizes are known, the uncompressed - /// size should be used + /// size should be used. /// public const string AttributeMessagingMessageEnvelopeSize = "messaging.message.envelope.size"; /// - /// A value used by the messaging system as an identifier for the message, represented as a string + /// A value used by the messaging system as an identifier for the message, represented as a string. /// public const string AttributeMessagingMessageId = "messaging.message.id"; /// - /// Deprecated, use messaging.operation.type instead + /// Deprecated, use messaging.operation.type instead. /// - [Obsolete("Replaced by messaging.operation.type")] + [Obsolete("Replaced by messaging.operation.type.")] public const string AttributeMessagingOperation = "messaging.operation"; /// - /// The system-specific name of the messaging operation + /// The system-specific name of the messaging operation. /// public const string AttributeMessagingOperationName = "messaging.operation.name"; /// - /// A string identifying the type of the messaging operation + /// A string identifying the type of the messaging operation. /// /// - /// If a custom value is used, it MUST be of low cardinality + /// If a custom value is used, it MUST be of low cardinality. /// public const string AttributeMessagingOperationType = "messaging.operation.type"; /// - /// RabbitMQ message routing key + /// RabbitMQ message routing key. /// public const string AttributeMessagingRabbitmqDestinationRoutingKey = "messaging.rabbitmq.destination.routing_key"; /// - /// RabbitMQ message delivery tag + /// RabbitMQ message delivery tag. /// public const string AttributeMessagingRabbitmqMessageDeliveryTag = "messaging.rabbitmq.message.delivery_tag"; /// - /// Deprecated, use messaging.consumer.group.name instead + /// Deprecated, use messaging.consumer.group.name instead. /// - [Obsolete("Replaced by messaging.consumer.group.name on the consumer spans. No replacement for producer spans")] + [Obsolete("Replaced by messaging.consumer.group.name on the consumer spans. No replacement for producer spans.")] public const string AttributeMessagingRocketmqClientGroup = "messaging.rocketmq.client_group"; /// - /// Model of message consumption. This only applies to consumer spans + /// Model of message consumption. This only applies to consumer spans. /// public const string AttributeMessagingRocketmqConsumptionModel = "messaging.rocketmq.consumption_model"; /// - /// The delay time level for delay message, which determines the message delay time + /// The delay time level for delay message, which determines the message delay time. /// public const string AttributeMessagingRocketmqMessageDelayTimeLevel = "messaging.rocketmq.message.delay_time_level"; /// - /// The timestamp in milliseconds that the delay message is expected to be delivered to consumer + /// The timestamp in milliseconds that the delay message is expected to be delivered to consumer. /// public const string AttributeMessagingRocketmqMessageDeliveryTimestamp = "messaging.rocketmq.message.delivery_timestamp"; /// - /// It is essential for FIFO message. Messages that belong to the same message group are always processed one by one within the same consumer group + /// It is essential for FIFO message. Messages that belong to the same message group are always processed one by one within the same consumer group. /// public const string AttributeMessagingRocketmqMessageGroup = "messaging.rocketmq.message.group"; /// - /// Key(s) of message, another way to mark message besides message id + /// Key(s) of message, another way to mark message besides message id. /// public const string AttributeMessagingRocketmqMessageKeys = "messaging.rocketmq.message.keys"; /// - /// The secondary classifier of message besides topic + /// The secondary classifier of message besides topic. /// public const string AttributeMessagingRocketmqMessageTag = "messaging.rocketmq.message.tag"; /// - /// Type of message + /// Type of message. /// public const string AttributeMessagingRocketmqMessageType = "messaging.rocketmq.message.type"; /// - /// Namespace of RocketMQ resources, resources in different namespaces are individual + /// Namespace of RocketMQ resources, resources in different namespaces are individual. /// public const string AttributeMessagingRocketmqNamespace = "messaging.rocketmq.namespace"; /// - /// Deprecated, use messaging.servicebus.destination.subscription_name instead + /// Deprecated, use messaging.servicebus.destination.subscription_name instead. /// - [Obsolete("Replaced by messaging.servicebus.destination.subscription_name")] + [Obsolete("Replaced by messaging.servicebus.destination.subscription_name.")] public const string AttributeMessagingServicebusDestinationSubscriptionName = "messaging.servicebus.destination.subscription_name"; /// - /// Describes the settlement type + /// Describes the settlement type. /// public const string AttributeMessagingServicebusDispositionStatus = "messaging.servicebus.disposition_status"; /// - /// Number of deliveries that have been attempted for this message + /// Number of deliveries that have been attempted for this message. /// public const string AttributeMessagingServicebusMessageDeliveryCount = "messaging.servicebus.message.delivery_count"; /// - /// The UTC epoch seconds at which the message has been accepted and stored in the entity + /// The UTC epoch seconds at which the message has been accepted and stored in the entity. /// public const string AttributeMessagingServicebusMessageEnqueuedTime = "messaging.servicebus.message.enqueued_time"; /// - /// The messaging system as identified by the client instrumentation + /// The messaging system as identified by the client instrumentation. /// /// - /// The actual messaging system may differ from the one known by the client. For example, when using Kafka client libraries to communicate with Azure Event Hubs, the messaging.system is set to kafka based on the instrumentation's best knowledge + /// The actual messaging system may differ from the one known by the client. For example, when using Kafka client libraries to communicate with Azure Event Hubs, the messaging.system is set to kafka based on the instrumentation's best knowledge. /// public const string AttributeMessagingSystem = "messaging.system"; /// - /// A string identifying the type of the messaging operation + /// A string identifying the type of the messaging operation. /// public static class MessagingOperationTypeValues { /// - /// One or more messages are provided for publishing to an intermediary. If a single message is published, the context of the "Publish" span can be used as the creation context and no "Create" span needs to be created + /// One or more messages are provided for publishing to an intermediary. If a single message is published, the context of the "Publish" span can be used as the creation context and no "Create" span needs to be created. /// public const string Publish = "publish"; /// - /// A message is created. "Create" spans always refer to a single message and are used to provide a unique creation context for messages in batch publishing scenarios + /// A message is created. "Create" spans always refer to a single message and are used to provide a unique creation context for messages in batch publishing scenarios. /// public const string Create = "create"; /// - /// One or more messages are requested by a consumer. This operation refers to pull-based scenarios, where consumers explicitly call methods of messaging SDKs to receive messages + /// One or more messages are requested by a consumer. This operation refers to pull-based scenarios, where consumers explicitly call methods of messaging SDKs to receive messages. /// public const string Receive = "receive"; /// - /// One or more messages are processed by a consumer + /// One or more messages are processed by a consumer. /// public const string Process = "process"; /// - /// One or more messages are settled + /// One or more messages are settled. /// public const string Settle = "settle"; /// - /// Deprecated. Use process instead + /// Deprecated. Use process instead. /// public const string Deliver = "deliver"; } /// - /// Model of message consumption. This only applies to consumer spans + /// Model of message consumption. This only applies to consumer spans. /// public static class MessagingRocketmqConsumptionModelValues { /// - /// Clustering consumption model + /// Clustering consumption model. /// public const string Clustering = "clustering"; /// - /// Broadcasting consumption model + /// Broadcasting consumption model. /// public const string Broadcasting = "broadcasting"; } /// - /// Type of message + /// Type of message. /// public static class MessagingRocketmqMessageTypeValues { /// - /// Normal message + /// Normal message. /// public const string Normal = "normal"; /// - /// FIFO message + /// FIFO message. /// public const string Fifo = "fifo"; /// - /// Delay message + /// Delay message. /// public const string Delay = "delay"; /// - /// Transaction message + /// Transaction message. /// public const string Transaction = "transaction"; } /// - /// Describes the settlement type + /// Describes the settlement type. /// public static class MessagingServicebusDispositionStatusValues { /// - /// Message is completed + /// Message is completed. /// public const string Complete = "complete"; /// - /// Message is abandoned + /// Message is abandoned. /// public const string Abandon = "abandon"; /// - /// Message is sent to dead letter queue + /// Message is sent to dead letter queue. /// public const string DeadLetter = "dead_letter"; /// - /// Message is deferred + /// Message is deferred. /// public const string Defer = "defer"; } /// - /// The messaging system as identified by the client instrumentation + /// The messaging system as identified by the client instrumentation. /// public static class MessagingSystemValues { /// - /// Apache ActiveMQ + /// Apache ActiveMQ. /// public const string Activemq = "activemq"; /// - /// Amazon Simple Queue Service (SQS) + /// Amazon Simple Queue Service (SQS). /// public const string AwsSqs = "aws_sqs"; /// - /// Azure Event Grid + /// Azure Event Grid. /// public const string Eventgrid = "eventgrid"; /// - /// Azure Event Hubs + /// Azure Event Hubs. /// public const string Eventhubs = "eventhubs"; /// - /// Azure Service Bus + /// Azure Service Bus. /// public const string Servicebus = "servicebus"; /// - /// Google Cloud Pub/Sub + /// Google Cloud Pub/Sub. /// public const string GcpPubsub = "gcp_pubsub"; /// - /// Java Message Service + /// Java Message Service. /// public const string Jms = "jms"; /// - /// Apache Kafka + /// Apache Kafka. /// public const string Kafka = "kafka"; /// - /// RabbitMQ + /// RabbitMQ. /// public const string Rabbitmq = "rabbitmq"; /// - /// Apache RocketMQ + /// Apache RocketMQ. /// public const string Rocketmq = "rocketmq"; /// - /// Apache Pulsar + /// Apache Pulsar. /// public const string Pulsar = "pulsar"; } diff --git a/src/OpenTelemetry.SemanticConventions/Attributes/NetAttributes.cs b/src/OpenTelemetry.SemanticConventions/Attributes/NetAttributes.cs index 06fdfff932..95b28032ab 100644 --- a/src/OpenTelemetry.SemanticConventions/Attributes/NetAttributes.cs +++ b/src/OpenTelemetry.SemanticConventions/Attributes/NetAttributes.cs @@ -15,152 +15,152 @@ namespace OpenTelemetry.SemanticConventions; public static class NetAttributes { /// - /// Deprecated, use network.local.address + /// Deprecated, use network.local.address. /// - [Obsolete("Replaced by network.local.address")] + [Obsolete("Replaced by network.local.address.")] public const string AttributeNetHostIp = "net.host.ip"; /// - /// Deprecated, use server.address + /// Deprecated, use server.address. /// - [Obsolete("Replaced by server.address")] + [Obsolete("Replaced by server.address.")] public const string AttributeNetHostName = "net.host.name"; /// - /// Deprecated, use server.port + /// Deprecated, use server.port. /// - [Obsolete("Replaced by server.port")] + [Obsolete("Replaced by server.port.")] public const string AttributeNetHostPort = "net.host.port"; /// - /// Deprecated, use network.peer.address + /// Deprecated, use network.peer.address. /// - [Obsolete("Replaced by network.peer.address")] + [Obsolete("Replaced by network.peer.address.")] public const string AttributeNetPeerIp = "net.peer.ip"; /// - /// Deprecated, use server.address on client spans and client.address on server spans + /// Deprecated, use server.address on client spans and client.address on server spans. /// - [Obsolete("Replaced by server.address on client spans and client.address on server spans")] + [Obsolete("Replaced by server.address on client spans and client.address on server spans.")] public const string AttributeNetPeerName = "net.peer.name"; /// - /// Deprecated, use server.port on client spans and client.port on server spans + /// Deprecated, use server.port on client spans and client.port on server spans. /// - [Obsolete("Replaced by server.port on client spans and client.port on server spans")] + [Obsolete("Replaced by server.port on client spans and client.port on server spans.")] public const string AttributeNetPeerPort = "net.peer.port"; /// - /// Deprecated, use network.protocol.name + /// Deprecated, use network.protocol.name. /// - [Obsolete("Replaced by network.protocol.name")] + [Obsolete("Replaced by network.protocol.name.")] public const string AttributeNetProtocolName = "net.protocol.name"; /// - /// Deprecated, use network.protocol.version + /// Deprecated, use network.protocol.version. /// - [Obsolete("Replaced by network.protocol.version")] + [Obsolete("Replaced by network.protocol.version.")] public const string AttributeNetProtocolVersion = "net.protocol.version"; /// - /// Deprecated, use network.transport and network.type + /// Deprecated, use network.transport and network.type. /// - [Obsolete("Split to network.transport and network.type")] + [Obsolete("Split to network.transport and network.type.")] public const string AttributeNetSockFamily = "net.sock.family"; /// - /// Deprecated, use network.local.address + /// Deprecated, use network.local.address. /// - [Obsolete("Replaced by network.local.address")] + [Obsolete("Replaced by network.local.address.")] public const string AttributeNetSockHostAddr = "net.sock.host.addr"; /// - /// Deprecated, use network.local.port + /// Deprecated, use network.local.port. /// - [Obsolete("Replaced by network.local.port")] + [Obsolete("Replaced by network.local.port.")] public const string AttributeNetSockHostPort = "net.sock.host.port"; /// - /// Deprecated, use network.peer.address + /// Deprecated, use network.peer.address. /// - [Obsolete("Replaced by network.peer.address")] + [Obsolete("Replaced by network.peer.address.")] public const string AttributeNetSockPeerAddr = "net.sock.peer.addr"; /// - /// Deprecated, no replacement at this time + /// Deprecated, no replacement at this time. /// - [Obsolete("Removed")] + [Obsolete("Removed.")] public const string AttributeNetSockPeerName = "net.sock.peer.name"; /// - /// Deprecated, use network.peer.port + /// Deprecated, use network.peer.port. /// - [Obsolete("Replaced by network.peer.port")] + [Obsolete("Replaced by network.peer.port.")] public const string AttributeNetSockPeerPort = "net.sock.peer.port"; /// - /// Deprecated, use network.transport + /// Deprecated, use network.transport. /// - [Obsolete("Replaced by network.transport")] + [Obsolete("Replaced by network.transport.")] public const string AttributeNetTransport = "net.transport"; /// - /// Deprecated, use network.transport and network.type + /// Deprecated, use network.transport and network.type. /// public static class NetSockFamilyValues { /// - /// IPv4 address + /// IPv4 address. /// - [Obsolete("Split to network.transport and network.type")] + [Obsolete("Split to network.transport and network.type.")] public const string Inet = "inet"; /// - /// IPv6 address + /// IPv6 address. /// - [Obsolete("Split to network.transport and network.type")] + [Obsolete("Split to network.transport and network.type.")] public const string Inet6 = "inet6"; /// - /// Unix domain socket path + /// Unix domain socket path. /// - [Obsolete("Split to network.transport and network.type")] + [Obsolete("Split to network.transport and network.type.")] public const string Unix = "unix"; } /// - /// Deprecated, use network.transport + /// Deprecated, use network.transport. /// public static class NetTransportValues { /// - /// ip_tcp + /// ip_tcp. /// - [Obsolete("Replaced by network.transport")] + [Obsolete("Replaced by network.transport.")] public const string IpTcp = "ip_tcp"; /// - /// ip_udp + /// ip_udp. /// - [Obsolete("Replaced by network.transport")] + [Obsolete("Replaced by network.transport.")] public const string IpUdp = "ip_udp"; /// - /// Named or anonymous pipe + /// Named or anonymous pipe. /// - [Obsolete("Replaced by network.transport")] + [Obsolete("Replaced by network.transport.")] public const string Pipe = "pipe"; /// - /// In-process communication + /// In-process communication. /// - [Obsolete("Replaced by network.transport")] + [Obsolete("Replaced by network.transport.")] public const string Inproc = "inproc"; /// - /// Something else (non IP-based) + /// Something else (non IP-based). /// - [Obsolete("Replaced by network.transport")] + [Obsolete("Replaced by network.transport.")] public const string Other = "other"; } } diff --git a/src/OpenTelemetry.SemanticConventions/Attributes/NetworkAttributes.cs b/src/OpenTelemetry.SemanticConventions/Attributes/NetworkAttributes.cs index ef64321563..301b5d9e70 100644 --- a/src/OpenTelemetry.SemanticConventions/Attributes/NetworkAttributes.cs +++ b/src/OpenTelemetry.SemanticConventions/Attributes/NetworkAttributes.cs @@ -15,297 +15,297 @@ namespace OpenTelemetry.SemanticConventions; public static class NetworkAttributes { /// - /// The ISO 3166-1 alpha-2 2-character country code associated with the mobile carrier network + /// The ISO 3166-1 alpha-2 2-character country code associated with the mobile carrier network. /// public const string AttributeNetworkCarrierIcc = "network.carrier.icc"; /// - /// The mobile carrier country code + /// The mobile carrier country code. /// public const string AttributeNetworkCarrierMcc = "network.carrier.mcc"; /// - /// The mobile carrier network code + /// The mobile carrier network code. /// public const string AttributeNetworkCarrierMnc = "network.carrier.mnc"; /// - /// The name of the mobile carrier + /// The name of the mobile carrier. /// public const string AttributeNetworkCarrierName = "network.carrier.name"; /// - /// This describes more details regarding the connection.type. It may be the type of cell technology connection, but it could be used for describing details about a wifi connection + /// This describes more details regarding the connection.type. It may be the type of cell technology connection, but it could be used for describing details about a wifi connection. /// public const string AttributeNetworkConnectionSubtype = "network.connection.subtype"; /// - /// The internet connection type + /// The internet connection type. /// public const string AttributeNetworkConnectionType = "network.connection.type"; /// - /// The network IO operation direction + /// The network IO operation direction. /// public const string AttributeNetworkIoDirection = "network.io.direction"; /// - /// Local address of the network connection - IP address or Unix domain socket name + /// Local address of the network connection - IP address or Unix domain socket name. /// public const string AttributeNetworkLocalAddress = "network.local.address"; /// - /// Local port number of the network connection + /// Local port number of the network connection. /// public const string AttributeNetworkLocalPort = "network.local.port"; /// - /// Peer address of the network connection - IP address or Unix domain socket name + /// Peer address of the network connection - IP address or Unix domain socket name. /// public const string AttributeNetworkPeerAddress = "network.peer.address"; /// - /// Peer port number of the network connection + /// Peer port number of the network connection. /// public const string AttributeNetworkPeerPort = "network.peer.port"; /// - /// OSI application layer or non-OSI equivalent + /// OSI application layer or non-OSI equivalent. /// /// - /// The value SHOULD be normalized to lowercase + /// The value SHOULD be normalized to lowercase. /// public const string AttributeNetworkProtocolName = "network.protocol.name"; /// - /// The actual version of the protocol used for network communication + /// The actual version of the protocol used for network communication. /// /// - /// If protocol version is subject to negotiation (for example using ALPN), this attribute SHOULD be set to the negotiated version. If the actual protocol version is not known, this attribute SHOULD NOT be set + /// If protocol version is subject to negotiation (for example using ALPN), this attribute SHOULD be set to the negotiated version. If the actual protocol version is not known, this attribute SHOULD NOT be set. /// public const string AttributeNetworkProtocolVersion = "network.protocol.version"; /// - /// OSI transport layer or inter-process communication method + /// OSI transport layer or inter-process communication method. /// /// /// The value SHOULD be normalized to lowercase. ///

    /// Consider always setting the transport when setting a port number, since /// a port number is ambiguous without knowing the transport. For example - /// different processes could be listening on TCP port 12345 and UDP port 12345 + /// different processes could be listening on TCP port 12345 and UDP port 12345. /// public const string AttributeNetworkTransport = "network.transport"; ///

    - /// OSI network layer or non-OSI equivalent + /// OSI network layer or non-OSI equivalent. /// /// - /// The value SHOULD be normalized to lowercase + /// The value SHOULD be normalized to lowercase. /// public const string AttributeNetworkType = "network.type"; /// - /// This describes more details regarding the connection.type. It may be the type of cell technology connection, but it could be used for describing details about a wifi connection + /// This describes more details regarding the connection.type. It may be the type of cell technology connection, but it could be used for describing details about a wifi connection. /// public static class NetworkConnectionSubtypeValues { /// - /// GPRS + /// GPRS. /// public const string Gprs = "gprs"; /// - /// EDGE + /// EDGE. /// public const string Edge = "edge"; /// - /// UMTS + /// UMTS. /// public const string Umts = "umts"; /// - /// CDMA + /// CDMA. /// public const string Cdma = "cdma"; /// - /// EVDO Rel. 0 + /// EVDO Rel. 0. /// public const string Evdo0 = "evdo_0"; /// - /// EVDO Rev. A + /// EVDO Rev. A. /// public const string EvdoA = "evdo_a"; /// - /// CDMA2000 1XRTT + /// CDMA2000 1XRTT. /// public const string Cdma20001xrtt = "cdma2000_1xrtt"; /// - /// HSDPA + /// HSDPA. /// public const string Hsdpa = "hsdpa"; /// - /// HSUPA + /// HSUPA. /// public const string Hsupa = "hsupa"; /// - /// HSPA + /// HSPA. /// public const string Hspa = "hspa"; /// - /// IDEN + /// IDEN. /// public const string Iden = "iden"; /// - /// EVDO Rev. B + /// EVDO Rev. B. /// public const string EvdoB = "evdo_b"; /// - /// LTE + /// LTE. /// public const string Lte = "lte"; /// - /// EHRPD + /// EHRPD. /// public const string Ehrpd = "ehrpd"; /// - /// HSPAP + /// HSPAP. /// public const string Hspap = "hspap"; /// - /// GSM + /// GSM. /// public const string Gsm = "gsm"; /// - /// TD-SCDMA + /// TD-SCDMA. /// public const string TdScdma = "td_scdma"; /// - /// IWLAN + /// IWLAN. /// public const string Iwlan = "iwlan"; /// - /// 5G NR (New Radio) + /// 5G NR (New Radio). /// public const string Nr = "nr"; /// - /// 5G NRNSA (New Radio Non-Standalone) + /// 5G NRNSA (New Radio Non-Standalone). /// public const string Nrnsa = "nrnsa"; /// - /// LTE CA + /// LTE CA. /// public const string LteCa = "lte_ca"; } /// - /// The internet connection type + /// The internet connection type. /// public static class NetworkConnectionTypeValues { /// - /// wifi + /// wifi. /// public const string Wifi = "wifi"; /// - /// wired + /// wired. /// public const string Wired = "wired"; /// - /// cell + /// cell. /// public const string Cell = "cell"; /// - /// unavailable + /// unavailable. /// public const string Unavailable = "unavailable"; /// - /// unknown + /// unknown. /// public const string Unknown = "unknown"; } /// - /// The network IO operation direction + /// The network IO operation direction. /// public static class NetworkIoDirectionValues { /// - /// transmit + /// transmit. /// public const string Transmit = "transmit"; /// - /// receive + /// receive. /// public const string Receive = "receive"; } /// - /// OSI transport layer or inter-process communication method + /// OSI transport layer or inter-process communication method. /// public static class NetworkTransportValues { /// - /// TCP + /// TCP. /// public const string Tcp = "tcp"; /// - /// UDP + /// UDP. /// public const string Udp = "udp"; /// - /// Named or anonymous pipe + /// Named or anonymous pipe. /// public const string Pipe = "pipe"; /// - /// Unix domain socket + /// Unix domain socket. /// public const string Unix = "unix"; /// - /// QUIC + /// QUIC. /// public const string Quic = "quic"; } /// - /// OSI network layer or non-OSI equivalent + /// OSI network layer or non-OSI equivalent. /// public static class NetworkTypeValues { /// - /// IPv4 + /// IPv4. /// public const string Ipv4 = "ipv4"; /// - /// IPv6 + /// IPv6. /// public const string Ipv6 = "ipv6"; } diff --git a/src/OpenTelemetry.SemanticConventions/Attributes/OciAttributes.cs b/src/OpenTelemetry.SemanticConventions/Attributes/OciAttributes.cs index ca9e010ce8..6f22b46301 100644 --- a/src/OpenTelemetry.SemanticConventions/Attributes/OciAttributes.cs +++ b/src/OpenTelemetry.SemanticConventions/Attributes/OciAttributes.cs @@ -15,11 +15,11 @@ namespace OpenTelemetry.SemanticConventions; public static class OciAttributes { /// - /// The digest of the OCI image manifest. For container images specifically is the digest by which the container image is known + /// The digest of the OCI image manifest. For container images specifically is the digest by which the container image is known. /// /// /// Follows OCI Image Manifest Specification, and specifically the Digest property. - /// An example can be found in Example Image Manifest + /// An example can be found in Example Image Manifest. /// public const string AttributeOciManifestDigest = "oci.manifest.digest"; } diff --git a/src/OpenTelemetry.SemanticConventions/Attributes/OpentracingAttributes.cs b/src/OpenTelemetry.SemanticConventions/Attributes/OpentracingAttributes.cs index 99041c4ea9..29f6aa5a02 100644 --- a/src/OpenTelemetry.SemanticConventions/Attributes/OpentracingAttributes.cs +++ b/src/OpenTelemetry.SemanticConventions/Attributes/OpentracingAttributes.cs @@ -15,25 +15,25 @@ namespace OpenTelemetry.SemanticConventions; public static class OpentracingAttributes { /// - /// Parent-child Reference type + /// Parent-child Reference type. /// /// - /// The causal relationship between a child Span and a parent Span + /// The causal relationship between a child Span and a parent Span. /// public const string AttributeOpentracingRefType = "opentracing.ref_type"; /// - /// Parent-child Reference type + /// Parent-child Reference type. /// public static class OpentracingRefTypeValues { /// - /// The parent Span depends on the child Span in some capacity + /// The parent Span depends on the child Span in some capacity. /// public const string ChildOf = "child_of"; /// - /// The parent Span doesn't depend in any way on the result of the child Span + /// The parent Span doesn't depend in any way on the result of the child Span. /// public const string FollowsFrom = "follows_from"; } diff --git a/src/OpenTelemetry.SemanticConventions/Attributes/OsAttributes.cs b/src/OpenTelemetry.SemanticConventions/Attributes/OsAttributes.cs index f5700c4ef3..0dac23f161 100644 --- a/src/OpenTelemetry.SemanticConventions/Attributes/OsAttributes.cs +++ b/src/OpenTelemetry.SemanticConventions/Attributes/OsAttributes.cs @@ -15,87 +15,87 @@ namespace OpenTelemetry.SemanticConventions; public static class OsAttributes { /// - /// Unique identifier for a particular build or compilation of the operating system + /// Unique identifier for a particular build or compilation of the operating system. /// public const string AttributeOsBuildId = "os.build_id"; /// - /// Human readable (not intended to be parsed) OS version information, like e.g. reported by ver or lsb_release -a commands + /// Human readable (not intended to be parsed) OS version information, like e.g. reported by ver or lsb_release -a commands. /// public const string AttributeOsDescription = "os.description"; /// - /// Human readable operating system name + /// Human readable operating system name. /// public const string AttributeOsName = "os.name"; /// - /// The operating system type + /// The operating system type. /// public const string AttributeOsType = "os.type"; /// - /// The version string of the operating system as defined in Version Attributes + /// The version string of the operating system as defined in Version Attributes. /// public const string AttributeOsVersion = "os.version"; /// - /// The operating system type + /// The operating system type. /// public static class OsTypeValues { /// - /// Microsoft Windows + /// Microsoft Windows. /// public const string Windows = "windows"; /// - /// Linux + /// Linux. /// public const string Linux = "linux"; /// - /// Apple Darwin + /// Apple Darwin. /// public const string Darwin = "darwin"; /// - /// FreeBSD + /// FreeBSD. /// public const string Freebsd = "freebsd"; /// - /// NetBSD + /// NetBSD. /// public const string Netbsd = "netbsd"; /// - /// OpenBSD + /// OpenBSD. /// public const string Openbsd = "openbsd"; /// - /// DragonFly BSD + /// DragonFly BSD. /// public const string Dragonflybsd = "dragonflybsd"; /// - /// HP-UX (Hewlett Packard Unix) + /// HP-UX (Hewlett Packard Unix). /// public const string Hpux = "hpux"; /// - /// AIX (Advanced Interactive eXecutive) + /// AIX (Advanced Interactive eXecutive). /// public const string Aix = "aix"; /// - /// SunOS, Oracle Solaris + /// SunOS, Oracle Solaris. /// public const string Solaris = "solaris"; /// - /// IBM z/OS + /// IBM z/OS. /// public const string ZOs = "z_os"; } diff --git a/src/OpenTelemetry.SemanticConventions/Attributes/OtelAttributes.cs b/src/OpenTelemetry.SemanticConventions/Attributes/OtelAttributes.cs index 56695acece..4d0407eda1 100644 --- a/src/OpenTelemetry.SemanticConventions/Attributes/OtelAttributes.cs +++ b/src/OpenTelemetry.SemanticConventions/Attributes/OtelAttributes.cs @@ -15,37 +15,37 @@ namespace OpenTelemetry.SemanticConventions; public static class OtelAttributes { /// - /// The name of the instrumentation scope - (InstrumentationScope.Name in OTLP) + /// The name of the instrumentation scope - (InstrumentationScope.Name in OTLP). /// public const string AttributeOtelScopeName = "otel.scope.name"; /// - /// The version of the instrumentation scope - (InstrumentationScope.Version in OTLP) + /// The version of the instrumentation scope - (InstrumentationScope.Version in OTLP). /// public const string AttributeOtelScopeVersion = "otel.scope.version"; /// - /// Name of the code, either "OK" or "ERROR". MUST NOT be set if the status code is UNSET + /// Name of the code, either "OK" or "ERROR". MUST NOT be set if the status code is UNSET. /// public const string AttributeOtelStatusCode = "otel.status_code"; /// - /// Description of the Status if it has a value, otherwise not set + /// Description of the Status if it has a value, otherwise not set. /// public const string AttributeOtelStatusDescription = "otel.status_description"; /// - /// Name of the code, either "OK" or "ERROR". MUST NOT be set if the status code is UNSET + /// Name of the code, either "OK" or "ERROR". MUST NOT be set if the status code is UNSET. /// public static class OtelStatusCodeValues { /// - /// The operation has been validated by an Application developer or Operator to have completed successfully + /// The operation has been validated by an Application developer or Operator to have completed successfully. /// public const string Ok = "OK"; /// - /// The operation contains an error + /// The operation contains an error. /// public const string Error = "ERROR"; } diff --git a/src/OpenTelemetry.SemanticConventions/Attributes/OtherAttributes.cs b/src/OpenTelemetry.SemanticConventions/Attributes/OtherAttributes.cs index 4be44a0190..267c5f867b 100644 --- a/src/OpenTelemetry.SemanticConventions/Attributes/OtherAttributes.cs +++ b/src/OpenTelemetry.SemanticConventions/Attributes/OtherAttributes.cs @@ -15,26 +15,26 @@ namespace OpenTelemetry.SemanticConventions; public static class OtherAttributes { /// - /// Deprecated, use db.client.connection.state instead + /// Deprecated, use db.client.connection.state instead. /// - [Obsolete("Replaced by db.client.connection.state")] + [Obsolete("Replaced by db.client.connection.state.")] public const string AttributeState = "state"; /// - /// Deprecated, use db.client.connection.state instead + /// Deprecated, use db.client.connection.state instead. /// public static class StateValues { /// - /// idle + /// idle. /// - [Obsolete("Replaced by db.client.connection.state")] + [Obsolete("Replaced by db.client.connection.state.")] public const string Idle = "idle"; /// - /// used + /// used. /// - [Obsolete("Replaced by db.client.connection.state")] + [Obsolete("Replaced by db.client.connection.state.")] public const string Used = "used"; } } diff --git a/src/OpenTelemetry.SemanticConventions/Attributes/PeerAttributes.cs b/src/OpenTelemetry.SemanticConventions/Attributes/PeerAttributes.cs index 3908588744..849d1f4302 100644 --- a/src/OpenTelemetry.SemanticConventions/Attributes/PeerAttributes.cs +++ b/src/OpenTelemetry.SemanticConventions/Attributes/PeerAttributes.cs @@ -15,7 +15,7 @@ namespace OpenTelemetry.SemanticConventions; public static class PeerAttributes { /// - /// The service.name of the remote service. SHOULD be equal to the actual service.name resource attribute of the remote service if any + /// The service.name of the remote service. SHOULD be equal to the actual service.name resource attribute of the remote service if any. /// public const string AttributePeerService = "peer.service"; } diff --git a/src/OpenTelemetry.SemanticConventions/Attributes/PoolAttributes.cs b/src/OpenTelemetry.SemanticConventions/Attributes/PoolAttributes.cs index 1d791b869b..8616ce65db 100644 --- a/src/OpenTelemetry.SemanticConventions/Attributes/PoolAttributes.cs +++ b/src/OpenTelemetry.SemanticConventions/Attributes/PoolAttributes.cs @@ -15,8 +15,8 @@ namespace OpenTelemetry.SemanticConventions; public static class PoolAttributes { /// - /// Deprecated, use db.client.connection.pool.name instead + /// Deprecated, use db.client.connection.pool.name instead. /// - [Obsolete("Replaced by db.client.connection.pool.name")] + [Obsolete("Replaced by db.client.connection.pool.name.")] public const string AttributePoolName = "pool.name"; } diff --git a/src/OpenTelemetry.SemanticConventions/Attributes/ProcessAttributes.cs b/src/OpenTelemetry.SemanticConventions/Attributes/ProcessAttributes.cs index 17273e200a..da4d98d30e 100644 --- a/src/OpenTelemetry.SemanticConventions/Attributes/ProcessAttributes.cs +++ b/src/OpenTelemetry.SemanticConventions/Attributes/ProcessAttributes.cs @@ -15,196 +15,196 @@ namespace OpenTelemetry.SemanticConventions; public static class ProcessAttributes { /// - /// The command used to launch the process (i.e. the command name). On Linux based systems, can be set to the zeroth string in proc/[pid]/cmdline. On Windows, can be set to the first parameter extracted from GetCommandLineW + /// The command used to launch the process (i.e. the command name). On Linux based systems, can be set to the zeroth string in proc/[pid]/cmdline. On Windows, can be set to the first parameter extracted from GetCommandLineW. /// public const string AttributeProcessCommand = "process.command"; /// - /// All the command arguments (including the command/executable itself) as received by the process. On Linux-based systems (and some other Unixoid systems supporting procfs), can be set according to the list of null-delimited strings extracted from proc/[pid]/cmdline. For libc-based executables, this would be the full argv vector passed to main + /// All the command arguments (including the command/executable itself) as received by the process. On Linux-based systems (and some other Unixoid systems supporting procfs), can be set according to the list of null-delimited strings extracted from proc/[pid]/cmdline. For libc-based executables, this would be the full argv vector passed to main. /// public const string AttributeProcessCommandArgs = "process.command_args"; /// - /// The full command used to launch the process as a single string representing the full command. On Windows, can be set to the result of GetCommandLineW. Do not set this if you have to assemble it just for monitoring; use process.command_args instead + /// The full command used to launch the process as a single string representing the full command. On Windows, can be set to the result of GetCommandLineW. Do not set this if you have to assemble it just for monitoring; use process.command_args instead. /// public const string AttributeProcessCommandLine = "process.command_line"; /// - /// Specifies whether the context switches for this data point were voluntary or involuntary + /// Specifies whether the context switches for this data point were voluntary or involuntary. /// public const string AttributeProcessContextSwitchType = "process.context_switch_type"; /// - /// Deprecated, use cpu.mode instead + /// Deprecated, use cpu.mode instead. /// - [Obsolete("Replaced by cpu.mode")] + [Obsolete("Replaced by cpu.mode.")] public const string AttributeProcessCpuState = "process.cpu.state"; /// - /// The date and time the process was created, in ISO 8601 format + /// The date and time the process was created, in ISO 8601 format. /// public const string AttributeProcessCreationTime = "process.creation.time"; /// - /// The name of the process executable. On Linux based systems, can be set to the Name in proc/[pid]/status. On Windows, can be set to the base name of GetProcessImageFileNameW + /// The name of the process executable. On Linux based systems, can be set to the Name in proc/[pid]/status. On Windows, can be set to the base name of GetProcessImageFileNameW. /// public const string AttributeProcessExecutableName = "process.executable.name"; /// - /// The full path to the process executable. On Linux based systems, can be set to the target of proc/[pid]/exe. On Windows, can be set to the result of GetProcessImageFileNameW + /// The full path to the process executable. On Linux based systems, can be set to the target of proc/[pid]/exe. On Windows, can be set to the result of GetProcessImageFileNameW. /// public const string AttributeProcessExecutablePath = "process.executable.path"; /// - /// The exit code of the process + /// The exit code of the process. /// public const string AttributeProcessExitCode = "process.exit.code"; /// - /// The date and time the process exited, in ISO 8601 format + /// The date and time the process exited, in ISO 8601 format. /// public const string AttributeProcessExitTime = "process.exit.time"; /// - /// The PID of the process's group leader. This is also the process group ID (PGID) of the process + /// The PID of the process's group leader. This is also the process group ID (PGID) of the process. /// public const string AttributeProcessGroupLeaderPid = "process.group_leader.pid"; /// - /// Whether the process is connected to an interactive shell + /// Whether the process is connected to an interactive shell. /// public const string AttributeProcessInteractive = "process.interactive"; /// - /// The username of the user that owns the process + /// The username of the user that owns the process. /// public const string AttributeProcessOwner = "process.owner"; /// - /// The type of page fault for this data point. Type major is for major/hard page faults, and minor is for minor/soft page faults + /// The type of page fault for this data point. Type major is for major/hard page faults, and minor is for minor/soft page faults. /// public const string AttributeProcessPagingFaultType = "process.paging.fault_type"; /// - /// Parent Process identifier (PPID) + /// Parent Process identifier (PPID). /// public const string AttributeProcessParentPid = "process.parent_pid"; /// - /// Process identifier (PID) + /// Process identifier (PID). /// public const string AttributeProcessPid = "process.pid"; /// - /// The real user ID (RUID) of the process + /// The real user ID (RUID) of the process. /// public const string AttributeProcessRealUserId = "process.real_user.id"; /// - /// The username of the real user of the process + /// The username of the real user of the process. /// public const string AttributeProcessRealUserName = "process.real_user.name"; /// - /// An additional description about the runtime of the process, for example a specific vendor customization of the runtime environment + /// An additional description about the runtime of the process, for example a specific vendor customization of the runtime environment. /// public const string AttributeProcessRuntimeDescription = "process.runtime.description"; /// - /// The name of the runtime of this process + /// The name of the runtime of this process. /// public const string AttributeProcessRuntimeName = "process.runtime.name"; /// - /// The version of the runtime of this process, as returned by the runtime without modification + /// The version of the runtime of this process, as returned by the runtime without modification. /// public const string AttributeProcessRuntimeVersion = "process.runtime.version"; /// - /// The saved user ID (SUID) of the process + /// The saved user ID (SUID) of the process. /// public const string AttributeProcessSavedUserId = "process.saved_user.id"; /// - /// The username of the saved user + /// The username of the saved user. /// public const string AttributeProcessSavedUserName = "process.saved_user.name"; /// - /// The PID of the process's session leader. This is also the session ID (SID) of the process + /// The PID of the process's session leader. This is also the session ID (SID) of the process. /// public const string AttributeProcessSessionLeaderPid = "process.session_leader.pid"; /// - /// The effective user ID (EUID) of the process + /// The effective user ID (EUID) of the process. /// public const string AttributeProcessUserId = "process.user.id"; /// - /// The username of the effective user of the process + /// The username of the effective user of the process. /// public const string AttributeProcessUserName = "process.user.name"; /// - /// Virtual process identifier + /// Virtual process identifier. /// /// - /// The process ID within a PID namespace. This is not necessarily unique across all processes on the host but it is unique within the process namespace that the process exists within + /// The process ID within a PID namespace. This is not necessarily unique across all processes on the host but it is unique within the process namespace that the process exists within. /// public const string AttributeProcessVpid = "process.vpid"; /// - /// Specifies whether the context switches for this data point were voluntary or involuntary + /// Specifies whether the context switches for this data point were voluntary or involuntary. /// public static class ProcessContextSwitchTypeValues { /// - /// voluntary + /// voluntary. /// public const string Voluntary = "voluntary"; /// - /// involuntary + /// involuntary. /// public const string Involuntary = "involuntary"; } /// - /// Deprecated, use cpu.mode instead + /// Deprecated, use cpu.mode instead. /// public static class ProcessCpuStateValues { /// - /// system + /// system. /// - [Obsolete("Replaced by cpu.mode")] + [Obsolete("Replaced by cpu.mode.")] public const string System = "system"; /// - /// user + /// user. /// - [Obsolete("Replaced by cpu.mode")] + [Obsolete("Replaced by cpu.mode.")] public const string User = "user"; /// - /// wait + /// wait. /// - [Obsolete("Replaced by cpu.mode")] + [Obsolete("Replaced by cpu.mode.")] public const string Wait = "wait"; } /// - /// The type of page fault for this data point. Type major is for major/hard page faults, and minor is for minor/soft page faults + /// The type of page fault for this data point. Type major is for major/hard page faults, and minor is for minor/soft page faults. /// public static class ProcessPagingFaultTypeValues { /// - /// major + /// major. /// public const string Major = "major"; /// - /// minor + /// minor. /// public const string Minor = "minor"; } diff --git a/src/OpenTelemetry.SemanticConventions/Attributes/RpcAttributes.cs b/src/OpenTelemetry.SemanticConventions/Attributes/RpcAttributes.cs index 2757fdb910..094511cff4 100644 --- a/src/OpenTelemetry.SemanticConventions/Attributes/RpcAttributes.cs +++ b/src/OpenTelemetry.SemanticConventions/Attributes/RpcAttributes.cs @@ -15,331 +15,331 @@ namespace OpenTelemetry.SemanticConventions; public static class RpcAttributes { /// - /// The error codes of the Connect request. Error codes are always string values + /// The error codes of the Connect request. Error codes are always string values. /// public const string AttributeRpcConnectRpcErrorCode = "rpc.connect_rpc.error_code"; /// - /// Connect request metadata, being the normalized Connect Metadata key (lowercase), the value being the metadata values + /// Connect request metadata, being the normalized Connect Metadata key (lowercase), the value being the metadata values. /// /// - /// Instrumentations SHOULD require an explicit configuration of which metadata values are to be captured. Including all request metadata values can be a security risk - explicit configuration helps avoid leaking sensitive information + /// Instrumentations SHOULD require an explicit configuration of which metadata values are to be captured. Including all request metadata values can be a security risk - explicit configuration helps avoid leaking sensitive information. /// public const string AttributeRpcConnectRpcRequestMetadataTemplate = "rpc.connect_rpc.request.metadata"; /// - /// Connect response metadata, being the normalized Connect Metadata key (lowercase), the value being the metadata values + /// Connect response metadata, being the normalized Connect Metadata key (lowercase), the value being the metadata values. /// /// - /// Instrumentations SHOULD require an explicit configuration of which metadata values are to be captured. Including all response metadata values can be a security risk - explicit configuration helps avoid leaking sensitive information + /// Instrumentations SHOULD require an explicit configuration of which metadata values are to be captured. Including all response metadata values can be a security risk - explicit configuration helps avoid leaking sensitive information. /// public const string AttributeRpcConnectRpcResponseMetadataTemplate = "rpc.connect_rpc.response.metadata"; /// - /// gRPC request metadata, being the normalized gRPC Metadata key (lowercase), the value being the metadata values + /// gRPC request metadata, being the normalized gRPC Metadata key (lowercase), the value being the metadata values. /// /// - /// Instrumentations SHOULD require an explicit configuration of which metadata values are to be captured. Including all request metadata values can be a security risk - explicit configuration helps avoid leaking sensitive information + /// Instrumentations SHOULD require an explicit configuration of which metadata values are to be captured. Including all request metadata values can be a security risk - explicit configuration helps avoid leaking sensitive information. /// public const string AttributeRpcGrpcRequestMetadataTemplate = "rpc.grpc.request.metadata"; /// - /// gRPC response metadata, being the normalized gRPC Metadata key (lowercase), the value being the metadata values + /// gRPC response metadata, being the normalized gRPC Metadata key (lowercase), the value being the metadata values. /// /// - /// Instrumentations SHOULD require an explicit configuration of which metadata values are to be captured. Including all response metadata values can be a security risk - explicit configuration helps avoid leaking sensitive information + /// Instrumentations SHOULD require an explicit configuration of which metadata values are to be captured. Including all response metadata values can be a security risk - explicit configuration helps avoid leaking sensitive information. /// public const string AttributeRpcGrpcResponseMetadataTemplate = "rpc.grpc.response.metadata"; /// - /// The numeric status code of the gRPC request + /// The numeric status code of the gRPC request. /// public const string AttributeRpcGrpcStatusCode = "rpc.grpc.status_code"; /// - /// error.code property of response if it is an error response + /// error.code property of response if it is an error response. /// public const string AttributeRpcJsonrpcErrorCode = "rpc.jsonrpc.error_code"; /// - /// error.message property of response if it is an error response + /// error.message property of response if it is an error response. /// public const string AttributeRpcJsonrpcErrorMessage = "rpc.jsonrpc.error_message"; /// - /// id property of request or response. Since protocol allows id to be int, string, null or missing (for notifications), value is expected to be cast to string for simplicity. Use empty string in case of null value. Omit entirely if this is a notification + /// id property of request or response. Since protocol allows id to be int, string, null or missing (for notifications), value is expected to be cast to string for simplicity. Use empty string in case of null value. Omit entirely if this is a notification. /// public const string AttributeRpcJsonrpcRequestId = "rpc.jsonrpc.request_id"; /// - /// Protocol version as in jsonrpc property of request/response. Since JSON-RPC 1.0 doesn't specify this, the value can be omitted + /// Protocol version as in jsonrpc property of request/response. Since JSON-RPC 1.0 doesn't specify this, the value can be omitted. /// public const string AttributeRpcJsonrpcVersion = "rpc.jsonrpc.version"; /// - /// Compressed size of the message in bytes + /// Compressed size of the message in bytes. /// public const string AttributeRpcMessageCompressedSize = "rpc.message.compressed_size"; /// - /// MUST be calculated as two different counters starting from 1 one for sent messages and one for received message + /// MUST be calculated as two different counters starting from 1 one for sent messages and one for received message. /// /// - /// This way we guarantee that the values will be consistent between different implementations + /// This way we guarantee that the values will be consistent between different implementations. /// public const string AttributeRpcMessageId = "rpc.message.id"; /// - /// Whether this is a received or sent message + /// Whether this is a received or sent message. /// public const string AttributeRpcMessageType = "rpc.message.type"; /// - /// Uncompressed size of the message in bytes + /// Uncompressed size of the message in bytes. /// public const string AttributeRpcMessageUncompressedSize = "rpc.message.uncompressed_size"; /// - /// The name of the (logical) method being called, must be equal to the $method part in the span name + /// The name of the (logical) method being called, must be equal to the $method part in the span name. /// /// - /// This is the logical name of the method from the RPC interface perspective, which can be different from the name of any implementing method/function. The code.function attribute may be used to store the latter (e.g., method actually executing the call on the server side, RPC client stub method on the client side) + /// This is the logical name of the method from the RPC interface perspective, which can be different from the name of any implementing method/function. The code.function attribute may be used to store the latter (e.g., method actually executing the call on the server side, RPC client stub method on the client side). /// public const string AttributeRpcMethod = "rpc.method"; /// - /// The full (logical) name of the service being called, including its package name, if applicable + /// The full (logical) name of the service being called, including its package name, if applicable. /// /// - /// This is the logical name of the service from the RPC interface perspective, which can be different from the name of any implementing class. The code.namespace attribute may be used to store the latter (despite the attribute name, it may include a class name; e.g., class with method actually executing the call on the server side, RPC client stub class on the client side) + /// This is the logical name of the service from the RPC interface perspective, which can be different from the name of any implementing class. The code.namespace attribute may be used to store the latter (despite the attribute name, it may include a class name; e.g., class with method actually executing the call on the server side, RPC client stub class on the client side). /// public const string AttributeRpcService = "rpc.service"; /// - /// A string identifying the remoting system. See below for a list of well-known identifiers + /// A string identifying the remoting system. See below for a list of well-known identifiers. /// public const string AttributeRpcSystem = "rpc.system"; /// - /// The error codes of the Connect request. Error codes are always string values + /// The error codes of the Connect request. Error codes are always string values. /// public static class RpcConnectRpcErrorCodeValues { /// - /// cancelled + /// cancelled. /// public const string Cancelled = "cancelled"; /// - /// unknown + /// unknown. /// public const string Unknown = "unknown"; /// - /// invalid_argument + /// invalid_argument. /// public const string InvalidArgument = "invalid_argument"; /// - /// deadline_exceeded + /// deadline_exceeded. /// public const string DeadlineExceeded = "deadline_exceeded"; /// - /// not_found + /// not_found. /// public const string NotFound = "not_found"; /// - /// already_exists + /// already_exists. /// public const string AlreadyExists = "already_exists"; /// - /// permission_denied + /// permission_denied. /// public const string PermissionDenied = "permission_denied"; /// - /// resource_exhausted + /// resource_exhausted. /// public const string ResourceExhausted = "resource_exhausted"; /// - /// failed_precondition + /// failed_precondition. /// public const string FailedPrecondition = "failed_precondition"; /// - /// aborted + /// aborted. /// public const string Aborted = "aborted"; /// - /// out_of_range + /// out_of_range. /// public const string OutOfRange = "out_of_range"; /// - /// unimplemented + /// unimplemented. /// public const string Unimplemented = "unimplemented"; /// - /// internal + /// internal. /// public const string Internal = "internal"; /// - /// unavailable + /// unavailable. /// public const string Unavailable = "unavailable"; /// - /// data_loss + /// data_loss. /// public const string DataLoss = "data_loss"; /// - /// unauthenticated + /// unauthenticated. /// public const string Unauthenticated = "unauthenticated"; } /// - /// The numeric status code of the gRPC request + /// The numeric status code of the gRPC request. /// public static class RpcGrpcStatusCodeValues { /// - /// OK + /// OK. /// public const int Ok = 0; /// - /// CANCELLED + /// CANCELLED. /// public const int Cancelled = 1; /// - /// UNKNOWN + /// UNKNOWN. /// public const int Unknown = 2; /// - /// INVALID_ARGUMENT + /// INVALID_ARGUMENT. /// public const int InvalidArgument = 3; /// - /// DEADLINE_EXCEEDED + /// DEADLINE_EXCEEDED. /// public const int DeadlineExceeded = 4; /// - /// NOT_FOUND + /// NOT_FOUND. /// public const int NotFound = 5; /// - /// ALREADY_EXISTS + /// ALREADY_EXISTS. /// public const int AlreadyExists = 6; /// - /// PERMISSION_DENIED + /// PERMISSION_DENIED. /// public const int PermissionDenied = 7; /// - /// RESOURCE_EXHAUSTED + /// RESOURCE_EXHAUSTED. /// public const int ResourceExhausted = 8; /// - /// FAILED_PRECONDITION + /// FAILED_PRECONDITION. /// public const int FailedPrecondition = 9; /// - /// ABORTED + /// ABORTED. /// public const int Aborted = 10; /// - /// OUT_OF_RANGE + /// OUT_OF_RANGE. /// public const int OutOfRange = 11; /// - /// UNIMPLEMENTED + /// UNIMPLEMENTED. /// public const int Unimplemented = 12; /// - /// INTERNAL + /// INTERNAL. /// public const int Internal = 13; /// - /// UNAVAILABLE + /// UNAVAILABLE. /// public const int Unavailable = 14; /// - /// DATA_LOSS + /// DATA_LOSS. /// public const int DataLoss = 15; /// - /// UNAUTHENTICATED + /// UNAUTHENTICATED. /// public const int Unauthenticated = 16; } /// - /// Whether this is a received or sent message + /// Whether this is a received or sent message. /// public static class RpcMessageTypeValues { /// - /// sent + /// sent. /// public const string Sent = "SENT"; /// - /// received + /// received. /// public const string Received = "RECEIVED"; } /// - /// A string identifying the remoting system. See below for a list of well-known identifiers + /// A string identifying the remoting system. See below for a list of well-known identifiers. /// public static class RpcSystemValues { /// - /// gRPC + /// gRPC. /// public const string Grpc = "grpc"; /// - /// Java RMI + /// Java RMI. /// public const string JavaRmi = "java_rmi"; /// - /// .NET WCF + /// .NET WCF. /// public const string DotnetWcf = "dotnet_wcf"; /// - /// Apache Dubbo + /// Apache Dubbo. /// public const string ApacheDubbo = "apache_dubbo"; /// - /// Connect RPC + /// Connect RPC. /// public const string ConnectRpc = "connect_rpc"; } diff --git a/src/OpenTelemetry.SemanticConventions/Attributes/ServerAttributes.cs b/src/OpenTelemetry.SemanticConventions/Attributes/ServerAttributes.cs index 75ecf5f8af..d201a41e92 100644 --- a/src/OpenTelemetry.SemanticConventions/Attributes/ServerAttributes.cs +++ b/src/OpenTelemetry.SemanticConventions/Attributes/ServerAttributes.cs @@ -15,18 +15,18 @@ namespace OpenTelemetry.SemanticConventions; public static class ServerAttributes { /// - /// Server domain name if available without reverse DNS lookup; otherwise, IP address or Unix domain socket name + /// Server domain name if available without reverse DNS lookup; otherwise, IP address or Unix domain socket name. /// /// - /// When observed from the client side, and when communicating through an intermediary, server.address SHOULD represent the server address behind any intermediaries, for example proxies, if it's available + /// When observed from the client side, and when communicating through an intermediary, server.address SHOULD represent the server address behind any intermediaries, for example proxies, if it's available. /// public const string AttributeServerAddress = "server.address"; /// - /// Server port number + /// Server port number. /// /// - /// When observed from the client side, and when communicating through an intermediary, server.port SHOULD represent the server port behind any intermediaries, for example proxies, if it's available + /// When observed from the client side, and when communicating through an intermediary, server.port SHOULD represent the server port behind any intermediaries, for example proxies, if it's available. /// public const string AttributeServerPort = "server.port"; } diff --git a/src/OpenTelemetry.SemanticConventions/Attributes/ServiceAttributes.cs b/src/OpenTelemetry.SemanticConventions/Attributes/ServiceAttributes.cs index 2d1352ef80..18d3b5f96b 100644 --- a/src/OpenTelemetry.SemanticConventions/Attributes/ServiceAttributes.cs +++ b/src/OpenTelemetry.SemanticConventions/Attributes/ServiceAttributes.cs @@ -15,7 +15,7 @@ namespace OpenTelemetry.SemanticConventions; public static class ServiceAttributes { /// - /// The string ID of the service instance + /// The string ID of the service instance. /// /// /// MUST be unique for each instance of the same service.namespace,service.name pair (in other words @@ -43,28 +43,28 @@ public static class ServiceAttributes /// likely be wrong, as the Collector might not know from which container within that pod the telemetry originated. /// However, Collectors can set the service.instance.id if they can unambiguously determine the service instance /// for that telemetry. This is typically the case for scraping receivers, as they know the target address and - /// port + /// port. /// public const string AttributeServiceInstanceId = "service.instance.id"; /// - /// Logical name of the service + /// Logical name of the service. /// /// - /// MUST be the same for all instances of horizontally scaled services. If the value was not specified, SDKs MUST fallback to unknown_service: concatenated with process.executable.name, e.g. unknown_service:bash. If process.executable.name is not available, the value MUST be set to unknown_service + /// MUST be the same for all instances of horizontally scaled services. If the value was not specified, SDKs MUST fallback to unknown_service: concatenated with process.executable.name, e.g. unknown_service:bash. If process.executable.name is not available, the value MUST be set to unknown_service. /// public const string AttributeServiceName = "service.name"; /// - /// A namespace for service.name + /// A namespace for service.name. /// /// - /// A string value having a meaning that helps to distinguish a group of services, for example the team name that owns a group of services. service.name is expected to be unique within the same namespace. If service.namespace is not specified in the Resource then service.name is expected to be unique for all services that have no explicit namespace defined (so the empty/unspecified namespace is simply one more valid namespace). Zero-length namespace string is assumed equal to unspecified namespace + /// A string value having a meaning that helps to distinguish a group of services, for example the team name that owns a group of services. service.name is expected to be unique within the same namespace. If service.namespace is not specified in the Resource then service.name is expected to be unique for all services that have no explicit namespace defined (so the empty/unspecified namespace is simply one more valid namespace). Zero-length namespace string is assumed equal to unspecified namespace. /// public const string AttributeServiceNamespace = "service.namespace"; /// - /// The version string of the service API or implementation. The format is not defined by these conventions + /// The version string of the service API or implementation. The format is not defined by these conventions. /// public const string AttributeServiceVersion = "service.version"; } diff --git a/src/OpenTelemetry.SemanticConventions/Attributes/SessionAttributes.cs b/src/OpenTelemetry.SemanticConventions/Attributes/SessionAttributes.cs index ed3c893b3f..9c2dbd9222 100644 --- a/src/OpenTelemetry.SemanticConventions/Attributes/SessionAttributes.cs +++ b/src/OpenTelemetry.SemanticConventions/Attributes/SessionAttributes.cs @@ -15,12 +15,12 @@ namespace OpenTelemetry.SemanticConventions; public static class SessionAttributes { /// - /// A unique id to identify a session + /// A unique id to identify a session. /// public const string AttributeSessionId = "session.id"; /// - /// The previous session.id for this user, when known + /// The previous session.id for this user, when known. /// public const string AttributeSessionPreviousId = "session.previous_id"; } diff --git a/src/OpenTelemetry.SemanticConventions/Attributes/SignalrAttributes.cs b/src/OpenTelemetry.SemanticConventions/Attributes/SignalrAttributes.cs index 1940defe58..396d051e8c 100644 --- a/src/OpenTelemetry.SemanticConventions/Attributes/SignalrAttributes.cs +++ b/src/OpenTelemetry.SemanticConventions/Attributes/SignalrAttributes.cs @@ -15,53 +15,53 @@ namespace OpenTelemetry.SemanticConventions; public static class SignalrAttributes { /// - /// SignalR HTTP connection closure status + /// SignalR HTTP connection closure status. /// public const string AttributeSignalrConnectionStatus = "signalr.connection.status"; /// - /// SignalR transport type + /// SignalR transport type. /// public const string AttributeSignalrTransport = "signalr.transport"; /// - /// SignalR HTTP connection closure status + /// SignalR HTTP connection closure status. /// public static class SignalrConnectionStatusValues { /// - /// The connection was closed normally + /// The connection was closed normally. /// public const string NormalClosure = "normal_closure"; /// - /// The connection was closed due to a timeout + /// The connection was closed due to a timeout. /// public const string Timeout = "timeout"; /// - /// The connection was closed because the app is shutting down + /// The connection was closed because the app is shutting down. /// public const string AppShutdown = "app_shutdown"; } /// - /// SignalR transport type + /// SignalR transport type. /// public static class SignalrTransportValues { /// - /// ServerSentEvents protocol + /// ServerSentEvents protocol. /// public const string ServerSentEvents = "server_sent_events"; /// - /// LongPolling protocol + /// LongPolling protocol. /// public const string LongPolling = "long_polling"; /// - /// WebSockets protocol + /// WebSockets protocol. /// public const string WebSockets = "web_sockets"; } diff --git a/src/OpenTelemetry.SemanticConventions/Attributes/SourceAttributes.cs b/src/OpenTelemetry.SemanticConventions/Attributes/SourceAttributes.cs index d64f93a789..47cf1d00dc 100644 --- a/src/OpenTelemetry.SemanticConventions/Attributes/SourceAttributes.cs +++ b/src/OpenTelemetry.SemanticConventions/Attributes/SourceAttributes.cs @@ -15,15 +15,15 @@ namespace OpenTelemetry.SemanticConventions; public static class SourceAttributes { /// - /// Source address - domain name if available without reverse DNS lookup; otherwise, IP address or Unix domain socket name + /// Source address - domain name if available without reverse DNS lookup; otherwise, IP address or Unix domain socket name. /// /// - /// When observed from the destination side, and when communicating through an intermediary, source.address SHOULD represent the source address behind any intermediaries, for example proxies, if it's available + /// When observed from the destination side, and when communicating through an intermediary, source.address SHOULD represent the source address behind any intermediaries, for example proxies, if it's available. /// public const string AttributeSourceAddress = "source.address"; /// - /// Source port number + /// Source port number. /// public const string AttributeSourcePort = "source.port"; } diff --git a/src/OpenTelemetry.SemanticConventions/Attributes/SystemAttributes.cs b/src/OpenTelemetry.SemanticConventions/Attributes/SystemAttributes.cs index 8cac7b5d53..d0595df537 100644 --- a/src/OpenTelemetry.SemanticConventions/Attributes/SystemAttributes.cs +++ b/src/OpenTelemetry.SemanticConventions/Attributes/SystemAttributes.cs @@ -15,380 +15,380 @@ namespace OpenTelemetry.SemanticConventions; public static class SystemAttributes { /// - /// The logical CPU number [0..n-1] + /// The logical CPU number [0..n-1]. /// public const string AttributeSystemCpuLogicalNumber = "system.cpu.logical_number"; /// - /// Deprecated, use cpu.mode instead + /// Deprecated, use cpu.mode instead. /// - [Obsolete("Replaced by cpu.mode")] + [Obsolete("Replaced by cpu.mode.")] public const string AttributeSystemCpuState = "system.cpu.state"; /// - /// The device identifier + /// The device identifier. /// public const string AttributeSystemDevice = "system.device"; /// - /// The filesystem mode + /// The filesystem mode. /// public const string AttributeSystemFilesystemMode = "system.filesystem.mode"; /// - /// The filesystem mount path + /// The filesystem mount path. /// public const string AttributeSystemFilesystemMountpoint = "system.filesystem.mountpoint"; /// - /// The filesystem state + /// The filesystem state. /// public const string AttributeSystemFilesystemState = "system.filesystem.state"; /// - /// The filesystem type + /// The filesystem type. /// public const string AttributeSystemFilesystemType = "system.filesystem.type"; /// - /// The memory state + /// The memory state. /// public const string AttributeSystemMemoryState = "system.memory.state"; /// - /// A stateless protocol MUST NOT set this attribute + /// A stateless protocol MUST NOT set this attribute. /// public const string AttributeSystemNetworkState = "system.network.state"; /// - /// The paging access direction + /// The paging access direction. /// public const string AttributeSystemPagingDirection = "system.paging.direction"; /// - /// The memory paging state + /// The memory paging state. /// public const string AttributeSystemPagingState = "system.paging.state"; /// - /// The memory paging type + /// The memory paging type. /// public const string AttributeSystemPagingType = "system.paging.type"; /// - /// The process state, e.g., Linux Process State Codes + /// The process state, e.g., Linux Process State Codes. /// public const string AttributeSystemProcessStatus = "system.process.status"; /// - /// Deprecated, use system.process.status instead + /// Deprecated, use system.process.status instead. /// - [Obsolete("Replaced by system.process.status")] + [Obsolete("Replaced by system.process.status.")] public const string AttributeSystemProcessesStatus = "system.processes.status"; /// - /// Deprecated, use cpu.mode instead + /// Deprecated, use cpu.mode instead. /// public static class SystemCpuStateValues { /// - /// user + /// user. /// - [Obsolete("Replaced by cpu.mode")] + [Obsolete("Replaced by cpu.mode.")] public const string User = "user"; /// - /// system + /// system. /// - [Obsolete("Replaced by cpu.mode")] + [Obsolete("Replaced by cpu.mode.")] public const string System = "system"; /// - /// nice + /// nice. /// - [Obsolete("Replaced by cpu.mode")] + [Obsolete("Replaced by cpu.mode.")] public const string Nice = "nice"; /// - /// idle + /// idle. /// - [Obsolete("Replaced by cpu.mode")] + [Obsolete("Replaced by cpu.mode.")] public const string Idle = "idle"; /// - /// iowait + /// iowait. /// - [Obsolete("Replaced by cpu.mode")] + [Obsolete("Replaced by cpu.mode.")] public const string Iowait = "iowait"; /// - /// interrupt + /// interrupt. /// - [Obsolete("Replaced by cpu.mode")] + [Obsolete("Replaced by cpu.mode.")] public const string Interrupt = "interrupt"; /// - /// steal + /// steal. /// - [Obsolete("Replaced by cpu.mode")] + [Obsolete("Replaced by cpu.mode.")] public const string Steal = "steal"; } /// - /// The filesystem state + /// The filesystem state. /// public static class SystemFilesystemStateValues { /// - /// used + /// used. /// public const string Used = "used"; /// - /// free + /// free. /// public const string Free = "free"; /// - /// reserved + /// reserved. /// public const string Reserved = "reserved"; } /// - /// The filesystem type + /// The filesystem type. /// public static class SystemFilesystemTypeValues { /// - /// fat32 + /// fat32. /// public const string Fat32 = "fat32"; /// - /// exfat + /// exfat. /// public const string Exfat = "exfat"; /// - /// ntfs + /// ntfs. /// public const string Ntfs = "ntfs"; /// - /// refs + /// refs. /// public const string Refs = "refs"; /// - /// hfsplus + /// hfsplus. /// public const string Hfsplus = "hfsplus"; /// - /// ext4 + /// ext4. /// public const string Ext4 = "ext4"; } /// - /// The memory state + /// The memory state. /// public static class SystemMemoryStateValues { /// - /// used + /// used. /// public const string Used = "used"; /// - /// free + /// free. /// public const string Free = "free"; /// - /// shared + /// shared. /// public const string Shared = "shared"; /// - /// buffers + /// buffers. /// public const string Buffers = "buffers"; /// - /// cached + /// cached. /// public const string Cached = "cached"; } /// - /// A stateless protocol MUST NOT set this attribute + /// A stateless protocol MUST NOT set this attribute. /// public static class SystemNetworkStateValues { /// - /// close + /// close. /// public const string Close = "close"; /// - /// close_wait + /// close_wait. /// public const string CloseWait = "close_wait"; /// - /// closing + /// closing. /// public const string Closing = "closing"; /// - /// delete + /// delete. /// public const string Delete = "delete"; /// - /// established + /// established. /// public const string Established = "established"; /// - /// fin_wait_1 + /// fin_wait_1. /// public const string FinWait1 = "fin_wait_1"; /// - /// fin_wait_2 + /// fin_wait_2. /// public const string FinWait2 = "fin_wait_2"; /// - /// last_ack + /// last_ack. /// public const string LastAck = "last_ack"; /// - /// listen + /// listen. /// public const string Listen = "listen"; /// - /// syn_recv + /// syn_recv. /// public const string SynRecv = "syn_recv"; /// - /// syn_sent + /// syn_sent. /// public const string SynSent = "syn_sent"; /// - /// time_wait + /// time_wait. /// public const string TimeWait = "time_wait"; } /// - /// The paging access direction + /// The paging access direction. /// public static class SystemPagingDirectionValues { /// - /// in + /// in. /// public const string In = "in"; /// - /// out + /// out. /// public const string Out = "out"; } /// - /// The memory paging state + /// The memory paging state. /// public static class SystemPagingStateValues { /// - /// used + /// used. /// public const string Used = "used"; /// - /// free + /// free. /// public const string Free = "free"; } /// - /// The memory paging type + /// The memory paging type. /// public static class SystemPagingTypeValues { /// - /// major + /// major. /// public const string Major = "major"; /// - /// minor + /// minor. /// public const string Minor = "minor"; } /// - /// The process state, e.g., Linux Process State Codes + /// The process state, e.g., Linux Process State Codes. /// public static class SystemProcessStatusValues { /// - /// running + /// running. /// public const string Running = "running"; /// - /// sleeping + /// sleeping. /// public const string Sleeping = "sleeping"; /// - /// stopped + /// stopped. /// public const string Stopped = "stopped"; /// - /// defunct + /// defunct. /// public const string Defunct = "defunct"; } /// - /// Deprecated, use system.process.status instead + /// Deprecated, use system.process.status instead. /// public static class SystemProcessesStatusValues { /// - /// running + /// running. /// - [Obsolete("Replaced by system.process.status")] + [Obsolete("Replaced by system.process.status.")] public const string Running = "running"; /// - /// sleeping + /// sleeping. /// - [Obsolete("Replaced by system.process.status")] + [Obsolete("Replaced by system.process.status.")] public const string Sleeping = "sleeping"; /// - /// stopped + /// stopped. /// - [Obsolete("Replaced by system.process.status")] + [Obsolete("Replaced by system.process.status.")] public const string Stopped = "stopped"; /// - /// defunct + /// defunct. /// - [Obsolete("Replaced by system.process.status")] + [Obsolete("Replaced by system.process.status.")] public const string Defunct = "defunct"; } } diff --git a/src/OpenTelemetry.SemanticConventions/Attributes/TelemetryAttributes.cs b/src/OpenTelemetry.SemanticConventions/Attributes/TelemetryAttributes.cs index 300181e4fd..85693b3786 100644 --- a/src/OpenTelemetry.SemanticConventions/Attributes/TelemetryAttributes.cs +++ b/src/OpenTelemetry.SemanticConventions/Attributes/TelemetryAttributes.cs @@ -15,26 +15,26 @@ namespace OpenTelemetry.SemanticConventions; public static class TelemetryAttributes { /// - /// The name of the auto instrumentation agent or distribution, if used + /// The name of the auto instrumentation agent or distribution, if used. /// /// /// Official auto instrumentation agents and distributions SHOULD set the telemetry.distro.name attribute to - /// a string starting with opentelemetry-, e.g. opentelemetry-java-instrumentation + /// a string starting with opentelemetry-, e.g. opentelemetry-java-instrumentation. /// public const string AttributeTelemetryDistroName = "telemetry.distro.name"; /// - /// The version string of the auto instrumentation agent or distribution, if used + /// The version string of the auto instrumentation agent or distribution, if used. /// public const string AttributeTelemetryDistroVersion = "telemetry.distro.version"; /// - /// The language of the telemetry SDK + /// The language of the telemetry SDK. /// public const string AttributeTelemetrySdkLanguage = "telemetry.sdk.language"; /// - /// The name of the telemetry SDK as defined above + /// The name of the telemetry SDK as defined above. /// /// /// The OpenTelemetry SDK MUST set the telemetry.sdk.name attribute to opentelemetry. @@ -42,77 +42,77 @@ public static class TelemetryAttributes /// telemetry.sdk.name attribute to the fully-qualified class or module name of this SDK's main entry point /// or another suitable identifier depending on the language. /// The identifier opentelemetry is reserved and MUST NOT be used in this case. - /// All custom identifiers SHOULD be stable across different versions of an implementation + /// All custom identifiers SHOULD be stable across different versions of an implementation. /// public const string AttributeTelemetrySdkName = "telemetry.sdk.name"; /// - /// The version string of the telemetry SDK + /// The version string of the telemetry SDK. /// public const string AttributeTelemetrySdkVersion = "telemetry.sdk.version"; /// - /// The language of the telemetry SDK + /// The language of the telemetry SDK. /// public static class TelemetrySdkLanguageValues { /// - /// cpp + /// cpp. /// public const string Cpp = "cpp"; /// - /// dotnet + /// dotnet. /// public const string Dotnet = "dotnet"; /// - /// erlang + /// erlang. /// public const string Erlang = "erlang"; /// - /// go + /// go. /// public const string Go = "go"; /// - /// java + /// java. /// public const string Java = "java"; /// - /// nodejs + /// nodejs. /// public const string Nodejs = "nodejs"; /// - /// php + /// php. /// public const string Php = "php"; /// - /// python + /// python. /// public const string Python = "python"; /// - /// ruby + /// ruby. /// public const string Ruby = "ruby"; /// - /// rust + /// rust. /// public const string Rust = "rust"; /// - /// swift + /// swift. /// public const string Swift = "swift"; /// - /// webjs + /// webjs. /// public const string Webjs = "webjs"; } diff --git a/src/OpenTelemetry.SemanticConventions/Attributes/TestAttributes.cs b/src/OpenTelemetry.SemanticConventions/Attributes/TestAttributes.cs index 6eae4b3f2a..d3d1bf9705 100644 --- a/src/OpenTelemetry.SemanticConventions/Attributes/TestAttributes.cs +++ b/src/OpenTelemetry.SemanticConventions/Attributes/TestAttributes.cs @@ -15,73 +15,73 @@ namespace OpenTelemetry.SemanticConventions; public static class TestAttributes { /// - /// The fully qualified human readable name of the test case + /// The fully qualified human readable name of the test case. /// public const string AttributeTestCaseName = "test.case.name"; /// - /// The status of the actual test case result from test execution + /// The status of the actual test case result from test execution. /// public const string AttributeTestCaseResultStatus = "test.case.result.status"; /// - /// The human readable name of a test suite + /// The human readable name of a test suite. /// public const string AttributeTestSuiteName = "test.suite.name"; /// - /// The status of the test suite run + /// The status of the test suite run. /// public const string AttributeTestSuiteRunStatus = "test.suite.run.status"; /// - /// The status of the actual test case result from test execution + /// The status of the actual test case result from test execution. /// public static class TestCaseResultStatusValues { /// - /// pass + /// pass. /// public const string Pass = "pass"; /// - /// fail + /// fail. /// public const string Fail = "fail"; } /// - /// The status of the test suite run + /// The status of the test suite run. /// public static class TestSuiteRunStatusValues { /// - /// success + /// success. /// public const string Success = "success"; /// - /// failure + /// failure. /// public const string Failure = "failure"; /// - /// skipped + /// skipped. /// public const string Skipped = "skipped"; /// - /// aborted + /// aborted. /// public const string Aborted = "aborted"; /// - /// timed_out + /// timed_out. /// public const string TimedOut = "timed_out"; /// - /// in_progress + /// in_progress. /// public const string InProgress = "in_progress"; } diff --git a/src/OpenTelemetry.SemanticConventions/Attributes/ThreadAttributes.cs b/src/OpenTelemetry.SemanticConventions/Attributes/ThreadAttributes.cs index 525597810c..e1b1c6db6f 100644 --- a/src/OpenTelemetry.SemanticConventions/Attributes/ThreadAttributes.cs +++ b/src/OpenTelemetry.SemanticConventions/Attributes/ThreadAttributes.cs @@ -15,12 +15,12 @@ namespace OpenTelemetry.SemanticConventions; public static class ThreadAttributes { /// - /// Current "managed" thread ID (as opposed to OS thread ID) + /// Current "managed" thread ID (as opposed to OS thread ID). /// public const string AttributeThreadId = "thread.id"; /// - /// Current thread name + /// Current thread name. /// public const string AttributeThreadName = "thread.name"; } diff --git a/src/OpenTelemetry.SemanticConventions/Attributes/TlsAttributes.cs b/src/OpenTelemetry.SemanticConventions/Attributes/TlsAttributes.cs index 87351db7ba..3c2845a398 100644 --- a/src/OpenTelemetry.SemanticConventions/Attributes/TlsAttributes.cs +++ b/src/OpenTelemetry.SemanticConventions/Attributes/TlsAttributes.cs @@ -15,166 +15,166 @@ namespace OpenTelemetry.SemanticConventions; public static class TlsAttributes { /// - /// String indicating the cipher used during the current connection + /// String indicating the cipher used during the current connection. /// /// - /// The values allowed for tls.cipher MUST be one of the Descriptions of the registered TLS Cipher Suits + /// The values allowed for tls.cipher MUST be one of the Descriptions of the registered TLS Cipher Suits. /// public const string AttributeTlsCipher = "tls.cipher"; /// - /// PEM-encoded stand-alone certificate offered by the client. This is usually mutually-exclusive of client.certificate_chain since this value also exists in that list + /// PEM-encoded stand-alone certificate offered by the client. This is usually mutually-exclusive of client.certificate_chain since this value also exists in that list. /// public const string AttributeTlsClientCertificate = "tls.client.certificate"; /// - /// Array of PEM-encoded certificates that make up the certificate chain offered by the client. This is usually mutually-exclusive of client.certificate since that value should be the first certificate in the chain + /// Array of PEM-encoded certificates that make up the certificate chain offered by the client. This is usually mutually-exclusive of client.certificate since that value should be the first certificate in the chain. /// public const string AttributeTlsClientCertificateChain = "tls.client.certificate_chain"; /// - /// Certificate fingerprint using the MD5 digest of DER-encoded version of certificate offered by the client. For consistency with other hash values, this value should be formatted as an uppercase hash + /// Certificate fingerprint using the MD5 digest of DER-encoded version of certificate offered by the client. For consistency with other hash values, this value should be formatted as an uppercase hash. /// public const string AttributeTlsClientHashMd5 = "tls.client.hash.md5"; /// - /// Certificate fingerprint using the SHA1 digest of DER-encoded version of certificate offered by the client. For consistency with other hash values, this value should be formatted as an uppercase hash + /// Certificate fingerprint using the SHA1 digest of DER-encoded version of certificate offered by the client. For consistency with other hash values, this value should be formatted as an uppercase hash. /// public const string AttributeTlsClientHashSha1 = "tls.client.hash.sha1"; /// - /// Certificate fingerprint using the SHA256 digest of DER-encoded version of certificate offered by the client. For consistency with other hash values, this value should be formatted as an uppercase hash + /// Certificate fingerprint using the SHA256 digest of DER-encoded version of certificate offered by the client. For consistency with other hash values, this value should be formatted as an uppercase hash. /// public const string AttributeTlsClientHashSha256 = "tls.client.hash.sha256"; /// - /// Distinguished name of subject of the issuer of the x.509 certificate presented by the client + /// Distinguished name of subject of the issuer of the x.509 certificate presented by the client. /// public const string AttributeTlsClientIssuer = "tls.client.issuer"; /// - /// A hash that identifies clients based on how they perform an SSL/TLS handshake + /// A hash that identifies clients based on how they perform an SSL/TLS handshake. /// public const string AttributeTlsClientJa3 = "tls.client.ja3"; /// - /// Date/Time indicating when client certificate is no longer considered valid + /// Date/Time indicating when client certificate is no longer considered valid. /// public const string AttributeTlsClientNotAfter = "tls.client.not_after"; /// - /// Date/Time indicating when client certificate is first considered valid + /// Date/Time indicating when client certificate is first considered valid. /// public const string AttributeTlsClientNotBefore = "tls.client.not_before"; /// - /// Deprecated, use server.address instead + /// Deprecated, use server.address instead. /// - [Obsolete("Replaced by `server.address")] + [Obsolete("Replaced by `server.address.")] public const string AttributeTlsClientServerName = "tls.client.server_name"; /// - /// Distinguished name of subject of the x.509 certificate presented by the client + /// Distinguished name of subject of the x.509 certificate presented by the client. /// public const string AttributeTlsClientSubject = "tls.client.subject"; /// - /// Array of ciphers offered by the client during the client hello + /// Array of ciphers offered by the client during the client hello. /// public const string AttributeTlsClientSupportedCiphers = "tls.client.supported_ciphers"; /// - /// String indicating the curve used for the given cipher, when applicable + /// String indicating the curve used for the given cipher, when applicable. /// public const string AttributeTlsCurve = "tls.curve"; /// - /// Boolean flag indicating if the TLS negotiation was successful and transitioned to an encrypted tunnel + /// Boolean flag indicating if the TLS negotiation was successful and transitioned to an encrypted tunnel. /// public const string AttributeTlsEstablished = "tls.established"; /// - /// String indicating the protocol being tunneled. Per the values in the IANA registry, this string should be lower case + /// String indicating the protocol being tunneled. Per the values in the IANA registry, this string should be lower case. /// public const string AttributeTlsNextProtocol = "tls.next_protocol"; /// - /// Normalized lowercase protocol name parsed from original string of the negotiated SSL/TLS protocol version + /// Normalized lowercase protocol name parsed from original string of the negotiated SSL/TLS protocol version. /// public const string AttributeTlsProtocolName = "tls.protocol.name"; /// - /// Numeric part of the version parsed from the original string of the negotiated SSL/TLS protocol version + /// Numeric part of the version parsed from the original string of the negotiated SSL/TLS protocol version. /// public const string AttributeTlsProtocolVersion = "tls.protocol.version"; /// - /// Boolean flag indicating if this TLS connection was resumed from an existing TLS negotiation + /// Boolean flag indicating if this TLS connection was resumed from an existing TLS negotiation. /// public const string AttributeTlsResumed = "tls.resumed"; /// - /// PEM-encoded stand-alone certificate offered by the server. This is usually mutually-exclusive of server.certificate_chain since this value also exists in that list + /// PEM-encoded stand-alone certificate offered by the server. This is usually mutually-exclusive of server.certificate_chain since this value also exists in that list. /// public const string AttributeTlsServerCertificate = "tls.server.certificate"; /// - /// Array of PEM-encoded certificates that make up the certificate chain offered by the server. This is usually mutually-exclusive of server.certificate since that value should be the first certificate in the chain + /// Array of PEM-encoded certificates that make up the certificate chain offered by the server. This is usually mutually-exclusive of server.certificate since that value should be the first certificate in the chain. /// public const string AttributeTlsServerCertificateChain = "tls.server.certificate_chain"; /// - /// Certificate fingerprint using the MD5 digest of DER-encoded version of certificate offered by the server. For consistency with other hash values, this value should be formatted as an uppercase hash + /// Certificate fingerprint using the MD5 digest of DER-encoded version of certificate offered by the server. For consistency with other hash values, this value should be formatted as an uppercase hash. /// public const string AttributeTlsServerHashMd5 = "tls.server.hash.md5"; /// - /// Certificate fingerprint using the SHA1 digest of DER-encoded version of certificate offered by the server. For consistency with other hash values, this value should be formatted as an uppercase hash + /// Certificate fingerprint using the SHA1 digest of DER-encoded version of certificate offered by the server. For consistency with other hash values, this value should be formatted as an uppercase hash. /// public const string AttributeTlsServerHashSha1 = "tls.server.hash.sha1"; /// - /// Certificate fingerprint using the SHA256 digest of DER-encoded version of certificate offered by the server. For consistency with other hash values, this value should be formatted as an uppercase hash + /// Certificate fingerprint using the SHA256 digest of DER-encoded version of certificate offered by the server. For consistency with other hash values, this value should be formatted as an uppercase hash. /// public const string AttributeTlsServerHashSha256 = "tls.server.hash.sha256"; /// - /// Distinguished name of subject of the issuer of the x.509 certificate presented by the client + /// Distinguished name of subject of the issuer of the x.509 certificate presented by the client. /// public const string AttributeTlsServerIssuer = "tls.server.issuer"; /// - /// A hash that identifies servers based on how they perform an SSL/TLS handshake + /// A hash that identifies servers based on how they perform an SSL/TLS handshake. /// public const string AttributeTlsServerJa3s = "tls.server.ja3s"; /// - /// Date/Time indicating when server certificate is no longer considered valid + /// Date/Time indicating when server certificate is no longer considered valid. /// public const string AttributeTlsServerNotAfter = "tls.server.not_after"; /// - /// Date/Time indicating when server certificate is first considered valid + /// Date/Time indicating when server certificate is first considered valid. /// public const string AttributeTlsServerNotBefore = "tls.server.not_before"; /// - /// Distinguished name of subject of the x.509 certificate presented by the server + /// Distinguished name of subject of the x.509 certificate presented by the server. /// public const string AttributeTlsServerSubject = "tls.server.subject"; /// - /// Normalized lowercase protocol name parsed from original string of the negotiated SSL/TLS protocol version + /// Normalized lowercase protocol name parsed from original string of the negotiated SSL/TLS protocol version. /// public static class TlsProtocolNameValues { /// - /// ssl + /// ssl. /// public const string Ssl = "ssl"; /// - /// tls + /// tls. /// public const string Tls = "tls"; } diff --git a/src/OpenTelemetry.SemanticConventions/Attributes/UrlAttributes.cs b/src/OpenTelemetry.SemanticConventions/Attributes/UrlAttributes.cs index 47fba2eb6e..c6277699c2 100644 --- a/src/OpenTelemetry.SemanticConventions/Attributes/UrlAttributes.cs +++ b/src/OpenTelemetry.SemanticConventions/Attributes/UrlAttributes.cs @@ -15,97 +15,97 @@ namespace OpenTelemetry.SemanticConventions; public static class UrlAttributes { /// - /// Domain extracted from the url.full, such as "opentelemetry.io" + /// Domain extracted from the url.full, such as "opentelemetry.io". /// /// - /// In some cases a URL may refer to an IP and/or port directly, without a domain name. In this case, the IP address would go to the domain field. If the URL contains a literal IPv6 address enclosed by [ and ], the [ and ] characters should also be captured in the domain field + /// In some cases a URL may refer to an IP and/or port directly, without a domain name. In this case, the IP address would go to the domain field. If the URL contains a literal IPv6 address enclosed by [ and ], the [ and ] characters should also be captured in the domain field. /// public const string AttributeUrlDomain = "url.domain"; /// - /// The file extension extracted from the url.full, excluding the leading dot + /// The file extension extracted from the url.full, excluding the leading dot. /// /// - /// The file extension is only set if it exists, as not every url has a file extension. When the file name has multiple extensions example.tar.gz, only the last one should be captured gz, not tar.gz + /// The file extension is only set if it exists, as not every url has a file extension. When the file name has multiple extensions example.tar.gz, only the last one should be captured gz, not tar.gz. /// public const string AttributeUrlExtension = "url.extension"; /// - /// The URI fragment component + /// The URI fragment component. /// public const string AttributeUrlFragment = "url.fragment"; /// - /// Absolute URL describing a network resource according to RFC3986 + /// Absolute URL describing a network resource according to RFC3986. /// /// /// For network calls, URL usually has scheme://host[:port][path][?query][#fragment] format, where the fragment is not transmitted over HTTP, but if it is known, it SHOULD be included nevertheless. /// url.full MUST NOT contain credentials passed via URL in form of https://username:password@www.example.com/. In such case username and password SHOULD be redacted and attribute's value SHOULD be https://REDACTED:REDACTED@www.example.com/. - /// url.full SHOULD capture the absolute URL when it is available (or can be reconstructed). Sensitive content provided in url.full SHOULD be scrubbed when instrumentations can identify it + /// url.full SHOULD capture the absolute URL when it is available (or can be reconstructed). Sensitive content provided in url.full SHOULD be scrubbed when instrumentations can identify it. /// public const string AttributeUrlFull = "url.full"; /// - /// Unmodified original URL as seen in the event source + /// Unmodified original URL as seen in the event source. /// /// /// In network monitoring, the observed URL may be a full URL, whereas in access logs, the URL is often just represented as a path. This field is meant to represent the URL as it was observed, complete or not. - /// url.original might contain credentials passed via URL in form of https://username:password@www.example.com/. In such case password and username SHOULD NOT be redacted and attribute's value SHOULD remain the same + /// url.original might contain credentials passed via URL in form of https://username:password@www.example.com/. In such case password and username SHOULD NOT be redacted and attribute's value SHOULD remain the same. /// public const string AttributeUrlOriginal = "url.original"; /// - /// The URI path component + /// The URI path component. /// /// - /// Sensitive content provided in url.path SHOULD be scrubbed when instrumentations can identify it + /// Sensitive content provided in url.path SHOULD be scrubbed when instrumentations can identify it. /// public const string AttributeUrlPath = "url.path"; /// - /// Port extracted from the url.full + /// Port extracted from the url.full. /// public const string AttributeUrlPort = "url.port"; /// - /// The URI query component + /// The URI query component. /// /// - /// Sensitive content provided in url.query SHOULD be scrubbed when instrumentations can identify it + /// Sensitive content provided in url.query SHOULD be scrubbed when instrumentations can identify it. /// public const string AttributeUrlQuery = "url.query"; /// - /// The highest registered url domain, stripped of the subdomain + /// The highest registered url domain, stripped of the subdomain. /// /// - /// This value can be determined precisely with the public suffix list. For example, the registered domain for foo.example.com is example.com. Trying to approximate this by simply taking the last two labels will not work well for TLDs such as co.uk + /// This value can be determined precisely with the public suffix list. For example, the registered domain for foo.example.com is example.com. Trying to approximate this by simply taking the last two labels will not work well for TLDs such as co.uk. /// public const string AttributeUrlRegisteredDomain = "url.registered_domain"; /// - /// The URI scheme component identifying the used protocol + /// The URI scheme component identifying the used protocol. /// public const string AttributeUrlScheme = "url.scheme"; /// - /// The subdomain portion of a fully qualified domain name includes all of the names except the host name under the registered_domain. In a partially qualified domain, or if the qualification level of the full name cannot be determined, subdomain contains all of the names below the registered domain + /// The subdomain portion of a fully qualified domain name includes all of the names except the host name under the registered_domain. In a partially qualified domain, or if the qualification level of the full name cannot be determined, subdomain contains all of the names below the registered domain. /// /// - /// The subdomain portion of www.east.mydomain.co.uk is east. If the domain has multiple levels of subdomain, such as sub2.sub1.example.com, the subdomain field should contain sub2.sub1, with no trailing period + /// The subdomain portion of www.east.mydomain.co.uk is east. If the domain has multiple levels of subdomain, such as sub2.sub1.example.com, the subdomain field should contain sub2.sub1, with no trailing period. /// public const string AttributeUrlSubdomain = "url.subdomain"; /// - /// The low-cardinality template of an absolute path reference + /// The low-cardinality template of an absolute path reference. /// public const string AttributeUrlTemplate = "url.template"; /// - /// The effective top level domain (eTLD), also known as the domain suffix, is the last part of the domain name. For example, the top level domain for example.com is com + /// The effective top level domain (eTLD), also known as the domain suffix, is the last part of the domain name. For example, the top level domain for example.com is com. /// /// - /// This value can be determined precisely with the public suffix list + /// This value can be determined precisely with the public suffix list. /// public const string AttributeUrlTopLevelDomain = "url.top_level_domain"; } diff --git a/src/OpenTelemetry.SemanticConventions/Attributes/UserAgentAttributes.cs b/src/OpenTelemetry.SemanticConventions/Attributes/UserAgentAttributes.cs index b6f934206e..7b728d07be 100644 --- a/src/OpenTelemetry.SemanticConventions/Attributes/UserAgentAttributes.cs +++ b/src/OpenTelemetry.SemanticConventions/Attributes/UserAgentAttributes.cs @@ -15,23 +15,23 @@ namespace OpenTelemetry.SemanticConventions; public static class UserAgentAttributes { /// - /// Name of the user-agent extracted from original. Usually refers to the browser's name + /// Name of the user-agent extracted from original. Usually refers to the browser's name. /// /// - /// Example of extracting browser's name from original string. In the case of using a user-agent for non-browser products, such as microservices with multiple names/versions inside the user_agent.original, the most significant name SHOULD be selected. In such a scenario it should align with user_agent.version + /// Example of extracting browser's name from original string. In the case of using a user-agent for non-browser products, such as microservices with multiple names/versions inside the user_agent.original, the most significant name SHOULD be selected. In such a scenario it should align with user_agent.version. /// public const string AttributeUserAgentName = "user_agent.name"; /// - /// Value of the HTTP User-Agent header sent by the client + /// Value of the HTTP User-Agent header sent by the client. /// public const string AttributeUserAgentOriginal = "user_agent.original"; /// - /// Version of the user-agent extracted from original. Usually refers to the browser's version + /// Version of the user-agent extracted from original. Usually refers to the browser's version. /// /// - /// Example of extracting browser's version from original string. In the case of using a user-agent for non-browser products, such as microservices with multiple names/versions inside the user_agent.original, the most significant version SHOULD be selected. In such a scenario it should align with user_agent.name + /// Example of extracting browser's version from original string. In the case of using a user-agent for non-browser products, such as microservices with multiple names/versions inside the user_agent.original, the most significant version SHOULD be selected. In such a scenario it should align with user_agent.name. /// public const string AttributeUserAgentVersion = "user_agent.version"; } diff --git a/src/OpenTelemetry.SemanticConventions/Attributes/UserAttributes.cs b/src/OpenTelemetry.SemanticConventions/Attributes/UserAttributes.cs index eff0f4754a..79df46aed5 100644 --- a/src/OpenTelemetry.SemanticConventions/Attributes/UserAttributes.cs +++ b/src/OpenTelemetry.SemanticConventions/Attributes/UserAttributes.cs @@ -15,35 +15,35 @@ namespace OpenTelemetry.SemanticConventions; public static class UserAttributes { /// - /// User email address + /// User email address. /// public const string AttributeUserEmail = "user.email"; /// - /// User's full name + /// User's full name. /// public const string AttributeUserFullName = "user.full_name"; /// - /// Unique user hash to correlate information for a user in anonymized form + /// Unique user hash to correlate information for a user in anonymized form. /// /// - /// Useful if user.id or user.name contain confidential information and cannot be used + /// Useful if user.id or user.name contain confidential information and cannot be used. /// public const string AttributeUserHash = "user.hash"; /// - /// Unique identifier of the user + /// Unique identifier of the user. /// public const string AttributeUserId = "user.id"; /// - /// Short name or login/username of the user + /// Short name or login/username of the user. /// public const string AttributeUserName = "user.name"; /// - /// Array of user roles at the time of the event + /// Array of user roles at the time of the event. /// public const string AttributeUserRoles = "user.roles"; } diff --git a/src/OpenTelemetry.SemanticConventions/Attributes/V8jsAttributes.cs b/src/OpenTelemetry.SemanticConventions/Attributes/V8jsAttributes.cs index 93e68417b6..552b92e723 100644 --- a/src/OpenTelemetry.SemanticConventions/Attributes/V8jsAttributes.cs +++ b/src/OpenTelemetry.SemanticConventions/Attributes/V8jsAttributes.cs @@ -15,71 +15,71 @@ namespace OpenTelemetry.SemanticConventions; public static class V8jsAttributes { /// - /// The type of garbage collection + /// The type of garbage collection. /// public const string AttributeV8jsGcType = "v8js.gc.type"; /// - /// The name of the space type of heap memory + /// The name of the space type of heap memory. /// /// - /// Value can be retrieved from value space_name of v8.getHeapSpaceStatistics() + /// Value can be retrieved from value space_name of v8.getHeapSpaceStatistics(). /// public const string AttributeV8jsHeapSpaceName = "v8js.heap.space.name"; /// - /// The type of garbage collection + /// The type of garbage collection. /// public static class V8jsGcTypeValues { /// - /// Major (Mark Sweep Compact) + /// Major (Mark Sweep Compact). /// public const string Major = "major"; /// - /// Minor (Scavenge) + /// Minor (Scavenge). /// public const string Minor = "minor"; /// - /// Incremental (Incremental Marking) + /// Incremental (Incremental Marking). /// public const string Incremental = "incremental"; /// - /// Weak Callbacks (Process Weak Callbacks) + /// Weak Callbacks (Process Weak Callbacks). /// public const string Weakcb = "weakcb"; } /// - /// The name of the space type of heap memory + /// The name of the space type of heap memory. /// public static class V8jsHeapSpaceNameValues { /// - /// New memory space + /// New memory space. /// public const string NewSpace = "new_space"; /// - /// Old memory space + /// Old memory space. /// public const string OldSpace = "old_space"; /// - /// Code memory space + /// Code memory space. /// public const string CodeSpace = "code_space"; /// - /// Map memory space + /// Map memory space. /// public const string MapSpace = "map_space"; /// - /// Large object memory space + /// Large object memory space. /// public const string LargeObjectSpace = "large_object_space"; } diff --git a/src/OpenTelemetry.SemanticConventions/Attributes/VcsAttributes.cs b/src/OpenTelemetry.SemanticConventions/Attributes/VcsAttributes.cs index 09a595f4c6..5173e18ffd 100644 --- a/src/OpenTelemetry.SemanticConventions/Attributes/VcsAttributes.cs +++ b/src/OpenTelemetry.SemanticConventions/Attributes/VcsAttributes.cs @@ -15,22 +15,22 @@ namespace OpenTelemetry.SemanticConventions; public static class VcsAttributes { /// - /// The ID of the change (pull request/merge request) if applicable. This is usually a unique (within repository) identifier generated by the VCS system + /// The ID of the change (pull request/merge request) if applicable. This is usually a unique (within repository) identifier generated by the VCS system. /// public const string AttributeVcsRepositoryChangeId = "vcs.repository.change.id"; /// - /// The human readable title of the change (pull request/merge request). This title is often a brief summary of the change and may get merged in to a ref as the commit summary + /// The human readable title of the change (pull request/merge request). This title is often a brief summary of the change and may get merged in to a ref as the commit summary. /// public const string AttributeVcsRepositoryChangeTitle = "vcs.repository.change.title"; /// - /// The name of the reference such as branch or tag in the repository + /// The name of the reference such as branch or tag in the repository. /// public const string AttributeVcsRepositoryRefName = "vcs.repository.ref.name"; /// - /// The revision, literally revised version, The revision most often refers to a commit object in Git, or a revision number in SVN + /// The revision, literally revised version, The revision most often refers to a commit object in Git, or a revision number in SVN. /// /// /// The revision can be a full hash value (see glossary), @@ -41,32 +41,32 @@ public static class VcsAttributes /// which is an integer that is monotonically increasing. In cases where /// it is identical to the ref.name, it SHOULD still be included. It is /// up to the implementer to decide which value to set as the revision - /// based on the VCS system and situational context + /// based on the VCS system and situational context. /// public const string AttributeVcsRepositoryRefRevision = "vcs.repository.ref.revision"; /// - /// The type of the reference in the repository + /// The type of the reference in the repository. /// public const string AttributeVcsRepositoryRefType = "vcs.repository.ref.type"; /// - /// The URL of the repository providing the complete address in order to locate and identify the repository + /// The URL of the repository providing the complete address in order to locate and identify the repository. /// public const string AttributeVcsRepositoryUrlFull = "vcs.repository.url.full"; /// - /// The type of the reference in the repository + /// The type of the reference in the repository. /// public static class VcsRepositoryRefTypeValues { /// - /// branch + /// branch. /// public const string Branch = "branch"; /// - /// tag + /// tag. /// public const string Tag = "tag"; } diff --git a/src/OpenTelemetry.SemanticConventions/Attributes/WebengineAttributes.cs b/src/OpenTelemetry.SemanticConventions/Attributes/WebengineAttributes.cs index 7797afcca9..d0122990e1 100644 --- a/src/OpenTelemetry.SemanticConventions/Attributes/WebengineAttributes.cs +++ b/src/OpenTelemetry.SemanticConventions/Attributes/WebengineAttributes.cs @@ -15,17 +15,17 @@ namespace OpenTelemetry.SemanticConventions; public static class WebengineAttributes { /// - /// Additional description of the web engine (e.g. detailed version and edition information) + /// Additional description of the web engine (e.g. detailed version and edition information). /// public const string AttributeWebengineDescription = "webengine.description"; /// - /// The name of the web engine + /// The name of the web engine. /// public const string AttributeWebengineName = "webengine.name"; /// - /// The version of the web engine + /// The version of the web engine. /// public const string AttributeWebengineVersion = "webengine.version"; } diff --git a/src/OpenTelemetry.SemanticConventions/scripts/generate.ps1 b/src/OpenTelemetry.SemanticConventions/scripts/generate.ps1 index 1a4e9581f3..d5969ddac0 100644 --- a/src/OpenTelemetry.SemanticConventions/scripts/generate.ps1 +++ b/src/OpenTelemetry.SemanticConventions/scripts/generate.ps1 @@ -3,7 +3,7 @@ $ROOT_DIR = "${SCRIPT_DIR}/../" # freeze the spec version to make SemanticAttributes generation reproducible $SEMCONV_VERSION="1.27.0" -$GENERATOR_VERSION="v0.9.2" +$GENERATOR_VERSION="v0.10.0" Set-Location $SCRIPT_DIR diff --git a/src/OpenTelemetry.SemanticConventions/scripts/generate.sh b/src/OpenTelemetry.SemanticConventions/scripts/generate.sh index a5c6c8e9c4..fb0f0315ec 100644 --- a/src/OpenTelemetry.SemanticConventions/scripts/generate.sh +++ b/src/OpenTelemetry.SemanticConventions/scripts/generate.sh @@ -6,7 +6,7 @@ ROOT_DIR="${SCRIPT_DIR}/../" # freeze the spec version to make SemanticAttributes generation reproducible SEMCONV_VERSION="1.27.0" -GENERATOR_VERSION="v0.9.2" +GENERATOR_VERSION="v0.10.0" cd ${SCRIPT_DIR} diff --git a/src/OpenTelemetry.SemanticConventions/scripts/templates/registry/weaver.yaml b/src/OpenTelemetry.SemanticConventions/scripts/templates/registry/weaver.yaml index 80787a2831..97cec0f8be 100644 --- a/src/OpenTelemetry.SemanticConventions/scripts/templates/registry/weaver.yaml +++ b/src/OpenTelemetry.SemanticConventions/scripts/templates/registry/weaver.yaml @@ -20,7 +20,8 @@ comment_formats: inline_code_snippet: "{{code}}" block_code_snippet: "{{code}}" trim: true - remove_trailing_dots: true + remove_trailing_dots: false + enforce_trailing_dots: true default_comment_format: csharp templates: