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
Changes from 1 commit
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
12 changes: 12 additions & 0 deletions _security-analytics/sec-analytics-config/detectors-config.md
Original file line number Diff line number Diff line change
Expand Up @@ -144,6 +144,18 @@ 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 triggers workflows for the Alerting plugin. The new threat detector generates an underlying composite monitor whose configuration is informed by the detection rules selected during creation of the new detector. The composite monitor executes according to the detector's schedule rather than the monitor's schedule.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

the composite monitor derives it's schedule from the detector's configuration


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

You can change the behavior of the automatically generated composite monitor by enabling or disabling the workflow functionality with the `plugins.security_analytics.enable_workflow_usage` setting. By default, the setting is `true`.

When set to `true`, a composite monitor is created with triggers based on the detector's Sigma rules and the Alerting plugin generates workflows.

When set to `false`, the underlying composite monitor is created without workflows and triggers based on Sigma rules are not configured.

---
## What's next

Expand Down