Skip to content

Commit 8dd75e5

Browse files
committed
[DOCS] Clarifies recommendation for audit index output type (#31146)
1 parent c0abfe7 commit 8dd75e5

File tree

4 files changed

+9
-12
lines changed

4 files changed

+9
-12
lines changed

x-pack/docs/en/security/auditing/event-types.asciidoc

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,4 @@
11
[role="xpack"]
2-
[float]
32
[[audit-event-types]]
43
=== Audit event types
54

x-pack/docs/en/security/auditing/output-index.asciidoc

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,4 @@
11
[role="xpack"]
2-
[float]
32
[[audit-index]]
43
=== Index audit output
54

@@ -36,3 +35,8 @@ xpack.security.audit.index.settings:
3635
number_of_shards: 1
3736
number_of_replicas: 1
3837
----------------------------
38+
39+
NOTE: Audit events are batched for indexing so there is a lag before
40+
events appear in the index. You can control how frequently batches of
41+
events are pushed to the index by setting
42+
`xpack.security.audit.index.flush_interval` in `elasticsearch.yml`.

x-pack/docs/en/security/auditing/output-logfile.asciidoc

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,4 @@
11
[role="xpack"]
2-
[float]
32
[[audit-log-output]]
43
=== Logfile audit output
54

x-pack/docs/en/security/auditing/overview.asciidoc

Lines changed: 4 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -29,12 +29,7 @@ indexing by setting `xpack.security.audit.outputs` in `elasticsearch.yml`:
2929
xpack.security.audit.outputs: [ index, logfile ]
3030
----------------------------
3131

32-
The `index` output type should be used in conjunction with the `logfile`
33-
output type Because it is possible for the `index` output type to lose
34-
messages if the target index is unavailable, the `access.log` should be
35-
used as the official record of events.
36-
37-
NOTE: Audit events are batched for indexing so there is a lag before
38-
events appear in the index. You can control how frequently batches of
39-
events are pushed to the index by setting
40-
`xpack.security.audit.index.flush_interval` in `elasticsearch.yml`.
32+
TIP: If you choose to enable the `index` output type, we strongly recommend that
33+
you still use the `logfile` output as the official record of events. If the
34+
target index is unavailable (for example, during a rolling upgrade), the `index`
35+
output can lose messages.

0 commit comments

Comments
 (0)