Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Change azure_ and az. to azure. across all conventions #1698

Draft
wants to merge 2 commits into
base: main
Choose a base branch
from

Conversation

lmolkova
Copy link
Contributor

@lmolkova lmolkova commented Dec 18, 2024

Azure-specific attributes/signals use azure. prefix to denote they belong to azure namespace.

We should

  • Consolidate cloud.platform enum values:
    • azure_aks -> azure.aks
    • azure_app_service -> azure.app_service
    • azure_container_apps -> azure.container_apps
    • azure_container_instances -> azure.container_instances
    • azure_functions -> azure.functions
    • azure_openshift -> azure.openshift
    • azure_vm -> azure.vm
  • Consolidate gen_ai.system enum values:
    • az.ai.inference -> azure.ai.inference
    • az.ai.openai -> -> azure.ai.openai
  • Azure SDK attributes
    • az.namespace -> azure.resource.namespace
    • az.service_request_id -> azure.service.request.id
  • Azure log event
    • az.resource.log -> azure.resource.log

Related to #1684 (comment), #608, #1708, #1613

PS: We should do similar renames for AWS and GCP, cloud.provider -> cloud.provider.name, cloud.platform -> ?

Merge requirement checklist

@lmolkova
Copy link
Contributor Author

lmolkova commented Dec 18, 2024

/cc @trask, @mattmccleary, @rajkumar-rangaraj, @cijothomas, @lzchen @RohitRanjanMS, @OsvaldoRosado, @reyang if the have any context on how breaking they expect it to be.

@lmolkova lmolkova changed the title Change azure_ to az. in enum values Change azure_ to az. in cloud.platform enum values on Dec 18, 2024
@RohitRanjanMS
Copy link

Thanks, @lmolkova . Functions is still in its early stages with respect to OTel, and I don't see any issues with this proposal.

@lzchen
Copy link

lzchen commented Dec 19, 2024

We do have azure resource detector that use some of these values although the component itself is experimental. In azmon exporter, we currently do not map resource attributes to telemetry custom dimensions BUT we do populate OTELRESOURCE custom metric which is populated with the resource attribute information. I believe this feature is in preview as well so probably not an issue to make breaking changes.

@jeremydvoss

@lmolkova lmolkova changed the title Change azure_ to az. in cloud.platform enum values on Change azure_ to az. in cloud.platform enum values Dec 27, 2024
@lmolkova lmolkova changed the title Change azure_ to az. in cloud.platform enum values Change azure_ and az. to azure. across all conventions Jan 17, 2025
brief: "The unique identifier of the service request. It's generated by the Azure service and returned with the response."
examples:
- "00000000-0000-0000-0000-000000000000"
- id: az.namespace
- id: azure.resource.namespace
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Alternatives:

  • azure.provider.namespace
  • azure.resource.provider.namespace - precise, but too long
  • azure.rp.namespace - this acronym is likely to be MS-internal thing

@@ -5,15 +5,15 @@ groups:
brief: >
This document defines generic attributes for Azure SDK.
attributes:
- id: az.service_request_id
- id: azure.service.request.id
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Alternatives:

  • azure.server.request.id (there is also azure.client.request.id counterpart not documented here) - this aligns with semconv better, but service gives a nuance that it's generated by the Azure service, while server is used in semconv more the context of user app

- id: azure_app_service
value: 'azure_app_service'
value: 'azure_app_service.app_service'
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

oops

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
Development

Successfully merging this pull request may close these issues.

3 participants