You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: _security/audit-logs/storage-types.md
+22-2Lines changed: 22 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -16,17 +16,37 @@ Setting | Description
16
16
:--- | :---
17
17
debug | Outputs to stdout. Useful for testing and debugging.
18
18
internal_opensearch | Writes to an audit index on the current OpenSearch cluster.
19
+
internal_opensearch_data_stream | Writes to an audit log data stream on the current OpenSearch cluster.
19
20
external_opensearch | Writes to an audit index on a remote OpenSearch cluster.
20
21
webhook | Sends events to an arbitrary HTTP endpoint.
21
22
log4j | Writes the events to a Log4j logger. You can use any Log4j [appender](https://logging.apache.org/log4j/2.x/manual/appenders.html), such as SNMP, JDBC, Cassandra, and Kafka.
22
23
23
24
You configure the output location in `opensearch.yml`:
`external_opensearch`, `webhook`, and `log4j` all have additional configuration options. Details follow.
30
+
`internal_opensearch_data_stream`, `external_opensearch`, `webhook`, and `log4j` can be customized with additional configuration options. For more information, see [Internal OpenSearch data streams](#internal-opensearch-data-streams).
31
+
32
+
33
+
## Internal OpenSearch data streams
34
+
35
+
You can configure the `internal_opensearch_data_stream` type with the following parameters.
36
+
37
+
38
+
Name | Data type | Description
39
+
:--- | :--- | :---
40
+
`plugins.security.audit.config.data_stream.name` | String | The name of the audit log data stream. Default is `opensearch-security-auditlog`.
41
+
42
+
### Template settings
43
+
44
+
Name | Data type | Description
45
+
:--- | :--- | :---
46
+
`plugins.security.audit.config.data_stream.template.manage` | Boolean | When `true`, the template for the data stream is managed by OpenSearch. Default is `true`.
47
+
`plugins.security.audit.config.data_stream.template.name` | String | The name of the data stream template. Default is `opensearch-security-auditlog`.
48
+
`plugins.security.audit.config.data_stream.template.number_of_replicas` | Integer | The number of replicas for the data stream. Default is `0`.
49
+
`plugins.security.audit.config.data_stream.template.number_of_shards` | Integer | The number of shards for the data stream. Default is `1`.
0 commit comments