The Rules page offers several ways to gain insight into the status of your detection rules:
- Rule Monitoring tab — The current state of all detection rules and their most recent executions. Go to the Rule Monitoring tab to get an overview of which rules are running, how long they’re taking, and if they’re having any trouble.
- Rule execution logs — Historical data for a single detection rule’s executions over time. Consult the rule execution logs to understand how a particular rule is running and whether it’s creating the alerts you expect.
Refer to the Troubleshoot missing alerts section below for strategies on using these tools.
Rule Monitoring tabedit
To view a summary of all rule executions, including the most recent failures and execution times, select the Rule Monitoring tab on the Rules page (Detect → Rules → Rule Monitoring).
On the Rule Monitoring tab, you can sort and filter rules just like you can on the Rules tab.
By default, you can only sort by the Rule and Enabled columns on this tab. To sort by any other column, switch on the Technical preview toggle above the table. This experimental table view allows advanced sorting capabilities. If you experience performance issues when working with the table, you can turn this setting off.
For detailed information on a rule, the alerts it generated, and associated errors, click on its name in the table. This also allows you to perform the same actions that are available on the Rules tab, such as modifying or deleting rules, activating or deactivating rules, exporting or importing rules, and duplicating prebuilt rules.
Rule execution logsedit
Each detection rule execution is logged, including its success or failure, any warning or error messages, and how long it took to search for data, create alerts, and complete. This can help you troubleshoot a particular rule if it isn’t behaving as expected (for example, if it isn’t creating alerts or takes a long time to run).
To access a rule’s execution log, go to Detect → Rules, click the rule’s name to open its details, then scroll down and select the Rule execution logs tab.
You can hover over each column heading to display a tooltip about that column’s data. Click a column heading to sort the table by that column.
Use these controls to filter what’s included in the logs table:
The Status drop-down filters the table by rule execution status:
- Succeeded: The rule was able to complete its defined search. This doesn’t necessarily mean it generated an alert, just that it ran without error.
- Failed: The rule encountered an error that prevented it from running. For example, a machine learning rule whose corresponding machine learning job wasn’t running.
- Partial failure: Nothing prevented the rule from running, but it still might not have returned the expected results. For example, a custom query rule tried to search an index pattern that couldn’t be found in Elasticsearch.
- The date and time picker sets the time range of rule executions included in the table. This is separate from the global date and time picker at the top of the rule details page.
- The Show metrics columns toggle includes more or less data in the table, pertaining to the timing of each rule execution.
- The Actions column allows you to show alerts generated from a given rule execution. Click the filter icon () to create a global search filter based on the rule execution’s ID value. This replaces any previously applied filters, changes the global date and time range to 24 hours before and after the rule execution, and displays a confirmation notification. You can revert this action by clicking Restore previous filters in the notification.
Troubleshoot missing alertsedit
When a rule fails to run close to its scheduled time, some alerts may be missing. There are a number of ways to try to resolve this issue:
You can also use Task Manager in Kibana to troubleshoot background tasks and processes that may be related to missing alerts:
If you see values in the Gaps column in the Rule Monitoring table or on the Rule details page for a small number of rules, you can increase those rules' Additional look-back time (Detect → Rules → the rule’s All actions menu (…) → Edit rule settings → Schedule → Additional look-back time).
It’s recommended to set the
Additional look-back time to at
least 1 minute. This ensures there are no missing alerts when a rule doesn’t
run exactly at its scheduled time.
Elastic Security prevents duplication. Any duplicate alerts that are discovered during the
Additional look-back time are not created.
If you see gaps for numerous rules:
- If you restarted Kibana when many rules were activated, try deactivating them and then reactivating them in small batches at staggered intervals. This ensures Kibana does not attempt to run all the rules at the same time.
- Consider adding another Kibana instance to your environment.
Troubleshoot ingestion pipeline delayedit
Even if your rule runs at its scheduled time, there might still be missing alerts if your ingestion pipeline delay is greater than your rule interval + additional look-back time. Prebuilt rules have a minimum interval + additional look-back time of 6 minutes in Elastic Stack version >=7.11.0. To avoid missed alerts for prebuilt rules, use caution to ensure that ingestion pipeline delays remain below 6 minutes.
In addition, use caution when creating custom rule schedules to ensure that the specified interval + additional look-back time is greater than your deployment’s ingestion pipeline delay.
You can reduce the number of missed alerts due to ingestion pipeline delay by specifying the
Timestamp override field value to
event.ingested in advanced settings during rule creation or editing. The detection engine uses the value from the
event.ingested field as the timestamp when executing the rule.
For example, say an event occurred at 10:00 but wasn’t ingested into Elasticsearch until 10:10 due to an ingestion pipeline delay. If you created a rule to detect that event with an interval + additional look-back time of 6 minutes, and the rule executes at 10:12, it would still detect the event because the
event.ingested timestamp was from 10:10, only 2 minutes before the rule executed and well within the rule’s 6-minute interval + additional look-back time.
Troubleshoot missing alerts for machine learning jobsedit
Machine learning detection rules use machine learning jobs that have dependencies on data fields populated by the Beats and Elastic Agent integrations. In Elastic Stack version 8.3, new machine learning jobs (prefixed with
v3) were released to operate on the ECS fields available at that time.
If you’re using 8.2 or earlier versions of Beats or Elastic Agent with Elastic Stack version 8.3 or later, you may need to duplicate prebuilt rules or create new custom rules before you update the Elastic prebuilt rules. Once you update the prebuilt rules, they will only use
v3 machine learning jobs. Duplicating the relevant prebuilt rules before updating them ensures continued coverage by allowing you to keep using
v2 jobs (in the duplicated rules) while also running the new
v3 jobs (in the updated prebuilt rules).
- Duplicated rules may result in duplicate anomaly detections and alerts.
Ensure that the relevant
v3machine learning jobs are running before you update the Elastic prebuilt rules.
If you only have 8.3 or later versions of Beats and Elastic Agent: You can download or update your prebuilt rules and use the latest
v3machine learning jobs. No additional action is required.
If you only have 8.2 or earlier versions of Beats or Elastic Agent, or a mix of old and new versions: To continue using the
v2machine learning jobs specified by pre-8.3 prebuilt detection rules, you must duplicate affected prebuilt rules before updating them to the latest rule versions. The duplicated rules can continue using the same
v2machine learning jobs, and the updated prebuilt machine learning rules will use the new
v3machine learning jobs.
If you have a non-Elastic data shipper that gathers ECS-compatible events: You can use the latest
v3machine learning jobs with no additional action required, as long as your data shipper uses the latest ECS specifications. However, if you’re migrating from machine learning rules using
v2jobs, ensure that you start the relevant
v3jobs before updating the Elastic prebuilt rules.
The following Elastic prebuilt rules use the new
v3 machine learning jobs to generate alerts. Duplicate their associated
v2 prebuilt rules before updating them if you need continued coverage from the
v2 machine learning jobs:
Unusual Linux Network Port Activity:
Anomalous Process For a Linux Population:
Unusual Linux Username:
Unusual Linux Process Calling the Metadata Service:
Unusual Linux User Calling the Metadata Service:
Unusual Process For a Linux Host:
Unusual Process For a Windows Host:
Unusual Windows Network Activity:
Unusual Windows Path Activity:
Anomalous Windows Process Creation:
Anomalous Process For a Windows Population:
Unusual Windows Username:
Unusual Windows Process Calling the Metadata Service:
Unusual Windows User Calling the Metadata Service: