-
Notifications
You must be signed in to change notification settings - Fork 24.8k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
[DOCS] Splits auditing.asciidoc into smaller files
- Loading branch information
Showing
7 changed files
with
248 additions
and
234 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,24 @@ | ||
[role="xpack"] | ||
[float] | ||
[[forwarding-audit-logfiles]] | ||
==== Forwarding audit logs to a remote cluster | ||
|
||
To index audit events to a remote Elasticsearch cluster, you configure | ||
the following `xpack.security.audit.index.client` settings: | ||
|
||
* `xpack.security.audit.index.client.hosts` | ||
* `xpack.security.audit.index.client.cluster.name` | ||
* `xpack.security.audit.index.client.xpack.security.user` | ||
|
||
For more information about these settings, see | ||
{ref}/auditing-settings.html#remote-audit-settings[Remote Audit Log Indexing Configuration Settings]. | ||
|
||
You can pass additional settings to the remote client by specifying them in the | ||
`xpack.security.audit.index.client` namespace. For example, to allow the remote | ||
client to discover all of the nodes in the remote cluster you can specify the | ||
`client.transport.sniff` setting: | ||
|
||
[source,yaml] | ||
---------------------------- | ||
xpack.security.audit.index.client.transport.sniff: true | ||
---------------------------- |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,14 @@ | ||
:edit_url: https://github.com/elastic/elasticsearch/edit/{branch}/x-pack/docs/en/security/auditing/overview.asciidoc | ||
include::overview.asciidoc[] | ||
|
||
:edit_url: https://github.com/elastic/elasticsearch/edit/{branch}/x-pack/docs/en/security/auditing/event-types.asciidoc | ||
include::event-types.asciidoc[] | ||
|
||
:edit_url: https://github.com/elastic/elasticsearch/edit/{branch}/x-pack/docs/en/security/auditing/output-logfile.asciidoc | ||
include::output-logfile.asciidoc[] | ||
|
||
:edit_url: https://github.com/elastic/elasticsearch/edit/{branch}/x-pack/docs/en/security/auditing/output-index.asciidoc | ||
include::output-index.asciidoc[] | ||
|
||
:edit_url: https://github.com/elastic/elasticsearch/edit/{branch}/x-pack/docs/en/security/auditing/forwarding-logs.asciidoc | ||
include::forwarding-logs.asciidoc[] |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,38 @@ | ||
[role="xpack"] | ||
[float] | ||
[[audit-index]] | ||
=== Index audit output | ||
|
||
In addition to logging to a file, you can store audit logs in Elasticsearch | ||
rolling indices. These indices can be either on the same cluster, or on a | ||
remote cluster. You configure the following settings in | ||
`elasticsearch.yml` to control how audit entries are indexed. To enable | ||
this output, you need to configure the setting `xpack.security.audit.outputs` | ||
in the `elasticsearch.yml` file: | ||
|
||
[source,yaml] | ||
---------------------------- | ||
xpack.security.audit.outputs: [ index, logfile ] | ||
---------------------------- | ||
|
||
For more configuration options, see | ||
{ref}/auditing-settings.html#index-audit-settings[Audit log indexing configuration settings]. | ||
|
||
IMPORTANT: No filtering is performed when auditing, so sensitive data may be | ||
audited in plain text when including the request body in audit events. | ||
|
||
[float] | ||
==== Audit index settings | ||
|
||
You can also configure settings for the indices that the events are stored in. | ||
These settings are configured in the `xpack.security.audit.index.settings` namespace | ||
in `elasticsearch.yml`. For example, the following configuration sets the | ||
number of shards and replicas to 1 for the audit indices: | ||
|
||
[source,yaml] | ||
---------------------------- | ||
xpack.security.audit.index.settings: | ||
index: | ||
number_of_shards: 1 | ||
number_of_replicas: 1 | ||
---------------------------- |
Oops, something went wrong.