[Azure Monitor Exporter] Add support for aadAudience configuration using Connection String (Azure#27317)

### Packages impacted by this PR
@azure/monitor-opentelemetry-exporter

Author: hectorhdzg

sdk/monitor/monitor-opentelemetry-exporter/review/monitor-opentelemetry-exporter.api.md

@@ -38,6 +38,7 @@ export class ApplicationInsightsSampler implements Sampler {
 // @public
 export abstract class AzureMonitorBaseExporter {
     constructor(options?: AzureMonitorExporterOptions, isStatsbeatExporter?: boolean);
+    protected aadAudience: string | undefined;
     protected endpointUrl: string;
     protected instrumentationKey: string;
     protected trackStatsbeat: boolean;

sdk/monitor/monitor-opentelemetry-exporter/src/Declarations/Contracts/Constants.ts

@@ -14,6 +14,7 @@ export type ConnectionString = { [key in ConnectionStringKey]?: string };
  */
 export type ConnectionStringKey =
   | "authorization"
+  | "aadaudience"
   | "instrumentationkey"
   | "ingestionendpoint"
   | "liveendpoint"

sdk/monitor/monitor-opentelemetry-exporter/src/export/base.ts

@@ -26,6 +26,10 @@ export abstract class AzureMonitorBaseExporter {
    *Flag to determine if exporter will generate Statsbeat data
    */
   protected trackStatsbeat: boolean = false;
+  /**
+   * Instrumentation key to be used for exported envelopes
+   */
+  protected aadAudience: string | undefined;
   private isStatsbeatExporter: boolean;
 
   /**
@@ -49,6 +53,7 @@ export abstract class AzureMonitorBaseExporter {
       this.instrumentationKey =
         parsedConnectionString.instrumentationkey || this.instrumentationKey;
       this.endpointUrl = parsedConnectionString.ingestionendpoint?.trim() || this.endpointUrl;
+      this.aadAudience = parsedConnectionString.aadaudience;
     }
 
     // Instrumentation key is required

sdk/monitor/monitor-opentelemetry-exporter/src/export/log.ts

@@ -27,12 +27,13 @@ export class AzureMonitorLogExporter extends AzureMonitorBaseExporter implements
 
   constructor(options: AzureMonitorExporterOptions = {}) {
     super(options);
-    this._sender = new HttpSender(
-      this.endpointUrl,
-      this.instrumentationKey,
-      this.trackStatsbeat,
-      options
-    );
+    this._sender = new HttpSender({
+      endpointUrl: this.endpointUrl,
+      instrumentationKey: this.instrumentationKey,
+      trackStatsbeat: this.trackStatsbeat,
+      exporterOptions: options,
+      aadAudience: this.aadAudience,
+    });
     diag.debug("AzureMonitorLogExporter was successfully setup");
   }
 

sdk/monitor/monitor-opentelemetry-exporter/src/export/metric.ts

@@ -34,12 +34,13 @@ export class AzureMonitorMetricExporter
 
   constructor(options: AzureMonitorExporterOptions = {}) {
     super(options);
-    this._sender = new HttpSender(
-      this.endpointUrl,
-      this.instrumentationKey,
-      this.trackStatsbeat,
-      options
-    );
+    this._sender = new HttpSender({
+      endpointUrl: this.endpointUrl,
+      instrumentationKey: this.instrumentationKey,
+      trackStatsbeat: this.trackStatsbeat,
+      exporterOptions: options,
+      aadAudience: this.aadAudience,
+    });
     diag.debug("AzureMonitorMetricExporter was successfully setup");
   }
 

sdk/monitor/monitor-opentelemetry-exporter/src/export/statsbeat/statsbeatExporter.ts

@@ -28,12 +28,12 @@ export class AzureMonitorStatsbeatExporter
    */
   constructor(options: AzureMonitorExporterOptions) {
     super(options, true);
-    this._sender = new HttpSender(
-      this.endpointUrl,
-      this.instrumentationKey,
-      this.trackStatsbeat,
-      options
-    );
+    this._sender = new HttpSender({
+      endpointUrl: this.endpointUrl,
+      instrumentationKey: this.instrumentationKey,
+      trackStatsbeat: this.trackStatsbeat,
+      exporterOptions: options,
+    });
   }
 
   /**

sdk/monitor/monitor-opentelemetry-exporter/src/export/trace.ts

@@ -27,12 +27,13 @@ export class AzureMonitorTraceExporter extends AzureMonitorBaseExporter implemen
    */
   constructor(options: AzureMonitorExporterOptions = {}) {
     super(options);
-    this.sender = new HttpSender(
-      this.endpointUrl,
-      this.instrumentationKey,
-      this.trackStatsbeat,
-      options
-    );
+    this.sender = new HttpSender({
+      endpointUrl: this.endpointUrl,
+      instrumentationKey: this.instrumentationKey,
+      trackStatsbeat: this.trackStatsbeat,
+      exporterOptions: options,
+      aadAudience: this.aadAudience,
+    });
     diag.debug("AzureMonitorTraceExporter was successfully setup");
   }
 

sdk/monitor/monitor-opentelemetry-exporter/src/platform/nodejs/baseSender.ts

@@ -27,23 +27,24 @@ export abstract class BaseSender {
   private statsbeatFailureCount: number = 0;
   private batchSendRetryIntervalMs: number = DEFAULT_BATCH_SEND_RETRY_INTERVAL_MS;
 
-  constructor(
-    endpointUrl: string,
-    instrumentationKey: string,
-    trackStatsbeat: boolean,
-    options: AzureMonitorExporterOptions = {}
-  ) {
+  constructor(options: {
+    endpointUrl: string;
+    instrumentationKey: string;
+    trackStatsbeat: boolean;
+    exporterOptions: AzureMonitorExporterOptions;
+    aadAudience?: string;
+  }) {
     this.numConsecutiveRedirects = 0;
-    this.persister = new FileSystemPersist(instrumentationKey, options);
-    if (trackStatsbeat) {
+    this.persister = new FileSystemPersist(options.instrumentationKey, options.exporterOptions);
+    if (options.trackStatsbeat) {
       // Initialize statsbeatMetrics
       this.networkStatsbeatMetrics = new NetworkStatsbeatMetrics({
-        instrumentationKey: instrumentationKey,
-        endpointUrl: endpointUrl,
+        instrumentationKey: options.instrumentationKey,
+        endpointUrl: options.endpointUrl,
       });
       this.longIntervalStatsbeatMetrics = getInstance({
-        instrumentationKey: instrumentationKey,
-        endpointUrl: endpointUrl,
+        instrumentationKey: options.instrumentationKey,
+        endpointUrl: options.endpointUrl,
       });
     }
     this.retryTimer = null;

sdk/monitor/monitor-opentelemetry-exporter/src/platform/nodejs/httpSender.ts

@@ -24,22 +24,28 @@ export class HttpSender extends BaseSender {
   private readonly appInsightsClient: ApplicationInsightsClient;
   private appInsightsClientOptions: ApplicationInsightsClientOptionalParams;
 
-  constructor(
-    endpointUrl: string,
-    instrumentationKey: string,
-    trackStatsbeat: boolean,
-    options?: AzureMonitorExporterOptions
-  ) {
-    super(endpointUrl, instrumentationKey, trackStatsbeat, options);
+  constructor(options: {
+    endpointUrl: string;
+    instrumentationKey: string;
+    trackStatsbeat: boolean;
+    exporterOptions: AzureMonitorExporterOptions;
+    aadAudience?: string;
+  }) {
+    super(options);
     // Build endpoint using provided configuration or default values
     this.appInsightsClientOptions = {
-      host: endpointUrl,
-      ...options,
+      host: options.endpointUrl,
+      ...options.exporterOptions,
     };
 
     if (this.appInsightsClientOptions.credential) {
       // Add credentialScopes
-      this.appInsightsClientOptions.credentialScopes = [applicationInsightsResource];
+      if (options.aadAudience) {
+        this.appInsightsClientOptions.credentialScopes = [options.aadAudience];
+      } else {
+        // Default
+        this.appInsightsClientOptions.credentialScopes = [applicationInsightsResource];
+      }
     }
     this.appInsightsClient = new ApplicationInsightsClient(this.appInsightsClientOptions);
 

sdk/monitor/monitor-opentelemetry-exporter/test/internal/connectionStringParser.test.ts

@@ -12,14 +12,16 @@ describe("ConnectionStringParser", () => {
       const instrumentationKey = "instr_key";
       const ingestionEndpoint = "ingest";
       const liveEndpoint = "live";
-      const connectionString = `Authorization=${authorization};InstrumentationKey=${instrumentationKey};IngestionEndpoint=${ingestionEndpoint};LiveEndpoint=${liveEndpoint}`;
+      const aadAudience = "audience";
+      const connectionString = `Authorization=${authorization};InstrumentationKey=${instrumentationKey};IngestionEndpoint=${ingestionEndpoint};LiveEndpoint=${liveEndpoint};AadAudience=${aadAudience}`;
 
       const result = ConnectionStringParser.parse(connectionString);
 
-      assert.deepEqual(result.authorization, authorization);
-      assert.deepEqual(result.instrumentationkey, instrumentationKey);
-      assert.deepEqual(result.ingestionendpoint, ingestionEndpoint);
-      assert.deepEqual(result.liveendpoint, liveEndpoint);
+      assert.strictEqual(result.authorization, authorization);
+      assert.strictEqual(result.instrumentationkey, instrumentationKey);
+      assert.strictEqual(result.ingestionendpoint, ingestionEndpoint);
+      assert.strictEqual(result.liveendpoint, liveEndpoint);
+      assert.strictEqual(result.aadaudience, aadAudience);
     });
 
     it("should sanitize URLs", () => {
@@ -29,9 +31,9 @@ describe("ConnectionStringParser", () => {
       const connectionString = `InstrumentationKey=${instrumentationKey};IngestionEndpoint=${ingestionEndpoint};LiveEndpoint=${liveEndpoint}`;
 
       const result = ConnectionStringParser.parse(connectionString);
-      assert.deepEqual(result.instrumentationkey, instrumentationKey);
-      assert.deepEqual(result.ingestionendpoint, "https://test.com");
-      assert.deepEqual(result.liveendpoint, "https://livetest.net");
+      assert.strictEqual(result.instrumentationkey, instrumentationKey);
+      assert.strictEqual(result.ingestionendpoint, "https://test.com");
+      assert.strictEqual(result.liveendpoint, "https://livetest.net");
     });
 
     it("should ignore invalid fields", () => {
@@ -43,10 +45,10 @@ describe("ConnectionStringParser", () => {
 
       const result = ConnectionStringParser.parse(connectionString);
 
-      assert.deepEqual(result.authorization, undefined);
-      assert.deepEqual(result.instrumentationkey, undefined);
-      assert.deepEqual(result.ingestionendpoint, Constants.DEFAULT_BREEZE_ENDPOINT);
-      assert.deepEqual(result.liveendpoint, Constants.DEFAULT_LIVEMETRICS_ENDPOINT);
+      assert.strictEqual(result.authorization, undefined);
+      assert.strictEqual(result.instrumentationkey, undefined);
+      assert.strictEqual(result.ingestionendpoint, Constants.DEFAULT_BREEZE_ENDPOINT);
+      assert.strictEqual(result.liveendpoint, Constants.DEFAULT_LIVEMETRICS_ENDPOINT);
     });
 
     const runTest = (options: {
@@ -59,13 +61,13 @@ describe("ConnectionStringParser", () => {
       const result = ConnectionStringParser.parse(options.connectionString);
 
       if (options.expectedAuthorization) {
-        assert.deepEqual(result.authorization, options.expectedAuthorization);
+        assert.strictEqual(result.authorization, options.expectedAuthorization);
       }
       if (options.expectedInstrumentationKey) {
-        assert.deepEqual(result.instrumentationkey, options.expectedInstrumentationKey);
+        assert.strictEqual(result.instrumentationkey, options.expectedInstrumentationKey);
       }
-      assert.deepEqual(result.ingestionendpoint, options.expectedBreezeEndpoint);
-      assert.deepEqual(result.liveendpoint, options.expectedLiveMetricsEndpoint);
+      assert.strictEqual(result.ingestionendpoint, options.expectedBreezeEndpoint);
+      assert.strictEqual(result.liveendpoint, options.expectedLiveMetricsEndpoint);
     };
 
     it("should use correct default endpoints", () => {