Skip to content

Modify logic to ensure that the cloud_RoleInstance gets populated with the k8 pod name if specified #45884

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.

Sign up for GitHub

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

Open
rads-1996 wants to merge 4 commits into
base: main
Choose a base branch
from
+45 −3
Open

Modify logic to ensure that the cloud_RoleInstance gets populated with the k8 pod name if specified #45884

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
017a8e5
Modify logic to ensure that the cloud_RoleInstance gets populated wit…
rads-1996 Mar 24, 2026
da2b4e8
Update CHANGELOG
rads-1996 Mar 24, 2026
893d257
Retrigger CI/CD pipeline
rads-1996 Mar 24, 2026
2c0d355
Retrigger CI/CD pipeline
rads-1996 Mar 25, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions sdk/monitor/azure-monitor-opentelemetry-exporter/CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,8 @@
### Breaking Changes

### Bugs Fixed
- Kubernetes pod name takes precedence when populating `cloud_RoleInstance`
([#45884](https://github.com/Azure/azure-sdk-for-python/pull/45884))

### Other Changes

Expand Down
6 changes: 3 additions & 3 deletions ...nitor/azure-monitor-opentelemetry-exporter/azure/monitor/opentelemetry/exporter/_utils.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -297,12 +297,12 @@ def _get_cloud_role(resource: Resource) -> str:


def _get_cloud_role_instance(resource: Resource) -> str:
service_instance_id = resource.attributes.get(ResourceAttributes.SERVICE_INSTANCE_ID)
if service_instance_id:
return service_instance_id # type: ignore
k8s_pod_name = resource.attributes.get(ResourceAttributes.K8S_POD_NAME)
if k8s_pod_name:
return k8s_pod_name # type: ignore
service_instance_id = resource.attributes.get(ResourceAttributes.SERVICE_INSTANCE_ID)
if service_instance_id:
return service_instance_id # type: ignore
return platform.node() # hostname default


Expand Down
40 changes: 40 additions & 0 deletions sdk/monitor/azure-monitor-opentelemetry-exporter/tests/test_utils.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -316,9 +316,49 @@ def test_populate_part_a_fields_aks_with_service(self):
tags = _utils._populate_part_a_fields(resource)
self.assertIsNotNone(tags)
self.assertEqual(tags.get("ai.cloud.role"), "testServiceName")
self.assertEqual(tags.get("ai.cloud.roleInstance"), "testPodName")
self.assertEqual(tags.get("ai.internal.nodeName"), tags.get("ai.cloud.roleInstance"))

def test_populate_part_a_fields_uses_service_instance_id_when_pod_name_empty(self):
resource = Resource(
{
"service.name": "testServiceName",
"service.instance.id": "testServiceInstanceId",
"k8s.deployment.name": "testDeploymentName",
"k8s.replicaset.name": "testReplicaSetName",
"k8s.statefulset.name": "testStatefulSetName",
"k8s.job.name": "testJobName",
"k8s.cronjob.name": "testCronJobName",
"k8s.daemonset.name": "testDaemonSetName",
"k8s.pod.name": "",
}
)
tags = _utils._populate_part_a_fields(resource)
self.assertIsNotNone(tags)
self.assertEqual(tags.get("ai.cloud.role"), "testServiceName")
self.assertEqual(tags.get("ai.cloud.roleInstance"), "testServiceInstanceId")
self.assertEqual(tags.get("ai.internal.nodeName"), tags.get("ai.cloud.roleInstance"))

def test_populate_part_a_fields_falls_back_to_hostname_when_pod_and_instance_id_empty(self):
resource = Resource(
{
"service.name": "testServiceName",
"service.instance.id": "",
"k8s.deployment.name": "testDeploymentName",
"k8s.replicaset.name": "testReplicaSetName",
"k8s.statefulset.name": "testStatefulSetName",
"k8s.job.name": "testJobName",
"k8s.cronjob.name": "testCronJobName",
"k8s.daemonset.name": "testDaemonSetName",
"k8s.pod.name": "",
}
)
tags = _utils._populate_part_a_fields(resource)
self.assertIsNotNone(tags)
self.assertEqual(tags.get("ai.cloud.role"), "testServiceName")
self.assertEqual(tags.get("ai.cloud.roleInstance"), platform.node())
self.assertEqual(tags.get("ai.internal.nodeName"), tags.get("ai.cloud.roleInstance"))

# Default service.name fields should be ignored when kubernetes values are present
def test_populate_part_a_fields_aks_with_unknown_service(self):
resource = Resource(
Expand Down
Loading