Skip to content

Commit 31d62d5

Browse files
tmanningerNaarcha-AWSnatebower
authored
Data Stream support for Audit- Log (opensearch-project#8356)
* Opensearch Data Stream auditlog Signed-off-by: tmanninger <[email protected]> * Opensearch Data Stream auditlog Signed-off-by: tmanninger <[email protected]> * Opensearch Data Stream auditlog Signed-off-by: tmanninger <[email protected]> * Change shards default value Signed-off-by: tmanninger <[email protected]> * Update _security/audit-logs/storage-types.md Co-authored-by: Naarcha-AWS <[email protected]> Signed-off-by: tmanninger <[email protected]> * Update _security/audit-logs/storage-types.md Co-authored-by: Naarcha-AWS <[email protected]> Signed-off-by: tmanninger <[email protected]> * Update _security/audit-logs/storage-types.md Co-authored-by: Naarcha-AWS <[email protected]> Signed-off-by: tmanninger <[email protected]> * Update _security/audit-logs/storage-types.md Co-authored-by: Naarcha-AWS <[email protected]> Signed-off-by: tmanninger <[email protected]> * Update _security/audit-logs/storage-types.md Co-authored-by: Naarcha-AWS <[email protected]> Signed-off-by: tmanninger <[email protected]> * Update _security/audit-logs/storage-types.md Co-authored-by: Naarcha-AWS <[email protected]> Signed-off-by: tmanninger <[email protected]> * Update _security/audit-logs/storage-types.md Co-authored-by: Naarcha-AWS <[email protected]> Signed-off-by: tmanninger <[email protected]> * Update _security/audit-logs/storage-types.md Co-authored-by: Naarcha-AWS <[email protected]> Signed-off-by: tmanninger <[email protected]> * Apply suggestions from code review Signed-off-by: Naarcha-AWS <[email protected]> * Update _security/audit-logs/storage-types.md Co-authored-by: Nathan Bower <[email protected]> Signed-off-by: tmanninger <[email protected]> --------- Signed-off-by: tmanninger <[email protected]> Signed-off-by: tmanninger <[email protected]> Signed-off-by: Naarcha-AWS <[email protected]> Co-authored-by: Naarcha-AWS <[email protected]> Co-authored-by: Nathan Bower <[email protected]>
1 parent 8abb45a commit 31d62d5

File tree

1 file changed

+22
-2
lines changed

1 file changed

+22
-2
lines changed

_security/audit-logs/storage-types.md

Lines changed: 22 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -16,17 +16,37 @@ Setting | Description
1616
:--- | :---
1717
debug | Outputs to stdout. Useful for testing and debugging.
1818
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.
1920
external_opensearch | Writes to an audit index on a remote OpenSearch cluster.
2021
webhook | Sends events to an arbitrary HTTP endpoint.
2122
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.
2223

2324
You configure the output location in `opensearch.yml`:
2425

2526
```
26-
plugins.security.audit.type: <debug|internal_opensearch|external_opensearch|webhook|log4j>
27+
plugins.security.audit.type: <debug|internal_opensearch|internal_opensearch_data_stream|external_opensearch|webhook|log4j>
2728
```
2829

29-
`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`.
3050

3151

3252
## External OpenSearch

0 commit comments

Comments
 (0)