Switch to weaver to generate semantic conventions (#4091)

opentelemetry-semantic-conventions/src/opentelemetry/semconv/_incubating/attributes/aws_attributes.py

@@ -219,70 +219,70 @@
 """
 The S3 bucket name the request refers to. Corresponds to the `--bucket` parameter of the [S3 API](https://docs.aws.amazon.com/cli/latest/reference/s3api/index.html) operations.
 Note: 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`.
 """
 
 AWS_S3_COPY_SOURCE: Final = "aws.s3.copy_source"
 """
 The source object (in the form `bucket`/`key`) for the copy operation.
 Note: The `copy_source` attribute applies to S3 copy operations and corresponds to the `--copy-source` parameter
- of the [copy-object operation within the S3 API](https://docs.aws.amazon.com/cli/latest/reference/s3api/copy-object.html).
- This applies in particular to the following operations:
+of the [copy-object operation within the S3 API](https://docs.aws.amazon.com/cli/latest/reference/s3api/copy-object.html).
+This applies in particular to the following operations:
 
- - [copy-object](https://docs.aws.amazon.com/cli/latest/reference/s3api/copy-object.html)
- - [upload-part-copy](https://docs.aws.amazon.com/cli/latest/reference/s3api/upload-part-copy.html).
+- [copy-object](https://docs.aws.amazon.com/cli/latest/reference/s3api/copy-object.html)
+- [upload-part-copy](https://docs.aws.amazon.com/cli/latest/reference/s3api/upload-part-copy.html).
 """
 
 AWS_S3_DELETE: Final = "aws.s3.delete"
 """
 The delete request container that specifies the objects to be deleted.
 Note: The `delete` attribute is only applicable to the [delete-object](https://docs.aws.amazon.com/cli/latest/reference/s3api/delete-object.html) operation.
- The `delete` attribute corresponds to the `--delete` parameter of the
- [delete-objects operation within the S3 API](https://docs.aws.amazon.com/cli/latest/reference/s3api/delete-objects.html).
+The `delete` attribute corresponds to the `--delete` parameter of the
+[delete-objects operation within the S3 API](https://docs.aws.amazon.com/cli/latest/reference/s3api/delete-objects.html).
 """
 
 AWS_S3_KEY: Final = "aws.s3.key"
 """
 The S3 object key the request refers to. Corresponds to the `--key` parameter of the [S3 API](https://docs.aws.amazon.com/cli/latest/reference/s3api/index.html) operations.
 Note: The `key` attribute is applicable to all object-related S3 operations, i.e. that require the object key as a mandatory parameter.
- This applies in particular to the following operations:
-
- - [copy-object](https://docs.aws.amazon.com/cli/latest/reference/s3api/copy-object.html)
- - [delete-object](https://docs.aws.amazon.com/cli/latest/reference/s3api/delete-object.html)
- - [get-object](https://docs.aws.amazon.com/cli/latest/reference/s3api/get-object.html)
- - [head-object](https://docs.aws.amazon.com/cli/latest/reference/s3api/head-object.html)
- - [put-object](https://docs.aws.amazon.com/cli/latest/reference/s3api/put-object.html)
- - [restore-object](https://docs.aws.amazon.com/cli/latest/reference/s3api/restore-object.html)
- - [select-object-content](https://docs.aws.amazon.com/cli/latest/reference/s3api/select-object-content.html)
- - [abort-multipart-upload](https://docs.aws.amazon.com/cli/latest/reference/s3api/abort-multipart-upload.html)
- - [complete-multipart-upload](https://docs.aws.amazon.com/cli/latest/reference/s3api/complete-multipart-upload.html)
- - [create-multipart-upload](https://docs.aws.amazon.com/cli/latest/reference/s3api/create-multipart-upload.html)
- - [list-parts](https://docs.aws.amazon.com/cli/latest/reference/s3api/list-parts.html)
- - [upload-part](https://docs.aws.amazon.com/cli/latest/reference/s3api/upload-part.html)
- - [upload-part-copy](https://docs.aws.amazon.com/cli/latest/reference/s3api/upload-part-copy.html).
+This applies in particular to the following operations:
+
+- [copy-object](https://docs.aws.amazon.com/cli/latest/reference/s3api/copy-object.html)
+- [delete-object](https://docs.aws.amazon.com/cli/latest/reference/s3api/delete-object.html)
+- [get-object](https://docs.aws.amazon.com/cli/latest/reference/s3api/get-object.html)
+- [head-object](https://docs.aws.amazon.com/cli/latest/reference/s3api/head-object.html)
+- [put-object](https://docs.aws.amazon.com/cli/latest/reference/s3api/put-object.html)
+- [restore-object](https://docs.aws.amazon.com/cli/latest/reference/s3api/restore-object.html)
+- [select-object-content](https://docs.aws.amazon.com/cli/latest/reference/s3api/select-object-content.html)
+- [abort-multipart-upload](https://docs.aws.amazon.com/cli/latest/reference/s3api/abort-multipart-upload.html)
+- [complete-multipart-upload](https://docs.aws.amazon.com/cli/latest/reference/s3api/complete-multipart-upload.html)
+- [create-multipart-upload](https://docs.aws.amazon.com/cli/latest/reference/s3api/create-multipart-upload.html)
+- [list-parts](https://docs.aws.amazon.com/cli/latest/reference/s3api/list-parts.html)
+- [upload-part](https://docs.aws.amazon.com/cli/latest/reference/s3api/upload-part.html)
+- [upload-part-copy](https://docs.aws.amazon.com/cli/latest/reference/s3api/upload-part-copy.html).
 """
 
 AWS_S3_PART_NUMBER: Final = "aws.s3.part_number"
 """
 The part number of the part being uploaded in a multipart-upload operation. This is a positive integer between 1 and 10,000.
 Note: The `part_number` attribute is only applicable to the [upload-part](https://docs.aws.amazon.com/cli/latest/reference/s3api/upload-part.html)
- and [upload-part-copy](https://docs.aws.amazon.com/cli/latest/reference/s3api/upload-part-copy.html) operations.
- The `part_number` attribute corresponds to the `--part-number` parameter of the
- [upload-part operation within the S3 API](https://docs.aws.amazon.com/cli/latest/reference/s3api/upload-part.html).
+and [upload-part-copy](https://docs.aws.amazon.com/cli/latest/reference/s3api/upload-part-copy.html) operations.
+The `part_number` attribute corresponds to the `--part-number` parameter of the
+[upload-part operation within the S3 API](https://docs.aws.amazon.com/cli/latest/reference/s3api/upload-part.html).
 """
 
 AWS_S3_UPLOAD_ID: Final = "aws.s3.upload_id"
 """
 Upload ID that identifies the multipart upload.
 Note: The `upload_id` attribute applies to S3 multipart-upload operations and corresponds to the `--upload-id` parameter
- of the [S3 API](https://docs.aws.amazon.com/cli/latest/reference/s3api/index.html) multipart operations.
- This applies in particular to the following operations:
-
- - [abort-multipart-upload](https://docs.aws.amazon.com/cli/latest/reference/s3api/abort-multipart-upload.html)
- - [complete-multipart-upload](https://docs.aws.amazon.com/cli/latest/reference/s3api/complete-multipart-upload.html)
- - [list-parts](https://docs.aws.amazon.com/cli/latest/reference/s3api/list-parts.html)
- - [upload-part](https://docs.aws.amazon.com/cli/latest/reference/s3api/upload-part.html)
- - [upload-part-copy](https://docs.aws.amazon.com/cli/latest/reference/s3api/upload-part-copy.html).
+of the [S3 API](https://docs.aws.amazon.com/cli/latest/reference/s3api/index.html) multipart operations.
+This applies in particular to the following operations:
+
+- [abort-multipart-upload](https://docs.aws.amazon.com/cli/latest/reference/s3api/abort-multipart-upload.html)
+- [complete-multipart-upload](https://docs.aws.amazon.com/cli/latest/reference/s3api/complete-multipart-upload.html)
+- [list-parts](https://docs.aws.amazon.com/cli/latest/reference/s3api/list-parts.html)
+- [upload-part](https://docs.aws.amazon.com/cli/latest/reference/s3api/upload-part.html)
+- [upload-part-copy](https://docs.aws.amazon.com/cli/latest/reference/s3api/upload-part-copy.html).
 """
 
 

opentelemetry-semantic-conventions/src/opentelemetry/semconv/_incubating/attributes/browser_attributes.py

@@ -36,5 +36,5 @@
 """
 The platform on which the browser is running.
 Note: This value is intended to be taken from the [UA client hints API](https://wicg.github.io/ua-client-hints/#interface) (`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](https://wicg.github.io/ua-client-hints/#sec-ch-ua-platform). Note that some (but not all) of these values can overlap with values in the [`os.type` and `os.name` attributes](./os.md). 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](https://wicg.github.io/ua-client-hints/#sec-ch-ua-platform). Note that some (but not all) of these values can overlap with values in the [`os.type` and `os.name` attributes](./os.md). However, for consistency, the values in the `browser.platform` attribute should capture the exact value that the user agent provides.
 """

opentelemetry-semantic-conventions/src/opentelemetry/semconv/_incubating/attributes/cloud_attributes.py

@@ -47,22 +47,22 @@
 """
 Cloud provider-specific native identifier of the monitored cloud resource (e.g. an [ARN](https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) on AWS, a [fully qualified resource ID](https://learn.microsoft.com/rest/api/resources/resources/get-by-id) on Azure, a [full resource name](https://cloud.google.com/apis/design/resource_names#full_resource_name) on GCP).
 Note: On some cloud providers, it may not be possible to determine the full ID at startup,
- so it may be necessary to set `cloud.resource_id` as a span attribute instead.
+so it may be necessary to set `cloud.resource_id` as a span attribute instead.
 
- The exact value to use for `cloud.resource_id` depends on the cloud provider.
- The following well-known definitions MUST be used if you set this attribute and they apply:
+The exact value to use for `cloud.resource_id` depends on the cloud provider.
+The following well-known definitions MUST be used if you set this attribute and they apply:
 
- * **AWS Lambda:** The function [ARN](https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html).
-  Take care not to use the "invoked ARN" directly but replace any
-  [alias suffix](https://docs.aws.amazon.com/lambda/latest/dg/configuration-aliases.html)
-  with the resolved function version, as the same runtime instance may be invokable with
-  multiple different aliases.
- * **GCP:** The [URI of the resource](https://cloud.google.com/iam/docs/full-resource-names)
- * **Azure:** The [Fully Qualified Resource ID](https://docs.microsoft.com/rest/api/resources/resources/get-by-id) of the invoked function,
-  *not* the function app, having the form
-  `/subscriptions/<SUBSCIPTION_GUID>/resourceGroups/<RG>/providers/Microsoft.Web/sites/<FUNCAPP>/functions/<FUNC>`.
-  This means that a span attribute MUST be used, as an Azure function app can host multiple functions that would usually share
-  a TracerProvider.
+* **AWS Lambda:** The function [ARN](https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html).
+ Take care not to use the "invoked ARN" directly but replace any
+ [alias suffix](https://docs.aws.amazon.com/lambda/latest/dg/configuration-aliases.html)
+ with the resolved function version, as the same runtime instance may be invokable with
+ multiple different aliases.
+* **GCP:** The [URI of the resource](https://cloud.google.com/iam/docs/full-resource-names)
+* **Azure:** The [Fully Qualified Resource ID](https://docs.microsoft.com/rest/api/resources/resources/get-by-id) of the invoked function,
+ *not* the function app, having the form
+ `/subscriptions/<SUBSCIPTION_GUID>/resourceGroups/<RG>/providers/Microsoft.Web/sites/<FUNCAPP>/functions/<FUNC>`.
+ This means that a span attribute MUST be used, as an Azure function app can host multiple functions that would usually share
+ a TracerProvider.
 """
 
 

opentelemetry-semantic-conventions/src/opentelemetry/semconv/_incubating/attributes/container_attributes.py

@@ -45,8 +45,8 @@
 """
 Runtime specific image identifier. Usually a hash algorithm followed by a UUID.
 Note: Docker defines a sha256 of the image id; `container.image.id` corresponds to the `Image` field from the Docker container inspect [API](https://docs.docker.com/engine/api/v1.43/#tag/Container/operation/ContainerInspect) 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.
+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.
 """
 
 CONTAINER_IMAGE_NAME: Final = "container.image.name"

opentelemetry-semantic-conventions/src/opentelemetry/semconv/_incubating/attributes/db_attributes.py

@@ -66,7 +66,7 @@
 """
 The name of a collection (table, container) within the database.
 Note: If the collection name is parsed from the query, it SHOULD match the value provided in the query and may be qualified with the schema and database name.
- 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.
 """
 
 DB_CONNECTION_STRING: Final = "db.connection_string"
@@ -161,8 +161,8 @@
 """
 The name of the database, fully qualified within the server address and port.
 Note: 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.
+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.
 """
 
 DB_OPERATION: Final = "db.operation"
@@ -180,7 +180,7 @@
 """
 The query parameters used in `db.query.text`, with `<key>` being the parameter name, and the attribute value being the parameter value.
 Note: 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 `<key>` SHOULD be the 0-based index.
+If a parameter has no name and instead is referenced only by index, then `<key>` SHOULD be the 0-based index.
 """
 
 DB_QUERY_TEXT: Final = "db.query.text"

opentelemetry-semantic-conventions/src/opentelemetry/semconv/_incubating/attributes/deployment_attributes.py

@@ -18,10 +18,10 @@
 """
 Name of the [deployment environment](https://wikipedia.org/wiki/Deployment_environment) (aka deployment tier).
 Note: `deployment.environment` does not affect the uniqueness constraints defined through
- the `service.namespace`, `service.name` and `service.instance.id` resource attributes.
- This implies that resources carrying the following attribute combinations MUST be
- considered to be identifying the same service:
+the `service.namespace`, `service.name` and `service.instance.id` resource attributes.
+This implies that resources carrying the following attribute combinations MUST be
+considered to be identifying the same service:
 
- * `service.name=frontend`, `deployment.environment=production`
- * `service.name=frontend`, `deployment.environment=staging`.
+* `service.name=frontend`, `deployment.environment=production`
+* `service.name=frontend`, `deployment.environment=staging`.
 """

opentelemetry-semantic-conventions/src/opentelemetry/semconv/_incubating/attributes/error_attributes.py

@@ -26,4 +26,4 @@
 @deprecated(reason="Deprecated in favor of stable :py:const:`opentelemetry.semconv.attributes.error_attributes.ErrorTypeValues`.") # type: ignore
 class ErrorTypeValues(Enum):
  OTHER = "_OTHER"
- """A fallback error value to be used when the instrumentation doesn't define a custom value."""
+ """Deprecated in favor of stable :py:const:`opentelemetry.semconv.attributes.error_attributes.ErrorTypeValues.OTHER`."""

opentelemetry-semantic-conventions/src/opentelemetry/semconv/_incubating/attributes/faas_attributes.py

@@ -84,21 +84,21 @@
 """
 The name of the single function that this runtime instance executes.
 Note: This is the name of the function as configured/deployed on the FaaS
- platform and is usually different from the name of the callback
- function (which may be stored in the
- [`code.namespace`/`code.function`](/docs/general/attributes.md#source-code-attributes)
- span attributes).
+platform and is usually different from the name of the callback
+function (which may be stored in the
+[`code.namespace`/`code.function`](/docs/general/attributes.md#source-code-attributes)
+span attributes).
 
- For some cloud providers, the above definition is ambiguous. The following
- definition of function name MUST be used for this attribute
- (and consequently the span name) for the listed cloud providers/products:
+For some cloud providers, the above definition is ambiguous. The following
+definition of function name MUST be used for this attribute
+(and consequently the span name) for the listed cloud providers/products:
 
- * **Azure:** The full name `<FUNCAPP>/<FUNC>`, i.e., function app name
-  followed by a forward slash followed by the function name (this form
-  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).
+* **Azure:** The full name `<FUNCAPP>/<FUNC>`, i.e., function app name
+ followed by a forward slash followed by the function name (this form
+ 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).
 """
 
 FAAS_TIME: Final = "faas.time"
@@ -116,13 +116,13 @@
 The immutable version of the function being executed.
 Note: Depending on the cloud provider and platform, use:
 
- * **AWS Lambda:** The [function version](https://docs.aws.amazon.com/lambda/latest/dg/configuration-versions.html)
-  (an integer represented as a decimal string).
- * **Google Cloud Run (Services):** The [revision](https://cloud.google.com/run/docs/managing/revisions)
-  (i.e., the function name plus the revision suffix).
- * **Google Cloud Functions:** The value of the
-  [`K_REVISION` environment variable](https://cloud.google.com/functions/docs/env-var#runtime_environment_variables_set_automatically).
- * **Azure Functions:** Not applicable. Do not set this attribute.
+* **AWS Lambda:** The [function version](https://docs.aws.amazon.com/lambda/latest/dg/configuration-versions.html)
+ (an integer represented as a decimal string).
+* **Google Cloud Run (Services):** The [revision](https://cloud.google.com/run/docs/managing/revisions)
+ (i.e., the function name plus the revision suffix).
+* **Google Cloud Functions:** The value of the
+ [`K_REVISION` environment variable](https://cloud.google.com/functions/docs/env-var#runtime_environment_variables_set_automatically).
+* **Azure Functions:** Not applicable. Do not set this attribute.
 """