[RP Integration] Stop sending requests to all endpoints when ikey is empty (#2061)

* Turn off breeze profiler api when ikey is empty

* Stop sending persisted file when ikey is empty

* Turn off live metric when ikey is empty

* Stop sending perfcounters when ikey is empty

* Add nullable to input parameter

* Reset url endpoints for ingestion, livemetric and profiler

* Fix spotless

* Add a comment

* Refactor

* Set null

* Change to private

* Add unit test

* Fix spotless

* Test one more code path

* Revert spotless on samplingOverrides

* Fix tests

* Fix spotless

Author: heyams

agent/agent-tooling/src/main/java/com/microsoft/applicationinsights/agent/internal/init/RpConfigurationPolling.java

@@ -23,6 +23,7 @@
 
 import static java.util.concurrent.TimeUnit.SECONDS;
 
+import com.microsoft.applicationinsights.agent.internal.common.Strings;
 import com.microsoft.applicationinsights.agent.internal.common.ThreadPoolUtils;
 import com.microsoft.applicationinsights.agent.internal.configuration.Configuration;
 import com.microsoft.applicationinsights.agent.internal.configuration.ConfigurationBuilder;
@@ -101,7 +102,9 @@ public void run() {
           logger.debug(
               "Connection string from the JSON config file is overriding the previously configured connection string.");
           telemetryClient.setConnectionString(newRpConfiguration.connectionString);
-          appIdSupplier.startAppIdRetrieval();
+          if (!Strings.isNullOrEmpty(newRpConfiguration.connectionString)) {
+            appIdSupplier.startAppIdRetrieval();
+          }
         }
 
         if (newRpConfiguration.sampling.percentage != rpConfiguration.sampling.percentage) {

agent/agent-tooling/src/main/java/com/microsoft/applicationinsights/agent/internal/localstorage/LocalFileSender.java

@@ -21,8 +21,10 @@
 
 package com.microsoft.applicationinsights.agent.internal.localstorage;
 
+import com.microsoft.applicationinsights.agent.internal.common.Strings;
 import com.microsoft.applicationinsights.agent.internal.common.ThreadPoolUtils;
 import com.microsoft.applicationinsights.agent.internal.telemetry.TelemetryChannel;
+import com.microsoft.applicationinsights.agent.internal.telemetry.TelemetryClient;
 import io.opentelemetry.sdk.common.CompletableResultCode;
 import java.util.concurrent.Executors;
 import java.util.concurrent.ScheduledExecutorService;
@@ -58,6 +60,10 @@ private LocalFileSender(LocalFileLoader localFileLoader, TelemetryChannel teleme
   public void run() {
     // TODO (heya) load all persisted files on disk in one or more batch per batch capacity?
     try {
+      if (Strings.isNullOrEmpty(TelemetryClient.getActive().getInstrumentationKey())) {
+        return;
+      }
+
       LocalFileLoader.PersistedFile persistedFile = localFileLoader.loadTelemetriesFromDisk();
       if (persistedFile != null) {
         CompletableResultCode resultCode =

agent/agent-tooling/src/main/java/com/microsoft/applicationinsights/agent/internal/quickpulse/QuickPulsePingSender.java

@@ -91,7 +91,7 @@ public QuickPulsePingSender(
 
   public QuickPulseHeaderInfo ping(String redirectedEndpoint) {
     String instrumentationKey = getInstrumentationKey();
-    if (instrumentationKey == null && "java".equals(System.getenv("FUNCTIONS_WORKER_RUNTIME"))) {
+    if (Strings.isNullOrEmpty(instrumentationKey)) {
       // Quick Pulse Ping uri will be null when the instrumentation key is null. When that happens,
       // turn off quick pulse.
       return new QuickPulseHeaderInfo(QuickPulseStatus.QP_IS_OFF);

agent/agent-tooling/src/main/java/com/microsoft/applicationinsights/agent/internal/telemetry/ConnectionString.java

@@ -39,9 +39,16 @@ public class ConnectionString {
 
   private ConnectionString() {}
 
-  public static void parseInto(String connectionString, TelemetryClient targetConfig)
-      throws InvalidConnectionStringException {
-    mapToConnectionConfiguration(getKeyValuePairs(connectionString), targetConfig);
+  public static void parseInto(String connectionString, TelemetryClient telemetryClient)
+      throws InvalidConnectionStringException, MalformedURLException {
+    // reset endpoint to default for ingestion, live metric and profiler
+    telemetryClient.getEndpointProvider().resetEndpointUrls();
+
+    if (Strings.isNullOrEmpty(connectionString)) {
+      telemetryClient.setInstrumentationKey(null);
+    } else {
+      mapToConnectionConfiguration(getKeyValuePairs(connectionString), telemetryClient);
+    }
   }
 
   public static void updateStatsbeatConnectionString(

agent/agent-tooling/src/main/java/com/microsoft/applicationinsights/agent/internal/telemetry/EndpointProvider.java

@@ -45,10 +45,7 @@ public class EndpointProvider {
 
   public EndpointProvider() {
     try {
-      ingestionEndpoint = new URL(DefaultEndpoints.INGESTION_ENDPOINT);
-      ingestionEndpointUrl = buildIngestionUrl(ingestionEndpoint);
-      liveEndpointUrl = buildLiveUri(new URL(DefaultEndpoints.LIVE_ENDPOINT));
-      profilerEndpoint = new URL(DefaultEndpoints.PROFILER_ENDPOINT);
+      resetEndpointUrls();
       snapshotEndpoint = new URL(DefaultEndpoints.SNAPSHOT_ENDPOINT);
       statsbeatEndpointUrl = buildIngestionUrl(ingestionEndpointUrl);
     } catch (MalformedURLException e) {
@@ -76,6 +73,14 @@ public URL getAppIdEndpointUrl(String instrumentationKey) {
     return buildAppIdUrl(instrumentationKey);
   }
 
+  // reset endpoint URLs for ingestion, live metric and profiler
+  public void resetEndpointUrls() throws MalformedURLException {
+    ingestionEndpoint = new URL(DefaultEndpoints.INGESTION_ENDPOINT);
+    ingestionEndpointUrl = buildIngestionUrl(ingestionEndpoint);
+    liveEndpointUrl = buildLiveUri(new URL(DefaultEndpoints.LIVE_ENDPOINT));
+    profilerEndpoint = new URL(DefaultEndpoints.PROFILER_ENDPOINT);
+  }
+
   private URL buildAppIdUrl(String instrumentationKey) {
     try {
       return buildUrl(

agent/agent-tooling/src/main/java/com/microsoft/applicationinsights/agent/internal/telemetry/TelemetryClient.java

@@ -49,6 +49,7 @@
 import io.opentelemetry.instrumentation.api.cache.Cache;
 import io.opentelemetry.sdk.common.CompletableResultCode;
 import java.io.File;
+import java.net.MalformedURLException;
 import java.util.ArrayList;
 import java.util.HashMap;
 import java.util.HashSet;
@@ -74,7 +75,7 @@ public class TelemetryClient {
 
   private final Set<String> nonFilterableMetricNames = new HashSet<>();
 
-  private volatile @MonotonicNonNull String instrumentationKey;
+  @Nullable private volatile String instrumentationKey;
   private volatile @MonotonicNonNull String roleName;
   private volatile @MonotonicNonNull String roleInstance;
   private volatile @MonotonicNonNull String statsbeatInstrumentationKey;
@@ -147,6 +148,10 @@ public static void setActive(TelemetryClient telemetryClient) {
   }
 
   public void trackAsync(TelemetryItem telemetry) {
+    if (Strings.isNullOrEmpty(instrumentationKey)) {
+      return;
+    }
+
     MonitorDomain data = telemetry.getData().getBaseData();
     if (data instanceof MetricsData) {
       MetricsData metricsData = (MetricsData) data;
@@ -305,13 +310,7 @@ public String getInstrumentationKey() {
   }
 
   /** Gets or sets the default instrumentation key for the application. */
-  public void setInstrumentationKey(String key) {
-
-    // A non null, non empty instrumentation key is a must
-    if (Strings.isNullOrEmpty(key)) {
-      throw new IllegalArgumentException("key");
-    }
-
+  public void setInstrumentationKey(@Nullable String key) {
     instrumentationKey = key;
   }
 
@@ -347,6 +346,8 @@ public void setConnectionString(String connectionString) {
       ConnectionString.parseInto(connectionString, this);
     } catch (InvalidConnectionStringException e) {
       throw new IllegalArgumentException("Invalid connection string", e);
+    } catch (MalformedURLException e) {
+      throw new IllegalStateException("Invalid endpoint urls.", e);
     }
   }
 

agent/agent-tooling/src/test/java/com/microsoft/applicationinsights/agent/internal/quickpulse/QuickPulseDataFetcherTests.java

@@ -80,14 +80,14 @@ void endpointChangesWithRedirectHeaderAndGetNewPingInterval() {
     headers.put("x-ms-qps-service-endpoint-redirect", "https://new.endpoint.com");
     headers.put("x-ms-qps-subscribed", "true");
     HttpHeaders httpHeaders = new HttpHeaders(headers);
+    TelemetryClient telemetryClient = TelemetryClient.createForTest();
+    telemetryClient.setInstrumentationKey("fake-key");
     HttpPipeline httpPipeline =
         new HttpPipelineBuilder()
             .httpClient(request -> Mono.just(new MockHttpResponse(request, 200, httpHeaders)))
             .build();
     QuickPulsePingSender quickPulsePingSender =
-        new QuickPulsePingSender(
-            httpPipeline, TelemetryClient.createForTest(), "machine1", "instance1", "qpid123");
-
+        new QuickPulsePingSender(httpPipeline, telemetryClient, "machine1", "instance1", "qpid123");
     QuickPulseHeaderInfo quickPulseHeaderInfo = quickPulsePingSender.ping(null);
     assertThat(QuickPulseStatus.QP_IS_ON).isEqualTo(quickPulseHeaderInfo.getQuickPulseStatus());
     assertThat(1000).isEqualTo(quickPulseHeaderInfo.getQpsServicePollingInterval());

agent/agent-tooling/src/test/java/com/microsoft/applicationinsights/agent/internal/quickpulse/QuickPulsePingSenderTests.java

@@ -78,13 +78,14 @@ void endpointChangesWithRedirectHeaderAndGetNewPingInterval() {
     headers.put("x-ms-qps-service-endpoint-redirect", "https://new.endpoint.com");
     headers.put("x-ms-qps-subscribed", "true");
     HttpHeaders httpHeaders = new HttpHeaders(headers);
+    TelemetryClient telemetryClient = TelemetryClient.createForTest();
+    telemetryClient.setInstrumentationKey("fake-ikey");
     HttpPipeline httpPipeline =
         new HttpPipelineBuilder()
             .httpClient(request -> Mono.just(new MockHttpResponse(request, 200, httpHeaders)))
             .build();
     QuickPulsePingSender quickPulsePingSender =
-        new QuickPulsePingSender(
-            httpPipeline, TelemetryClient.createForTest(), "machine1", "instance1", "qpid123");
+        new QuickPulsePingSender(httpPipeline, telemetryClient, "machine1", "instance1", "qpid123");
     QuickPulseHeaderInfo quickPulseHeaderInfo = quickPulsePingSender.ping(null);
     assertThat(QuickPulseStatus.QP_IS_ON).isEqualTo(quickPulseHeaderInfo.getQuickPulseStatus());
     assertThat(1000).isEqualTo(quickPulseHeaderInfo.getQpsServicePollingInterval());

agent/agent-tooling/src/test/java/com/microsoft/applicationinsights/agent/internal/telemetry/ConnectionStringParsingTests.java

@@ -457,12 +457,6 @@ void emptyIkeyValueIsInvalid() {
         .isInstanceOf(InvalidConnectionStringException.class);
   }
 
-  @Test
-  void emptyStringIsInvalid() {
-    assertThatThrownBy(() -> ConnectionString.parseInto("", telemetryClient))
-        .isInstanceOf(InvalidConnectionStringException.class);
-  }
-
   @Test
   void nonKeyValueStringIsInvalid() {
     assertThatThrownBy(
@@ -500,4 +494,42 @@ void giantValuesAreNotAllowed() {
         .isInstanceOf(InvalidConnectionStringException.class)
         .hasMessageContaining(Integer.toString(ConnectionString.CONNECTION_STRING_MAX_LENGTH));
   }
+
+  @Test
+  void resetEndpointUrlTest() throws MalformedURLException, InvalidConnectionStringException {
+    String fakeConnectionString =
+        "InstrumentationKey=fake-key;IngestionEndpoint=https://ingestion.example.com/;LiveEndpoint=https://live.example.com/";
+    ConnectionString.parseInto(fakeConnectionString, telemetryClient);
+
+    assertThat(telemetryClient.getEndpointProvider().getIngestionEndpointUrl().toString())
+        .isEqualTo("https://ingestion.example.com/v2.1/track");
+    assertThat(telemetryClient.getEndpointProvider().getLiveEndpointUrl().toString())
+        .isEqualTo("https://live.example.com/QuickPulseService.svc");
+
+    String emptyConnectionString = "";
+    ConnectionString.parseInto(emptyConnectionString, telemetryClient);
+
+    assertThat(telemetryClient.getEndpointProvider().getIngestionEndpointUrl().toString())
+        .isEqualTo("https://dc.services.visualstudio.com/v2.1/track");
+    assertThat(telemetryClient.getEndpointProvider().getLiveEndpointUrl().toString())
+        .isEqualTo("https://rt.services.visualstudio.com/QuickPulseService.svc");
+
+    String newFakeConnectionString =
+        "InstrumentationKey=new-fake-key;IngestionEndpoint=https://new-ingestion.example.com/;LiveEndpoint=https://new-live.example.com/";
+    ConnectionString.parseInto(newFakeConnectionString, telemetryClient);
+
+    assertThat(telemetryClient.getEndpointProvider().getIngestionEndpointUrl().toString())
+        .isEqualTo("https://new-ingestion.example.com/v2.1/track");
+    assertThat(telemetryClient.getEndpointProvider().getLiveEndpointUrl().toString())
+        .isEqualTo("https://new-live.example.com/QuickPulseService.svc");
+
+    String newerFakeConnectionString =
+        "InstrumentationKey=newer-fake-key;IngestionEndpoint=https://newer-ingestion.example.com/;LiveEndpoint=https://newer-live.example.com/";
+    ConnectionString.parseInto(newerFakeConnectionString, telemetryClient);
+
+    assertThat(telemetryClient.getEndpointProvider().getIngestionEndpointUrl().toString())
+        .isEqualTo("https://newer-ingestion.example.com/v2.1/track");
+    assertThat(telemetryClient.getEndpointProvider().getLiveEndpointUrl().toString())
+        .isEqualTo("https://newer-live.example.com/QuickPulseService.svc");
+  }
 }