Fix redirection logic for calls to quickpulse (Azure#44211)

* fix

* fix style

* using url syntax instead of substring

* pr comments

Author: harsimar

sdk/monitor/azure-monitor-opentelemetry-autoconfigure/src/main/java/com/azure/monitor/opentelemetry/autoconfigure/implementation/quickpulse/QuickPulse.java

@@ -4,6 +4,8 @@
 package com.azure.monitor.opentelemetry.autoconfigure.implementation.quickpulse;
 
 import com.azure.core.http.HttpPipeline;
+import com.azure.core.util.logging.ClientLogger;
+import com.azure.core.util.logging.LogLevel;
 import com.azure.monitor.opentelemetry.autoconfigure.implementation.models.TelemetryItem;
 import com.azure.monitor.opentelemetry.autoconfigure.implementation.quickpulse.filtering.FilteringConfiguration;
 import com.azure.monitor.opentelemetry.autoconfigure.implementation.quickpulse.swagger.LiveMetricsRestAPIsForClientSDKs;
@@ -28,6 +30,8 @@ public class QuickPulse {
 
     private volatile QuickPulseDataCollector collector;
 
+    private static final ClientLogger LOGGER = new ClientLogger(QuickPulse.class);
+
     public static QuickPulse create(HttpPipeline httpPipeline, Supplier<URL> endpointUrl,
         Supplier<String> instrumentationKey, @Nullable String roleName, @Nullable String roleInstance,
         String sdkVersion) {
@@ -69,6 +73,11 @@ public void add(TelemetryItem telemetryItem) {
 
     private void initialize(HttpPipeline httpPipeline, Supplier<URL> endpointUrl, Supplier<String> instrumentationKey,
         @Nullable String roleName, @Nullable String roleInstance, String sdkVersion) {
+        if (LOGGER.canLogAtLevel(LogLevel.VERBOSE)) {
+            LOGGER.verbose(
+                "Initializing QuickPulse with instrumentation key: {} , URL {}, rolename {}, role instance {}, sdk version {}",
+                maskIkey(instrumentationKey.get()), endpointUrl.get().toString(), roleName, roleInstance, sdkVersion);
+        }
 
         String quickPulseId = UUID.randomUUID().toString().replace("-", "");
         ArrayBlockingQueue<MonitoringDataPoint> sendQueue = new ArrayBlockingQueue<>(256, true);
@@ -121,4 +130,8 @@ private void initialize(HttpPipeline httpPipeline, Supplier<URL> endpointUrl, Su
 
         this.collector = collector;
     }
+
+    private String maskIkey(String ikey) {
+        return "*" + ikey.substring(ikey.length() - 13);
+    }
 }

sdk/monitor/azure-monitor-opentelemetry-autoconfigure/src/main/java/com/azure/monitor/opentelemetry/autoconfigure/implementation/quickpulse/QuickPulseCoordinator.java

@@ -9,6 +9,8 @@
 import org.slf4j.MDC;
 import reactor.util.annotation.Nullable;
 
+import java.net.MalformedURLException;
+import java.net.URL;
 import java.util.concurrent.TimeUnit;
 
 import static com.azure.monitor.opentelemetry.autoconfigure.implementation.utils.AzureMonitorMsgId.QUICK_PULSE_PING_ERROR;
@@ -70,7 +72,6 @@ public void run() {
 
     @SuppressWarnings("try")
     private long sendData() {
-        dataSender.setRedirectEndpointPrefix(qpsServiceRedirectedEndpoint);
         dataFetcher.prepareQuickPulseDataForSend();
 
         QuickPulseStatus qpStatus = dataSender.getQuickPulseStatus();
@@ -152,7 +153,16 @@ private long ping() {
     private QuickPulseStatus handleReceivedPingHeaders(IsSubscribedHeaders pingHeaders) {
         String redirectLink = pingHeaders.getXMsQpsServiceEndpointRedirectV2();
         if (!Strings.isNullOrEmpty(redirectLink)) {
-            qpsServiceRedirectedEndpoint = redirectLink;
+            try {
+                URL redirectUrl = new URL(redirectLink);
+                // Taking the QuickPulseService.svc part out if present because the swagger will add that on.
+                qpsServiceRedirectedEndpoint = redirectUrl.getProtocol() + "://" + redirectUrl.getHost() + "/";
+                logger.verbose("Handling ping header to redirect to {}", qpsServiceRedirectedEndpoint);
+                dataSender.setRedirectEndpointPrefix(qpsServiceRedirectedEndpoint);
+            } catch (MalformedURLException e) {
+                logger.error("The service returned a malformed URL in the redirect header: {}. Exception message: {}",
+                    redirectLink, e.getMessage());
+            }
         }
 
         String pollingIntervalHeader = pingHeaders.getXMsQpsServicePollingIntervalHint();

sdk/monitor/azure-monitor-opentelemetry-autoconfigure/src/main/java/com/azure/monitor/opentelemetry/autoconfigure/implementation/quickpulse/QuickPulseDataSender.java

@@ -54,6 +54,8 @@ class QuickPulseDataSender implements Runnable {
         this.qpStatus = QuickPulseStatus.QP_IS_OFF;
         this.instrumentationKey = instrumentationKey;
         this.configuration = configuration;
+        logger.verbose("QuickPulseDataSender initialized with endpointUrl: {}, instrumentationKey: {}",
+            endpointUrl.get().toString(), instrumentationKey.get());
     }
 
     @Override
@@ -73,6 +75,7 @@ public void run() {
             }
 
             long sendTime = System.nanoTime();
+            // should not include "QuickPulseService.svc/"
             String endpointPrefix
                 = Strings.isNullOrEmpty(redirectEndpointPrefix) ? getQuickPulseEndpoint() : redirectEndpointPrefix;
             // TODO (harskaur): for a future PR revisit caching & retry mechanism for failed post requests (shouldn't retry), send "cached" data points in the next post
@@ -88,6 +91,8 @@ public void run() {
             }
 
             try {
+                // the swagger will add on the QuickPulseService.svc/ when creating the request.
+                logger.verbose("About to publish to quickpulse with the endpoint prefix: {}", endpointPrefix);
                 Response<CollectionConfigurationInfo> responseMono = liveMetricsRestAPIsForClientSDKs
                     .publishNoCustomHeadersWithResponseAsync(endpointPrefix, instrumentationKey.get(), etag,
                         transmissionTimeInTicks, dataPointList)
@@ -122,8 +127,7 @@ public void run() {
 
             } catch (RuntimeException e) { // this includes ServiceErrorException & RuntimeException thrown from quickpulse post api
                 onPostError(sendTime);
-                logger.error(
-                    "QuickPulseDataSender received a service error while attempting to send data to quickpulse {}",
+                logger.error("QuickPulseDataSender received an error while attempting to send data to quickpulse {}",
                     e.getMessage());
             }
 

sdk/monitor/azure-monitor-opentelemetry-autoconfigure/src/main/java/com/azure/monitor/opentelemetry/autoconfigure/implementation/quickpulse/QuickPulsePingSender.java

@@ -78,12 +78,15 @@ IsSubscribedHeaders ping(String redirectedEndpoint) {
 
         Date currentDate = new Date();
         long transmissionTimeInTicks = currentDate.getTime() * 10000 + TICKS_AT_EPOCH;
+        // should not include "QuickPulseService.svc/"
         String endpointPrefix
             = Strings.isNullOrEmpty(redirectedEndpoint) ? getQuickPulseEndpoint() : redirectedEndpoint;
+        logger.verbose("About to ping quickpulse with the endpoint prefix: {}", endpointPrefix);
 
         long sendTime = System.nanoTime();
 
         try {
+            // The swagger api appends QuickPulseService.svc/ when creating the request.
             Response<CollectionConfigurationInfo> responseMono
                 = liveMetricsRestAPIsForClientSDKs
                     .isSubscribedNoCustomHeadersWithResponseAsync(endpointPrefix, instrumentationKey,
@@ -118,9 +121,9 @@ IsSubscribedHeaders ping(String redirectedEndpoint) {
         } catch (RuntimeException e) {
             // 404 landed here
             Throwable t = e.getCause();
-            if (!NetworkFriendlyExceptions.logSpecialOneTimeFriendlyException(t, getQuickPulseEndpoint(),
+            if (!NetworkFriendlyExceptions.logSpecialOneTimeFriendlyException(t, endpointPrefix,
                 friendlyExceptionThrown, logger)) {
-                operationLogger.recordFailure(t.getMessage() + " (" + endpointPrefix + ")", t, QUICK_PULSE_PING_ERROR);
+                operationLogger.recordFailure(t.getMessage(), t, QUICK_PULSE_PING_ERROR);
             }
         }
         return onPingError(sendTime);