-
Notifications
You must be signed in to change notification settings - Fork 156
Monitoring audit logging #352
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from all commits
Commits
Show all changes
32 commits
Select commit
Hold shift + click to select a range
6a1979e
audit logging initial changes
eedugon d870029
elasticsearch audit events prepared to be moved to reference
eedugon 07e5dec
work in progress, applying shaina's suggestions
eedugon 460db8e
audit logging updated
eedugon 838bf49
audit logging more updates
eedugon c559ba0
extra changes for a draft PR
eedugon 94f9220
refining changes and removing migration comments
eedugon 9cf349f
small update
eedugon 6e9e46c
toc and titles updated
eedugon dc389b4
enable audit log simplified a bit
eedugon 3bc8233
added serverless unavailble tags
eedugon c4347ef
link fixed
eedugon 8f298ee
Merge branch 'main' into monitoring_audit_logging
eedugon 2c2517d
renaming again with tool to fix links
eedugon b4d38b7
links fixed due to kibana audit logs file deleted
eedugon d4491dd
subscription feature note updated
eedugon fee0d0a
fixing conflicts
eedugon 7e86fe4
fixed link in get-started/introduction.md file
eedugon 1b4dd3f
Update manage-data/ingest/ingesting-data-from-applications/ingest-dat…
eedugon 542f5a5
Update manage-data/ingest/ingesting-data-from-applications/ingest-dat…
eedugon e852bd4
changes applied per psanz suggestions
eedugon b206e7f
resolved small conflicts
eedugon 433fdbc
fixing links
eedugon a107e95
correlating events updated
eedugon 55db7cb
audit request body updated
eedugon f801787
minor changes, ready for review
eedugon 6e4bb9a
Merge branch 'main' into monitoring_audit_logging
eedugon df94d2c
Apply suggestions from code review
eedugon 79e6760
Update deploy-manage/monitor/logging-configuration/correlating-kibana…
eedugon 24d1154
changes post Shaina's review
eedugon 664a9fe
elasticsearch audit details removed and asciidocalypse temp links added
eedugon e19962a
fixing conflicts
eedugon File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or 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
53 changes: 53 additions & 0 deletions
53
deploy-manage/monitor/logging-configuration/configuring-audit-logs.md
This file contains hidden or 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,53 @@ | ||
--- | ||
applies: | ||
hosted: all | ||
ece: all | ||
eck: all | ||
stack: all | ||
serverless: unavailable | ||
--- | ||
|
||
# Configure audit logging [audit-logging-configuration] | ||
|
||
When auditing security events, a single client request might generate multiple audit events across multiple cluster nodes, potentially leading to a high volume of log data and I/O operations. To maintain clarity and ensure logs remain actionable, {{es}} and {{kib}} provide configuration mechanisms to control what events are logged and which can be ignored. | ||
|
||
### Elasticsearch auditing configuration | ||
|
||
{{es}} configuration options include: | ||
|
||
* [{{es}} audited events settings](https://www.elastic.co/guide/en/elasticsearch/reference/current/auditing-settings.html#event-audit-settings): Use include and exclude filters to control the types of events that get logged. | ||
* [{{es}} node information settings](https://www.elastic.co/guide/en/elasticsearch/reference/current/auditing-settings.html#node-audit-settings): Control whether to add or hide node information such as hostname or IP address in the audited events. | ||
* [{{es}} ignore policies settings](https://www.elastic.co/guide/en/elasticsearch/reference/current/auditing-settings.html#audit-event-ignore-policies): Use ignore policies for fine-grained control over which audit events are printed to the log file. | ||
|
||
::::{tip} | ||
In {{es}}, all auditing settings except `xpack.security.audit.enabled` are dynamic. This means you can configure them using the [cluster update settings API](https://www.elastic.co/guide/en/elasticsearch/reference/current/cluster-update-settings.html), allowing changes to take effect immediately without requiring a restart. This approach is faster and more convenient than modifying `elasticsearch.yml`. | ||
:::: | ||
|
||
For a complete description of event details and format, refer to the following resources: | ||
* [{{es}} audit events details and schema]() asciidocalypse://elasticsearch/docs/reference/elasticsearch/elasticsearch-audit-events | ||
* [{{es}} log entry output format](/deploy-manage/monitor/logging-configuration/logfile-audit-output.md#audit-log-entry-format) | ||
|
||
### Kibana auditing configuration | ||
|
||
To control the logs that are outputted by Kibana, you can use [{{kib}} ignore filters](https://www.elastic.co/guide/en/kibana/current/security-settings-kb.html#audit-logging-ignore-filters). These are a list of filters that determine which events should be excluded from the audit log. | ||
|
||
In self-managed systems, you can optionally configure audit logs location, and file/rolling file using [{{kib}} audit logging settings](https://www.elastic.co/guide/en/kibana/current/security-settings-kb.html#audit-logging-settings). | ||
|
||
|
||
::::{tip} | ||
To configure {{kib}} settings, follow the same [procedure](./enabling-audit-logs.md#enable-audit-logging-procedure) as when enabling {{kib}} audit logs, but apply the relevant settings instead. | ||
:::: | ||
|
||
For a complete description of auditing event details, such as `category`, `type`, or `action`, refer to [{{kib}} audit events](https://www.elastic.co/guide/en/kibana/current/xpack-security-audit-logging.html#xpack-security-ecs-audit-logging). | ||
|
||
### General recommendations | ||
|
||
* Consider starting with {{es}} [`xpack.security.audit.logfile.events.include`](https://www.elastic.co/guide/en/elasticsearch/reference/current/auditing-settings.html#xpack-sa-lf-events-include) and [{{kib}} ignore filters](https://www.elastic.co/guide/en/kibana/current/security-settings-kb.html#audit-logging-ignore-filters) settings to specify the type of events you want to include or exclude in the auditing output. | ||
|
||
* If you need a more granular control, refer to [{{es}} audit events ignore policies](./logfile-audit-events-ignore-policies.md) for a better understanding how ignore policies work and when they are beneficial. | ||
|
||
* Refer to [auditing search queries](./auditing-search-queries.md) for details on logging request bodies in the {{es}} audit logs. | ||
|
||
::::{important} | ||
Sensitive data may be audited in plain text when including the request body in audit events, even though all the security APIs, such as those that change the user’s password, have the credentials filtered out when audited. | ||
:::: |
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.