Add roleName to profile metadata (#1725)

johnoliver · web-flow · commit 1ff5d2545402 · 2021-06-02T10:53:56.000-07:00
diff --git a/agent/agent-profiler/agent-profiler-api/src/main/java/com/microsoft/applicationinsights/profiler/ProfilerServiceFactory.java b/agent/agent-profiler/agent-profiler-api/src/main/java/com/microsoft/applicationinsights/profiler/ProfilerServiceFactory.java
@@ -20,6 +20,7 @@ Future<ProfilerService> initialize(
             String instrumentationKey,
             CloseableHttpClient httpClient,
             ScheduledExecutorService serviceProfilerExecutorService,
-            String userAgent
+            String userAgent,
+            String roleName
     );
 }
diff --git a/agent/agent-profiler/agent-service-profiler/src/main/java/com/microsoft/applicationinsights/serviceprofilerapi/JfrProfilerServiceFactory.java b/agent/agent-profiler/agent-service-profiler/src/main/java/com/microsoft/applicationinsights/serviceprofilerapi/JfrProfilerServiceFactory.java
@@ -34,15 +34,17 @@ public synchronized Future<ProfilerService> initialize(
             String instrumentationKey,
             CloseableHttpClient httpClient,
             ScheduledExecutorService serviceProfilerExecutorService,
-            String userAgent) {
+            String userAgent,
+            String roleName) {
         if (INSTANCE == null) {
             ServiceProfilerClientV2 serviceProfilerClient = new ProfilerFrontendClientV2(config.getServiceProfilerFrontEndPoint(), instrumentationKey, httpClient, userAgent);
 
             ServiceProfilerUploader uploader = new ServiceProfilerUploader(
                     serviceProfilerClient,
                     machineName,
                     processId,
-                    appIdSupplier);
+                    appIdSupplier,
+                    roleName);
 
             INSTANCE = new JfrProfilerService(
                     appIdSupplier,
diff --git a/agent/agent-profiler/agent-service-profiler/src/main/java/com/microsoft/applicationinsights/serviceprofilerapi/client/contract/BlobMetadataConstants.java b/agent/agent-profiler/agent-service-profiler/src/main/java/com/microsoft/applicationinsights/serviceprofilerapi/client/contract/BlobMetadataConstants.java
@@ -34,4 +34,5 @@ public class BlobMetadataConstants {
   public static final String PROGRAMMING_LANGUAGE_META_NAME = "spProgrammingLanguage";
   public static final String OS_PLATFORM_META_NAME = "spOSPlatform";
   public static final String TRACE_FILE_FORMAT_META_NAME = "spTraceFileFormat";
+  public static final String ROLE_NAME_META_NAME = "RoleName";
 }
diff --git a/agent/agent-profiler/agent-service-profiler/src/main/java/com/microsoft/applicationinsights/serviceprofilerapi/upload/ServiceProfilerUploader.java b/agent/agent-profiler/agent-service-profiler/src/main/java/com/microsoft/applicationinsights/serviceprofilerapi/upload/ServiceProfilerUploader.java
@@ -20,23 +20,6 @@
  */
 package com.microsoft.applicationinsights.serviceprofilerapi.upload;
 
-import java.io.File;
-import java.io.FileOutputStream;
-import java.io.IOException;
-import java.io.OutputStream;
-import java.net.MalformedURLException;
-import java.net.URISyntaxException;
-import java.net.URL;
-import java.nio.file.Files;
-import java.nio.file.Path;
-import java.util.Base64;
-import java.util.Comparator;
-import java.util.HashMap;
-import java.util.Random;
-import java.util.UUID;
-import java.util.function.Supplier;
-import java.util.zip.GZIPOutputStream;
-
 import com.azure.core.http.rest.Response;
 import com.azure.storage.blob.BlobAsyncClient;
 import com.azure.storage.blob.BlobContainerAsyncClient;
@@ -61,6 +44,23 @@
 import org.slf4j.LoggerFactory;
 import reactor.core.publisher.Mono;
 
+import java.io.File;
+import java.io.FileOutputStream;
+import java.io.IOException;
+import java.io.OutputStream;
+import java.net.MalformedURLException;
+import java.net.URISyntaxException;
+import java.net.URL;
+import java.nio.file.Files;
+import java.nio.file.Path;
+import java.util.Base64;
+import java.util.Comparator;
+import java.util.HashMap;
+import java.util.Random;
+import java.util.UUID;
+import java.util.function.Supplier;
+import java.util.zip.GZIPOutputStream;
+
 /**
  * Uploads profiles to the service profiler endpoint
  */
@@ -73,16 +73,19 @@ public class ServiceProfilerUploader {
     private final String machineName;
     private final Supplier<String> appIdSupplier;
     private final String processId;
+    private final String roleName;
 
     public ServiceProfilerUploader(
             ServiceProfilerClientV2 serviceProfilerClient,
             String machineName,
             String processId,
-            Supplier<String> appIdSupplier) {
+            Supplier<String> appIdSupplier,
+            String roleName) {
         this.appIdSupplier = appIdSupplier;
         this.machineName = machineName;
         this.serviceProfilerClient = serviceProfilerClient;
         this.processId = processId;
+        this.roleName = roleName;
     }
 
     /**
@@ -232,15 +235,19 @@ protected UploadFinishArgs reportUploadComplete(UUID profileId, Response<BlockBl
         }
     }
 
-    private BlobUploadFromFileOptions createBlockBlobOptions(File file, UploadContext uploadContext) {
+    BlobUploadFromFileOptions createBlockBlobOptions(File file, UploadContext uploadContext) {
         HashMap<String, String> metadata = new HashMap<>();
 
         metadata.put(BlobMetadataConstants.DATA_CUBE_META_NAME, uploadContext.getDataCube().toString().toLowerCase());
         metadata.put(BlobMetadataConstants.MACHINE_NAME_META_NAME, uploadContext.getMachineName());
         metadata.put(BlobMetadataConstants.START_TIME_META_NAME, TimestampContract.timestampToString(uploadContext.getSessionId()));
         metadata.put(BlobMetadataConstants.PROGRAMMING_LANGUAGE_META_NAME, "Java");
         metadata.put(BlobMetadataConstants.OS_PLATFORM_META_NAME, OsPlatformProvider.getOSPlatformDescription());
-        metadata.put(BlobMetadataConstants.TRACE_FILE_FORMAT_META_NAME, "Netperf");
+        metadata.put(BlobMetadataConstants.TRACE_FILE_FORMAT_META_NAME, "jfr");
+
+        if (roleName != null && !roleName.isEmpty()) {
+            metadata.put(BlobMetadataConstants.ROLE_NAME_META_NAME, roleName);
+        }
 
         String fullFilePath = file
                 .getAbsoluteFile()
diff --git a/agent/agent-profiler/agent-service-profiler/src/test/java/com/microsoft/applicationinsights/serviceprofilerapi/upload/ServiceProfilerUploaderTest.java b/agent/agent-profiler/agent-service-profiler/src/test/java/com/microsoft/applicationinsights/serviceprofilerapi/upload/ServiceProfilerUploaderTest.java
@@ -20,25 +20,28 @@
  */
 package com.microsoft.applicationinsights.serviceprofilerapi.upload;
 
-import java.io.File;
-import java.io.FileOutputStream;
-import java.io.IOException;
-import java.net.URISyntaxException;
-import java.nio.charset.UnsupportedCharsetException;
-import java.util.Date;
-import java.util.UUID;
-import java.util.concurrent.atomic.AtomicBoolean;
-
+import com.azure.storage.blob.options.BlobUploadFromFileOptions;
 import com.microsoft.applicationinsights.profileUploader.ServiceProfilerIndex;
 import com.microsoft.applicationinsights.serviceprofilerapi.client.ClientClosedException;
 import com.microsoft.applicationinsights.serviceprofilerapi.client.ServiceProfilerClientV2;
 import com.microsoft.applicationinsights.serviceprofilerapi.client.contract.ArtifactAcceptedResponse;
 import com.microsoft.applicationinsights.serviceprofilerapi.client.contract.BlobAccessPass;
+import com.microsoft.applicationinsights.serviceprofilerapi.client.contract.BlobMetadataConstants;
 import com.microsoft.applicationinsights.serviceprofilerapi.client.uploader.UploadContext;
 import com.microsoft.applicationinsights.serviceprofilerapi.client.uploader.UploadFinishArgs;
-import org.junit.*;
+import org.junit.Assert;
+import org.junit.Test;
 import reactor.core.publisher.Mono;
 
+import java.io.File;
+import java.io.FileOutputStream;
+import java.io.IOException;
+import java.net.URISyntaxException;
+import java.nio.charset.UnsupportedCharsetException;
+import java.util.Date;
+import java.util.UUID;
+import java.util.concurrent.atomic.AtomicBoolean;
+
 public class ServiceProfilerUploaderTest {
     @Test
     public void uploadFileGoodPathReturnsExpectedResponse() throws IOException {
@@ -52,7 +55,8 @@ public void uploadFileGoodPathReturnsExpectedResponse() throws IOException {
                 serviceProfilerClient,
                 "a-machine-name",
                 "a-process-id",
-                appId::toString
+                appId::toString,
+                "a-role-name"
         ) {
             @Override
             protected Mono<UploadFinishArgs> performUpload(UploadContext uploadContext, BlobAccessPass uploadPass, File file) {
@@ -80,10 +84,47 @@ protected Mono<UploadFinishArgs> performUpload(UploadContext uploadContext, Blob
 
                             Assert.assertEquals(appId.toString(),
                                     result.getServiceProfilerIndex().getProperties().get(ServiceProfilerIndex.SERVICE_PROFILER_DATACUBE_PROPERTY_NAME));
-
                         });
     }
 
+    @Test
+    public void roleNameIsCorrectlyAddedToMetaData() throws IOException {
+
+        ServiceProfilerClientV2 serviceProfilerClient = stubServiceProfilerClient();
+
+        File tmpFile = createFakeJfrFile();
+        UUID appId = UUID.randomUUID();
+
+        BlobUploadFromFileOptions blobOptions = new ServiceProfilerUploader(
+                serviceProfilerClient,
+                "a-machine-name",
+                "a-process-id",
+                appId::toString,
+                "a-role-name"
+        ).createBlockBlobOptions(
+                tmpFile,
+                new UploadContext("a-machine-name", UUID.randomUUID(), 1, tmpFile, UUID.randomUUID())
+        );
+
+        // Role name is set correctly
+        Assert.assertEquals("a-role-name", blobOptions.getMetadata().get(BlobMetadataConstants.ROLE_NAME_META_NAME));
+
+
+        blobOptions = new ServiceProfilerUploader(
+                serviceProfilerClient,
+                "a-machine-name",
+                "a-process-id",
+                appId::toString,
+                null
+        ).createBlockBlobOptions(
+                tmpFile,
+                new UploadContext("a-machine-name", UUID.randomUUID(), 1, tmpFile, UUID.randomUUID())
+        );
+
+        // Null role name tag is not added
+        Assert.assertNull(blobOptions.getMetadata().get(BlobMetadataConstants.ROLE_NAME_META_NAME));
+
+    }
 
     @Test
     public void uploadWithoutAFileThrows() {
@@ -92,7 +133,7 @@ public void uploadWithoutAFileThrows() {
 
         UUID appId = UUID.randomUUID();
 
-        ServiceProfilerUploader serviceProfilerUploader = new ServiceProfilerUploader(serviceProfilerClient, "a-machine-name", "a-process-id", appId::toString);
+        ServiceProfilerUploader serviceProfilerUploader = new ServiceProfilerUploader(serviceProfilerClient, "a-machine-name", "a-process-id", appId::toString, "a-role-name");
 
         AtomicBoolean threw = new AtomicBoolean(false);
         serviceProfilerUploader
@@ -121,15 +162,18 @@ private File createFakeJfrFile() throws IOException {
     public static ServiceProfilerClientV2 stubServiceProfilerClient() {
         return new ServiceProfilerClientV2() {
 
-            @Override public BlobAccessPass getUploadAccess(UUID profileId) {
+            @Override
+            public BlobAccessPass getUploadAccess(UUID profileId) {
                 return new BlobAccessPass("https://localhost:99999/a-blob-uri", null, "a-sas-token");
             }
 
-            @Override public ArtifactAcceptedResponse reportUploadFinish(UUID profileId, String etag) throws URISyntaxException, UnsupportedCharsetException, ClientClosedException {
+            @Override
+            public ArtifactAcceptedResponse reportUploadFinish(UUID profileId, String etag) throws URISyntaxException, UnsupportedCharsetException, ClientClosedException {
                 return null;
             }
 
-            @Override public String getSettings(Date oldTimeStamp) {
+            @Override
+            public String getSettings(Date oldTimeStamp) {
                 return null;
             }
         };
diff --git a/agent/agent-tooling/src/main/java/com/microsoft/applicationinsights/agent/internal/AiComponentInstaller.java b/agent/agent-tooling/src/main/java/com/microsoft/applicationinsights/agent/internal/AiComponentInstaller.java
@@ -170,6 +170,7 @@ private static void start(Instrumentation instrumentation) {
                 SystemInformation.INSTANCE.getProcessId(),
                 formServiceProfilerConfig(config.preview.profiler),
                 configuration.getRoleInstance(),
+                configuration.getRoleName(),
                 // TODO this will not work with Azure Spring Cloud updating connection string at runtime
                 configuration.getInstrumentationKey(),
                 telemetryClient,
diff --git a/core/src/main/java/com/microsoft/applicationinsights/internal/profiler/ProfilerServiceInitializer.java b/core/src/main/java/com/microsoft/applicationinsights/internal/profiler/ProfilerServiceInitializer.java
@@ -64,6 +64,7 @@ public synchronized static void initialize(Supplier<String> appIdSupplier,
                                                String processId,
                                                ServiceProfilerServiceConfig config,
                                                String machineName,
+                                               String roleName,
                                                String instrumentationKey,
                                                TelemetryClient client,
                                                String userAgent,
@@ -73,6 +74,7 @@ public synchronized static void initialize(Supplier<String> appIdSupplier,
                 processId,
                 config,
                 machineName,
+                roleName,
                 instrumentationKey,
                 client,
                 LazyHttpClient.getInstance(),
@@ -85,6 +87,7 @@ public synchronized static void initialize(Supplier<String> appIdSupplier,
                                                String processId,
                                                ServiceProfilerServiceConfig config,
                                                String machineName,
+                                               String roleName,
                                                String instrumentationKey,
                                                TelemetryClient client,
                                                CloseableHttpClient httpClient,
@@ -125,7 +128,8 @@ public synchronized static void initialize(Supplier<String> appIdSupplier,
                     instrumentationKey,
                     httpClient,
                     serviceProfilerExecutorService,
-                    userAgent
+                    userAgent,
+                    roleName
             );
 
             serviceProfilerExecutorService.submit(() -> {
diff --git a/core/src/test/java/com/microsoft/applicationinsights/internal/profiler/ProfilerServiceTest.java b/core/src/test/java/com/microsoft/applicationinsights/internal/profiler/ProfilerServiceTest.java
@@ -231,7 +231,8 @@ private ServiceProfilerUploader getServiceProfilerJFRUpload(ServiceProfilerClien
                 clientV2,
                 machineName,
                 processId,
-                appIdSupplier
+                appIdSupplier,
+                "a-role-name"
         ) {
             @Override
             protected Mono<UploadFinishArgs> performUpload(UploadContext uploadContext, BlobAccessPass uploadPass, File file) {

Original file line number	Diff line number	Diff line change
`@@ -20,6 +20,7 @@ Future<ProfilerService> initialize(`
`20`	`20`	`String instrumentationKey,`
`21`	`21`	`CloseableHttpClient httpClient,`
`22`	`22`	`ScheduledExecutorService serviceProfilerExecutorService,`
`23`		`- String userAgent`
	`23`	`+ String userAgent,`
	`24`	`+ String roleName`
`24`	`25`	`);`
`25`	`26`	`}`
Original file line number	Diff line number	Diff line change
`@@ -34,4 +34,5 @@ public class BlobMetadataConstants {`
`34`	`34`	`public static final String PROGRAMMING_LANGUAGE_META_NAME = "spProgrammingLanguage";`
`35`	`35`	`public static final String OS_PLATFORM_META_NAME = "spOSPlatform";`
`36`	`36`	`public static final String TRACE_FILE_FORMAT_META_NAME = "spTraceFileFormat";`
	`37`	`+ public static final String ROLE_NAME_META_NAME = "RoleName";`
`37`	`38`	`}`