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.

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

Populate ai.application.version from service.version #43733

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
+81 −48
Open

Populate ai.application.version from service.version #43733

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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: 1 addition & 1 deletion .../main/java/com/azure/monitor/opentelemetry/autoconfigure/AzureMonitorExporterBuilder.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -128,7 +128,7 @@ private BiConsumer<AbstractTelemetryBuilder, Resource> createDefaultsPopulator()
builder.setResource(resource);
builder.addTag(ContextTagKeys.AI_INTERNAL_SDK_VERSION.toString(), VersionGenerator.getSdkVersion());
// TODO (trask) unify these
resourceParser.updateRoleNameAndInstance(builder, resource);
resourceParser.updateRoleNameAndInstanceAndVersion(builder, resource);
};
}

Expand Down
31 changes: 21 additions & 10 deletions ...va/com/azure/monitor/opentelemetry/autoconfigure/implementation/utils/ResourceParser.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,15 +32,7 @@ public ResourceParser() {
}

// visible for testing
public void updateRoleNameAndInstance(AbstractTelemetryBuilder builder, Resource resource) {

// update AKS role name and role instance
if (AksResourceAttributes.isAks(resource)) {
builder.addTag(ContextTagKeys.AI_CLOUD_ROLE.toString(), AksResourceAttributes.getAksRoleName(resource));
builder.addTag(ContextTagKeys.AI_CLOUD_ROLE_INSTANCE.toString(),
AksResourceAttributes.getAksRoleInstance(resource));
return;
}
public void updateRoleNameAndInstanceAndVersion(AbstractTelemetryBuilder builder, Resource resource) {

Map<String, String> tags = builder.build().getTags();
if (tags == null || !tags.containsKey(ContextTagKeys.AI_CLOUD_ROLE.toString())) {
Expand All @@ -50,9 +42,20 @@ public void updateRoleNameAndInstance(AbstractTelemetryBuilder builder, Resource
if (tags == null || !tags.containsKey(ContextTagKeys.AI_CLOUD_ROLE_INSTANCE.toString())) {
builder.addTag(ContextTagKeys.AI_CLOUD_ROLE_INSTANCE.toString(), getRoleInstance(resource));
}

if (tags == null || !tags.containsKey(ContextTagKeys.AI_APPLICATION_VER.toString())) {
String applicationVersion = resource.getAttribute(ServiceAttributes.SERVICE_VERSION);
if (applicationVersion != null) {
builder.addTag(ContextTagKeys.AI_APPLICATION_VER.toString(), applicationVersion);
}
}
}

private String getRoleName(Resource resource) {
if (AksResourceAttributes.isAks(resource)) {
return AksResourceAttributes.getAksRoleName(resource);
}

String serviceName = resource.getAttribute(ServiceAttributes.SERVICE_NAME);
if (serviceName == null || DEFAULT_SERVICE_NAME.equals(serviceName)) {
if (websiteSiteName != null) {
Expand All @@ -71,6 +74,10 @@ private String getRoleName(Resource resource) {
}

private String getRoleInstance(Resource resource) {
if (AksResourceAttributes.isAks(resource)) {
return AksResourceAttributes.getAksRoleInstance(resource);
}

String roleInstance = resource.getAttribute(ServiceIncubatingAttributes.SERVICE_INSTANCE_ID);
if (roleInstance != null) {
return roleInstance;
Expand All @@ -79,7 +86,11 @@ private String getRoleInstance(Resource resource) {
if (roleInstance != null) {
return roleInstance;
}
return HostName.get(); // default hostname
roleInstance = HostName.get(); // default hostname
if (roleInstance != null) {
return roleInstance;
}
return "unknown"; // this is for backwards compatibility in the Java agent
}

public static String getWebsiteSiteNameEnvVar(Function<String, String> envVars) {
Expand Down
16 changes: 8 additions & 8 deletions ...e/monitor/opentelemetry/autoconfigure/implementation/utils/AksResourceAttributesTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ void testDefault() {
"cloud.provider=Azure,cloud.platform=azure_aks,service.name=unknown_service:java"));
Resource resource = ResourceConfiguration.createEnvironmentResource(config);

new ResourceParser().updateRoleNameAndInstance(builder, resource);
new ResourceParser().updateRoleNameAndInstanceAndVersion(builder, resource);
Map<String, String> map = new HashMap<>(2);
map.put(ContextTagKeys.AI_CLOUD_ROLE.toString(), "unknown_service:java");
map.put(ContextTagKeys.AI_CLOUD_ROLE_INSTANCE.toString(), HostName.get());
Expand All @@ -46,7 +46,7 @@ void testServiceNameAndK8sPodName() {
"cloud.provider=Azure,cloud.platform=azure_aks,service.name=test-service-name,k8s.pod.name=test-pod-name"));
Resource resource = ResourceConfiguration.createEnvironmentResource(config);

new ResourceParser().updateRoleNameAndInstance(builder, resource);
new ResourceParser().updateRoleNameAndInstanceAndVersion(builder, resource);
Map<String, String> tags = builder.build().getTags();
assertThat(tags.get(ContextTagKeys.AI_CLOUD_ROLE.toString())).isEqualTo("test-service-name");
assertThat(tags.get(ContextTagKeys.AI_CLOUD_ROLE_INSTANCE.toString())).isEqualTo("test-pod-name");
Expand All @@ -58,7 +58,7 @@ void testK8sDeploymentName() {
"cloud.provider=Azure,cloud.platform=azure_aks,service.name=unknown_service:java,k8s.deployment.name=test-deployment-name,k8s.pod.name=test-pod-name"));
Resource resource = ResourceConfiguration.createEnvironmentResource(config);

new ResourceParser().updateRoleNameAndInstance(builder, resource);
new ResourceParser().updateRoleNameAndInstanceAndVersion(builder, resource);
Map<String, String> tags = builder.build().getTags();
assertThat(tags.get(ContextTagKeys.AI_CLOUD_ROLE.toString())).isEqualTo("test-deployment-name");
assertThat(tags.get(ContextTagKeys.AI_CLOUD_ROLE_INSTANCE.toString())).isEqualTo("test-pod-name");
Expand All @@ -70,7 +70,7 @@ void testK8sReplicaSetName() {
"cloud.provider=Azure,cloud.platform=azure_aks,service.name=unknown_service:java,k8s.replicaset.name=test-replicaset-name,k8s.pod.name=test-pod-name"));
Resource resource = ResourceConfiguration.createEnvironmentResource(config);

new ResourceParser().updateRoleNameAndInstance(builder, resource);
new ResourceParser().updateRoleNameAndInstanceAndVersion(builder, resource);
Map<String, String> tags = builder.build().getTags();
assertThat(tags.get(ContextTagKeys.AI_CLOUD_ROLE.toString())).isEqualTo("test-replicaset-name");
assertThat(tags.get(ContextTagKeys.AI_CLOUD_ROLE_INSTANCE.toString())).isEqualTo("test-pod-name");
Expand All @@ -82,7 +82,7 @@ void testK8sStatefulSetName() {
"cloud.provider=Azure,cloud.platform=azure_aks,service.name=unknown_service:java,k8s.statefulset.name=test-statefulset-name,k8s.pod.name=test-pod-name"));
Resource resource = ResourceConfiguration.createEnvironmentResource(config);

new ResourceParser().updateRoleNameAndInstance(builder, resource);
new ResourceParser().updateRoleNameAndInstanceAndVersion(builder, resource);
Map<String, String> tags = builder.build().getTags();
assertThat(tags.get(ContextTagKeys.AI_CLOUD_ROLE.toString())).isEqualTo("test-statefulset-name");
assertThat(tags.get(ContextTagKeys.AI_CLOUD_ROLE_INSTANCE.toString())).isEqualTo("test-pod-name");
Expand All @@ -94,7 +94,7 @@ void testKsJobName() {
"cloud.provider=Azure,cloud.platform=azure_aks,service.name=unknown_service:java,k8s.job.name=test-job-name,k8s.pod.name=test-pod-name"));
Resource resource = ResourceConfiguration.createEnvironmentResource(config);

new ResourceParser().updateRoleNameAndInstance(builder, resource);
new ResourceParser().updateRoleNameAndInstanceAndVersion(builder, resource);
Map<String, String> tags = builder.build().getTags();
assertThat(tags.get(ContextTagKeys.AI_CLOUD_ROLE.toString())).isEqualTo("test-job-name");
assertThat(tags.get(ContextTagKeys.AI_CLOUD_ROLE_INSTANCE.toString())).isEqualTo("test-pod-name");
Expand All @@ -106,7 +106,7 @@ void testK8sCronJobName() {
"cloud.provider=Azure,cloud.platform=azure_aks,service.name=unknown_service:java,k8s.cronjob.name=test-cronjob-name,k8s.pod.name=test-pod-name"));
Resource resource = ResourceConfiguration.createEnvironmentResource(config);

new ResourceParser().updateRoleNameAndInstance(builder, resource);
new ResourceParser().updateRoleNameAndInstanceAndVersion(builder, resource);
Map<String, String> tags = builder.build().getTags();
assertThat(tags.get(ContextTagKeys.AI_CLOUD_ROLE.toString())).isEqualTo("test-cronjob-name");
assertThat(tags.get(ContextTagKeys.AI_CLOUD_ROLE_INSTANCE.toString())).isEqualTo("test-pod-name");
Expand All @@ -118,7 +118,7 @@ void testK8sDaemonSetName() {
"cloud.provider=Azure,cloud.platform=azure_aks,service.name=unknown_service:java,k8s.daemonset.name=test-daemonset-name,k8s.pod.name=test-pod-name"));
Resource resource = ResourceConfiguration.createEnvironmentResource(config);

new ResourceParser().updateRoleNameAndInstance(builder, resource);
new ResourceParser().updateRoleNameAndInstanceAndVersion(builder, resource);
Map<String, String> tags = builder.build().getTags();
assertThat(tags.get(ContextTagKeys.AI_CLOUD_ROLE.toString())).isEqualTo("test-daemonset-name");
assertThat(tags.get(ContextTagKeys.AI_CLOUD_ROLE_INSTANCE.toString())).isEqualTo("test-pod-name");
Expand Down
80 changes: 51 additions & 29 deletions ...om/azure/monitor/opentelemetry/autoconfigure/implementation/utils/ResourceParserTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,16 +7,13 @@
import com.azure.monitor.opentelemetry.autoconfigure.implementation.models.ContextTagKeys;
import io.opentelemetry.api.common.Attributes;
import io.opentelemetry.api.common.AttributesBuilder;
import io.opentelemetry.sdk.autoconfigure.spi.ConfigProperties;
import io.opentelemetry.sdk.autoconfigure.spi.internal.DefaultConfigProperties;
import io.opentelemetry.sdk.resources.Resource;
import io.opentelemetry.semconv.ServiceAttributes;
import io.opentelemetry.semconv.incubating.ServiceIncubatingAttributes;
import org.junit.jupiter.api.BeforeEach;
import org.junit.jupiter.api.Test;
import reactor.util.annotation.Nullable;

import java.util.Collections;
import java.util.HashMap;
import java.util.Map;

Expand All @@ -25,6 +22,7 @@

class ResourceParserTest {

private static final String DEFAULT_ROLE_NAME = "unknown_service:java";
private static final String DEFAULT_ROLE_INSTANCE = HostName.get();
private MetricTelemetryBuilder builder;

Expand All @@ -35,54 +33,80 @@ void setup() {

@Test
void testDefaultResource() {
new ResourceParser().updateRoleNameAndInstance(builder, Resource.create(Attributes.empty()));
assertThat(builder.build().getTags())
.contains(entry(ContextTagKeys.AI_CLOUD_ROLE_INSTANCE.toString(), DEFAULT_ROLE_INSTANCE));
new ResourceParser().updateRoleNameAndInstanceAndVersion(builder, Resource.create(Attributes.empty()));

Map<String, String> tags = builder.build().getTags();
assertThat(tags).contains(entry(ContextTagKeys.AI_CLOUD_ROLE.toString(), DEFAULT_ROLE_NAME),
entry(ContextTagKeys.AI_CLOUD_ROLE_INSTANCE.toString(), DEFAULT_ROLE_INSTANCE)).hasSize(2);
}

@Test
void testServiceNameFromResource() {
Resource resource = createTestResource("fake-service-name", null, null);
new ResourceParser().updateRoleNameAndInstance(builder, resource);

new ResourceParser().updateRoleNameAndInstanceAndVersion(builder, resource);

Map<String, String> tags = builder.build().getTags();
assertThat(tags.get(ContextTagKeys.AI_CLOUD_ROLE.toString())).isEqualTo("fake-service-name");
assertThat(tags.get(ContextTagKeys.AI_CLOUD_ROLE_INSTANCE.toString())).isEqualTo(DEFAULT_ROLE_INSTANCE);
assertThat(tags).contains(entry(ContextTagKeys.AI_CLOUD_ROLE.toString(), "fake-service-name"),
entry(ContextTagKeys.AI_CLOUD_ROLE_INSTANCE.toString(), DEFAULT_ROLE_INSTANCE)).hasSize(2);
}

@Test
void testServiceInstanceFromResource() {
Resource resource = createTestResource(null, null, "fake-service-instance");
new ResourceParser().updateRoleNameAndInstance(builder, resource);
assertThat(builder.build().getTags())
.contains(entry(ContextTagKeys.AI_CLOUD_ROLE_INSTANCE.toString(), "fake-service-instance"));

new ResourceParser().updateRoleNameAndInstanceAndVersion(builder, resource);

Map<String, String> tags = builder.build().getTags();
assertThat(tags).contains(entry(ContextTagKeys.AI_CLOUD_ROLE.toString(), DEFAULT_ROLE_NAME),
entry(ContextTagKeys.AI_CLOUD_ROLE_INSTANCE.toString(), "fake-service-instance")).hasSize(2);
}

@Test
void testVersionFromResource() {
Resource resource = Resource.create(Attributes.of(ServiceAttributes.SERVICE_VERSION, "fake-service-version"));

new ResourceParser().updateRoleNameAndInstanceAndVersion(builder, resource);

Map<String, String> tags = builder.build().getTags();
assertThat(tags).contains(entry(ContextTagKeys.AI_CLOUD_ROLE.toString(), DEFAULT_ROLE_NAME),
entry(ContextTagKeys.AI_CLOUD_ROLE_INSTANCE.toString(), DEFAULT_ROLE_INSTANCE),
entry(ContextTagKeys.AI_APPLICATION_VER.toString(), "fake-service-version")).hasSize(3);
}

@Test
void testServiceNamespaceFromResource() {
Resource resource = createTestResource(null, "fake-service-namespace", null);
new ResourceParser().updateRoleNameAndInstance(builder, resource);

new ResourceParser().updateRoleNameAndInstanceAndVersion(builder, resource);

Map<String, String> tags = builder.build().getTags();
assertThat(tags.get(ContextTagKeys.AI_CLOUD_ROLE.toString())).isEqualTo("[fake-service-namespace]");
assertThat(tags.get(ContextTagKeys.AI_CLOUD_ROLE_INSTANCE.toString())).isEqualTo(DEFAULT_ROLE_INSTANCE);
assertThat(tags).contains(entry(ContextTagKeys.AI_CLOUD_ROLE.toString(), "[fake-service-namespace]"),
entry(ContextTagKeys.AI_CLOUD_ROLE_INSTANCE.toString(), DEFAULT_ROLE_INSTANCE)).hasSize(2);
}

@Test
void testServiceNameAndInstanceFromResource() {
Resource resource = createTestResource("fake-service-name", null, "fake-instance");
new ResourceParser().updateRoleNameAndInstance(builder, resource);

new ResourceParser().updateRoleNameAndInstanceAndVersion(builder, resource);

Map<String, String> tags = builder.build().getTags();
assertThat(tags.get(ContextTagKeys.AI_CLOUD_ROLE.toString())).isEqualTo("fake-service-name");
assertThat(tags.get(ContextTagKeys.AI_CLOUD_ROLE_INSTANCE.toString())).isEqualTo("fake-instance");
assertThat(tags).contains(entry(ContextTagKeys.AI_CLOUD_ROLE.toString(), "fake-service-name"),
entry(ContextTagKeys.AI_CLOUD_ROLE_INSTANCE.toString(), "fake-instance")).hasSize(2);
}

@Test
void testServiceNameAndInstanceAndNamespaceFromResource() {
Resource resource = createTestResource("fake-service-name", "fake-service-namespace", "fake-instance");
new ResourceParser().updateRoleNameAndInstance(builder, resource);

new ResourceParser().updateRoleNameAndInstanceAndVersion(builder, resource);

Map<String, String> tags = builder.build().getTags();
assertThat(tags.get(ContextTagKeys.AI_CLOUD_ROLE.toString()))
.isEqualTo("[fake-service-namespace]/fake-service-name");
assertThat(tags.get(ContextTagKeys.AI_CLOUD_ROLE_INSTANCE.toString())).isEqualTo("fake-instance");
assertThat(tags)
.contains(entry(ContextTagKeys.AI_CLOUD_ROLE.toString(), "[fake-service-namespace]/fake-service-name"),
entry(ContextTagKeys.AI_CLOUD_ROLE_INSTANCE.toString(), "fake-instance"))
.hasSize(2);
}

@Test
Expand All @@ -91,14 +115,12 @@ void testWebsiteSiteNameAndWebsiteInstanceId() {
envVars.put("WEBSITE_SITE_NAME", "test_website_site_name");
envVars.put("WEBSITE_INSTANCE_ID", "test_website_instance_id");
Resource resource = createTestResource(null, null, null);
new ResourceParser(envVars).updateRoleNameAndInstance(builder, resource);
Map<String, String> tags = builder.build().getTags();
assertThat(tags.get(ContextTagKeys.AI_CLOUD_ROLE.toString())).isEqualTo("test_website_site_name");
assertThat(tags.get(ContextTagKeys.AI_CLOUD_ROLE_INSTANCE.toString())).isEqualTo("test_website_instance_id");
}

private static ConfigProperties getConfiguration() {
return DefaultConfigProperties.create(Collections.singletonMap("HOSTNAME", DEFAULT_ROLE_INSTANCE));
new ResourceParser(envVars).updateRoleNameAndInstanceAndVersion(builder, resource);

Map<String, String> tags = builder.build().getTags();
assertThat(tags).contains(entry(ContextTagKeys.AI_CLOUD_ROLE.toString(), "test_website_site_name"),
entry(ContextTagKeys.AI_CLOUD_ROLE_INSTANCE.toString(), "test_website_instance_id")).hasSize(2);
}

private static Resource createTestResource(@Nullable String serviceName, @Nullable String serviceNameSpace,
Expand Down
Loading