Skip to content

Commit

Permalink
[DOCS] Clarify audit index settings when remote indexing (#30923)
Browse files Browse the repository at this point in the history
  • Loading branch information
albertzaharovits authored Jun 12, 2018
1 parent ef453b3 commit e988ace
Show file tree
Hide file tree
Showing 2 changed files with 16 additions and 0 deletions.
9 changes: 9 additions & 0 deletions docs/reference/settings/audit-settings.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -112,6 +112,15 @@ xpack.security.audit.index.settings:
number_of_replicas: 1
----------------------------
--
+
--
NOTE: These settings apply to the local audit indices, as well as to the
<<remote-audit-settings, remote audit indices>>, but only if the remote cluster
does *not* have {security} installed, or the {es} versions are different.
If the remote cluster has {security} installed, and the versions coincide, the
settings for the audit indices there will take precedence,
even if they are unspecified (i.e. left to defaults).
--

[[remote-audit-settings]]
==== Remote Audit Log Indexing Configuration Settings
Expand Down
7 changes: 7 additions & 0 deletions x-pack/docs/en/security/auditing/output-index.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -36,6 +36,13 @@ xpack.security.audit.index.settings:
number_of_replicas: 1
----------------------------

These settings apply to the local audit indices, as well as to the
<<forwarding-audit-logfiles, remote audit indices>>, but only if the remote cluster
does *not* have {security} installed, or the {es} versions are different.
If the remote cluster has {security} installed, and the versions coincide, the
settings for the audit indices there will take precedence,
even if they are unspecified (i.e. left to defaults).

NOTE: Audit events are batched for indexing so there is a lag before
events appear in the index. You can control how frequently batches of
events are pushed to the index by setting
Expand Down

0 comments on commit e988ace

Please sign in to comment.