Update expression and anomaly detector documentation #8041
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
Signed-off-by: Kondaka <[email protected]>
kkondaka
requested review from
kolchfa-aws,
Naarcha-AWS,
vagimeli,
AMoo-Miki,
natebower,
dlvenable,
stephen-crawford and
epugh
as code owners
|
Thank you for submitting your PR. The PR states are In progress (or Draft) -> Tech review -> Doc review -> Editorial review -> Merged. Before you submit your PR for doc review, make sure the content is technically accurate. If you need help finding a tech reviewer, tag a maintainer. When you're ready for doc review, tag the assignee of this PR. The doc reviewer may push edits to the PR directly or leave comments and editorial suggestions for you to address (let us know in a comment if you have a preference). The doc reviewer will arrange for an editorial review. |
dlvenable
requested changes
Aug 16, 2024
Co-authored-by: David Venable <[email protected]> Signed-off-by: Melissa Vagi <[email protected]>
Co-authored-by: David Venable <[email protected]> Signed-off-by: Melissa Vagi <[email protected]>
Co-authored-by: David Venable <[email protected]> Signed-off-by: Melissa Vagi <[email protected]>
Co-authored-by: David Venable <[email protected]> Signed-off-by: Melissa Vagi <[email protected]>
Co-authored-by: David Venable <[email protected]> Signed-off-by: Melissa Vagi <[email protected]>
vagimeli
approved these changes
Aug 19, 2024
| @@ -53,6 +53,7 @@ You can configure `random_cut_forest` mode with the following options. | |||
| | `sample_size` | `256` | 100--2500 | The sample size used in the ML algorithm. | | |||
| | `time_decay` | `0.1` | 0--1.0 | The time decay value used in the ML algorithm. Used as the mathematical expression `timeDecay` divided by `SampleSize` in the ML algorithm. | | |||
| | `type` | `metrics` | N/A | The type of data sent to the algorithm. | | |||
| | `output_after` | 32 | N/A | Indicates the number of events to consume before outputting anamolies | | |||
There was a problem hiding this comment.
Suggested change
| | `output_after` | 32 | N/A | Indicates the number of events to consume before outputting anamolies | | |
| | `output_after` | 32 | N/A | Specifies the number of events to process before outputting any detected anomalies. | |
| <Any> / <Any> | ||
| ``` | ||
|
|
||
| The following are some example arithmetic expressions: |
There was a problem hiding this comment.
Suggested change
| The following are some example arithmetic expressions: | |
| The following are example arithmetic expressions: |
| ``` | ||
| {% include copy-curl.html %} | ||
|
|
||
| The following are some example arithmetic expressions used in conditional expressions : |
There was a problem hiding this comment.
Suggested change
| The following are some example arithmetic expressions used in conditional expressions : | |
| The following are example arithmetic expressions that can be used in conditional expressions: |
| @@ -91,9 +93,64 @@ not /status_code in {200, 202} | |||
| ``` | |||
| {% include copy-curl.html %} | |||
|
|
|||
| ### Arithmetic expressions | |||
|
|
|||
| Arithmetic expressions allow you to do few basic arithmetic operations. Arithmetic expressions may be combined with conditional expressions to make more complex conditional expressions. The available arithmetic operators are `+`, `-`, `*`, and `/` for doing addition, subtraction, multiplication and division respectively. The syntax for using the arithmetic operators is as follows: | |||
There was a problem hiding this comment.
Suggested change
| Arithmetic expressions allow you to do few basic arithmetic operations. Arithmetic expressions may be combined with conditional expressions to make more complex conditional expressions. The available arithmetic operators are `+`, `-`, `*`, and `/` for doing addition, subtraction, multiplication and division respectively. The syntax for using the arithmetic operators is as follows: | |
| Arithmetic expressions enable basic mathematical operations like addition, subtraction, multiplication, and division. These expressions can be combined with conditional expressions to create more complex conditional statements. The available arithmetic operators are +, -, *, and /. The syntax for using the arithmetic operators is as follows: |
| <String Variable or String Literal> + <String Variable or String Literal> | ||
| ``` | ||
|
|
||
| The following are some example string concatenation expressions: |
There was a problem hiding this comment.
Suggested change
| The following are some example string concatenation expressions: | |
| The following are example string concatenation expressions: |
| ``` | ||
| {% include copy-curl.html %} | ||
|
|
||
| The following are some example string concatenation expressions used in conditional expressions : |
There was a problem hiding this comment.
Suggested change
| The following are some example string concatenation expressions used in conditional expressions : | |
| The following are example string concatenation expressions that can be used in conditional expressions: |
|
|
||
| ### String concatenation expressions | ||
|
|
||
| String concatenation expressions allow you to concatenate strings to generate new strings. The concatenated strings can be used in conditional expressions too. The syntax for using string concatenation is as follows: |
There was a problem hiding this comment.
Suggested change
| String concatenation expressions allow you to concatenate strings to generate new strings. The concatenated strings can be used in conditional expressions too. The syntax for using string concatenation is as follows: | |
| String concatenation expressions enable you to combine strings to create new strings. These concatenated strings can also be used within conditional expressions. The syntax for using string concatenation is as follows: |
| ### Reserved symbols | ||
|
|
||
| Reserved symbols are symbols that are not currently used in the expression syntax but are reserved for possible future functionality or extensions. Reserved symbols include `^`, `*`, `/`, `%`, `+`, `-`, `xor`, `=`, `+=`, `-=`, `*=`, `/=`, `%=`, `++`, `--`, and `${<text>}`. | ||
| Reserved symbols are symbols that are not currently used in the expression syntax but are reserved for possible future functionality or extensions. Reserved symbols include `^`, `%`, `xor`, `=`, `+=`, `-=`, `*=`, `/=`, `%=`, `++`, `--`, and `${<text>}`. |
There was a problem hiding this comment.
Suggested change
| Reserved symbols are symbols that are not currently used in the expression syntax but are reserved for possible future functionality or extensions. Reserved symbols include `^`, `%`, `xor`, `=`, `+=`, `-=`, `*=`, `/=`, `%=`, `++`, `--`, and `${<text>}`. | |
| Certain symbols, such as ^, %, xor, =, +=, -=, *=, /=, %=, ++, --, and ${<text>}, are reserved for future functionality or extensions. Reserved symbols include `^`, `%`, `xor`, `=`, `+=`, `-=`, `*=`, `/=`, `%=`, `++`, `--`, and `${<text>}`. |
|
@dlvenable I've completed the doc review and accepted your edits and comments. I also edited text for readability and style. Please review and approve at your availability, and then I'll move this forward for publishing. Thank you. |
vagimeli
added
Needs SME
vagimeli
added
data-prepper
and removed
3 - Tech review
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
Data Prepper supports arithmetic operators but the documentation is not updated to reflect that.
Also, Random Cut forest in anomaly detector processor support a new option which is not reflected in the documentation.
Issues Resolved
List any issues this PR will resolve, e.g. Closes [...].
Version
List the OpenSearch version to which this PR applies, e.g. 2.14, 2.12--2.14, or all.
Frontend features
If you're submitting documentation for an OpenSearch Dashboards feature, add a video that shows how a user will interact with the UI step by step. A voiceover is optional.
Checklist
For more information on following Developer Certificate of Origin and signing off your commits, please check here.