Skip to content

Add docs on replicating APM Server or Beats indices #36333

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.

Sign up for GitHub

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

Merged
jasontedor merged 2 commits into from
Dec 6, 2018
Merged

Add docs on replicating APM Server or Beats indices #36333

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
028cedf
Add docs on replicating APM Server or Beats indices
jasontedor Dec 6, 2018
f807f7b
Reword based on feedback
jasontedor Dec 6, 2018
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
23 changes: 22 additions & 1 deletion docs/reference/ccr/requirements.asciidoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -42,4 +42,25 @@ The number of soft deletes to retain. Soft deletes are collected during merges
on the underlying Lucene index yet retained up to the number of operations
configured by this setting. The default value is `0`.

For more information about index settings, see {ref}/index-modules.html[Index modules].
For more information about index settings, see {ref}/index-modules.html[Index modules].

[float]
[[ccr-overview-beats]]
==== Setting soft deletes on indices created by APM Server or Beats

If you want to replicate indices created by APM Server or Beats, and are
allowing APM Server or Beats to manage index templates you will want to add some

@dedemorton dedemorton Dec 6, 2018

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I would state this more directly and say:

If you want to replicate indices created by APM Server or Beats, and are
allowing APM Server or Beats to manage index templates, you need to
enable soft deletes. To enable soft deletes, add the following settings
to the APM Server or Beats configuration file.

settings to enable soft deletes. For example, you could make the following
changes to the relevant APM Server or Beats configuration file.

["source","yaml"]
----------------------------------------------------------------------
setup.template.overwrite: true
setup.template.settings:
index.soft_deletes.enabled: true
index.soft_deletes.retention.operations: 1024
----------------------------------------------------------------------

For additional information on controlling the index templates managed by APM
Server or Beats, see the relevant documentation on loading the Elasticsearch
index template.