Adds support for tracking feature usage in a new user agent metadata section (aws#5667)

* Adds support for tracking feature usage in a new user agent metadata section and adds a base set of features. Where features were already a part of the user agent string, they are now converted to the new format where a feature is represented as a Base64 encoded string, listed in BusinessMetricsFeatureId. For example, using DynamoDb Enhanced Client was previously recorded as 'hll/ddb-enh' in the user agent, but is now a 'd' in the business metrics metadata section 'm/'.

* Minor changes from PR feedback

* More module separation fixes

* fix corrupted test file

* Changing class name

* removing this test to include in separate PR

Author: cenedhryn

.changes/next-release/feature-AWSSDKforJavav2-22a34e4.json

@@ -0,0 +1,6 @@
+{
+    "type": "feature",
+    "category": "AWS SDK for Java v2",
+    "contributor": "",
+    "description": "Adds support for tracking feature usage in a new user agent metadata section and adds a base set of features. Where features were already a part of the user agent string, they are now converted to the new format where a feature is represented as a Base64 encoded string. For example, using DynamoDb Enhanced Client was previously recorded as 'hll/ddb-enh' in the user agent, but is now a 'd' in the business metrics metadata section 'm/'."
+}

codegen/src/main/java/software/amazon/awssdk/codegen/poet/common/UserAgentUtilsSpec.java

@@ -30,12 +30,10 @@
 import software.amazon.awssdk.codegen.poet.PoetExtension;
 import software.amazon.awssdk.codegen.poet.PoetUtils;
 import software.amazon.awssdk.core.ApiName;
-import software.amazon.awssdk.core.util.VersionInfo;
+import software.amazon.awssdk.core.useragent.BusinessMetricFeatureId;
 
 public class UserAgentUtilsSpec implements ClassSpec {
 
-    private static final String PAGINATOR_USER_AGENT = "PAGINATED";
-
     protected final IntermediateModel model;
     protected final PoetExtension poetExtensions;
 
@@ -106,12 +104,12 @@ private MethodSpec applyPaginatorUserAgentMethod() {
                          .addParameter(typeVariableName, "request")
                          .addTypeVariable(typeVariableName)
                          .addStatement("return applyUserAgentInfo(request, b -> b.addApiName($T.builder()"
-                                       + ".version($T.SDK_VERSION)"
                                        + ".name($S)"
+                                       + ".version($S)"
                                        + ".build()))",
                                        ApiName.class,
-                                       VersionInfo.class,
-                                       PAGINATOR_USER_AGENT)
+                                       "sdk-metrics",
+                                       BusinessMetricFeatureId.PAGINATOR)
                          .returns(typeVariableName)
                          .build();
     }

codegen/src/main/java/software/amazon/awssdk/codegen/poet/waiters/BaseWaiterClassSpec.java

@@ -57,6 +57,7 @@
 import software.amazon.awssdk.codegen.poet.PoetUtils;
 import software.amazon.awssdk.core.ApiName;
 import software.amazon.awssdk.core.internal.waiters.WaiterAttribute;
+import software.amazon.awssdk.core.useragent.BusinessMetricFeatureId;
 import software.amazon.awssdk.core.waiters.WaiterAcceptor;
 import software.amazon.awssdk.core.waiters.WaiterOverrideConfiguration;
 import software.amazon.awssdk.core.waiters.WaiterState;
@@ -75,7 +76,7 @@ public abstract class BaseWaiterClassSpec implements ClassSpec {
     public static final String FAILURE_MESSAGE_FORMAT_FOR_ERROR_MATCHER = "A waiter acceptor was matched on error "
                                                                           + "condition (%s) and transitioned the waiter to "
                                                                           + "failure state";
-    private static final String WAITERS_USER_AGENT = "waiter";
+    private static final String WAITERS_USER_AGENT = "B";
     private final IntermediateModel model;
     private final String modelPackage;
     private final Map<String, WaiterDefinition> waiters;
@@ -403,11 +404,11 @@ static MethodSpec applyWaitersUserAgentMethod(PoetExtension poetExtensions, Inte
             .get(ClassName.get(Consumer.class), ClassName.get(AwsRequestOverrideConfiguration.Builder.class));
 
         CodeBlock codeBlock = CodeBlock.builder()
-                                       .addStatement("$T userAgentApplier = b -> b.addApiName($T.builder().version"
-                                                     + "($S).name($S).build())",
+                                       .addStatement("$T userAgentApplier = b -> b.addApiName($T.builder().name"
+                                                     + "($S).version($S).build())",
                                                      parameterizedTypeName, ApiName.class,
-                                                     WAITERS_USER_AGENT,
-                                                     "hll")
+                                                     "sdk-metrics",
+                                                     BusinessMetricFeatureId.WAITER)
                                        .addStatement("$T overrideConfiguration =\n"
                                                      + "            request.overrideConfiguration().map(c -> c.toBuilder()"
                                                      + ".applyMutation"

codegen/src/test/resources/software/amazon/awssdk/codegen/poet/common/test-user-agent-class.java

@@ -5,7 +5,6 @@
 import software.amazon.awssdk.annotations.SdkInternalApi;
 import software.amazon.awssdk.awscore.AwsRequestOverrideConfiguration;
 import software.amazon.awssdk.core.ApiName;
-import software.amazon.awssdk.core.util.VersionInfo;
 import software.amazon.awssdk.services.json.model.JsonRequest;
 
 @Generated("software.amazon.awssdk:codegen")
@@ -23,7 +22,6 @@ public static <T extends JsonRequest> T applyUserAgentInfo(T request,
     }
 
     public static <T extends JsonRequest> T applyPaginatorUserAgent(T request) {
-        return applyUserAgentInfo(request,
-                                  b -> b.addApiName(ApiName.builder().version(VersionInfo.SDK_VERSION).name("PAGINATED").build()));
+        return applyUserAgentInfo(request, b -> b.addApiName(ApiName.builder().name("sdk-metrics").version("C").build()));
     }
 }

codegen/src/test/resources/software/amazon/awssdk/codegen/poet/waiters/query-async-waiter-class.java

@@ -125,7 +125,7 @@ public static QueryAsyncWaiter.Builder builder() {
 
     private <T extends QueryRequest> T applyWaitersUserAgent(T request) {
         Consumer<AwsRequestOverrideConfiguration.Builder> userAgentApplier = b -> b.addApiName(ApiName.builder()
-                                                                                                      .version("waiter").name("hll").build());
+                                                                                                      .name("sdk-metrics").version("B").build());
         AwsRequestOverrideConfiguration overrideConfiguration = request.overrideConfiguration()
                                                                        .map(c -> c.toBuilder().applyMutation(userAgentApplier).build())
                                                                        .orElse((AwsRequestOverrideConfiguration.builder().applyMutation(userAgentApplier).build()));

codegen/src/test/resources/software/amazon/awssdk/codegen/poet/waiters/query-sync-waiter-class.java

@@ -107,7 +107,7 @@ public static QueryWaiter.Builder builder() {
 
     private <T extends QueryRequest> T applyWaitersUserAgent(T request) {
         Consumer<AwsRequestOverrideConfiguration.Builder> userAgentApplier = b -> b.addApiName(ApiName.builder()
-                                                                                                      .version("waiter").name("hll").build());
+                                                                                                      .name("sdk-metrics").version("B").build());
         AwsRequestOverrideConfiguration overrideConfiguration = request.overrideConfiguration()
                                                                        .map(c -> c.toBuilder().applyMutation(userAgentApplier).build())
                                                                        .orElse((AwsRequestOverrideConfiguration.builder().applyMutation(userAgentApplier).build()));

core/aws-core/src/main/java/software/amazon/awssdk/awscore/internal/AwsExecutionContextBuilder.java

@@ -16,9 +16,13 @@
 package software.amazon.awssdk.awscore.internal;
 
 import static software.amazon.awssdk.auth.signer.internal.util.SignerMethodResolver.resolveSigningMethodUsed;
+import static software.amazon.awssdk.core.client.config.SdkClientOption.RETRY_POLICY;
+import static software.amazon.awssdk.core.client.config.SdkClientOption.RETRY_STRATEGY;
 import static software.amazon.awssdk.core.interceptor.SdkExecutionAttribute.RESOLVED_CHECKSUM_SPECS;
+import static software.amazon.awssdk.core.internal.useragent.BusinessMetricsUtils.resolveRetryMode;
 
 import java.util.Map;
+import java.util.Optional;
 import software.amazon.awssdk.annotations.SdkInternalApi;
 import software.amazon.awssdk.auth.signer.AwsSignerExecutionAttribute;
 import software.amazon.awssdk.awscore.AwsExecutionAttribute;
@@ -45,6 +49,7 @@
 import software.amazon.awssdk.core.internal.InternalCoreExecutionAttribute;
 import software.amazon.awssdk.core.internal.util.HttpChecksumResolver;
 import software.amazon.awssdk.core.signer.Signer;
+import software.amazon.awssdk.core.useragent.BusinessMetricCollection;
 import software.amazon.awssdk.endpoints.EndpointProvider;
 import software.amazon.awssdk.http.auth.scheme.NoAuthAuthScheme;
 import software.amazon.awssdk.http.auth.spi.scheme.AuthScheme;
@@ -116,7 +121,8 @@ private AwsExecutionContextBuilder() {
                           clientConfig.option(AwsClientOption.USE_GLOBAL_ENDPOINT))
             .putAttribute(AwsExecutionAttribute.AWS_AUTH_ACCOUNT_ID_ENDPOINT_MODE,
                           clientConfig.option(AwsClientOption.ACCOUNT_ID_ENDPOINT_MODE))
-            .putAttribute(RESOLVED_CHECKSUM_SPECS, HttpChecksumResolver.resolveChecksumSpecs(executionAttributes));
+            .putAttribute(RESOLVED_CHECKSUM_SPECS, HttpChecksumResolver.resolveChecksumSpecs(executionAttributes))
+            .putAttribute(SdkInternalExecutionAttribute.BUSINESS_METRICS, resolveUserAgentBusinessMetrics(clientConfig));
 
         // Auth Scheme resolution related attributes
         putAuthSchemeResolutionAttributes(executionAttributes, clientConfig, originalRequest);
@@ -264,7 +270,6 @@ private static MetricCollector resolveMetricCollector(ClientExecutionParams<?, ?
         return metricCollector;
     }
 
-
     /**
      * Resolves the endpoint provider, with the request override configuration taking precedence over the
      * provided default client clientConfig.
@@ -277,5 +282,11 @@ private static EndpointProvider resolveEndpointProvider(SdkRequest request,
                       .orElse(clientConfig.option(SdkClientOption.ENDPOINT_PROVIDER));
     }
 
-
+    private static BusinessMetricCollection resolveUserAgentBusinessMetrics(SdkClientConfiguration clientConfig) {
+        BusinessMetricCollection businessMetrics = new BusinessMetricCollection();
+        Optional<String> retryModeMetric = resolveRetryMode(clientConfig.option(RETRY_POLICY),
+                                                            clientConfig.option(RETRY_STRATEGY));
+        retryModeMetric.ifPresent(businessMetrics::addMetric);
+        return businessMetrics;
+    }
 }

core/sdk-core/src/main/java/software/amazon/awssdk/core/client/builder/SdkDefaultClientBuilder.java

@@ -44,7 +44,6 @@
 import static software.amazon.awssdk.core.client.config.SdkClientOption.PROFILE_FILE;
 import static software.amazon.awssdk.core.client.config.SdkClientOption.PROFILE_FILE_SUPPLIER;
 import static software.amazon.awssdk.core.client.config.SdkClientOption.PROFILE_NAME;
-import static software.amazon.awssdk.core.client.config.SdkClientOption.RETRY_POLICY;
 import static software.amazon.awssdk.core.client.config.SdkClientOption.RETRY_STRATEGY;
 import static software.amazon.awssdk.core.client.config.SdkClientOption.SCHEDULED_EXECUTOR_SERVICE;
 import static software.amazon.awssdk.core.client.config.SdkClientOption.SYNC_HTTP_CLIENT;
@@ -53,7 +52,6 @@
 import static software.amazon.awssdk.core.internal.useragent.UserAgentConstant.HTTP;
 import static software.amazon.awssdk.core.internal.useragent.UserAgentConstant.INTERNAL_METADATA_MARKER;
 import static software.amazon.awssdk.core.internal.useragent.UserAgentConstant.IO;
-import static software.amazon.awssdk.core.internal.useragent.UserAgentConstant.RETRY_MODE;
 import static software.amazon.awssdk.utils.CollectionUtils.mergeLists;
 import static software.amazon.awssdk.utils.Validate.paramNotNull;
 
@@ -96,7 +94,6 @@
 import software.amazon.awssdk.core.internal.useragent.SdkClientUserAgentProperties;
 import software.amazon.awssdk.core.internal.useragent.SdkUserAgentBuilder;
 import software.amazon.awssdk.core.retry.RetryMode;
-import software.amazon.awssdk.core.retry.RetryPolicy;
 import software.amazon.awssdk.core.util.SystemUserAgent;
 import software.amazon.awssdk.http.ExecutableHttpRequest;
 import software.amazon.awssdk.http.HttpExecuteRequest;
@@ -108,9 +105,6 @@
 import software.amazon.awssdk.profiles.ProfileFile;
 import software.amazon.awssdk.profiles.ProfileFileSystemSetting;
 import software.amazon.awssdk.profiles.ProfileProperty;
-import software.amazon.awssdk.retries.AdaptiveRetryStrategy;
-import software.amazon.awssdk.retries.LegacyRetryStrategy;
-import software.amazon.awssdk.retries.StandardRetryStrategy;
 import software.amazon.awssdk.retries.api.RetryStrategy;
 import software.amazon.awssdk.utils.AttributeMap;
 import software.amazon.awssdk.utils.AttributeMap.LazyValueSource;
@@ -394,31 +388,12 @@ protected SdkClientConfiguration invokePlugins(SdkClientConfiguration config) {
         return config;
     }
 
-    //TODO (useragent): Refactor this as part of moving value to business metrics (UA 2.1)
-    private static String resolveRetryMode(RetryPolicy retryPolicy, RetryStrategy retryStrategy) {
-        if (retryPolicy != null) {
-            return retryPolicy.retryMode().toString();
-        }
-        if (retryStrategy instanceof StandardRetryStrategy) {
-            return RetryMode.STANDARD.toString();
-        }
-        if (retryStrategy instanceof LegacyRetryStrategy) {
-            return RetryMode.LEGACY.toString();
-        }
-        if (retryStrategy instanceof AdaptiveRetryStrategy) {
-            return RetryMode.ADAPTIVE.toString();
-        }
-        return "UnknownRetryMode";
-    }
-
     private String resolveClientUserAgent(LazyValueSource config) {
         SdkClientUserAgentProperties clientProperties = new SdkClientUserAgentProperties();
 
         ClientType clientType = config.get(CLIENT_TYPE);
         ClientType resolvedClientType = clientType == null ? ClientType.UNKNOWN : clientType;
 
-        clientProperties.putProperty(RETRY_MODE, StringUtils.lowerCase(resolveRetryMode(config.get(RETRY_POLICY),
-                                                                                        config.get(RETRY_STRATEGY))));
         clientProperties.putProperty(INTERNAL_METADATA_MARKER, StringUtils.trimToEmpty(config.get(INTERNAL_USER_AGENT)));
         clientProperties.putProperty(IO, StringUtils.lowerCase(resolvedClientType.name()));
         clientProperties.putProperty(HTTP, SdkHttpUtils.urlEncode(clientName(resolvedClientType,

core/sdk-core/src/main/java/software/amazon/awssdk/core/client/config/SdkClientOption.java

@@ -33,6 +33,7 @@
 import software.amazon.awssdk.core.internal.useragent.SdkClientUserAgentProperties;
 import software.amazon.awssdk.core.retry.RetryMode;
 import software.amazon.awssdk.core.retry.RetryPolicy;
+import software.amazon.awssdk.core.useragent.BusinessMetricCollection;
 import software.amazon.awssdk.endpoints.EndpointProvider;
 import software.amazon.awssdk.http.SdkHttpClient;
 import software.amazon.awssdk.http.async.SdkAsyncHttpClient;
@@ -272,6 +273,14 @@ public final class SdkClientOption<T> extends ClientOption<T> {
      */
     public static final SdkClientOption<String> CLIENT_USER_AGENT = new SdkClientOption<>(String.class);
 
+    /**
+     * A user agent prefix that is specific to the client (agnostic of the request).
+     *
+     * Not currently in use, since the introduction of {@link SdkClientUserAgentProperties}
+     */
+    public static final SdkClientOption<BusinessMetricCollection> BUSINESS_METRICS =
+        new SdkClientOption<>(BusinessMetricCollection.class);
+
     /**
      * Option to specify the default retry mode.
      *

core/sdk-core/src/main/java/software/amazon/awssdk/core/interceptor/SdkInternalExecutionAttribute.java

@@ -26,6 +26,7 @@
 import software.amazon.awssdk.core.interceptor.trait.HttpChecksum;
 import software.amazon.awssdk.core.interceptor.trait.HttpChecksumRequired;
 import software.amazon.awssdk.core.internal.interceptor.trait.RequestCompression;
+import software.amazon.awssdk.core.useragent.BusinessMetricCollection;
 import software.amazon.awssdk.endpoints.Endpoint;
 import software.amazon.awssdk.endpoints.EndpointProvider;
 import software.amazon.awssdk.http.SdkHttpExecutionAttributes;
@@ -46,6 +47,12 @@ public final class SdkInternalExecutionAttribute extends SdkExecutionAttribute {
      */
     public static final ExecutionAttribute<Boolean> IS_FULL_DUPLEX = new ExecutionAttribute<>("IsFullDuplex");
 
+    /**
+     * A collection of business metrics feature ids.
+     */
+    public static final ExecutionAttribute<BusinessMetricCollection> BUSINESS_METRICS =
+        new ExecutionAttribute<>("BusinessMetricsCollection");
+
     /**
      * If true, indicates that this is an event streaming request being sent over RPC, and therefore the serialized
      * request object is encapsulated as an event of type {@code initial-request}.