-
Notifications
You must be signed in to change notification settings - Fork 25k
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.
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
[DOCS] Document ingest processor description #70899
Conversation
Pinging @elastic/es-core-features (Team:Core/Features) |
Pinging @elastic/es-docs (Team:Docs) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks, @jrodewig. I left two minor comments below, neither of which are blocking.
docs/reference/ingest.asciidoc
Outdated
@@ -410,7 +412,8 @@ PUT _ingest/pipeline/my-pipeline | |||
"processors": [ | |||
{ | |||
"set": { | |||
"field": "received", | |||
"description": "Set 'event.ingested' to '_ingest.timestamp' value", |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I might say something here about copying the value out of ingest metadata which is not indexed into the document so that the timestamp is indexed?
| `description` | no | - | Description of the processor configuration. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Minor, but the processor description can be anything that's useful to the user and doesn't necessarily have to be about the processor's configuration.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I'll change this to:
Description of the processor. Useful for describing the purpose of the processor or its configuration.
Thanks @danhermann! |
Documents the processor-level
description
parameter added in #57906. Relates to #70442.This PR covers the most visible places for setting up an ingest pipeline. I'll investigate adding additional processor-level descriptions as a separate effort.
cc @cjcenizal
Changes
description
parameter to the common parameters used on every processor docs pagePreviews