Add tests

Author: varunnvs92

core/metrics-spi/pom.xml

@@ -11,6 +11,9 @@
 
     <artifactId>metrics-spi</artifactId>
     <name>AWS Java SDK :: Metrics SPI</name>
+    <description> This is the base module for SDK metrics feature. It contains the interfaces used for metrics feature
+        that are used by other modules in the library.
+    </description>
 
     <dependencies>
         <dependency>
@@ -54,11 +57,6 @@
             <artifactId>mockito-core</artifactId>
             <scope>test</scope>
         </dependency>
-        <dependency>
-            <groupId>software.amazon.awssdk</groupId>
-            <artifactId>utils</artifactId>
-            <version>2.2.1-SNAPSHOT</version>
-        </dependency>
     </dependencies>
 
 

core/metrics-spi/src/main/java/software/amazon/awssdk/metrics/MetricCategory.java

@@ -16,24 +16,43 @@
 package software.amazon.awssdk.metrics;
 
 import software.amazon.awssdk.annotations.SdkPublicApi;
+import software.amazon.awssdk.metrics.internal.SdkMetric;
 
 /**
  * A enum class representing the different types of metric categories in the SDK.
  *
  * A metric can be tagged with multiple categories. Clients can enable/disable metric collection
- * at {@link MetricCategory} level.
+ * at a {@link MetricCategory} level.
+ *
+ * @see SdkMetric
  */
 @SdkPublicApi
 public enum MetricCategory {
-    None("none"),
 
-    Default("default"),
+    /**
+     * All metrics defined by the SDK are classified under this category at a minimum. If the metrics feature is enabled
+     * but the category to collect is not, only metrics that are classified under this category are collected by the SDK
+     */
+    DEFAULT("default"),
 
-    HttpClient("httpclient"),
+    /**
+     * Metrics collected at the http client level are classified under this category.
+     */
+    HTTP_CLIENT("httpclient"),
 
-    Streaming("streaming"),
+    /**
+     * Metrics specific to streaming, eventStream APIs are classified under this category.
+     */
+    STREAMING("streaming"),
 
-    All("all")
+    /**
+     * This is an umbrella category (provided for convenience) that records metrics belonging to every category
+     * defined in this enum. Clients who wish to collect lot of SDK metrics data should use this.
+     *
+     * Note: Enabling this option is verbose and can be expensive based on the platform the metrics are uploaded to.
+     * Please make sure you need all this data before using this category.
+     */
+    ALL("all")
 
     ;
 

core/metrics-spi/src/main/java/software/amazon/awssdk/metrics/internal/MetricSystemSetting.java

@@ -26,18 +26,19 @@
 public enum MetricSystemSetting implements SystemSetting {
 
     /**
-     * Enable the Java SDK Metrics by setting this property.
-     *
-     * Metrics feature is disabled if this feature is not specified or specified to anything other than "true"
+     * Enable the Java SDK Metrics by setting this property. Metrics feature is disabled if this feature is not specified or
+     * specified to anything other than "true"
      */
     AWS_JAVA_SDK_METRICS_ENABLED("aws.javasdk2x.metrics.enabled", null),
 
     /**
      * Specify comma separated {@link MetricCategory} values to enable the categories for metrics collection.
      * Only metrics belonging to these categories are collected by the SDK.
      *
-     * This value is defaulted to {@link MetricCategory#Default}. If this property is not set but metrics are enabled,
-     * then metrics belonging to {@link MetricCategory#Default} category are collected.
+     * <p>
+     * This value is defaulted to {@link MetricCategory#DEFAULT}. If this property is not set but metrics are enabled,
+     * then metrics belonging to {@link MetricCategory#DEFAULT} category are collected.
+     * </p>
      */
     AWS_JAVA_SDK_METRICS_CATEGORY("aws.javasdk2x.metrics.category", "Default")
 

core/metrics-spi/src/main/java/software/amazon/awssdk/metrics/SdkMetrics.java renamed to core/metrics-spi/src/main/java/software/amazon/awssdk/metrics/internal/SdkMetric.java

@@ -13,96 +13,100 @@
  * permissions and limitations under the License.
  */
 
-package software.amazon.awssdk.metrics;
+package software.amazon.awssdk.metrics.internal;
+
+import static software.amazon.awssdk.metrics.MetricCategory.DEFAULT;
+import static software.amazon.awssdk.metrics.MetricCategory.HTTP_CLIENT;
 
 import java.util.Arrays;
 import java.util.Collections;
 import java.util.HashSet;
 import java.util.Set;
-import software.amazon.awssdk.annotations.SdkProtectedApi;
+import software.amazon.awssdk.annotations.SdkInternalApi;
+import software.amazon.awssdk.metrics.MetricCategory;
 import software.amazon.awssdk.metrics.meter.Metric;
 
 /**
  * A enum representing the metrics supported by the SDK. All metrics collected by the SDK will be declared in this
  * enum class along with the metric's corresponding {@link MetricCategory}.
  */
 // TODO List is not complete
-@SdkProtectedApi
-public enum SdkMetrics implements Metric {
+@SdkInternalApi
+public enum SdkMetric implements Metric {
 
     /**
      * Service ID of the AWS service that the API request is made against
      */
-    Service("Service", MetricCategory.Default),
+    Service("Service", DEFAULT),
 
     /**
      * The name of the AWS operation the request is made to
      */
-    Api("Api", MetricCategory.Default),
+    Operation("Operation", DEFAULT),
 
     /**
      * The total time taken to finish (success or fail) a request (inclusive of all retries)
      */
-    ApiCallLatency("ApiCallLatency", MetricCategory.Default),
+    ApiCallLatency("ApiCallLatency", DEFAULT),
 
     /**
      * The time taken to marshall the request
      */
-    MarshallingLatency("MarshallingLatency", MetricCategory.Default),
+    MarshallingLatency("MarshallingLatency", DEFAULT),
 
     /**
      * Total number of attempts that were made by the service client to fulfill this request before succeeding or failing.
      * (This value would be 1 if there are no retries)
      */
-    ApiCallAttemptCount("ApiCallAttemptCount", MetricCategory.Default),
+    ApiCallAttemptCount("ApiCallAttemptCount", DEFAULT),
 
     /**
      * The time taken to sign the request
      */
-    SigningLatency("SigningLatency", MetricCategory.Default),
+    SigningLatency("SigningLatency", DEFAULT),
 
     /**
-     * The time taken by the underlying http client to start the Api call attempt and return the response
+     * The time taken by the underlying http client to start the Operation call attempt and return the response
      */
-    HttpRequestRoundTripLatency("HttpRequestRoundTripLatency", MetricCategory.Default),
+    HttpRequestRoundTripLatency("HttpRequestRoundTripLatency", DEFAULT),
 
     /**
      * The time taken to unmarshall the response (either successful and failed response)
      */
-    UnmarshallingLatency("UnmarshallingLatency", MetricCategory.Default),
+    UnmarshallingLatency("UnmarshallingLatency", DEFAULT),
 
     /**
-     * The total time taken for an Api call attempt
+     * The total time taken for an Operation call attempt
      */
-    ApiCallAttemptLatency("ApiCallAttemptLatency", MetricCategory.Default),
+    ApiCallAttemptLatency("ApiCallAttemptLatency", DEFAULT),
 
     /**
      * The http status code returned in the response
      */
-    HttpStatusCode("HttpStatusCode", MetricCategory.Default),
+    HttpStatusCode("HttpStatusCode", DEFAULT),
 
     /**
      * The request Id for the request. Represented by x-amz-request-id header in response
      */
-    AwsRequestId("AwsRequestId", MetricCategory.Default),
+    AwsRequestId("AwsRequestId", DEFAULT),
 
     /**
      * The extended request Id for the request. Represented by x-amz-id-2 header in response
      */
-    ExtendedRequestId("ExtendedRequestId", MetricCategory.Default),
+    ExtendedRequestId("ExtendedRequestId", DEFAULT),
 
     /**
      * Maximum number of streams allowed on a http2 connection
      */
-    MaxStreamCount("MaxStreamCount", MetricCategory.Default, MetricCategory.HttpClient)
+    MaxStreamCount("MaxStreamCount", DEFAULT, HTTP_CLIENT)
 
     ;
 
     private final String value;
 
     private final Set<MetricCategory> categories;
 
-    SdkMetrics(String value, MetricCategory... categories) {
+    SdkMetric(String value, MetricCategory... categories) {
         this.value = value;
         this.categories = Collections.unmodifiableSet(new HashSet<>(Arrays.asList(categories)));
     }

core/metrics-spi/src/main/java/software/amazon/awssdk/metrics/meter/DefaultGauge.java

@@ -21,7 +21,6 @@
 import java.util.concurrent.atomic.AtomicReference;
 import software.amazon.awssdk.annotations.SdkPublicApi;
 import software.amazon.awssdk.metrics.MetricCategory;
-import software.amazon.awssdk.utils.Validate;
 
 /**
  * A basic implementation of {@link Gauge} that has ability to set, update and return a single value.
@@ -35,7 +34,6 @@ public final class DefaultGauge<TypeT> implements Gauge<TypeT> {
     private final Set<MetricCategory> categories;
 
     private DefaultGauge(Builder<TypeT> builder) {
-        Validate.notNull(builder.value, "Value cannot be null");
         this.atomicReference = new AtomicReference<>(builder.value);
         this.categories = Collections.unmodifiableSet(builder.categories);
     }

core/metrics-spi/src/main/java/software/amazon/awssdk/metrics/meter/DefaultTimer.java

@@ -76,6 +76,16 @@ public <T> T record(Callable<T> task) {
         }
     }
 
+    @Override
+    public void start() {
+        startTime = clock.instant();
+    }
+
+    @Override
+    public void end() {
+        endTime = clock.instant();
+    }
+
     @Override
     public Instant startTime() {
         return startTime;
@@ -126,7 +136,7 @@ private Builder() {
         /**
          * Sets the {@link Clock} implementation the timer should use. The default value is {@link Clock#systemUTC()}
          *
-         * @param clock the {@link Clock} implementation used by the time
+         * @param clock the {@link Clock} implementation used by the timer
          * @return This object for method chaining
          */
         Builder clock(Clock clock) {

core/metrics-spi/src/main/java/software/amazon/awssdk/metrics/meter/NoOpTimer.java

@@ -27,13 +27,12 @@
  * Always returns {@link Duration#ZERO} as the total duration.
  */
 @SdkPublicApi
-public enum  NoOpTimer implements Timer {
+public enum NoOpTimer implements Timer {
     /** Singleton instance **/
     INSTANCE;
 
     @Override
     public void record(long duration, TimeUnit timeUnit) {
-
     }
 
     @Override
@@ -50,6 +49,14 @@ public <T> T record(Callable<T> task) {
         }
     }
 
+    @Override
+    public void start() {
+    }
+
+    @Override
+    public void end() {
+    }
+
     @Override
     public Instant startTime() {
         return Instant.now();