diff --git a/data-prepper-plugins/aggregate-processor/src/main/java/org/opensearch/dataprepper/plugins/processor/aggregate/AggregateProcessorConfig.java b/data-prepper-plugins/aggregate-processor/src/main/java/org/opensearch/dataprepper/plugins/processor/aggregate/AggregateProcessorConfig.java index e1522b23ed..3f7fedb539 100644 --- a/data-prepper-plugins/aggregate-processor/src/main/java/org/opensearch/dataprepper/plugins/processor/aggregate/AggregateProcessorConfig.java +++ b/data-prepper-plugins/aggregate-processor/src/main/java/org/opensearch/dataprepper/plugins/processor/aggregate/AggregateProcessorConfig.java @@ -31,7 +31,7 @@ public class AggregateProcessorConfig { @JsonPropertyDescription("An unordered list by which to group events. Events with the same values as these keys are put into the same group. " + "If an event does not contain one of the identification_keys, then the value of that key is considered to be equal to null. " + - "At least one identification_key is required. An example configuration is [\"sourceIp\", \"destinationIp\", \"port\"].") + "At least one identification_key is required.") @JsonProperty("identification_keys") @NotEmpty @ExampleValues({ diff --git a/data-prepper-plugins/anomaly-detector-processor/src/main/java/org/opensearch/dataprepper/plugins/processor/anomalydetector/AnomalyDetectorProcessorConfig.java b/data-prepper-plugins/anomaly-detector-processor/src/main/java/org/opensearch/dataprepper/plugins/processor/anomalydetector/AnomalyDetectorProcessorConfig.java index 578e22a351..a8c45316ea 100644 --- a/data-prepper-plugins/anomaly-detector-processor/src/main/java/org/opensearch/dataprepper/plugins/processor/anomalydetector/AnomalyDetectorProcessorConfig.java +++ b/data-prepper-plugins/anomaly-detector-processor/src/main/java/org/opensearch/dataprepper/plugins/processor/anomalydetector/AnomalyDetectorProcessorConfig.java @@ -34,7 +34,7 @@ public class AnomalyDetectorProcessorConfig { @UsesDataPrepperPlugin(pluginType = AnomalyDetectorMode.class) private PluginModel detectorMode; - @JsonPropertyDescription("If provided, anomalies will be detected within each unique instance of these keys. For example, if you provide the ip field, anomalies will be detected separately for each unique IP address.") + @JsonPropertyDescription("If provided, anomalies will be detected within each unique instance of these keys. For example, if you provide the IP field, anomalies will be detected separately for each unique IP address.") @JsonProperty("identification_keys") @ExampleValues({ @Example(value = "ip_address", description = "Anomalies will be detected separately for each unique IP address from the existing ip_address key of the Event.") diff --git a/data-prepper-plugins/anomaly-detector-processor/src/main/java/org/opensearch/dataprepper/plugins/processor/anomalydetector/modes/RandomCutForestModeConfig.java b/data-prepper-plugins/anomaly-detector-processor/src/main/java/org/opensearch/dataprepper/plugins/processor/anomalydetector/modes/RandomCutForestModeConfig.java index 74c90fca50..46657946d4 100644 --- a/data-prepper-plugins/anomaly-detector-processor/src/main/java/org/opensearch/dataprepper/plugins/processor/anomalydetector/modes/RandomCutForestModeConfig.java +++ b/data-prepper-plugins/anomaly-detector-processor/src/main/java/org/opensearch/dataprepper/plugins/processor/anomalydetector/modes/RandomCutForestModeConfig.java @@ -51,7 +51,7 @@ public class RandomCutForestModeConfig { @JsonProperty(value = "time_decay", defaultValue = "" + DEFAULT_TIME_DECAY) private double timeDecay = DEFAULT_TIME_DECAY; - @JsonPropertyDescription("Output after indicates the number of events to consume before outputting anomalies. Default is 32.") + @JsonPropertyDescription("The number of events to train the model before generating an anomaly event. Default is 32.") @JsonProperty(value = "output_after", defaultValue = "" + DEFAULT_OUTPUT_AFTER) private int outputAfter = DEFAULT_OUTPUT_AFTER; diff --git a/data-prepper-plugins/aws-lambda/src/main/java/org/opensearch/dataprepper/plugins/lambda/processor/LambdaProcessorConfig.java b/data-prepper-plugins/aws-lambda/src/main/java/org/opensearch/dataprepper/plugins/lambda/processor/LambdaProcessorConfig.java index c9675ed931..49b35ebf08 100644 --- a/data-prepper-plugins/aws-lambda/src/main/java/org/opensearch/dataprepper/plugins/lambda/processor/LambdaProcessorConfig.java +++ b/data-prepper-plugins/aws-lambda/src/main/java/org/opensearch/dataprepper/plugins/lambda/processor/LambdaProcessorConfig.java @@ -17,7 +17,7 @@ import org.opensearch.dataprepper.plugins.lambda.common.config.LambdaCommonConfig; @JsonPropertyOrder -@JsonClassDescription("The aws_lambda processor enables invocation of an AWS Lambda function within your Data Prepper pipeline in order to process events." + +@JsonClassDescription("The aws_lambda processor enables invocation of an AWS Lambda function within your pipeline in order to process events. " + "It supports both synchronous and asynchronous invocations based on your use case.") public class LambdaProcessorConfig extends LambdaCommonConfig { static final String DEFAULT_INVOCATION_TYPE = "request-response"; @@ -40,7 +40,7 @@ public class LambdaProcessorConfig extends LambdaCommonConfig { @JsonPropertyDescription("Defines a condition for event to use this processor.") @ExampleValues({ - @Example(value = "event['status'] == 'process'", description = "The processor will only run on this condition.") + @Example(value = "/some_key == null", description = "The processor will only run on events where this condition evaluates to true.") }) @JsonProperty("lambda_when") private String whenCondition; diff --git a/data-prepper-plugins/date-processor/src/main/java/org/opensearch/dataprepper/plugins/processor/date/DateProcessorConfig.java b/data-prepper-plugins/date-processor/src/main/java/org/opensearch/dataprepper/plugins/processor/date/DateProcessorConfig.java index 2e3114d979..05deb5aa07 100644 --- a/data-prepper-plugins/date-processor/src/main/java/org/opensearch/dataprepper/plugins/processor/date/DateProcessorConfig.java +++ b/data-prepper-plugins/date-processor/src/main/java/org/opensearch/dataprepper/plugins/processor/date/DateProcessorConfig.java @@ -10,6 +10,7 @@ import com.fasterxml.jackson.annotation.JsonProperty; import com.fasterxml.jackson.annotation.JsonPropertyDescription; import com.fasterxml.jackson.annotation.JsonPropertyOrder; +import com.fasterxml.jackson.annotation.JsonAlias; import jakarta.validation.constraints.AssertTrue; import org.opensearch.dataprepper.model.annotations.AlsoRequired; import org.opensearch.dataprepper.model.annotations.ConditionalRequired; @@ -133,8 +134,7 @@ public static boolean isValidPattern(final String pattern) { private Boolean fromTimeReceived = DEFAULT_FROM_TIME_RECEIVED; @JsonProperty("match") - @JsonPropertyDescription("The date match configuration. " + - "This option cannot be defined at the same time as from_time_received. " + + @JsonPropertyDescription("This option cannot be defined at the same time as from_time_received. " + "The date processor will use the first pattern that matches each event's timestamp field. " + "You must provide at least one pattern unless you have from_time_received.") @AlsoRequired(values = { @@ -155,9 +155,11 @@ public static boolean isValidPattern(final String pattern) { }) private String outputFormat = DEFAULT_OUTPUT_FORMAT; - @JsonProperty("to_origination_metadata") - @JsonPropertyDescription("When true, the matched time is also added to the event's metadata as an instance of " + - "Instant. Default is false.") + @JsonProperty("origination_timestamp_to_metadata") + @JsonAlias("to_origination_metadata") + @JsonPropertyDescription("Include the origination timestamp in the metadata. " + + "Enabling this option will use this timestamp to report the EndToEndLatency metric " + + "when events reach the sink. Default is false.") private Boolean toOriginationMetadata = DEFAULT_TO_ORIGINATION_METADATA; @JsonProperty("source_timezone") @@ -187,7 +189,7 @@ public static boolean isValidPattern(final String pattern) { "or a string representation of the " + "locale object, such as en_US. " + "A full list of locale fields, including language, country, and variant, can be found " + - "here." + + "here. " + "Default is Locale.ROOT.") @ExampleValues({ @Example("en-US"), @@ -196,10 +198,10 @@ public static boolean isValidPattern(final String pattern) { private String locale; @JsonProperty("date_when") - @JsonPropertyDescription("Specifies under what condition the date processor should perform matching. " + + @JsonPropertyDescription("Specifies under what condition the date processor should run. " + "Default is no condition.") @ExampleValues({ - @Example(value = "/some_key == null", description = "Only runs the date processor on the Event if some_key is null or doesn't exist.") + @Example(value = "/some_key == null", description = "The processor will only run on events where this condition evaluates to true.") }) private String dateWhen; diff --git a/data-prepper-plugins/drop-events-processor/src/main/java/org/opensearch/dataprepper/plugins/processor/drop/DropEventProcessorConfig.java b/data-prepper-plugins/drop-events-processor/src/main/java/org/opensearch/dataprepper/plugins/processor/drop/DropEventProcessorConfig.java index dbf1e9b63d..29e5de133d 100644 --- a/data-prepper-plugins/drop-events-processor/src/main/java/org/opensearch/dataprepper/plugins/processor/drop/DropEventProcessorConfig.java +++ b/data-prepper-plugins/drop-events-processor/src/main/java/org/opensearch/dataprepper/plugins/processor/drop/DropEventProcessorConfig.java @@ -27,7 +27,7 @@ public class DropEventProcessorConfig { }) private String dropWhen; - @JsonPropertyDescription("Specifies how exceptions are handled when an exception occurs while evaluating an event. Default value is skip, which drops the event so that it is not sent to further processors or sinks.") + @JsonPropertyDescription("Specifies how exceptions are handled when an exception occurs while evaluating an event. Default value is skip, which sends the events to further processors or sinks.") @JsonProperty(value = "handle_failed_events", defaultValue = "skip") private HandleFailedEventsOption handleFailedEventsOption = HandleFailedEventsOption.SKIP; diff --git a/data-prepper-plugins/flatten-processor/src/main/java/org/opensearch/dataprepper/plugins/processor/flatten/FlattenProcessorConfig.java b/data-prepper-plugins/flatten-processor/src/main/java/org/opensearch/dataprepper/plugins/processor/flatten/FlattenProcessorConfig.java index e5f4cb5c1b..747eeb4ab5 100644 --- a/data-prepper-plugins/flatten-processor/src/main/java/org/opensearch/dataprepper/plugins/processor/flatten/FlattenProcessorConfig.java +++ b/data-prepper-plugins/flatten-processor/src/main/java/org/opensearch/dataprepper/plugins/processor/flatten/FlattenProcessorConfig.java @@ -7,9 +7,9 @@ import com.fasterxml.jackson.annotation.JsonClassDescription; import com.fasterxml.jackson.annotation.JsonProperty; - import com.fasterxml.jackson.annotation.JsonPropertyDescription; import com.fasterxml.jackson.annotation.JsonPropertyOrder; +import com.fasterxml.jackson.annotation.JsonAlias; import jakarta.validation.constraints.AssertTrue; import jakarta.validation.constraints.NotNull; import org.opensearch.dataprepper.model.annotations.ExampleValues; @@ -20,7 +20,7 @@ import java.util.List; @JsonPropertyOrder -@JsonClassDescription("The flatten processor transforms nested objects inside of events into flattened structures.") +@JsonClassDescription("The flatten processor transforms nested objects inside of events into flattened structures.") public class FlattenProcessorConfig { static final String REMOVE_LIST_INDICES_KEY = "remove_list_indices"; @@ -44,12 +44,14 @@ public class FlattenProcessorConfig { }) private String target; - @JsonProperty("remove_processed_fields") + @JsonProperty("remove_source_keys") + @JsonAlias("remove_processed_fields") @JsonPropertyDescription("When true, the processor removes all processed fields from the source. " + "The default is false which leaves the source fields.") private boolean removeProcessedFields = false; - @JsonProperty(REMOVE_LIST_INDICES_KEY) + @JsonProperty("remove_list_elements") + @JsonAlias(REMOVE_LIST_INDICES_KEY) @JsonPropertyDescription("When true, the processor converts the fields from the source map into lists and " + "puts the lists into the target field. Default is false.") private boolean removeListIndices = false; diff --git a/data-prepper-plugins/key-value-processor/src/main/java/org/opensearch/dataprepper/plugins/processor/keyvalue/KeyValueProcessorConfig.java b/data-prepper-plugins/key-value-processor/src/main/java/org/opensearch/dataprepper/plugins/processor/keyvalue/KeyValueProcessorConfig.java index 501dbb9d54..cfc1804a30 100644 --- a/data-prepper-plugins/key-value-processor/src/main/java/org/opensearch/dataprepper/plugins/processor/keyvalue/KeyValueProcessorConfig.java +++ b/data-prepper-plugins/key-value-processor/src/main/java/org/opensearch/dataprepper/plugins/processor/keyvalue/KeyValueProcessorConfig.java @@ -195,8 +195,7 @@ public class KeyValueProcessorConfig { "If this flag is enabled, then the content between the delimiters is considered to be one entity and " + "they are not parsed as key-value pairs. The following characters are used a group delimiters: " + "{...}, [...], <...>, (...), \"...\", '...', http://... (space), and https:// (space). " + - "Default is false. For example, if value_grouping is true, then " + - "{\"key1=[a=b,c=d]&key2=value2\"} parses to {\"key1\": \"[a=b,c=d]\", \"key2\": \"value2\"}.") + "Default is false.") @AlsoRequired(values = { @AlsoRequired.Required(name = FIELD_DELIMITER_REGEX_KEY, allowedValues = {"null"}) }) diff --git a/data-prepper-plugins/mutate-event-processors/src/main/java/org/opensearch/dataprepper/plugins/processor/mutateevent/AddEntryProcessorConfig.java b/data-prepper-plugins/mutate-event-processors/src/main/java/org/opensearch/dataprepper/plugins/processor/mutateevent/AddEntryProcessorConfig.java index 5529428ecb..cf46fc13ae 100644 --- a/data-prepper-plugins/mutate-event-processors/src/main/java/org/opensearch/dataprepper/plugins/processor/mutateevent/AddEntryProcessorConfig.java +++ b/data-prepper-plugins/mutate-event-processors/src/main/java/org/opensearch/dataprepper/plugins/processor/mutateevent/AddEntryProcessorConfig.java @@ -66,7 +66,7 @@ public class AddEntryProcessorConfig { public static class Entry { @JsonPropertyDescription("The key of the new entry to be added. Some examples of keys include my_key, " + "myKey, and object/sub_Key. The key can also be a format expression, for example, ${/key1} to " + - "use the value of field key1 as the key. Either one of key or metadata_key is required.") + "use the value of field key1 as the key. Exactly one of key or metadata_key is required.") @AlsoRequired(values = { @AlsoRequired.Required(name=METADATA_KEY_KEY, allowedValues = {"null"}) }) @@ -79,7 +79,8 @@ public static class Entry { @JsonProperty(METADATA_KEY_KEY) @JsonPropertyDescription("The key for the new metadata attribute. The argument must be a literal string key " + - "and not a JSON Pointer. Either one of key or metadata_key is required.") + "and not a JSON Pointer. Adds an attribute to the Events that will not be sent to the sinks, but can be used for condition expressions and routing with the getMetadata function. " + + "Exactly one of key or metadata_key is required.") @AlsoRequired(values = { @AlsoRequired.Required(name="key", allowedValues = {"null"}) }) @@ -103,7 +104,7 @@ public static class Entry { private Object value; @JsonPropertyDescription("A format string to use as the value of the new entry, for example, " + - "${key1}-${key2}, where key1 and key2 are existing keys in the event. Required if neither" + + "${key1}-${key2}, where key1 and key2 are existing keys in the event. Required if neither " + "value nor value_expression is specified.") @AlsoRequired(values = { @AlsoRequired.Required(name="value", allowedValues = {"null"}), @@ -132,7 +133,7 @@ public static class Entry { @JsonProperty(OVERWRITE_IF_KEY_EXISTS_KEY) @JsonPropertyDescription("When set to true, the existing value is overwritten if key already exists " + - "in the event. The default value is false.") + "in the event. Only one of overwrite_if_key_exists or append_if_key_exists can be true. The default value is false.") @AlsoRequired(values = { @AlsoRequired.Required(name=APPEND_IF_KEY_EXISTS_KEY, allowedValues = {"false"}) }) diff --git a/data-prepper-plugins/mutate-event-processors/src/main/java/org/opensearch/dataprepper/plugins/processor/mutateevent/ConvertEntryTypeProcessorConfig.java b/data-prepper-plugins/mutate-event-processors/src/main/java/org/opensearch/dataprepper/plugins/processor/mutateevent/ConvertEntryTypeProcessorConfig.java index f184e02896..0d938792c1 100644 --- a/data-prepper-plugins/mutate-event-processors/src/main/java/org/opensearch/dataprepper/plugins/processor/mutateevent/ConvertEntryTypeProcessorConfig.java +++ b/data-prepper-plugins/mutate-event-processors/src/main/java/org/opensearch/dataprepper/plugins/processor/mutateevent/ConvertEntryTypeProcessorConfig.java @@ -9,6 +9,7 @@ import com.fasterxml.jackson.annotation.JsonProperty; import com.fasterxml.jackson.annotation.JsonPropertyOrder; import com.fasterxml.jackson.annotation.JsonPropertyDescription; +import com.fasterxml.jackson.annotation.JsonAlias; import org.opensearch.dataprepper.model.annotations.AlsoRequired; import org.opensearch.dataprepper.model.annotations.ConditionalRequired; import org.opensearch.dataprepper.model.annotations.ConditionalRequired.IfThenElse; @@ -55,7 +56,8 @@ public class ConvertEntryTypeProcessorConfig implements ConverterArguments { @JsonPropertyDescription("Target type for the values. Default value is integer.") private TargetType type = TargetType.INTEGER; - @JsonProperty("null_values") + @JsonProperty("null_conversion_values") + @JsonAlias("null_values") @JsonPropertyDescription("String representation of what constitutes a null value. If the field value equals one of these strings, then the value is considered null and is converted to null.") private List nullValues; diff --git a/data-prepper-plugins/mutate-event-processors/src/main/java/org/opensearch/dataprepper/plugins/processor/mutateevent/CopyValueProcessorConfig.java b/data-prepper-plugins/mutate-event-processors/src/main/java/org/opensearch/dataprepper/plugins/processor/mutateevent/CopyValueProcessorConfig.java index e44c1da74e..d0f991fc33 100644 --- a/data-prepper-plugins/mutate-event-processors/src/main/java/org/opensearch/dataprepper/plugins/processor/mutateevent/CopyValueProcessorConfig.java +++ b/data-prepper-plugins/mutate-event-processors/src/main/java/org/opensearch/dataprepper/plugins/processor/mutateevent/CopyValueProcessorConfig.java @@ -20,7 +20,7 @@ import java.util.List; @JsonPropertyOrder -@JsonClassDescription("The copy_values processor copies values within an event to other fields within the event.") +@JsonClassDescription("The copy_values processor copies values from an event to another key in an event.") public class CopyValueProcessorConfig { static final String FROM_LIST_KEY = "from_list"; static final String TO_LIST_KEY = "to_list"; @@ -30,15 +30,13 @@ public static class Entry { @NotEmpty @NotNull @JsonProperty("from_key") - @JsonPropertyDescription("The key of the entry to be copied. Either from_key and " + - "to_key or from_list and to_list must be defined.") + @JsonPropertyDescription("The key of the entry to be copied. This must be configured.") private String fromKey; @NotEmpty @NotNull @JsonProperty("to_key") - @JsonPropertyDescription("The key of the new entry to be added. Either from_key and " + - "to_key or from_list and to_list must be defined.") + @JsonPropertyDescription("The key of the new entry to be added. This must be configured.") private String toKey; @JsonProperty("overwrite_if_to_key_exists") @@ -88,16 +86,16 @@ public Entry() { private List entries; @JsonProperty(FROM_LIST_KEY) - @JsonPropertyDescription("The key of the list of objects to be copied. Either from_key and " + - "to_key or from_list and to_list must be defined.") + @JsonPropertyDescription("The key of the list of objects to be copied. " + + "Both from_key and to_key must be configured and will be applied on the corresponding list.") @AlsoRequired(values = { @AlsoRequired.Required(name = TO_LIST_KEY) }) private String fromList; @JsonProperty(TO_LIST_KEY) - @JsonPropertyDescription("The key of the new list to be added. Either from_key and " + - "to_key or from_list and to_list must be defined.") + @JsonPropertyDescription("The key of the new list to be added. " + + "Both from_key and to_key must be configured and will be applied on the corresponding list.") @AlsoRequired(values = { @AlsoRequired.Required(name = FROM_LIST_KEY) }) diff --git a/data-prepper-plugins/obfuscate-processor/src/main/java/org/opensearch/dataprepper/plugins/processor/obfuscation/ObfuscationProcessorConfig.java b/data-prepper-plugins/obfuscate-processor/src/main/java/org/opensearch/dataprepper/plugins/processor/obfuscation/ObfuscationProcessorConfig.java index fa0ddf355c..935d99c219 100644 --- a/data-prepper-plugins/obfuscate-processor/src/main/java/org/opensearch/dataprepper/plugins/processor/obfuscation/ObfuscationProcessorConfig.java +++ b/data-prepper-plugins/obfuscate-processor/src/main/java/org/opensearch/dataprepper/plugins/processor/obfuscation/ObfuscationProcessorConfig.java @@ -27,7 +27,7 @@ public class ObfuscationProcessorConfig { @JsonProperty("source") - @JsonPropertyDescription("The source field to obfuscate.") + @JsonPropertyDescription("The source key to obfuscate. Default action is to mask with *.") @NotEmpty @NotNull @ExampleValues({