Fix javadocs

aws · Jun 7, 2021 · a4736b3 · a4736b3
1 parent 730c248
commit a4736b3
Showing 1 changed file with 10 additions and 1 deletion.
diff --git a/.../java/software/amazon/awssdk/metrics/publishers/cloudwatch/CloudWatchMetricPublisher.java b/.../java/software/amazon/awssdk/metrics/publishers/cloudwatch/CloudWatchMetricPublisher.java
@@ -42,6 +42,7 @@
 import software.amazon.awssdk.annotations.Immutable;
 import software.amazon.awssdk.annotations.SdkPublicApi;
 import software.amazon.awssdk.annotations.ThreadSafe;
+import software.amazon.awssdk.core.client.config.ClientOverrideConfiguration;
 import software.amazon.awssdk.core.metrics.CoreMetric;
 import software.amazon.awssdk.metrics.MetricCategory;
 import software.amazon.awssdk.metrics.MetricCollection;
@@ -91,8 +92,16 @@
  *
  * <p><b>Configuring AWS SDK clients to upload client metrics</b>
  *
- * TODO
+ * <p>
+ * Create a {@link CloudWatchMetricPublisher}, and configure it via
+ * {@link ClientOverrideConfiguration.Builder#addMetricPublisher(MetricPublisher)}
  *
+ * <pre>
+ *     CloudWatchMetricPublisher cloudWatchMetricPublisher = CloudWatchMetricPublisher.create();
+ *     S3Client s3 = S3Client.builder()
+ *                           .overrideConfiguration(o -> o.addMetricPublisher(cloudWatchMetricPublisher))
+ *                           .build();
+ * </pre>
  * <p><b>Uploading your own custom metrics</b>
  *
  * <i>Step 1: Define which metrics you wish to collect</i>