Fix ai telemetry key override, #592. (#593)

* Add new configuration for telemetryProxy.
* Simplify the telemetry events.
* Add Unit test for telemetry.

Signed-off-by: Pan Li <panli@microsoft.com>

Author: Incarnation-p-lee

azure-spring-boot-starters/azure-spring-boot-starter/pom.xml

@@ -48,29 +48,4 @@
         </resources>
     </build>
 
-    <profiles>
-        <profile>
-            <id>dev</id>
-            <activation>
-                <property>
-                    <name>!release</name>
-                </property>
-                <activeByDefault>true</activeByDefault>
-            </activation>
-            <properties>
-                <ai.instrumentkey>fda156f5-2eb8-48ab-8a3c-3e06b3c64b49</ai.instrumentkey>
-            </properties>
-        </profile>
-        <profile>
-            <id>release</id>
-            <activation>
-                <property>
-                    <name>release</name>
-                </property>
-            </activation>
-            <properties>
-                <ai.instrumentkey>${telemetry.instrumentationKey}</ai.instrumentkey>
-            </properties>
-        </profile>
-    </profiles>
 </project>

azure-spring-boot-starters/azure-spring-boot-starter/src/main/resources/ApplicationInsights.xml

@@ -240,5 +240,4 @@
             <scope>test</scope>
         </dependency>
     </dependencies>
-
 </project>

azure-spring-boot/pom.xml

@@ -8,14 +8,13 @@
 
 import com.microsoft.azure.AzureEnvironment;
 import com.microsoft.azure.AzureResponseBuilder;
-import com.microsoft.azure.credentials.MSICredentials;
+import com.microsoft.azure.credentials.AppServiceMSICredentials;
 import com.microsoft.azure.keyvault.KeyVaultClient;
 import com.microsoft.azure.serializer.AzureJacksonAdapter;
 import com.microsoft.azure.spring.support.UserAgent;
-import com.microsoft.azure.telemetry.TelemetryData;
 import com.microsoft.azure.telemetry.TelemetryProxy;
+import com.microsoft.azure.utils.PropertyLoader;
 import com.microsoft.rest.RestClient;
-import com.microsoft.azure.credentials.AppServiceMSICredentials;
 import com.microsoft.rest.credentials.ServiceClientCredentials;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
@@ -27,9 +26,14 @@
 import org.springframework.util.Assert;
 import org.springframework.util.ClassUtils;
 
+import javax.annotation.PostConstruct;
 import java.util.HashMap;
+import java.util.Map;
 import java.util.Optional;
 
+import static com.microsoft.azure.telemetry.TelemetryData.SERVICE_NAME;
+import static com.microsoft.azure.telemetry.TelemetryData.getClassPackageSimpleName;
+
 class KeyVaultEnvironmentPostProcessorHelper {
     private static final Logger LOG = LoggerFactory.getLogger(KeyVaultEnvironmentPostProcessorHelper.class);
 
@@ -38,7 +42,8 @@ class KeyVaultEnvironmentPostProcessorHelper {
 
     public KeyVaultEnvironmentPostProcessorHelper(final ConfigurableEnvironment environment) {
         this.environment = environment;
-        this.telemetryProxy = new TelemetryProxy(this.allowTelemetry(environment));
+        // As auto-configuration not available when post processor, load it from file.
+        this.telemetryProxy = new TelemetryProxy(PropertyLoader.getTelemetryInstrumentationKey());
     }
 
     public void addKeyVaultPropertySource() {
@@ -58,8 +63,6 @@ public void addKeyVaultPropertySource() {
 
         final KeyVaultClient kvClient = new KeyVaultClient(restClient);
 
-        this.trackCustomEvent();
-
         try {
             final MutablePropertySources sources = this.environment.getPropertySources();
             final KeyVaultOperation kvOperation = new KeyVaultOperation(kvClient, vaultUri, refreshInterval);
@@ -136,11 +139,14 @@ private boolean allowTelemetry(final ConfigurableEnvironment env) {
         return env.getProperty(Constants.AZURE_KEYVAULT_ALLOW_TELEMETRY, Boolean.class, true);
     }
 
+    @PostConstruct
     private void trackCustomEvent() {
-        final HashMap<String, String> customTelemetryProperties = new HashMap<>();
-        customTelemetryProperties.put(TelemetryData.SERVICE_NAME, "keyvault");
+        if (allowTelemetry(environment)) {
+            final Map<String, String> events = new HashMap<>();
+
+            events.put(SERVICE_NAME, getClassPackageSimpleName(KeyVaultEnvironmentPostProcessorHelper.class));
 
-        final String className = ClassUtils.getUserClass(this.getClass()).getSimpleName();
-        this.telemetryProxy.trackEvent(className, customTelemetryProperties);
+            telemetryProxy.trackEvent(ClassUtils.getUserClass(getClass()).getSimpleName(), events);
+        }
     }
 }

azure-spring-boot/src/main/java/com/microsoft/azure/keyvault/spring/KeyVaultEnvironmentPostProcessorHelper.java

@@ -5,7 +5,6 @@
  */
 package com.microsoft.azure.spring.autoconfigure.aad;
 
-import com.microsoft.azure.telemetry.TelemetryData;
 import com.microsoft.azure.telemetry.TelemetryProxy;
 import com.nimbusds.jose.util.DefaultResourceRetriever;
 import com.nimbusds.jose.util.ResourceRetriever;
@@ -22,7 +21,12 @@
 import org.springframework.context.annotation.Scope;
 import org.springframework.util.ClassUtils;
 
+import javax.annotation.PostConstruct;
 import java.util.HashMap;
+import java.util.Map;
+
+import static com.microsoft.azure.telemetry.TelemetryData.SERVICE_NAME;
+import static com.microsoft.azure.telemetry.TelemetryData.getClassPackageSimpleName;
 
 @Configuration
 @ConditionalOnWebApplication
@@ -33,15 +37,17 @@ public class AADAuthenticationFilterAutoConfiguration {
     private static final Logger LOG = LoggerFactory.getLogger(AADAuthenticationProperties.class);
 
     private final AADAuthenticationProperties aadAuthProps;
+
     private final ServiceEndpointsProperties serviceEndpointsProps;
 
     private final TelemetryProxy telemetryProxy;
 
     public AADAuthenticationFilterAutoConfiguration(AADAuthenticationProperties aadAuthFilterProps,
-                                                    ServiceEndpointsProperties serviceEndpointsProps) {
+                                                    ServiceEndpointsProperties serviceEndpointsProps,
+                                                    TelemetryProxy telemetryProxy) {
         this.aadAuthProps = aadAuthFilterProps;
         this.serviceEndpointsProps = serviceEndpointsProps;
-        this.telemetryProxy = new TelemetryProxy(aadAuthFilterProps.isAllowTelemetry());
+        this.telemetryProxy = telemetryProxy;
     }
 
     /**
@@ -54,7 +60,6 @@ public AADAuthenticationFilterAutoConfiguration(AADAuthenticationProperties aadA
     @ConditionalOnMissingBean(AADAuthenticationFilter.class)
     public AADAuthenticationFilter azureADJwtTokenFilter() {
         LOG.info("AzureADJwtTokenFilter Constructor.");
-        trackCustomEvent();
         return new AADAuthenticationFilter(aadAuthProps, serviceEndpointsProps, getJWTResourceRetriever());
     }
 
@@ -66,13 +71,14 @@ public ResourceRetriever getJWTResourceRetriever() {
                 aadAuthProps.getJwtSizeLimit());
     }
 
+    @PostConstruct
     private void trackCustomEvent() {
-        final HashMap<String, String> customTelemetryProperties = new HashMap<>();
-        final String[] packageNames = this.getClass().getPackage().getName().split("\\.");
+        if (aadAuthProps.isAllowTelemetry()) {
+            final Map<String, String> events = new HashMap<>();
+
+            events.put(SERVICE_NAME, getClassPackageSimpleName(AADAuthenticationFilterAutoConfiguration.class));
 
-        if (packageNames.length > 1) {
-            customTelemetryProperties.put(TelemetryData.SERVICE_NAME, packageNames[packageNames.length - 1]);
+            telemetryProxy.trackEvent(ClassUtils.getUserClass(getClass()).getSimpleName(), events);
         }
-        telemetryProxy.trackEvent(ClassUtils.getUserClass(this.getClass()).getSimpleName(), customTelemetryProperties);
     }
 }

azure-spring-boot/src/main/java/com/microsoft/azure/spring/autoconfigure/aad/AADAuthenticationFilterAutoConfiguration.java

@@ -5,6 +5,7 @@
  */
 package com.microsoft.azure.spring.autoconfigure.aad;
 
+import com.microsoft.azure.telemetry.TelemetryProxy;
 import org.springframework.boot.autoconfigure.condition.ConditionalOnProperty;
 import org.springframework.boot.autoconfigure.condition.ConditionalOnWebApplication;
 import org.springframework.boot.context.properties.EnableConfigurationProperties;
@@ -14,6 +15,14 @@
 import org.springframework.security.oauth2.client.oidc.userinfo.OidcUserRequest;
 import org.springframework.security.oauth2.client.userinfo.OAuth2UserService;
 import org.springframework.security.oauth2.core.oidc.user.OidcUser;
+import org.springframework.util.ClassUtils;
+
+import javax.annotation.PostConstruct;
+import java.util.HashMap;
+import java.util.Map;
+
+import static com.microsoft.azure.telemetry.TelemetryData.SERVICE_NAME;
+import static com.microsoft.azure.telemetry.TelemetryData.getClassPackageSimpleName;
 
 @Configuration
 @ConditionalOnWebApplication(type = ConditionalOnWebApplication.Type.SERVLET)
@@ -22,18 +31,35 @@
 @PropertySource(value = "classpath:serviceEndpoints.properties")
 @EnableConfigurationProperties({AADAuthenticationProperties.class, ServiceEndpointsProperties.class})
 public class AADOAuth2AutoConfiguration {
-    private AADAuthenticationProperties aadAuthProps;
-    private ServiceEndpointsProperties serviceEndpointsProps;
+
+    private final TelemetryProxy telemetryProxy;
+
+    private final AADAuthenticationProperties aadAuthProps;
+
+    private final ServiceEndpointsProperties serviceEndpointsProps;
 
     public AADOAuth2AutoConfiguration(AADAuthenticationProperties aadAuthProperties,
-                                      ServiceEndpointsProperties serviceEndpointsProps) {
+                                      ServiceEndpointsProperties serviceEndpointsProps,
+                                      TelemetryProxy telemetryProxy) {
         this.aadAuthProps = aadAuthProperties;
         this.serviceEndpointsProps = serviceEndpointsProps;
+        this.telemetryProxy = telemetryProxy;
     }
 
     @Bean
     @ConditionalOnProperty(prefix = "azure.activedirectory", value = "active-directory-groups")
     public OAuth2UserService<OidcUserRequest, OidcUser> oidcUserService() {
         return new AADOAuth2UserService(aadAuthProps, serviceEndpointsProps);
     }
+
+    @PostConstruct
+    private void trackCustomEvent() {
+        if (aadAuthProps.isAllowTelemetry()) {
+            final Map<String, String> events = new HashMap<>();
+
+            events.put(SERVICE_NAME, getClassPackageSimpleName(AADOAuth2AutoConfiguration.class));
+
+            telemetryProxy.trackEvent(ClassUtils.getUserClass(getClass()).getSimpleName(), events);
+        }
+    }
 }

azure-spring-boot/src/main/java/com/microsoft/azure/spring/autoconfigure/aad/AADOAuth2AutoConfiguration.java

@@ -5,7 +5,6 @@
  */
 package com.microsoft.azure.spring.autoconfigure.b2c;
 
-import com.microsoft.azure.telemetry.TelemetryData;
 import com.microsoft.azure.telemetry.TelemetryProxy;
 import lombok.NonNull;
 import org.springframework.boot.autoconfigure.condition.ConditionalOnMissingBean;
@@ -23,13 +22,15 @@
 import org.springframework.util.ClassUtils;
 import org.springframework.util.StringUtils;
 
+import javax.annotation.PostConstruct;
 import java.util.ArrayList;
 import java.util.HashMap;
 import java.util.List;
 import java.util.Map;
 
 import static com.microsoft.azure.spring.autoconfigure.b2c.AADB2CProperties.PREFIX;
 import static com.microsoft.azure.spring.autoconfigure.b2c.AADB2CProperties.USER_FLOW_SIGN_UP_OR_SIGN_IN;
+import static com.microsoft.azure.telemetry.TelemetryData.*;
 
 @Configuration
 @ConditionalOnWebApplication
@@ -50,12 +51,14 @@ public class AADB2CAutoConfiguration {
 
     private final AADB2CProperties properties;
 
+    private final TelemetryProxy telemetryProxy;
+
     public AADB2CAutoConfiguration(@NonNull ClientRegistrationRepository repository,
-                                   @NonNull AADB2CProperties properties) {
+                                   @NonNull AADB2CProperties properties,
+                                   @NonNull TelemetryProxy telemetryProxy) {
         this.repository = repository;
         this.properties = properties;
-
-        trackCustomEvent(properties.isAllowTelemetry());
+        this.telemetryProxy = telemetryProxy;
     }
 
     @Bean
@@ -77,13 +80,13 @@ public AADB2COidcLoginConfigurer b2cLoginConfigurer(AADB2CLogoutSuccessHandler h
         return new AADB2COidcLoginConfigurer(properties, handler, resolver);
     }
 
-    private void trackCustomEvent(boolean isAllowTelemetry) {
-        if (isAllowTelemetry) {
-            final TelemetryProxy telemetryProxy = new TelemetryProxy(true);
+    @PostConstruct
+    private void trackCustomEvent() {
+        if (properties.isAllowTelemetry()) {
             final Map<String, String> events = new HashMap<>();
 
-            events.put(TelemetryData.SERVICE_NAME, getClass().getPackage().getName().replaceAll("\\w+\\.", ""));
-            events.put(TelemetryData.TENANT_NAME, properties.getTenant());
+            events.put(SERVICE_NAME, getClassPackageSimpleName(AADB2CAutoConfiguration.class));
+            events.put(TENANT_NAME, properties.getTenant());
 
             telemetryProxy.trackEvent(ClassUtils.getUserClass(getClass()).getSimpleName(), events);
         }

azure-spring-boot/src/main/java/com/microsoft/azure/spring/autoconfigure/b2c/AADB2CAutoConfiguration.java

@@ -13,7 +13,6 @@
 import com.microsoft.azure.spring.data.cosmosdb.core.DocumentDbTemplate;
 import org.springframework.beans.factory.ObjectProvider;
 import org.springframework.boot.autoconfigure.condition.ConditionalOnClass;
-import org.springframework.boot.autoconfigure.condition.ConditionalOnProperty;
 import org.springframework.boot.context.properties.EnableConfigurationProperties;
 import org.springframework.context.annotation.Configuration;
 

azure-spring-boot/src/main/java/com/microsoft/azure/spring/autoconfigure/cosmosdb/DocumentDBAutoConfiguration.java

@@ -5,7 +5,6 @@
  */
 package com.microsoft.azure.spring.autoconfigure.gremlin;
 
-import com.microsoft.azure.telemetry.TelemetryData;
 import com.microsoft.azure.telemetry.TelemetryProxy;
 import com.microsoft.spring.data.gremlin.common.GremlinConfig;
 import com.microsoft.spring.data.gremlin.common.GremlinFactory;
@@ -26,8 +25,12 @@
 import org.springframework.lang.NonNull;
 import org.springframework.util.ClassUtils;
 
+import javax.annotation.PostConstruct;
 import java.util.HashMap;
 
+import static com.microsoft.azure.telemetry.TelemetryData.SERVICE_NAME;
+import static com.microsoft.azure.telemetry.TelemetryData.getClassPackageSimpleName;
+
 @Configuration
 @ConditionalOnClass({GremlinFactory.class, GremlinTemplate.class, MappingGremlinConverter.class})
 @ConditionalOnProperty(prefix = "gremlin", value = {"endpoint", "port", "username", "password"})
@@ -40,21 +43,22 @@ public class GremlinAutoConfiguration {
 
     private final ApplicationContext applicationContext;
 
-    public GremlinAutoConfiguration(@NonNull GremlinProperties properties, @NonNull ApplicationContext context) {
+    public GremlinAutoConfiguration(@NonNull GremlinProperties properties, @NonNull ApplicationContext context,
+                                    TelemetryProxy telemetryProxy) {
         this.properties = properties;
         this.applicationContext = context;
-        this.telemetryProxy = new TelemetryProxy(properties.isTelemetryAllowed());
+        this.telemetryProxy = telemetryProxy;
     }
 
+    @PostConstruct
     private void trackCustomEvent() {
-        final HashMap<String, String> customTelemetryProperties = new HashMap<>();
-        final String[] packageNames = this.getClass().getPackage().getName().split("\\.");
+        if (properties.isTelemetryAllowed()) {
+            final HashMap<String, String> events = new HashMap<>();
 
-        if (packageNames.length > 1) {
-            customTelemetryProperties.put(TelemetryData.SERVICE_NAME, packageNames[packageNames.length - 1]);
-        }
+            events.put(SERVICE_NAME, getClassPackageSimpleName(GremlinAutoConfiguration.class));
 
-        telemetryProxy.trackEvent(ClassUtils.getUserClass(this.getClass()).getSimpleName(), customTelemetryProperties);
+            telemetryProxy.trackEvent(ClassUtils.getUserClass(this.getClass()).getSimpleName(), events);
+        }
     }
 
     @Bean
@@ -80,8 +84,6 @@ public GremlinConfig getGremlinConfig() {
     @Bean
     @ConditionalOnMissingBean
     public GremlinFactory gremlinFactory() {
-        this.trackCustomEvent();
-
         return new GremlinFactory(getGremlinConfig());
     }