Skip to content

Commit

Permalink
docs: update fleet/agent pipeline docs (#90659) (#90698)
Browse files Browse the repository at this point in the history
* docs: update fleet/agent pipeline docs

* Apply suggestions from code review

Co-authored-by: Adam Locke <[email protected]>

Co-authored-by: Adam Locke <[email protected]>

Co-authored-by: Adam Locke <[email protected]>
  • Loading branch information
bmorelli25 and Adam Locke authored Oct 5, 2022
1 parent 1afecf7 commit 35c0f89
Showing 1 changed file with 8 additions and 6 deletions.
14 changes: 8 additions & 6 deletions docs/reference/ingest.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -300,18 +300,20 @@ output.elasticsearch:
[[pipelines-for-fleet-elastic-agent]]
=== Pipelines for {fleet} and {agent}

{fleet-guide}/index.html[{fleet}] automatically adds ingest pipelines for its
integrations. {fleet} applies these pipelines using <<index-templates,index
{agent} integrations ship with default ingest pipelines that preprocess and enrich data before indexing.
{fleet-guide}/index.html[{fleet}] applies these pipelines using <<index-templates,index
templates>> that include <<set-default-pipeline,pipeline index settings>>. {es}
matches these templates to your {fleet} data streams based on the
{fleet-guide}/data-streams.html#data-streams-naming-scheme[stream's naming
scheme].

WARNING: Do not change {fleet}'s ingest pipelines or use custom pipelines for
your {fleet} integrations. Doing so can break your {fleet} data streams.
Each default integration pipeline calls a nonexistent, unversioned `@custom` ingest pipeline.
If unaltered, this pipeline call has no effect on your data. However, you can modify this call to
create custom pipelines for integrations that persist across upgrades.
Refer to {fleet-guide}/data-streams-pipeline-tutorial.html[Tutorial: Transform data with custom ingest pipelines] to learn more.

{fleet} doesn't provide an ingest pipeline for the **Custom logs** integration.
You can safely specify a pipeline for this integration in one of two ways: an
{fleet} doesn't provide a default ingest pipeline for the **Custom logs** integration,
but you can specify a pipeline for this integration using an
<<pipeline-custom-logs-index-template,index template>> or a
<<pipeline-custom-logs-configuration,custom configuration>>.

Expand Down

0 comments on commit 35c0f89

Please sign in to comment.