Add semantic conventions for Azure subscription ID and resource group#3722
Add semantic conventions for Azure subscription ID and resource group#3722kathiehuang wants to merge 2 commits into
Conversation
|
This PR contains changes to area(s) that do not have an active SIG/project and will be auto-closed:
Such changes may be rejected or put on hold until a new SIG/project is established. Please refer to the Semantic Convention Areas |
|
@lmolkova @MikeGoldsmith @thompson-tomo @trask Hi all - I saw you had contributed to the Azure semantic conventions in the past. This PR formalizes two Azure attributes that are already emitted in practice by the
I was wondering if it would be possible to reopen this PR and get a review. Thank you! |
|
Hi @kathiehuang — sorry for the slow reply. I think what you've proposed looks good from a technical view. One thing worth noting is the attribute key The actual blocker isn't technical — the auto-close was triggered by the lack of an active SIG for the |
MikeGoldsmith
left a comment
There was a problem hiding this comment.
Looks good to me. I've noted a few things but the only thing to do is combine the two changelog entries.
| | <a id="cloud-resource-id" href="#cloud-resource-id">`cloud.resource_id`</a> |  | string | 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://google.aip.dev/122#full-resource-names) on GCP) [5] | `arn:aws:lambda:REGION:ACCOUNT_ID:function:my-function`; `//run.googleapis.com/projects/PROJECT_ID/locations/LOCATION_ID/services/SERVICE_ID`; `/subscriptions/<SUBSCRIPTION_GUID>/resourceGroups/<RG>/providers/Microsoft.Web/sites/<FUNCAPP>/functions/<FUNC>` | | ||
|
|
||
| **[1] `cloud.availability_zone`:** Availability zones are called "zones" on Alibaba Cloud and Google Cloud. | ||
| **[1] `cloud.account.id`:** For Azure, this is the subscription ID. |
There was a problem hiding this comment.
I think these notes are good to help indicate what to expect per cloud provider.
aea121a to
27d3b84
Compare
|
This PR contains changes to area(s) that do not have an active SIG/project and will be auto-closed:
Such changes may be rejected or put on hold until a new SIG/project is established. Please refer to the Semantic Convention Areas |
|
Thanks @trask 👍🏻 |
Fixes #3697
Fixes #3708
Changes
Adds two Azure resource conventions that are already used in practice by the OpenTelemetry collector-contrib
azurevmresource detector but were not formally defined:azure.resourcegroup.name(new attribute): The name of the Azure resource group the resource belongs to.cloud.account.id(updated note + example): Documents that for Azure, this attribute maps to the subscription ID, and adds a UUID-format example.Naming note:
azure.resourcegroup.nameuses a single-tokenresourcegrouprather than the semconv underscore formazure.resource_group.name. This intentionally matches the name already emitted by theazurevmdetector in collector-contrib. The semconv form would beazure.resource_group.name.Important
Pull requests acceptance are subject to the triage process as described in Issue and PR Triage Management.
PRs that do not follow the guidance above, may be automatically rejected and closed.
Merge requirement checklist
[chore]azure.resourcegroup.nameis already emitted by theazurevmdetector inresourcedetectionprocessorand referenced multiple times in collector-contribcloud.account.idfor Azure subscription ID is already used in practice by the same detector