IMPORTANT: No additional bug fixes or documentation updates will be released for this version. For the latest information, see the current release documentation.
« Custom roles provider extension Audit event types »
Elastic Docs ›Elasticsearch Guide [6.4] ›Secure a cluster

Auditing security events

edit
IMPORTANT: This documentation is no longer updated. Refer to Elastic's version policy and the latest documentation.

Auditing security events

edit

You can enable auditing to keep track of security-related events such as authentication failures and refused connections. Logging these events enables you to monitor your cluster for suspicious activity and provides evidence in the event of an attack.

Audit logs are disabled by default. To enable this functionality, you must set xpack.security.audit.enabled to true in elasticsearch.yml.

X-Pack security provides two ways to persist audit logs:

  • The logfile output, which persists events to a dedicated <clustername>_access.log file on the host’s file system.
  • The index output, which persists events to an Elasticsearch index. The audit index can reside on the same cluster, or a separate cluster.

By default, only the logfile output is used when enabling auditing. To facilitate browsing and analyzing the events, you can also enable indexing by setting xpack.security.audit.outputs in elasticsearch.yml:

xpack.security.audit.outputs: [ index, logfile ]

If you choose to enable the index output type, we strongly recommend that you still use the logfile output as the official record of events. If the target index is unavailable (for example, during a rolling upgrade), the index output can lose messages.

« Custom roles provider extension Audit event types »