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.

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

Merged
merged 5 commits into from
Mar 26, 2021
Merged

[DOCS] Document ingest processor description #70899

merged 5 commits into from
Mar 26, 2021

Conversation

jrodewig
Copy link
Contributor

@jrodewig jrodewig commented Mar 26, 2021

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

  • Adds the description parameter to the common parameters used on every processor docs page
  • Adds usage examples to the ingest pipeline tutorials, create pipeline API docs, and enrich processor example

Previews

@jrodewig jrodewig marked this pull request as ready for review March 26, 2021 09:48
@jrodewig jrodewig added :Data Management/Ingest Node Execution or management of Ingest Pipelines including GeoIP >docs General docs changes v7.12.1 v8.0.0 labels Mar 26, 2021
@jrodewig jrodewig requested a review from jakelandis March 26, 2021 09:48
@elasticmachine elasticmachine added Team:Data Management Meta label for data/management team Team:Docs Meta label for docs team labels Mar 26, 2021
@elasticmachine
Copy link
Collaborator

Pinging @elastic/es-core-features (Team:Core/Features)

@elasticmachine
Copy link
Collaborator

Pinging @elastic/es-docs (Team:Docs)

@jrodewig jrodewig requested a review from danhermann March 26, 2021 09:48
Copy link
Contributor

@danhermann danhermann left a 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.

@@ -410,7 +412,8 @@ PUT _ingest/pipeline/my-pipeline
"processors": [
{
"set": {
"field": "received",
"description": "Set 'event.ingested' to '_ingest.timestamp' value",
Copy link
Contributor

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.
Copy link
Contributor

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.

Copy link
Contributor Author

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.

@jrodewig
Copy link
Contributor Author

Thanks @danhermann!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
:Data Management/Ingest Node Execution or management of Ingest Pipelines including GeoIP >docs General docs changes Team:Data Management Meta label for data/management team Team:Docs Meta label for docs team v7.12.1 v7.13.0 v8.0.0-alpha1
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants