[Monitor Exporter] Replace instrumentationKey with connectionString in builder (Azure#17179)

* Replace instrumentationKey with connectionString in builder

Author: srnagar

sdk/monitor/microsoft-opentelemetry-exporter-azuremonitor/CHANGELOG.md

@@ -1,7 +1,10 @@
 # Release History
 
-## 1.0.0-beta.2 (Unreleased)
-
+## 1.0.0-beta.2 (2020-11-10)
+### Breaking changes
+- Moved this package to `com.microsoft` Maven group.
+- Renamed artifact to `microsoft-opentelemetry-exporter-azuremonitor`.
+- Replaced `instrumentationKey()` with `connectionString()` in the `AzureMonitorExporterBuilder`.
 
 ## 1.0.0-beta.1 (2020-10-06)
 

sdk/monitor/microsoft-opentelemetry-exporter-azuremonitor/README.md

@@ -23,7 +23,7 @@ For more information, please read [introduction to Application Insights][applica
 <dependency>
   <groupId>com.microsoft</groupId>
   <artifactId>microsoft-opentelemetry-exporter-azuremonitor</artifactId>
-  <version>1.0.0-beta.1</version>
+  <version>1.0.0-beta.2</version>
 </dependency>
 ```
 [//]: # ({x-version-update-end})
@@ -41,7 +41,7 @@ right corner.
 <!-- embedme ./src/samples/java/com/microsoft/opentelemetry/exporter/azuremonitor/ReadmeSamples.java#L26-L28 -->
 ```java
 AzureMonitorExporter azureMonitorExporter = new AzureMonitorExporterBuilder()
-    .instrumentationKey("{instrumentation-key}")
+    .connectionString("{connection-string}")
     .buildExporter();
 ```
 
@@ -53,7 +53,7 @@ The following example shows how to export a collection of available [Spans][span
 <!-- embedme ./src/samples/java/com/microsoft/opentelemetry/exporter/azuremonitor/ReadmeSamples.java#L35-L40 -->
 ```java
 AzureMonitorExporter azureMonitorExporter = new AzureMonitorExporterBuilder()
-    .instrumentationKey("{instrumentation-key}")
+    .connectionString("{connection-string}")
     .buildExporter();
 
 CompletableResultCode resultCode = azureMonitorExporter.export(getSpanDataCollection());

sdk/monitor/microsoft-opentelemetry-exporter-azuremonitor/pom.xml

@@ -112,4 +112,27 @@
       </plugin>
     </plugins>
   </build>
+
+  <profiles>
+    <profile>
+      <id>java-lts</id>
+      <activation>
+        <jdk>[11,)</jdk>
+      </activation>
+      <build>
+        <plugins>
+          <plugin>
+            <groupId>org.apache.maven.plugins</groupId>
+            <artifactId>maven-surefire-plugin</artifactId>
+            <version>3.0.0-M3</version> <!-- {x-version-update;org.apache.maven.plugins:maven-surefire-plugin;external_dependency} -->
+            <configuration>
+              <argLine>
+                --add-opens com.microsoft.opentelemetry.exporter.azuremonitor/com.microsoft.opentelemetry.exporter.azuremonitor=ALL-UNNAMED
+              </argLine>
+            </configuration>
+          </plugin>
+        </plugins>
+      </build>
+    </profile>
+  </profiles>
 </project>

sdk/monitor/microsoft-opentelemetry-exporter-azuremonitor/src/main/java/com/microsoft/opentelemetry/exporter/azuremonitor/AzureMonitorExporterBuilder.java

@@ -20,6 +20,8 @@
 
 import java.net.MalformedURLException;
 import java.net.URL;
+import java.util.HashMap;
+import java.util.Map;
 import java.util.Objects;
 
 /**
@@ -45,12 +47,12 @@ public AzureMonitorExporterBuilder() {
      * @throws NullPointerException if {@code endpoint} is null.
      * @throws IllegalArgumentException if {@code endpoint} cannot be parsed into a valid URL.
      */
-    public AzureMonitorExporterBuilder endpoint(String endpoint) {
+    AzureMonitorExporterBuilder endpoint(String endpoint) {
         Objects.requireNonNull(endpoint, "'endpoint' cannot be null.");
 
         try {
             URL url = new URL(endpoint);
-            restServiceClientBuilder.host(url.getHost());
+            restServiceClientBuilder.host(url.getProtocol() + "://" + url.getHost());
         } catch (MalformedURLException ex) {
             throw logger.logExceptionAsWarning(
                 new IllegalArgumentException("'endpoint' must be a valid URL.", ex));
@@ -134,15 +136,39 @@ public AzureMonitorExporterBuilder configuration(Configuration configuration) {
     }
 
     /**
-     * Sets the instrumentation key to use for exporting telemetry events to Azure Monitor.
-     * @param instrumentationKey The instrumentation key of the Azure Monitor resource.
+     * The connection string to use for exporting telemetry events to Azure Monitor.
+     * @param connectionString The connection string for the Azure Monitor resource.
      * @return The updated {@link AzureMonitorExporterBuilder} object.
+     * @throws NullPointerException If the connection string is {@code null}.
+     * @throws IllegalArgumentException If the connection string is invalid.
      */
-    public AzureMonitorExporterBuilder instrumentationKey(String instrumentationKey) {
-        this.instrumentationKey = instrumentationKey;
+    public AzureMonitorExporterBuilder connectionString(String connectionString) {
+        Map<String, String> keyValues = extractKeyValuesFromConnectionString(connectionString);
+        if (!keyValues.containsKey("InstrumentationKey")) {
+            throw logger.logExceptionAsError(
+                new IllegalArgumentException("InstrumentationKey not found in connectionString"));
+        }
+        this.instrumentationKey = keyValues.get("InstrumentationKey");
+        String endpoint = keyValues.get("IngestionEndpoint");
+        if (endpoint != null) {
+            this.endpoint(endpoint);
+        }
         return this;
     }
 
+    private Map<String, String> extractKeyValuesFromConnectionString(String connectionString) {
+        Objects.requireNonNull(connectionString);
+        Map<String, String> keyValues = new HashMap<>();
+        String[] splits = connectionString.split(";");
+        for (String split : splits) {
+            String[] keyValPair = split.split("=");
+            if (keyValPair.length == 2) {
+                keyValues.put(keyValPair[0], keyValPair[1]);
+            }
+        }
+        return keyValues;
+    }
+
     /**
      * Creates a {@link MonitorExporterClient} based on options set in the builder. Every time {@code
      * buildAsyncClient()} is called a new instance of {@link MonitorExporterClient} is created.
@@ -190,7 +216,9 @@ MonitorExporterAsyncClient buildAsyncClient() {
      * @throws NullPointerException if the instrumentation key is not set.
      */
     public AzureMonitorExporter buildExporter() {
-        Objects.requireNonNull(instrumentationKey, "'instrumentationKey' cannot be null");
+        // instrumentationKey is extracted from connectionString, so, if instrumentationKey is null
+        // then the error message should read "connectionString cannot be null".
+        Objects.requireNonNull(instrumentationKey, "'connectionString' cannot be null");
         return new AzureMonitorExporter(buildClient(), instrumentationKey);
     }
 

sdk/monitor/microsoft-opentelemetry-exporter-azuremonitor/src/samples/java/com/microsoft/opentelemetry/exporter/azuremonitor/AzureMonitorExporterSample.java

@@ -19,7 +19,7 @@ public class AzureMonitorExporterSample {
      */
     public static void main(String[] args) {
         AzureMonitorExporter azureMonitorExporter = new AzureMonitorExporterBuilder()
-            .instrumentationKey("{instrumentation-key}")
+            .connectionString("{connection-string}")
             .buildExporter();
         CompletableResultCode resultCode =
             azureMonitorExporter.export(Collections.singleton(new AzureMonitorExporterTest.RequestSpanData()));

sdk/monitor/microsoft-opentelemetry-exporter-azuremonitor/src/samples/java/com/microsoft/opentelemetry/exporter/azuremonitor/ReadmeSamples.java

@@ -24,7 +24,7 @@ public class ReadmeSamples {
      */
     public void createExporter() {
         AzureMonitorExporter azureMonitorExporter = new AzureMonitorExporterBuilder()
-            .instrumentationKey("{instrumentation-key}")
+            .connectionString("{connection-string}")
             .buildExporter();
     }
 
@@ -33,7 +33,7 @@ public void createExporter() {
      */
     public void exportSpanData() {
         AzureMonitorExporter azureMonitorExporter = new AzureMonitorExporterBuilder()
-            .instrumentationKey("{instrumentation-key}")
+            .connectionString("{connection-string}")
             .buildExporter();
 
         CompletableResultCode resultCode = azureMonitorExporter.export(getSpanDataCollection());

sdk/monitor/microsoft-opentelemetry-exporter-azuremonitor/src/test/java/com/microsoft/opentelemetry/exporter/azuremonitor/AzureMonitorExporterBuilderTest.java

@@ -0,0 +1,39 @@
+// Copyright (c) Microsoft Corporation. All rights reserved.
+// Licensed under the MIT License.
+
+package com.microsoft.opentelemetry.exporter.azuremonitor;
+
+import org.junit.jupiter.api.Assertions;
+import org.junit.jupiter.params.ParameterizedTest;
+import org.junit.jupiter.params.provider.Arguments;
+import org.junit.jupiter.params.provider.MethodSource;
+
+import java.util.stream.Stream;
+
+/**
+ * Unit tests for {@link AzureMonitorExporterBuilder}.
+ */
+public class AzureMonitorExporterBuilderTest {
+
+    @ParameterizedTest
+    @MethodSource("getInvalidConnectionStrings")
+    public <T extends RuntimeException> void testInvalidConnectionStrings(String connectionString,
+                                                                          Class<T> exceptionExpected) {
+        Assertions.assertThrows(exceptionExpected, () -> new AzureMonitorExporterBuilder()
+            .connectionString(connectionString)
+            .buildExporter());
+
+    }
+
+    private static Stream<Arguments> getInvalidConnectionStrings() {
+        return Stream.of(
+            Arguments.of(null, NullPointerException.class),
+            Arguments.of("", IllegalArgumentException.class),
+            Arguments.of("InstrumentationKey=;IngestionEndpoint=url", IllegalArgumentException.class),
+            Arguments.of("Instrumentation=iKey;IngestionEndpoint=url", IllegalArgumentException.class),
+            Arguments.of("InstrumentationKey;IngestionEndpoint=url", IllegalArgumentException.class),
+            Arguments.of("InstrumentationKey;IngestionEndpoint=url", IllegalArgumentException.class),
+            Arguments.of("IngestionEndpoint=url", IllegalArgumentException.class)
+        );
+    }
+}

sdk/monitor/microsoft-opentelemetry-exporter-azuremonitor/src/test/java/com/microsoft/opentelemetry/exporter/azuremonitor/AzureMonitorExporterTest.java

@@ -34,7 +34,7 @@ public class AzureMonitorExporterTest extends MonitorExporterClientTestBase {
     @Test
     public void testExportRequestData() {
         AzureMonitorExporter azureMonitorExporter = getClientBuilder()
-            .instrumentationKey("{instrumentation-key}")
+            .connectionString("InstrumentationKey=ikey;IngestionEndpoint=https://testendpoint.com")
             .buildExporter();
         CompletableResultCode export = azureMonitorExporter.export(Collections.singleton(new RequestSpanData()));
         Assertions.assertTrue(export.isDone());