Updated s3 sink metrics (opensearch-project#2888)

asifsmohammed · Jun 16, 2023 · 8e7114f · 8e7114f
1 parent c7bfc2e
commit 8e7114f
Show file tree

Hide file tree

Showing 2 changed files with 18 additions and 5 deletions.
diff --git a/data-prepper-plugins/s3-sink/README.md b/data-prepper-plugins/s3-sink/README.md
@@ -58,6 +58,19 @@ pipeline:
 
 - `buffer_type` (Optional) : Records stored temporary before flushing into s3 bucket. Possible values are `local_file` and `in_memory`. Defaults to `in_memory`.
 
+## Metrics
+
+### Counters
+
+* `s3SinkObjectsSucceeded` - The number of S3 objects that the S3 sink has successfully written to S3.
+* `s3SinkObjectsFailed` - The number of S3 objects that the S3 sink failed to write to S3.
+* `s3SinkObjectsEventsSucceeded` - The number of records that the S3 sink has successfully written to S3.
+* `s3SinkObjectsEventsFailed` - The number of records that the S3 sink has failed to write to S3.
+
+### Distribution Summaries
+
+* `s3SinkObjectSizeBytes` - Measures the distribution of the S3 request's payload size in bytes.
+
 
 ## Developer Guide
 

diff --git a/...-plugins/s3-sink/src/main/java/org/opensearch/dataprepper/plugins/sink/S3SinkService.java b/...-plugins/s3-sink/src/main/java/org/opensearch/dataprepper/plugins/sink/S3SinkService.java
@@ -35,11 +35,11 @@
 public class S3SinkService {
 
     private static final Logger LOG = LoggerFactory.getLogger(S3SinkService.class);
-    public static final String OBJECTS_SUCCEEDED = "s3ObjectsSucceeded";
-    public static final String OBJECTS_FAILED = "s3ObjectsFailed";
-    public static final String NUMBER_OF_RECORDS_FLUSHED_TO_S3_SUCCESS = "s3ObjectsEventsSucceeded";
-    public static final String NUMBER_OF_RECORDS_FLUSHED_TO_S3_FAILED = "s3ObjectsEventsFailed";
-    static final String S3_OBJECTS_SIZE = "s3ObjectSizeBytes";
+    public static final String OBJECTS_SUCCEEDED = "s3SinkObjectsSucceeded";
+    public static final String OBJECTS_FAILED = "s3SinkObjectsFailed";
+    public static final String NUMBER_OF_RECORDS_FLUSHED_TO_S3_SUCCESS = "s3SinkObjectsEventsSucceeded";
+    public static final String NUMBER_OF_RECORDS_FLUSHED_TO_S3_FAILED = "s3SinkObjectsEventsFailed";
+    static final String S3_OBJECTS_SIZE = "s3SinkObjectSizeBytes";
     private final S3SinkConfig s3SinkConfig;
     private final Lock reentrantLock;
     private final BufferFactory bufferFactory;