This version of the OpenSearch documentation is no longer maintained. For the latest version, see the current documentation. For information about OpenSearch version maintenance, see Release Schedule and Maintenance Policy.
Table of contents
Audit logs let you track access to your OpenSearch cluster and are useful for compliance purposes or in the aftermath of a security breach. You can configure the categories to be logged, the detail level of the logged messages, and where to store the logs.
To enable audit logging:
Add the following line to
opensearch.ymlon each node:
This setting stores audit logs on the current cluster. For other storage options, see Audit Log Storage Types.
Restart each node.
After this initial setup, you can use OpenSearch Dashboards to manage your audit log categories and other settings. In OpenSearch Dashboards, select Security and then Audit logs.
An alternative is to specify initial settings for audit logging in the
opensearch.yml files (which file depends on the setting—see Audit log settings). Thereafter, you can use Dashboards or the Audit logs API to manage and update settings.
Audit logging records events in two ways: HTTP requests (REST) and the transport layer. The following table provides descriptions of tracked events and whether or not they are logged on the REST or transport layer.
|Event||Logged on REST||Logged on transport||Description|
| ||Yes||Yes||The credentials of a request could not be validated, most likely because the user does not exist or the password is incorrect.|
| ||Yes||Yes||A user successfully authenticated.|
| ||No||Yes||The user does not have the required permissions to make the request.|
| ||No||Yes||A user made a successful request to OpenSearch.|
| ||Yes||Yes||An attempt was made to access OpenSearch without a valid SSL/TLS certificate.|
| ||No||Yes||An attempt was made to modify the Security plugin internal user and privileges index without the required permissions or TLS admin certificate.|
| ||Yes||Yes||An attempt was made to spoof a request to OpenSearch with the Security plugin internal headers.|
Audit log settings
The following default log settings work well for most use cases. However, you can change settings to save storage space or adapt the information to your exact needs.
Settings in audit.yml
The following settings are stored in the
To exclude categories, list them in the following setting:
plugins.security.audit.config.disabled_rest_categories: <disabled categories> plugins.security.audit.config.disabled_transport_categories: <disabled categories>
plugins.security.audit.config.disabled_rest_categories: AUTHENTICATED, opensearch_SECURITY_INDEX_ATTEMPT plugins.security.audit.config.disabled_transport_categories: GRANTED_PRIVILEGES
If you want to log events in all categories, use
plugins.security.audit.config.disabled_rest_categories: NONE plugins.security.audit.config.disabled_transport_categories: NONE
Disable REST or the transport layer
By default, the Security plugin logs events on both REST and the transport layer. You can disable either type:
plugins.security.audit.config.enable_rest: false plugins.security.audit.config.enable_transport: false
Disable request body logging
By default, the Security plugin includes the body of the request (if available) for both REST and the transport layer. If you do not want or need the request body, you can disable it:
Log index names
By default, the Security plugin logs all indexes affected by a request. Because index names can be aliases and contain wildcards/date patterns, the Security plugin logs the index name that the user submitted and the actual index name to which it resolves.
For example, if you use an alias or a wildcard, the audit event might look like:
audit_trace_indices: [ "human*" ], audit_trace_resolved_indices: [ "humanresources" ]
You can disable this feature by setting:
This feature is only disabled if
plugins.security.audit.config.log_request_body is also set to
Configure bulk request handling
Bulk requests can contain many indexing operations. By default, the Security plugin only logs the single bulk request, not each individual operation.
The Security plugin can be configured to log each indexing operation as a separate event:
This change can create an extremely large number of events in the audit logs, so we don’t recommend enabling this setting if you frequently use the
You can exclude certain requests from being logged by configuring actions for transport requests and/or HTTP request paths (REST):
plugins.security.audit.config.ignore_requests: ["indices:data/read/*", "SearchRequest"]
By default, the Security plugin logs events from all users but excludes the internal OpenSearch Dashboards server user
kibanaserver. You can exclude other users:
plugins.security.audit.config.ignore_users: - kibanaserver - admin
If requests from all users should be logged, use
You can exclude sensitive headers from being included in the logs—for example, the
Settings in opensearch.yml
The following settings are stored in the
Configure the audit log index name
By default, the Security plugin stores audit events in a daily rolling index named
Use a date pattern in the index name to configure daily, weekly, or monthly rolling indexes:
For a reference on the date pattern format, see the Joda DateTimeFormat documentation.
(Advanced) Tune the thread pool
The Search plugin logs events asynchronously, which minimizes the performance impact on your cluster. The plugin uses a fixed thread pool to log events:
The default setting is
10. Setting this value to
0 disables the thread pool, which means the plugin logs events synchronously. To set the maximum queue length per thread: