Config description changes for aggregate and anomaly detector processors. #4829
Conversation
kkondaka
requested review from
chenqi0805,
engechas,
graytaylor0,
dinujoh,
KarstenSchnitter,
dlvenable and
oeyh
as code owners
kkondaka
force-pushed
the
config-desc-changes
branch
2 times, most recently
from
c7f8f27
to
a487dbc
Compare
Signed-off-by: Krishna Kondaka <[email protected]>
Signed-off-by: Krishna Kondaka <[email protected]>
…ector processors Signed-off-by: Krishna Kondaka <[email protected]>
kkondaka
force-pushed
the
config-desc-changes
branch
from
a487dbc
to
dab40a2
Compare
| @JsonProperty("aggregated_events_tag") | ||
| private String aggregatedEventsTag; | ||
|
|
||
| @JsonPropertyDescription("A [conditional expression](https://opensearch.org/docs/latest/data-prepper/pipelines/expression-syntax/), " + |
There was a problem hiding this comment.
This copied the markdown string conditional expression
| @JsonProperty("end_time_key") | ||
| String endTimeKey = DEFAULT_END_TIME_KEY; | ||
|
|
||
| @JsonPropertyDescription("Format of the aggregated event.otel_metrics: Default output format. Outputs in OTel metrics SUM type with count as value.raw - Generates a JSON object with the count_key field as a count value and the start_time_key field with aggregation start time as value.") |
There was a problem hiding this comment.
This description is a little confusing. Why the combination of event.otel_metrics, and value.raw? Also there is a typo in OTel with caps
There was a problem hiding this comment.
This is directly copied from https://opensearch.org/docs/latest/data-prepper/pipelines/configuration/processors/aggregate/. But there is some ambiguity here due to formatting. I will fix it.
| @JsonProperty("key") | ||
| @NotNull | ||
| String key; | ||
|
|
||
| @JsonPropertyDescription("The units for the values in the key.") |
There was a problem hiding this comment.
It can be anything. It is the name of the units. It could be "bytes", "MB" and so on.
| @JsonProperty("buckets") | ||
| @NotNull | ||
| List<Number> buckets; | ||
|
|
||
| @JsonPropertyDescription("Format of the aggregated event.otel_metrics: Default output format. Outputs in OTel metrics SUM type with count as value.raw - Generates a JSON object with the count_key field as a count value and the start_time_key field with aggregation start time as value.") |
| import jakarta.validation.constraints.AssertTrue; | ||
|
|
||
| public class PercentSamplerAggregateActionConfig { | ||
| @JsonPropertyDescription("Percent value of the sampling to be done.") |
There was a problem hiding this comment.
Should mention this must be greater than 0.0 and less than 100.0
| import jakarta.validation.constraints.NotNull; | ||
| import jakarta.validation.constraints.AssertTrue; | ||
|
|
||
| import java.time.Duration; | ||
|
|
||
| public class TailSamplerAggregateActionConfig { | ||
| @JsonPropertyDescription("period to wait before considering that a trace event is complete") |
There was a problem hiding this comment.
Should capitalize the first letter on all of these
| @JsonProperty("percent") | ||
| @NotNull | ||
| private Integer percent; | ||
|
|
||
| @JsonPropertyDescription("condition that determines if an event is error event or not") |
There was a problem hiding this comment.
Should link to the expression documentation and be clear if this is a Data Prepper conditional expression
| @JsonProperty("wait_period") | ||
| @NotNull | ||
| private Duration waitPeriod; | ||
|
|
||
| @JsonPropertyDescription("percent value to use for sampling non error events.") |
There was a problem hiding this comment.
Should mention this is Integer between 0 and 100 as there is another percent parameter with double.
| @@ -25,22 +26,27 @@ public class RandomCutForestModeConfig { | |||
|
|
|||
| public static final String VERSION_1_0 = "1.0"; | |||
|
|
|||
| @JsonPropertyDescription("The algorithm version number.") | |||
There was a problem hiding this comment.
Might be nice to mention the default of all of these in the JsonPropertyDescription
Signed-off-by: Krishna Kondaka <[email protected]>
Signed-off-by: Krishna Kondaka <[email protected]>
Description
Config description changes for aggregate and anomaly detector processors.
Issues Resolved
Resolves #[Issue number to be closed when this PR is merged]
Check List
By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.
For more information on following Developer Certificate of Origin and signing off your commits, please check here.