Documentation improvements for a number of Data Prepper processors. #5023
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Updates some enumerations used in processors to support the @JsonValue. Corrects @JsonClassDescription to use HTML rather than Markdown. Signed-off-by: David Venable <[email protected]>
dlvenable
requested review from
chenqi0805,
engechas,
graytaylor0,
dinujoh,
kkondaka,
KarstenSchnitter and
oeyh
as code owners
graytaylor0
reviewed
Oct 4, 2024
| @JsonProperty("drop_when") | ||
| @NotEmpty | ||
| private String dropWhen; | ||
|
|
||
| @JsonPropertyDescription("Specifies how exceptions are handled when an exception occurs while evaluating an event. Default value is 'drop', which drops the event so that it is not sent to OpenSearch. Available options are 'drop', 'drop_silently', 'skip', and 'skip_silently'.") | ||
| @JsonPropertyDescription("Specifies how exceptions are handled when an exception occurs while evaluating an event. Default value is <code>drop</code>, which drops the event so that it is not sent to further processors or sinks.") |
There was a problem hiding this comment.
Looks like this one was incorrect before, as the default behavior is to SKIP
| @JsonProperty(INCLUDE_PERFORMANCE_METADATA) | ||
| @JsonPropertyDescription("A <code>Boolean</code> on whether to include performance metadata into event metadata, " + | ||
| "e.g. _total_grok_patterns_attempted, _total_grok_processing_time.") | ||
| @JsonPropertyDescription("A boolean value to determine whether or not to performance metadata into event metadata. " + |
There was a problem hiding this comment.
looks like typo in whether or not to performance metadata
…s performance metadata tags. Signed-off-by: David Venable <[email protected]>
graytaylor0
approved these changes
Oct 7, 2024
4 tasks
chenqi0805
approved these changes
Oct 7, 2024
4 tasks
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
Updates some enumerations used in processors to support the
@JsonValueannotation. Corrects@JsonClassDescriptionto use HTML rather than Markdown. Various unit test improvements for modified unit tests.This follows on other PRs such as:
In particular, for #4985, I missed the
@JsonClassDescriptionheaders.Issues Resolved
None
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.