MAINT: backfill doc in json property description for otel_metrics (op…

…ensearch-project#4722) * MAINT: backfill doc in json property description for otel_metrics Signed-off-by: George Chen <[email protected]>
JannikBrand · Jul 13, 2024 · a988177 · a988177
1 parent b1300c3
commit a988177
Showing 1 changed file with 6 additions and 0 deletions.
diff --git a/...g/opensearch/dataprepper/plugins/processor/otelmetrics/OtelMetricsRawProcessorConfig.java b/...g/opensearch/dataprepper/plugins/processor/otelmetrics/OtelMetricsRawProcessorConfig.java
@@ -6,17 +6,23 @@
 package org.opensearch.dataprepper.plugins.processor.otelmetrics;
 
 import static org.opensearch.dataprepper.plugins.otel.codec.OTelProtoCodec.DEFAULT_EXPONENTIAL_HISTOGRAM_MAX_ALLOWED_SCALE;
+
 import com.fasterxml.jackson.annotation.JsonProperty;
+import com.fasterxml.jackson.annotation.JsonPropertyDescription;
 
 public class OtelMetricsRawProcessorConfig {
 
     @JsonProperty("flatten_attributes")
+    @JsonPropertyDescription("Whether or not to flatten the `attributes` field in the JSON data.")
     boolean flattenAttributesFlag = true;
 
+    @JsonPropertyDescription("Whether or not to calculate histogram buckets.")
     private Boolean calculateHistogramBuckets = true;
 
+    @JsonPropertyDescription("Whether or not to calculate exponential histogram buckets.")
     private Boolean calculateExponentialHistogramBuckets = true;
 
+    @JsonPropertyDescription("Maximum allowed scale in exponential histogram calculation.")
     private Integer exponentialHistogramMaxAllowedScale = DEFAULT_EXPONENTIAL_HISTOGRAM_MAX_ALLOWED_SCALE;
 
     public Boolean getCalculateExponentialHistogramBuckets() {