Add semantic conventions for Azure Container Apps replica name and revision id #3860
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,12 @@ | ||
| change_type: enhancement | ||
|
|
||
| component: azure | ||
|
|
||
| note: > | ||
| Add `azure.container_app.instance` and `azure.container_app` entities, and | ||
| `azure.container_app.instance.id` and `azure.container_app.revision.name` attributes, for | ||
| identifying replicas and revisions of an Azure Container App. | ||
|
|
||
| issues: [3857] | ||
|
|
||
| subtext: |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,36 @@ | ||
| <!-- NOTE: THIS FILE IS AUTOGENERATED. DO NOT EDIT BY HAND. --> | ||
| <!-- see templates/registry/markdown/entity_namespace.md.j2 --> | ||
|
|
||
| # Azure | ||
|
|
||
| ## Azure Container App | ||
|
|
||
| **Status:**  | ||
|
|
||
| **type:** `azure.container_app` | ||
|
|
||
| **Description:** Resource used by a revision of an Azure Container App. Does not apply to Azure Container Apps Jobs. | ||
|
|
||
| **Attributes:** | ||
|
|
||
| | Role | Key | Stability | [Requirement Level](https://opentelemetry.io/docs/specs/semconv/general/attribute-requirement-level/) | Value Type | Description | Example Values | | ||
| | --- | --- | --- | --- | --- | --- | --- | | ||
| | Identity | [`azure.container_app.revision.name`](/docs/registry/attributes/azure.md) |  | `Required` | string | The name of the revision of an Azure Container App. [1] | `my-containerapp--20mh1s9` | | ||
|
|
||
| **[1] `azure.container_app.revision.name`:** The value should be set to the [`CONTAINER_APP_REVISION`](https://learn.microsoft.com/azure/container-apps/environment-variables) environment variable. | ||
|
|
||
| ## Azure Container App Instance | ||
|
|
||
| **Status:**  | ||
|
|
||
| **type:** `azure.container_app.instance` | ||
|
|
||
| **Description:** Resource used by an Azure Container App replica. | ||
|
|
||
| **Attributes:** | ||
|
|
||
| | Role | Key | Stability | [Requirement Level](https://opentelemetry.io/docs/specs/semconv/general/attribute-requirement-level/) | Value Type | Description | Example Values | | ||
| | --- | --- | --- | --- | --- | --- | --- | | ||
| | Identity | [`azure.container_app.instance.id`](/docs/registry/attributes/azure.md) |  | `Required` | string | The name of the replica of an Azure Container App. [2] | `my-containerapp--20mh1s9-86c8c4b497-zx9bq` | | ||
|
|
||
| **[2] `azure.container_app.instance.id`:** The value should be set to the [`CONTAINER_APP_REPLICA_NAME`](https://learn.microsoft.com/azure/container-apps/environment-variables) environment variable. | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,20 @@ | ||
| <!--- Hugo front matter used to generate the website version of this page: | ||
| linkTitle: Azure | ||
| ---> | ||
|
|
||
| # Azure semantic conventions | ||
|
|
||
| **Status**: [Development][DocumentStatus] | ||
|
|
||
| This directory defines standards for resource attributes that only apply to | ||
| Azure resources. If an attribute could apply to resources from more than one | ||
| cloud provider (like account ID, operating system, etc), it belongs in the | ||
| parent `model` directory. | ||
|
|
||
| ## Services | ||
|
|
||
| Attributes that relate to an individual Azure service: | ||
|
|
||
| - [Container Apps](./container-apps.md) | ||
|
|
||
| [DocumentStatus]: https://opentelemetry.io/docs/specs/otel/document-status |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,54 @@ | ||
| # Azure Container Apps | ||
|
|
||
| **Status**: [Development][DocumentStatus] | ||
|
|
||
| These conventions are recommended for resources running on | ||
| [Azure Container Apps](https://learn.microsoft.com/azure/container-apps/overview). They do not apply to Azure Container Apps Jobs. | ||
|
|
||
| <!-- semconv entity.azure.container_app.instance --> | ||
| <!-- NOTE: THIS TEXT IS AUTOGENERATED. DO NOT EDIT BY HAND. --> | ||
| <!-- see templates/registry/markdown/snippet.md.j2 --> | ||
| <!-- prettier-ignore-start --> | ||
|
|
||
| **Status:**  | ||
|
|
||
| **type:** `azure.container_app.instance` | ||
|
|
||
| **Description:** Resource used by an Azure Container App replica. | ||
|
|
||
| **Attributes:** | ||
|
|
||
| | Role | Key | Stability | [Requirement Level](https://opentelemetry.io/docs/specs/semconv/general/attribute-requirement-level/) | Value Type | Description | Example Values | | ||
| | --- | --- | --- | --- | --- | --- | --- | | ||
| | Identity | [`azure.container_app.instance.id`](/docs/registry/attributes/azure.md) |  | `Required` | string | The name of the replica of an Azure Container App. [1] | `my-containerapp--20mh1s9-86c8c4b497-zx9bq` | | ||
|
|
||
| **[1] `azure.container_app.instance.id`:** The value should be set to the [`CONTAINER_APP_REPLICA_NAME`](https://learn.microsoft.com/azure/container-apps/environment-variables) environment variable. | ||
| <!-- prettier-ignore-end --> | ||
| <!-- END AUTOGENERATED TEXT --> | ||
| <!-- endsemconv --> | ||
|
|
||
| <!-- semconv entity.azure.container_app --> | ||
| <!-- NOTE: THIS TEXT IS AUTOGENERATED. DO NOT EDIT BY HAND. --> | ||
| <!-- see templates/registry/markdown/snippet.md.j2 --> | ||
| <!-- prettier-ignore-start --> | ||
|
|
||
| **Status:**  | ||
|
|
||
| **type:** `azure.container_app` | ||
|
|
||
| **Description:** Resource used by a revision of an Azure Container App. Does not apply to Azure Container Apps Jobs. | ||
|
|
||
| **Attributes:** | ||
|
|
||
| | Role | Key | Stability | [Requirement Level](https://opentelemetry.io/docs/specs/semconv/general/attribute-requirement-level/) | Value Type | Description | Example Values | | ||
| | --- | --- | --- | --- | --- | --- | --- | | ||
| | Identity | [`azure.container_app.revision.name`](/docs/registry/attributes/azure.md) |  | `Required` | string | The name of the revision of an Azure Container App. [1] | `my-containerapp--20mh1s9` | | ||
|
|
||
| **[1] `azure.container_app.revision.name`:** The value should be set to the [`CONTAINER_APP_REVISION`](https://learn.microsoft.com/azure/container-apps/environment-variables) environment variable. | ||
| <!-- prettier-ignore-end --> | ||
| <!-- END AUTOGENERATED TEXT --> | ||
| <!-- endsemconv --> | ||
|
|
||
| Additionally, [the `cloud.provider` resource attribute MUST be set to `azure`](../../cloud.md). | ||
|
|
||
| [DocumentStatus]: https://opentelemetry.io/docs/specs/otel/document-status |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,22 @@ | ||
| groups: | ||
| - id: entity.azure.container_app.instance | ||
| type: entity | ||
| stability: development | ||
| name: azure.container_app.instance | ||
| brief: > | ||
| Resource used by an Azure Container App replica. | ||
| attributes: | ||
| - ref: azure.container_app.instance.id | ||
| role: identifying | ||
| requirement_level: required | ||
|
|
||
| - id: entity.azure.container_app | ||
| type: entity | ||
| stability: development | ||
| name: azure.container_app | ||
| brief: > | ||
| Resource used by a revision of an Azure Container App. Does not apply to Azure Container Apps Jobs. | ||
| attributes: | ||
| - ref: azure.container_app.revision.name | ||
| role: identifying | ||
| requirement_level: required | ||
|
There was a problem hiding this comment.
For Azure Container Apps jobs, this required identity cannot be populated: Microsoft’s built-in environment-variable docs list Useful? React with 👍 / 👎.
Contributor
Author
There was a problem hiding this comment. Clarified that Azure Container Apps Jobs are out of scope in 2063e7b |
||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
It looks like the generation title-cases the entity's
namefield directlysemantic-conventions/templates/registry/markdown/entity_namespace.md.j2
Line 7 in d36e740
and setting an explicit display name/title doesn't seem to be supported by the generator