Skip to content

Commit 7cda000

Browse files
eedugonthekofimensah
authored andcommitted
Audit logs moved to security (#743)
Audit logging content moved from `monitor > logging configuration > audit logs` to `security > secure your cluster > audit logs`. For reviewing and consideration. cc: @shainaraskas / @florent-leborgne / @leemthompo
1 parent 2952d31 commit 7cda000

25 files changed

+38
-32
lines changed

deploy-manage/deploy/deployment-comparison.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ For more details about feature availability in Serverless, check [](elastic-clou
1212
| [Security configurations](/deploy-manage/security.md) | Full control | Limited control | Limited control |
1313
| [Authentication realms](/deploy-manage/users-roles.md) | Available | Available | Available, through Elastic Cloud only |
1414
| [Custom roles](/deploy-manage/users-roles.md) | Available | Available | Available |
15-
| [Audit logging](/deploy-manage/monitor/logging-configuration/configuring-audit-logs.md) | Available | Available | No |
15+
| [Audit logging](/deploy-manage/security/logging-configuration/security-event-audit-logging.md) | Available | Available | No |
1616

1717
## Infrastructure and cluster management
1818

deploy-manage/monitor/stack-monitoring/collecting-log-data-with-filebeat.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ If you’re using {{agent}}, do not deploy {{filebeat}} for log collection. Inst
2727

2828
2. Identify which logs you want to monitor.
2929

30-
The {{filebeat}} {{es}} module can handle [audit logs](../logging-configuration/logfile-audit-output.md), [deprecation logs](../logging-configuration/elasticsearch-log4j-configuration-self-managed.md#deprecation-logging), [gc logs](elasticsearch://reference/elasticsearch/jvm-settings.md#gc-logging), [server logs](../logging-configuration/elasticsearch-log4j-configuration-self-managed.md), and [slow logs](elasticsearch://reference/elasticsearch/index-settings/slow-log.md). For more information about the location of your {{es}} logs, see the [path.logs](../../deploy/self-managed/important-settings-configuration.md#path-settings) setting.
30+
The {{filebeat}} {{es}} module can handle [audit logs](../../security/logging-configuration/logfile-audit-output.md), [deprecation logs](../logging-configuration/elasticsearch-log4j-configuration-self-managed.md#deprecation-logging), [gc logs](elasticsearch://reference/elasticsearch/jvm-settings.md#gc-logging), [server logs](../logging-configuration/elasticsearch-log4j-configuration-self-managed.md), and [slow logs](elasticsearch://reference/elasticsearch/index-settings/slow-log.md). For more information about the location of your {{es}} logs, see the [path.logs](../../deploy/self-managed/important-settings-configuration.md#path-settings) setting.
3131

3232
::::{important}
3333
If there are both structured (`*.json`) and unstructured (plain text) versions of the logs, you must use the structured logs. Otherwise, they might not appear in the appropriate context in {{kib}}.

deploy-manage/monitor/stack-monitoring/ece-stack-monitoring.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -181,7 +181,7 @@ When shipping logs to a monitoring deployment there are more logging features av
181181

182182
#### For {{es}}: [ece-extra-logging-features-elasticsearch]
183183

184-
* [Audit logging](../logging-configuration/enabling-audit-logs.md) - logs security-related events on your deployment
184+
* [Audit logging](../../security/logging-configuration/enabling-audit-logs.md) - logs security-related events on your deployment
185185
* [Slow query and index logging](elasticsearch://reference/elasticsearch/index-settings/slow-log.md) - helps find and debug slow queries and indexing
186186
* Verbose logging - helps debug stack issues by increasing component logs
187187

@@ -190,7 +190,7 @@ After you’ve enabled log delivery on your deployment, you can [add the Elastic
190190

191191
#### For Kibana: [ece-extra-logging-features-kibana]
192192

193-
* [Audit logging](../logging-configuration/enabling-audit-logs.md) - logs security-related events on your deployment
193+
* [Audit logging](../../security/logging-configuration/enabling-audit-logs.md) - logs security-related events on your deployment
194194

195195
After you’ve enabled log delivery on your deployment, you can [add the Kibana user settings](../../deploy/cloud-enterprise/edit-stack-settings.md) to enable this feature.
196196

deploy-manage/security.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -121,6 +121,7 @@ There is no orchestration layer for self-managed deployments because you directl
121121
- [**Traffic filtering**](security/traffic-filtering.md): IP filtering, private links, and static IPs
122122
- [**Secure communications**](security/secure-cluster-communications.md): TLS configuration, certificates management
123123
- [**Data protection**](security/data-security.md): Encryption at rest, secure settings, saved objects
124+
- [**Security event audit logging**](security/logging-configuration/security-event-audit-logging.md): {{es}} and {{kib}} audit logs
124125
- [**Session management**](security/kibana-session-management.md): Kibana session controls
125126
- [**FIPS 140-2 compliance**](security/fips-140-2.md): Federal security standards
126127

deploy-manage/monitor/logging-configuration/configuring-audit-logs.md renamed to deploy-manage/security/logging-configuration/configuring-audit-logs.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ When auditing security events, a single client request might generate multiple a
2626

2727
For a complete description of event details and format, refer to the following resources:
2828
* [{{es}} audit events details and schema](elasticsearch://reference/elasticsearch/elasticsearch-audit-events.md)
29-
* [{{es}} log entry output format](/deploy-manage/monitor/logging-configuration/logfile-audit-output.md#audit-log-entry-format)
29+
* [{{es}} log entry output format](./logfile-audit-output.md#audit-log-entry-format)
3030

3131
### Kibana auditing configuration
3232

deploy-manage/monitor/logging-configuration/enabling-audit-logs.md renamed to deploy-manage/security/logging-configuration/enabling-audit-logs.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -25,10 +25,10 @@ You can log security-related events such as authentication failures and refused
2525
This section describes how to enable and configure audit logging in both {{es}} and {{kib}} for all supported deployment types, including self-managed clusters, {{ech}}, {{ece}} (ECE), and {{eck}} (ECK).
2626

2727
::::{important}
28-
In orchestrated deployments, audit logs must be shipped to a monitoring deployment; otherwise, they remain at container level and won't be accessible to users. For details on configuring log forwarding in orchestrated environments, refer to [logging configuration](../logging-configuration.md).
28+
In orchestrated deployments, audit logs must be shipped to a monitoring deployment; otherwise, they remain at container level and won't be accessible to users. For details on configuring log forwarding in orchestrated environments, refer to [logging configuration](/deploy-manage/monitor/logging-configuration.md).
2929
::::
3030

31-
When audit logging is enabled, security events are persisted to a dedicated `<clustername>_audit.json` file on the host’s file system, on every cluster node. For more information, refer to [{{es}} logfile audit output](logfile-audit-output.md).
31+
When audit logging is enabled, security events are persisted to a dedicated `<clustername>_audit.json` file on the host’s file system, on every cluster node. For more information, refer to [{{es}} logfile audit output](./logfile-audit-output.md).
3232

3333
## Enable audit logging [enable-audit-logging-procedure]
3434

deploy-manage/monitor/logging-configuration/logfile-audit-output.md renamed to deploy-manage/security/logging-configuration/logfile-audit-output.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -31,6 +31,6 @@ The audit events are formatted as JSON documents, and each event is printed on a
3131

3232
There are however a few attributes that are exceptions to the above format. The `put`, `delete`, `change`, `create` and `invalidate` attributes, which are only present for events with the `event.type: "security_config_change"` attribute, contain the **nested JSON** representation of the security change taking effect. The contents of the security config change are hence not displayed as top-level dot-named fields in the audit event document. That’s because the fields are specific to the particular kind of security change and do not show up in any other audit events. The benefits of a columnar format are therefore much more limited; the space-saving benefits of the nested structure is the favoured trade-off in this case.
3333

34-
When the `request.body` attribute is present (see [Auditing search queries](auditing-search-queries.md)), it contains a string value containing the full HTTP request body, escaped as per the JSON RFC 4677.
34+
When the `request.body` attribute is present (see [Auditing search queries](./auditing-search-queries.md)), it contains a string value containing the full HTTP request body, escaped as per the JSON RFC 4677.
3535

3636
Refer to [audit event types](elasticsearch://reference/elasticsearch/elasticsearch-audit-events.md) for a complete list of fields, as well as examples, for each entry type.

deploy-manage/toc.yml

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -522,6 +522,15 @@ toc:
522522
- file: security/enabling-cipher-suites-for-stronger-encryption.md
523523
- file: security/secure-settings.md
524524
- file: security/secure-saved-objects.md
525+
- file: security/logging-configuration/security-event-audit-logging.md
526+
children:
527+
- file: security/logging-configuration/enabling-audit-logs.md
528+
- file: security/logging-configuration/configuring-audit-logs.md
529+
children:
530+
- file: security/logging-configuration/logfile-audit-events-ignore-policies.md
531+
- file: security/logging-configuration/logfile-audit-output.md
532+
- file: security/logging-configuration/auditing-search-queries.md
533+
- file: security/logging-configuration/correlating-kibana-elasticsearch-audit-logs.md
525534
- file: security/kibana-session-management.md
526535
- file: security/fips-140-2.md
527536
- file: security/secure-clients-integrations.md
@@ -742,15 +751,6 @@ toc:
742751
children:
743752
- file: monitor/logging-configuration/kibana-log-settings-examples.md
744753
- file: monitor/logging-configuration/kibana-logging-cli-configuration.md
745-
- file: monitor/logging-configuration/security-event-audit-logging.md
746-
children:
747-
- file: monitor/logging-configuration/enabling-audit-logs.md
748-
- file: monitor/logging-configuration/configuring-audit-logs.md
749-
children:
750-
- file: monitor/logging-configuration/logfile-audit-events-ignore-policies.md
751-
- file: monitor/logging-configuration/logfile-audit-output.md
752-
- file: monitor/logging-configuration/auditing-search-queries.md
753-
- file: monitor/logging-configuration/correlating-kibana-elasticsearch-audit-logs.md
754754
- file: cloud-organization.md
755755
children:
756756
- file: cloud-organization/billing.md

deploy-manage/upgrade.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -48,7 +48,7 @@ It is very important to map all the components that are being used on the {{stac
4848
* External services (Kafka, etc.)
4949

5050
:::{tip}
51-
When you do your inventory, you can [enable audit logging](/deploy-manage/monitor/logging-configuration/enabling-audit-logs.md) to evaluate resources accessing your deployment.
51+
When you do your inventory, you can [enable audit logging](/deploy-manage/security/logging-configuration/enabling-audit-logs.md) to evaluate resources accessing your deployment.
5252
:::
5353

5454
**Test your development environment**

deploy-manage/users-roles.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ Preventing unauthorized access is only one element of a complete security strate
2222

2323
* Restrict the nodes and clients that can connect to the cluster using [traffic filters](/deploy-manage/security/traffic-filtering.md).
2424
* Take steps to maintain your data integrity and confidentiality by [encrypting HTTP and inter-node communications](/deploy-manage/security/secure-cluster-communications.md), as well as [encrypting your data at rest](/deploy-manage/security/encrypt-deployment.md).
25-
* Maintain an [audit trail](/deploy-manage/monitor/logging-configuration/security-event-audit-logging.md) for security-related events.
25+
* Maintain an [audit trail](/deploy-manage/security/logging-configuration/security-event-audit-logging.md) for security-related events.
2626
* Control access to dashboards and other saved objects in your UI using [{{kib}} spaces](/deploy-manage/manage-spaces.md).
2727
* Connect your cluster to a [remote cluster](/deploy-manage/remote-clusters.md) to enable cross-cluster replication and search.
2828
* Manage [API keys](/deploy-manage/api-keys.md) used for programmatic access to Elastic.

deploy-manage/users-roles/cluster-or-deployment-auth/internal-users.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,5 +20,5 @@ The {{stack-security-features}} use eight *internal* users (`_system`, `_xpack`,
2020

2121
These users are only used by requests that originate from within the cluster. For this reason, they cannot be used to authenticate against the API and there is no password to manage or reset.
2222

23-
From time-to-time you may find a reference to one of these users inside your logs, including [audit logs](../../monitor/logging-configuration/enabling-audit-logs.md).
23+
From time-to-time you may find a reference to one of these users inside your logs, including [audit logs](../../security/logging-configuration/enabling-audit-logs.md).
2424

manage-data/ingest/ingesting-data-from-applications/ingest-data-with-nodejs-on-elasticsearch-service.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -292,7 +292,7 @@ const client = new Client({
292292
})
293293
```
294294

295-
Check [Create API key API](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-security-create-api-key) to learn more about API Keys and [Security privileges](../../../deploy-manage/users-roles/cluster-or-deployment-auth/elasticsearch-privileges.md) to understand which privileges are needed. If you are not sure what the right combination of privileges for your custom application is, you can enable [audit logging](../../../deploy-manage/monitor/logging-configuration/enabling-audit-logs.md) on {{es}} to find out what privileges are being used. To learn more about how logging works on {{ech}} or {{ece}}, check [Monitoring Elastic Cloud deployment logs and metrics](https://www.elastic.co/blog/monitoring-elastic-cloud-deployment-logs-and-metrics).
295+
Check [Create API key API](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-security-create-api-key) to learn more about API Keys and [Security privileges](../../../deploy-manage/users-roles/cluster-or-deployment-auth/elasticsearch-privileges.md) to understand which privileges are needed. If you are not sure what the right combination of privileges for your custom application is, you can enable [audit logging](../../../deploy-manage/security/logging-configuration/enabling-audit-logs.md) on {{es}} to find out what privileges are being used. To learn more about how logging works on {{ech}} or {{ece}}, check [Monitoring Elastic Cloud deployment logs and metrics](https://www.elastic.co/blog/monitoring-elastic-cloud-deployment-logs-and-metrics).
296296

297297

298298
### Best practices [ec_best_practices]

manage-data/ingest/ingesting-data-from-applications/ingest-data-with-python-on-elasticsearch-service.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -353,7 +353,7 @@ es = Elasticsearch(
353353
)
354354
```
355355

356-
Check [Create API key API](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-security-create-api-key) to learn more about API Keys and [Security privileges](../../../deploy-manage/users-roles/cluster-or-deployment-auth/elasticsearch-privileges.md) to understand which privileges are needed. If you are not sure what the right combination of privileges for your custom application is, you can enable [audit logging](../../../deploy-manage/monitor/logging-configuration/enabling-audit-logs.md) on {{es}} to find out what privileges are being used. To learn more about how logging works on {{ech}} or {{ece}}, check [Monitoring Elastic Cloud deployment logs and metrics](https://www.elastic.co/blog/monitoring-elastic-cloud-deployment-logs-and-metrics).
356+
Check [Create API key API](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-security-create-api-key) to learn more about API Keys and [Security privileges](../../../deploy-manage/users-roles/cluster-or-deployment-auth/elasticsearch-privileges.md) to understand which privileges are needed. If you are not sure what the right combination of privileges for your custom application is, you can enable [audit logging](../../../deploy-manage/security/logging-configuration/enabling-audit-logs.md) on {{es}} to find out what privileges are being used. To learn more about how logging works on {{ech}} or {{ece}}, check [Monitoring Elastic Cloud deployment logs and metrics](https://www.elastic.co/blog/monitoring-elastic-cloud-deployment-logs-and-metrics).
357357

358358
For more information on refreshing an index, searching, updating, and deleting, check the [elasticsearch-py examples](elasticsearch-py://reference/examples.md).
359359

raw-migrated-files/cloud/cloud-heroku/ech-enable-logging-and-monitoring.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -172,7 +172,7 @@ When shipping logs to a monitoring deployment there are more logging features av
172172

173173
#### For {{es}}: [ech-extra-logging-features-elasticsearch]
174174

175-
* [Audit logging](../../../deploy-manage/monitor/logging-configuration/enabling-audit-logs.md) - logs security-related events on your deployment
175+
* [Audit logging](../../../deploy-manage/security/logging-configuration/enabling-audit-logs.md) - logs security-related events on your deployment
176176
* [Slow query and index logging](elasticsearch://reference/elasticsearch/index-settings/slow-log.md) - helps find and debug slow queries and indexing
177177
* Verbose logging - helps debug stack issues by increasing component logs
178178

@@ -181,7 +181,7 @@ After you’ve enabled log delivery on your deployment, you can [add the Elastic
181181

182182
#### For Kibana: [ech-extra-logging-features-kibana]
183183

184-
* [Audit logging](../../../deploy-manage/monitor/logging-configuration/enabling-audit-logs.md) - logs security-related events on your deployment
184+
* [Audit logging](../../../deploy-manage/security/logging-configuration/enabling-audit-logs.md) - logs security-related events on your deployment
185185

186186
After you’ve enabled log delivery on your deployment, you can [add the Kibana user settings](../../../deploy-manage/deploy/elastic-cloud/edit-stack-settings.md) to enable this feature.
187187

raw-migrated-files/cloud/cloud/ec-enable-logging-and-monitoring.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -172,7 +172,7 @@ When shipping logs to a monitoring deployment there are more logging features av
172172

173173
#### For {{es}}: [ec-extra-logging-features-elasticsearch]
174174

175-
* [Audit logging](../../../deploy-manage/monitor/logging-configuration/enabling-audit-logs.md) - logs security-related events on your deployment
175+
* [Audit logging](../../../deploy-manage/security/logging-configuration/enabling-audit-logs.md) - logs security-related events on your deployment
176176
* [Slow query and index logging](elasticsearch://reference/elasticsearch/index-settings/slow-log.md) - helps find and debug slow queries and indexing
177177
* Verbose logging - helps debug stack issues by increasing component logs
178178

@@ -181,7 +181,7 @@ After you’ve enabled log delivery on your deployment, you can [add the Elastic
181181

182182
#### For Kibana: [ec-extra-logging-features-kibana]
183183

184-
* [Audit logging](../../../deploy-manage/monitor/logging-configuration/enabling-audit-logs.md) - logs security-related events on your deployment
184+
* [Audit logging](../../../deploy-manage/security/logging-configuration/enabling-audit-logs.md) - logs security-related events on your deployment
185185

186186
After you’ve enabled log delivery on your deployment, you can [add the Kibana user settings](../../../deploy-manage/deploy/elastic-cloud/edit-stack-settings.md) to enable this feature.
187187

raw-migrated-files/cloud/cloud/ec-getting-started-node-js.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -272,7 +272,7 @@ const client = new Client({
272272
})
273273
```
274274

275-
Check [Create API key API](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-security-create-api-key) to learn more about API Keys and [Security privileges](../../../deploy-manage/users-roles/cluster-or-deployment-auth/elasticsearch-privileges.md) to understand which privileges are needed. If you are not sure what the right combination of privileges for your custom application is, you can enable [audit logging](../../../deploy-manage/monitor/logging-configuration/enabling-audit-logs.md) on {{es}} to find out what privileges are being used. To learn more about how logging works on {{ech}}, check [Monitoring Elastic Cloud deployment logs and metrics](https://www.elastic.co/blog/monitoring-elastic-cloud-deployment-logs-and-metrics).
275+
Check [Create API key API](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-security-create-api-key) to learn more about API Keys and [Security privileges](../../../deploy-manage/users-roles/cluster-or-deployment-auth/elasticsearch-privileges.md) to understand which privileges are needed. If you are not sure what the right combination of privileges for your custom application is, you can enable [audit logging](../../../deploy-manage/security/logging-configuration/enabling-audit-logs.md) on {{es}} to find out what privileges are being used. To learn more about how logging works on {{ech}}, check [Monitoring Elastic Cloud deployment logs and metrics](https://www.elastic.co/blog/monitoring-elastic-cloud-deployment-logs-and-metrics).
276276

277277

278278
### Best practices [ec_best_practices]

0 commit comments

Comments
 (0)