Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Example values for rename_keys, split_string, substitute_string, truncate #5130

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Example values for rename_keys, split_string, substitute_string, truncate #5130

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 8 additions & 3 deletions ...va/org/opensearch/dataprepper/plugins/processor/mutateevent/RenameKeyProcessorConfig.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,8 @@
import jakarta.validation.Valid;
import jakarta.validation.constraints.NotEmpty;
import jakarta.validation.constraints.NotNull;
import org.opensearch.dataprepper.model.annotations.ExampleValues;
import org.opensearch.dataprepper.model.annotations.ExampleValues.Example;
import org.opensearch.dataprepper.model.event.EventKey;
import org.opensearch.dataprepper.model.event.EventKeyConfiguration;
import org.opensearch.dataprepper.model.event.EventKeyFactory;
Expand Down Expand Up @@ -42,9 +44,12 @@ public static class Entry {
private boolean overwriteIfToKeyExists = false;

@JsonProperty("rename_when")
@JsonPropertyDescription("A <a href=\"https://opensearch.org/docs/latest/data-prepper/pipelines/expression-syntax/\">conditional expression</a>, " +
"such as <code>/some-key == \"test\"</code>, that will be evaluated to determine whether the processor will be " +
"run on the event. By default, all events will be processed unless otherwise stated.")
@JsonPropertyDescription("A <a href=\"https://opensearch.org/docs/latest/data-prepper/pipelines/expression-syntax/\">conditional expression</a> " +
"that will be evaluated to determine whether the processor will be run on the event. " +
"By default, all events will be processed if no condition is provided.")
@ExampleValues(
@Example(value = "startsWith(/path, \"https://\")", description = "Rename the string only if it starts with an HTTPS scheme.")
)
private String renameWhen;

public EventKey getFromKey() {
Expand Down
11 changes: 11 additions & 0 deletions ...org/opensearch/dataprepper/plugins/processor/mutatestring/SplitStringProcessorConfig.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,8 @@
import org.opensearch.dataprepper.model.annotations.ConditionalRequired;
import org.opensearch.dataprepper.model.annotations.ConditionalRequired.IfThenElse;
import org.opensearch.dataprepper.model.annotations.ConditionalRequired.SchemaProperty;
import org.opensearch.dataprepper.model.annotations.ExampleValues;
import org.opensearch.dataprepper.model.annotations.ExampleValues.Example;
import org.opensearch.dataprepper.model.event.EventKey;

import java.util.List;
Expand Down Expand Up @@ -51,6 +53,9 @@ public static class Entry {
@AlsoRequired(values = {
@AlsoRequired.Required(name=DELIMITER_REGEX_KEY, allowedValues = {"null", "\"\""})
})
@ExampleValues(
@Example(value = "/", description = "Split a file path.")
)
private String delimiter;

@JsonProperty("delimiter_regex")
Expand All @@ -59,11 +64,17 @@ public static class Entry {
@AlsoRequired(values = {
@AlsoRequired.Required(name="delimiter", allowedValues = {"null", "\"\""})
})
@ExampleValues(
@Example(value = "(file:///|/+)", description = "Split a file URI, treating multiple slashes as a single slash.")
)
private String delimiterRegex;

@JsonProperty("split_when")
@JsonPropertyDescription("Specifies under what condition the <code>split_string</code> processor should perform splitting. " +
"Default is no condition.")
@ExampleValues(
@Example(value = "startsWith(/path, \"file://\")", description = "Split a string only if it starts with the file URI scheme.")
)
private String splitWhen;

public EventKey getSource() {
Expand Down
15 changes: 12 additions & 3 deletions ...pensearch/dataprepper/plugins/processor/mutatestring/SubstituteStringProcessorConfig.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,8 @@
import com.fasterxml.jackson.annotation.JsonPropertyDescription;
import com.fasterxml.jackson.annotation.JsonPropertyOrder;
import jakarta.validation.constraints.NotNull;
import org.opensearch.dataprepper.model.annotations.ExampleValues;
import org.opensearch.dataprepper.model.annotations.ExampleValues.Example;
import org.opensearch.dataprepper.model.event.EventKey;

import java.util.List;
Expand All @@ -27,15 +29,22 @@ public static class Entry {
"be escaped using <code>\\\\</code> when using double quotes and <code>\\</code> when using single quotes. " +
"See <a href=\"https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/regex/Pattern.html\">Java Patterns</a> " +
"for more information.")
@ExampleValues({
@Example(value = "/+", description = "Matches at least one forward slash and can be used to normalize a path."),
@Example(value = "'[?&#=]'", description = "Matches some special characters common in URIs.")
})
private String from;

@JsonPropertyDescription("The string to be substituted for each match of <code>from</code>.")
private String to;

@JsonProperty("substitute_when")
@JsonPropertyDescription("A <a href=\"https://opensearch.org/docs/latest/data-prepper/pipelines/expression-syntax/\">conditional expression</a>, " +
"such as <code>/some-key == \"test\"</code>, that will be evaluated to determine whether the processor will be " +
"run on the event. By default, all events will be processed unless otherwise stated.")
@JsonPropertyDescription("A <a href=\"https://opensearch.org/docs/latest/data-prepper/pipelines/expression-syntax/\">conditional expression</a> " +
"that will be evaluated to determine whether the processor will be run on the event. " +
"By default, all events will be processed if no condition is provided.")
@ExampleValues(
@Example(value = "startsWith(/request_uri, \"https://\")", description = "Substitute on the string only if it starts with an HTTPS scheme.")
)
private String substituteWhen;

public EventKey getSource() {
Expand Down
9 changes: 7 additions & 2 deletions ...n/java/org/opensearch/dataprepper/plugins/processor/truncate/TruncateProcessorConfig.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,8 @@
import jakarta.validation.constraints.NotNull;
import jakarta.validation.constraints.AssertTrue;
import jakarta.validation.Valid;
import org.opensearch.dataprepper.model.annotations.ExampleValues;
import org.opensearch.dataprepper.model.annotations.ExampleValues.Example;

import java.util.List;

Expand Down Expand Up @@ -41,8 +43,11 @@ public static class Entry {
private Boolean recurse = false;

@JsonProperty("truncate_when")
@JsonPropertyDescription("A <a href=\"https://opensearch.org/docs/latest/data-prepper/pipelines/expression-syntax/\">conditional expression</a> such as <code>/test != false</code>. " +
"If specified, the <code>truncate</code> processor will only run on events when the expression evaluates to true. ")
@JsonPropertyDescription("A <a href=\"https://opensearch.org/docs/latest/data-prepper/pipelines/expression-syntax/\">conditional expression</a>. " +
"If specified, the <code>truncate</code> processor will only run on events when the expression evaluates to true.")
@ExampleValues(
@Example(value = "length(/node_name) > 10", description = "Truncate if the value of node_name is greater than 10 characters.")
)
private String truncateWhen;

public Entry(final List<String> sourceKeys, final Integer startAt, final Integer length, final String truncateWhen, final Boolean recurse) {
Expand Down
Loading