Skip to content

Commit

Permalink
[DOCS] Rename auditing topic. Closes #49012 (#49013)
Browse files Browse the repository at this point in the history
* [DOCS] Rename auditing topic. Closes #49012

* Fixed file name, fixed settings link.

* Add link to settings
  • Loading branch information
debadair committed Nov 14, 2019
1 parent b8d85cf commit 82bc3f5
Show file tree
Hide file tree
Showing 6 changed files with 36 additions and 23 deletions.
8 changes: 7 additions & 1 deletion docs/reference/redirects.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -921,11 +921,17 @@ See <<monitoring-overview>>.
See <<monitor-elasticsearch-cluster>>.

[role="exclude",id="docker-cli-run"]
=== Docker Run

See <<docker-cli-run-dev-mode>>.

[role="exclude",id="auditing"]
=== Audit logging

See <<enable-audit-logging>>.

[role="exclude",id="analysis-compound-word-tokenfilter"]
=== Compound word token filters

See <<analysis-dict-decomp-tokenfilter>> and
<<analysis-hyp-decomp-tokenfilter>>.
<<analysis-hyp-decomp-tokenfilter>>.
6 changes: 3 additions & 3 deletions docs/reference/settings/audit-settings.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -5,16 +5,16 @@
<titleabbrev>Auditing settings</titleabbrev>
++++

All of these settings can be added to the `elasticsearch.yml` configuration
file. For more information, see <<auditing>>.
You configure security auditing settings in the `elasticsearch.yml` configuration file
on each node in the cluster. For more information, see <<enable-audit-logging>>.

[[general-audit-settings]]
==== General Auditing Settings

`xpack.security.audit.enabled`::
Set to `true` to enable auditing on the node. The default value is `false`.
This puts the auditing events in a dedicated file named `<clustername>_audit.json`
on each node. For more information, see <<configuring-logging-levels>>.
on each node.

[[event-audit-settings]]
==== Audited Event Settings
Expand Down
24 changes: 24 additions & 0 deletions x-pack/docs/en/security/auditing/enable-audit-logging.asciidoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
[role="xpack"]
[[enable-audit-logging]]
== Enabling audit logging

You can log security-related events such as authentication failures and refused connections
to monitor your cluster for suspicious activity.
Audit logging also provides forensic evidence in the event of an attack.

[IMPORTANT]
============================================================================
Audit logs are **disabled** by default. You must explicitly enable audit logging.
============================================================================

To enable enable audit logging:

. Set `xpack.security.audit.enabled` to `true` in `elasticsearch.yml`.
. Restart {es}.

When audit logging is enabled, <<audit-event-types, security events>> are persisted to
a dedicated `<clustername>_audit.json` file on the host's file system (on each node).

You can configure additional options to control what events are logged and
what information is included in the audit log.
For more information, see <<auditing-settings>>.
2 changes: 1 addition & 1 deletion x-pack/docs/en/security/auditing/event-types.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
[[audit-event-types]]
=== Audit event types

When you are <<auditing,auditing security events>>, each request can generate
When you are <<enable-audit-logging,auditing security events>>, each request can generate
multiple audit events.

The following is a list of the events that can be generated:
Expand Down
2 changes: 1 addition & 1 deletion x-pack/docs/en/security/auditing/index.asciidoc
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
include::overview.asciidoc[]
include::enable-audit-logging.asciidoc[]

include::event-types.asciidoc[]

Expand Down
17 changes: 0 additions & 17 deletions x-pack/docs/en/security/auditing/overview.asciidoc

This file was deleted.

0 comments on commit 82bc3f5

Please sign in to comment.