Deprecated the azure spring telemetry configuration item and remove t…

…he telemetry code usage. (#22200)
Azure · Jun 18, 2021 · b1dcfcd · b1dcfcd
1 parent 88b2b2f
commit b1dcfcd
Show file tree

Hide file tree

Showing 72 changed files with 102 additions and 1,462 deletions.
diff --git a/eng/code-quality-reports/src/main/resources/checkstyle/checkstyle-suppressions.xml b/eng/code-quality-reports/src/main/resources/checkstyle/checkstyle-suppressions.xml
@@ -486,7 +486,6 @@ the main ServiceBusClientBuilder. -->
   <suppress checks="com.azure.tools.checkstyle.checks.EnforceFinalFieldsCheck" files="com.azure.spring.autoconfigure.jms.ConnectionStringResolver"/>
   <suppress checks="com.azure.tools.checkstyle.checks.EnforceFinalFieldsCheck" files="com.azure.spring.data.cosmos.config.AbstractCosmosConfiguration.java"/>
   <suppress checks="com.azure.tools.checkstyle.checks.EnforceFinalFieldsCheck" files="com.azure.spring.data.cosmos.core.query.CosmosPageRequest.java"/>
-  <suppress checks="com.azure.tools.checkstyle.checks.EnforceFinalFieldsCheck" files="com.azure.spring.cloud.autoconfigure.telemetry.TelemetryAutoConfiguration.java"/>
   <suppress checks="com.azure.tools.checkstyle.checks.EnforceFinalFieldsCheck" files="com.azure.spring.cloud.autoconfigure.context.AzureEnvironmentAutoConfiguration.java"/>
   <suppress checks="com.azure.tools.checkstyle.checks.EnforceFinalFieldsCheck" files="com.azure.spring.cloud.autoconfigure.storage.AzureStorageQueueAutoConfiguration.java"/>
   <suppress checks="com.azure.tools.checkstyle.checks.EnforceFinalFieldsCheck" files="com.azure.spring.cloud.autoconfigure.storage.AzureStorageAutoConfiguration.java"/>

diff --git a/eng/code-quality-reports/src/main/resources/spotbugs/spotbugs-exclude.xml b/eng/code-quality-reports/src/main/resources/spotbugs/spotbugs-exclude.xml
@@ -2278,23 +2278,14 @@
   <!-- Exclude from spring related classes -->
   <Match>
     <Or>
-      <Class name="com.azure.spring.utils.GetHashMac"/> <!-- false positive -->
       <Class name="com.azure.spring.utils.PropertyLoader"/> <!-- false positive -->
-      <Class name="com.azure.spring.cloud.telemetry.GetHashMac"/> <!-- false positive -->
     </Or>
     <Bug pattern="RCN_REDUNDANT_NULLCHECK_WOULD_HAVE_BEEN_A_NPE,
                   NP_LOAD_OF_KNOWN_NULL_VALUE,
                   RCN_REDUNDANT_NULLCHECK_OF_NONNULL_VALUE,
                   RCN_REDUNDANT_NULLCHECK_OF_NULL_VALUE"/>
   </Match>
 
-  <Match>
-    <Or>
-      <Class name="com.azure.spring.telemetry.TelemetryEventData$EventData$CustomData"/> <!-- false positive -->
-    </Or>
-    <Bug pattern="UPM_UNCALLED_PRIVATE_METHOD"/>
-  </Match>
-
   <Match>
     <Or>
       <Class name="com.azure.spring.integration.servicebus.queue.ServiceBusQueueTemplate$QueueMessageHandler"/> <!-- false positive -->

diff --git a/eng/jacoco-test-coverage/pom.xml b/eng/jacoco-test-coverage/pom.xml
@@ -462,11 +462,6 @@
       <artifactId>azure-spring-cloud-context</artifactId>
       <version>2.6.0-beta.1</version> <!-- {x-version-update;com.azure.spring:azure-spring-cloud-context;current} -->
     </dependency>
-    <dependency>
-      <groupId>com.azure.spring</groupId>
-      <artifactId>azure-spring-cloud-telemetry</artifactId>
-      <version>2.6.0-beta.1</version> <!-- {x-version-update;com.azure.spring:azure-spring-cloud-telemetry;current} -->
-    </dependency>
     <dependency>
       <groupId>com.azure.spring</groupId>
       <artifactId>azure-spring-integration-core</artifactId>

diff --git a/eng/versioning/version_client.txt b/eng/versioning/version_client.txt
@@ -166,7 +166,6 @@ com.azure.spring:azure-spring-cloud-stream-binder-servicebus-core;2.5.0;2.6.0-be
 com.azure.spring:azure-spring-cloud-stream-binder-servicebus-queue;2.5.0;2.6.0-beta.1
 com.azure.spring:azure-spring-cloud-stream-binder-servicebus-topic;2.5.0;2.6.0-beta.1
 com.azure.spring:azure-spring-cloud-stream-binder-test;2.5.0;2.6.0-beta.1
-com.azure.spring:azure-spring-cloud-telemetry;2.5.0;2.6.0-beta.1
 com.azure.spring:azure-spring-integration-core;2.5.0;2.6.0-beta.1
 com.azure.spring:azure-spring-integration-eventhubs;2.5.0;2.6.0-beta.1
 com.azure.spring:azure-spring-integration-servicebus;2.5.0;2.6.0-beta.1

diff --git a/sdk/boms/azure-spring-cloud-dependencies/CHANGELOG.md b/sdk/boms/azure-spring-cloud-dependencies/CHANGELOG.md
@@ -1,5 +1,8 @@
 # Release History
 
+## 3.6.0-beta.1 (Unreleased)
+### Breaking Changes
+- Remove `azure-spring-cloud-telemetry` module dependency.
 
 ## 2.5.0 (2021-05-24)
 

diff --git a/sdk/boms/azure-spring-cloud-dependencies/pom.xml b/sdk/boms/azure-spring-cloud-dependencies/pom.xml
@@ -173,11 +173,6 @@
         <artifactId>spring-cloud-starter-azure-appconfiguration-config</artifactId>
         <version>${azure.spring.appconfigure.version}</version>
       </dependency>
-      <dependency>
-        <groupId>com.azure.spring</groupId>
-        <artifactId>azure-spring-cloud-telemetry</artifactId>
-        <version>${azure.spring.cloud.version}</version>
-      </dependency>
       <dependency>
         <groupId>com.azure.spring</groupId>
         <artifactId>azure-identity-spring</artifactId>

diff --git a/sdk/spring/azure-spring-boot-samples/azure-spring-cloud-sample-eventhubs-binder/pom.xml b/sdk/spring/azure-spring-boot-samples/azure-spring-cloud-sample-eventhubs-binder/pom.xml
@@ -44,12 +44,6 @@
       <artifactId>azure-spring-cloud-stream-binder-eventhubs</artifactId>
       <version>2.6.0-beta.1</version> <!-- {x-version-update;com.azure.spring:azure-spring-cloud-stream-binder-eventhubs;current} -->
     </dependency>
-    <!-- Storage library for provisioning checkpoint storage -->
-    <dependency>
-      <groupId>com.azure.spring</groupId>
-      <artifactId>azure-spring-cloud-storage</artifactId>
-      <version>2.6.0-beta.1</version> <!-- {x-version-update;com.azure.spring:azure-spring-cloud-storage;current} -->
-    </dependency>
     <dependency>
       <groupId>org.springframework.boot</groupId>
       <artifactId>spring-boot-starter-logging</artifactId>

diff --git a/sdk/spring/azure-spring-boot-starter-active-directory-b2c/CHANGELOG.md b/sdk/spring/azure-spring-boot-starter-active-directory-b2c/CHANGELOG.md
@@ -1,7 +1,8 @@
 # Release History
 
 ## 3.6.0-beta.1 (Unreleased)
-
+### Breaking Changes
+- Deprecated `allowTelemetry` configuration item.
 
 ## 3.5.0 (2021-05-24)
 ### New Features

diff --git a/sdk/spring/azure-spring-boot-starter-active-directory/CHANGELOG.md b/sdk/spring/azure-spring-boot-starter-active-directory/CHANGELOG.md
@@ -3,6 +3,7 @@
 ## 3.6.0-beta.1 (Unreleased)
 ### Breaking Changes
 - Deprecate aad.group.enable-full-list, use aad.group.allowed-group-ids=all instead.
+- Deprecated `allowTelemetry` configuration item.
 
 ### New Features
 - Support domain_hint in aad-starter.([#21517](https://github.com/Azure/azure-sdk-for-java/issues/21517))

diff --git a/sdk/spring/azure-spring-boot-starter-cosmos/CHANGELOG.md b/sdk/spring/azure-spring-boot-starter-cosmos/CHANGELOG.md
@@ -1,7 +1,8 @@
 # Release History
 
 ## 3.6.0-beta.1 (Unreleased)
-
+### Breaking Changes
+- Deprecated `allowTelemetry` configuration item.
 
 ## 3.5.0 (2021-05-24)
 ### New Features

diff --git a/sdk/spring/azure-spring-boot-starter-keyvault-secrets/CHANGELOG.md b/sdk/spring/azure-spring-boot-starter-keyvault-secrets/CHANGELOG.md
@@ -1,7 +1,8 @@
 # Release History
 
 ## 3.6.0-beta.1 (Unreleased)
-
+### Breaking Changes
+- Deprecated `allowTelemetry` configuration item.
 
 ## 3.5.0 (2021-05-24)
 ### New Features

diff --git a/sdk/spring/azure-spring-boot/CHANGELOG.md b/sdk/spring/azure-spring-boot/CHANGELOG.md
@@ -3,6 +3,7 @@
 ## 3.6.0-beta.1 (Unreleased)
 ### Breaking Changes
 - Deprecate aad.group.enable-full-list, use aad.group.allowed-group-ids=all instead.
+- Deprecated `allowTelemetry` configuration item in each module property class.
 
 ### New Features
 - Support domain_hint in aad-starter.([#21517](https://github.com/Azure/azure-sdk-for-java/issues/21517))

diff --git a/...ain/java/com/azure/spring/autoconfigure/aad/AADAuthenticationFilterAutoConfiguration.java b/...ain/java/com/azure/spring/autoconfigure/aad/AADAuthenticationFilterAutoConfiguration.java
@@ -4,7 +4,6 @@
 package com.azure.spring.autoconfigure.aad;
 
 import com.azure.spring.aad.AADAuthorizationServerEndpoints;
-import com.azure.spring.telemetry.TelemetrySender;
 import com.nimbusds.jose.jwk.source.DefaultJWKSetCache;
 import com.nimbusds.jose.jwk.source.JWKSetCache;
 import com.nimbusds.jose.util.DefaultResourceRetriever;
@@ -21,16 +20,9 @@
 import org.springframework.boot.context.properties.EnableConfigurationProperties;
 import org.springframework.context.annotation.Bean;
 import org.springframework.context.annotation.Configuration;
-import org.springframework.util.ClassUtils;
 
-import javax.annotation.PostConstruct;
-import java.util.HashMap;
-import java.util.Map;
 import java.util.concurrent.TimeUnit;
 
-import static com.azure.spring.telemetry.TelemetryData.SERVICE_NAME;
-import static com.azure.spring.telemetry.TelemetryData.getClassPackageSimpleName;
-
 /**
  * {@link EnableAutoConfiguration Auto-configuration} for Azure Active Authentication filters.
  * <p>
@@ -111,14 +103,4 @@ public JWKSetCache getJWKSetCache() {
         long refreshTime = properties.getJwkSetCacheRefreshTime();
         return new DefaultJWKSetCache(lifespan, refreshTime, TimeUnit.MILLISECONDS);
     }
-
-    @PostConstruct
-    private void sendTelemetry() {
-        if (properties.isAllowTelemetry()) {
-            final Map<String, String> events = new HashMap<>();
-            final TelemetrySender sender = new TelemetrySender();
-            events.put(SERVICE_NAME, getClassPackageSimpleName(AADAuthenticationFilterAutoConfiguration.class));
-            sender.send(ClassUtils.getUserClass(getClass()).getSimpleName(), events);
-        }
-    }
 }
diff --git a/...ng-boot/src/main/java/com/azure/spring/autoconfigure/aad/AADAuthenticationProperties.java b/...ng-boot/src/main/java/com/azure/spring/autoconfigure/aad/AADAuthenticationProperties.java
@@ -326,6 +326,9 @@ public void setPostLogoutRedirectUri(String postLogoutRedirectUri) {
         this.postLogoutRedirectUri = postLogoutRedirectUri;
     }
 
+    @Deprecated
+    @DeprecatedConfigurationProperty(
+        reason = "Deprecate the telemetry endpoint and use HTTP header User Agent instead.")
     public boolean isAllowTelemetry() {
         return allowTelemetry;
     }

diff --git a/...spring-boot/src/main/java/com/azure/spring/autoconfigure/b2c/AADB2CAutoConfiguration.java b/...spring-boot/src/main/java/com/azure/spring/autoconfigure/b2c/AADB2CAutoConfiguration.java
@@ -2,7 +2,6 @@
 // Licensed under the MIT License.
 package com.azure.spring.autoconfigure.b2c;
 
-import com.azure.spring.telemetry.TelemetrySender;
 import org.springframework.boot.autoconfigure.condition.ConditionalOnMissingBean;
 import org.springframework.boot.autoconfigure.condition.ConditionalOnResource;
 import org.springframework.boot.context.properties.EnableConfigurationProperties;
@@ -12,15 +11,6 @@
 import org.springframework.context.annotation.Import;
 import org.springframework.lang.NonNull;
 import org.springframework.security.oauth2.client.registration.ClientRegistrationRepository;
-import org.springframework.util.ClassUtils;
-
-import javax.annotation.PostConstruct;
-import java.util.HashMap;
-import java.util.Map;
-
-import static com.azure.spring.telemetry.TelemetryData.SERVICE_NAME;
-import static com.azure.spring.telemetry.TelemetryData.TENANT_NAME;
-import static com.azure.spring.telemetry.TelemetryData.getClassPackageSimpleName;
 
 /**
  * When the configuration matches the {@link AADB2CConditions.CommonCondition.WebAppMode} condition,
@@ -61,15 +51,4 @@ public AADB2COidcLoginConfigurer b2cLoginConfigurer(AADB2CLogoutSuccessHandler h
                                                         AADB2CAuthorizationRequestResolver resolver) {
         return new AADB2COidcLoginConfigurer(handler, resolver);
     }
-
-    @PostConstruct
-    private void sendTelemetry() {
-        if (properties.isAllowTelemetry()) {
-            final Map<String, String> events = new HashMap<>();
-            final TelemetrySender sender = new TelemetrySender();
-            events.put(SERVICE_NAME, getClassPackageSimpleName(AADB2CAutoConfiguration.class));
-            events.put(TENANT_NAME, properties.getTenant());
-            sender.send(ClassUtils.getUserClass(getClass()).getSimpleName(), events);
-        }
-    }
 }
diff --git a/.../azure-spring-boot/src/main/java/com/azure/spring/autoconfigure/b2c/AADB2CProperties.java b/.../azure-spring-boot/src/main/java/com/azure/spring/autoconfigure/b2c/AADB2CProperties.java
@@ -249,6 +249,9 @@ public void setAuthenticateAdditionalParameters(Map<String, Object> authenticate
         this.authenticateAdditionalParameters = authenticateAdditionalParameters;
     }
 
+    @Deprecated
+    @DeprecatedConfigurationProperty(
+        reason = "Deprecate the telemetry endpoint and use HTTP header User Agent instead.")
     public boolean isAllowTelemetry() {
         return allowTelemetry;
     }

diff --git a/...ure-spring-boot/src/main/java/com/azure/spring/autoconfigure/cosmos/CosmosProperties.java b/...ure-spring-boot/src/main/java/com/azure/spring/autoconfigure/cosmos/CosmosProperties.java
@@ -9,6 +9,7 @@
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 import org.springframework.boot.context.properties.ConfigurationProperties;
+import org.springframework.boot.context.properties.DeprecatedConfigurationProperty;
 import org.springframework.validation.annotation.Validated;
 
 import javax.validation.constraints.NotEmpty;
@@ -102,6 +103,9 @@ public void setConsistencyLevel(ConsistencyLevel consistencyLevel) {
         this.consistencyLevel = consistencyLevel;
     }
 
+    @Deprecated
+    @DeprecatedConfigurationProperty(
+        reason = "Deprecate the telemetry endpoint and use HTTP header User Agent instead.")
     public boolean isAllowTelemetry() {
         return allowTelemetry;
     }

diff --git a/...-boot/src/main/java/com/azure/spring/keyvault/KeyVaultEnvironmentPostProcessorHelper.java b/...-boot/src/main/java/com/azure/spring/keyvault/KeyVaultEnvironmentPostProcessorHelper.java
@@ -13,26 +13,20 @@
 import com.azure.security.keyvault.secrets.SecretClientBuilder;
 import com.azure.security.keyvault.secrets.SecretServiceVersion;
 import com.azure.spring.keyvault.KeyVaultProperties.Property;
-import com.azure.spring.telemetry.TelemetrySender;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 import org.springframework.boot.context.properties.bind.Bindable;
 import org.springframework.boot.context.properties.bind.Binder;
 import org.springframework.core.env.ConfigurableEnvironment;
 import org.springframework.core.env.MutablePropertySources;
 import org.springframework.util.Assert;
-import org.springframework.util.ClassUtils;
 import org.springframework.util.StringUtils;
 
 import java.util.Arrays;
 import java.util.Collections;
-import java.util.HashMap;
 import java.util.List;
-import java.util.Map;
 import java.util.Optional;
 
-import static com.azure.spring.telemetry.TelemetryData.SERVICE_NAME;
-import static com.azure.spring.telemetry.TelemetryData.getClassPackageSimpleName;
 import static com.azure.spring.utils.ApplicationId.AZURE_SPRING_KEY_VAULT;
 import static com.azure.spring.utils.Constants.AZURE_KEYVAULT_PROPERTYSOURCE_NAME;
 import static com.azure.spring.utils.Constants.DEFAULT_REFRESH_INTERVAL_MS;
@@ -51,8 +45,6 @@ class KeyVaultEnvironmentPostProcessorHelper {
     KeyVaultEnvironmentPostProcessorHelper(final ConfigurableEnvironment environment) {
         this.environment = environment;
         Assert.notNull(environment, "environment must not be null!");
-        // As @PostConstructor not available when post processor, call it explicitly.
-        sendTelemetry();
     }
 
     /**
@@ -182,13 +174,6 @@ public TokenCredential getCredentials(String normalizedName) {
         return new ManagedIdentityCredentialBuilder().build();
     }
 
-    private String getPropertyValue(final Property property) {
-        return Optional.of(property)
-                .map(KeyVaultProperties::getPropertyName)
-                .map(environment::getProperty)
-                .orElse(null);
-    }
-
     private String getPropertyValue(final String normalizedName, final Property property) {
         return getPropertyValue(normalizedName, property, null);
     }
@@ -198,19 +183,4 @@ private String getPropertyValue(final String normalizedName, final Property prop
             .map(environment::getProperty)
             .orElse(defaultValue);
     }
-
-    private boolean allowTelemetry() {
-        return Boolean.parseBoolean(getPropertyValue(Property.ALLOW_TELEMETRY));
-    }
-
-    private void sendTelemetry() {
-        if (allowTelemetry()) {
-            final Map<String, String> events = new HashMap<>();
-            final TelemetrySender sender = new TelemetrySender();
-
-            events.put(SERVICE_NAME, getClassPackageSimpleName(KeyVaultEnvironmentPostProcessorHelper.class));
-
-            sender.send(ClassUtils.getUserClass(getClass()).getSimpleName(), events);
-        }
-    }
 }
diff --git a/sdk/spring/azure-spring-boot/src/main/java/com/azure/spring/keyvault/KeyVaultProperties.java b/sdk/spring/azure-spring-boot/src/main/java/com/azure/spring/keyvault/KeyVaultProperties.java
@@ -9,6 +9,7 @@
 import java.util.List;
 import java.util.stream.Collectors;
 import java.util.stream.Stream;
+import org.springframework.boot.context.properties.DeprecatedConfigurationProperty;
 
 /**
  * KeyVaultProperties
@@ -107,6 +108,9 @@ public void setCaseSensitiveKeys(String caseSensitiveKeys) {
         this.caseSensitiveKeys = caseSensitiveKeys;
     }
 
+    @Deprecated
+    @DeprecatedConfigurationProperty(
+        reason = "Deprecate the telemetry endpoint and use HTTP header User Agent instead.")
     public String getAllowTelemetry() {
         return allowTelemetry;
     }
@@ -139,7 +143,6 @@ public void setAllowTelemetry(String allowTelemetry) {
      * enum Property
      */
     public enum Property {
-        ALLOW_TELEMETRY("allow-telemetry"),
         CASE_SENSITIVE_KEYS("case-sensitive-keys"),
         CERTIFICATE_PASSWORD("certificate-password"),
         AUTHORITY_HOST("authority-host"),

diff --git a/sdk/spring/azure-spring-boot/src/main/java/com/azure/spring/telemetry/TelemetryData.java b/sdk/spring/azure-spring-boot/src/main/java/com/azure/spring/telemetry/TelemetryData.java