Skip to content
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

Add documentation for automatic Alerting workflows from detector creation #5003

Merged
merged 8 commits into from
Sep 19, 2023
Merged
Show file tree
Hide file tree
Changes from 6 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion _api-reference/cluster-api/cluster-settings.md
Original file line number Diff line number Diff line change
Expand Up @@ -60,7 +60,8 @@ Not all cluster settings can be updated using the cluster settings API. You will
The following request field parameters are compatible with the cluster API.

| Field | Data type | Description |
:--- | :--- | :---
| :--- | :--- | :--- |
| plugins.security_analytics.enable_workflow_usage | Boolean | Supports integration of Alerting plugin workflows with Security Analytics. Determines whether composite monitor workflows are generated for the Alerting plugin after creating a new threat detector in Security Analytics. By default, the setting is `true`. <br> <br> When set to `true`, composite monitor workflows based on an associated threat detector's configuration are enabled. When set to `false`, composite monitor workflows based on an associated threat detector's configuration are disabled. <br> <br> For more information about Alerting plugin workflow integration with Security Analytics, see [Integrated Alerting plugin workflows]({{site.url}}{{site.baseurl}}/security-analytics/sec-analytics-config/detectors-config/#integrated-alerting-plugin-workflows). |
cwillum marked this conversation as resolved.
Show resolved Hide resolved
| action.auto_create_index | Boolean | Automatically creates an index if the index doesn't already exist. Also applies any index templates that are configured. Default is `true`. |
| action.destructive_requires_name | Boolean | When set to `true`, you must specify the index name to delete an index. You cannot delete all indexes or use wildcards. Default is `true`. |
| cluster.indices.close.enable | Boolean | Enables closing of open indexes in OpenSearch. Default is `true`. |
Expand Down
2 changes: 1 addition & 1 deletion _observing-your-data/alerting/composite-monitors.md
Original file line number Diff line number Diff line change
Expand Up @@ -63,7 +63,7 @@ In this simple example, the first monitor could be a per document monitor config

## Managing composite monitors with the API

You can manage composite monitors using the REST API or OpenSearch Dashboards. This section covers API functionality for composite monitors.
You can manage composite monitors using the REST API or [OpenSearch Dashboards](#creating-composite-monitors-in-opensearch-dashboards). This section covers API functionality for composite monitors.
cwillum marked this conversation as resolved.
Show resolved Hide resolved

### Create composite monitor

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -144,6 +144,14 @@ To set up an alert for a detector, continue with the following steps:

1. Review the specifications for the detector and select **Create detector** in the lower-right corner of the screen. The detector details for the new detector are displayed. When you navigate to the main **Threat detectors** page, the new detector appears in the list.

## Integrated Alerting plugin workflows

By default, when you create a threat detector the system automatically creates a composite monitor and triggers workflows for the Alerting plugin. The detector's rules are converted into search queries for the Alerting plugin monitor, and the monitor executes its queries according to a schedule derived from the detector's configuration.
cwillum marked this conversation as resolved.
Show resolved Hide resolved

You can change the behavior of automatically generated composite monitors by enabling or disabling the workflow functionality with the `plugins.security_analytics.enable_workflow_usage` setting. This setting is defined using the [Cluster settings API]({{site.url}}{{site.baseurl}}/api-reference/cluster-api/cluster-settings/).

For more information about composite monitors and their workflows, see [Composite monitors]({{site.url}}{{site.baseurl}}/observing-your-data/alerting/composite-monitors/).

---
## What's next

Expand Down