Skip to content

Commit

Permalink
[Maps] Update asset tracking tutorial with production consideration f…
Browse files Browse the repository at this point in the history
…or rule check interval (#158664)

Fixes #127289

## Summary

Updates the asset tracking tutorial docs with considerations for running
in production.

For a better demo experience the tutorial uses a 5 second interval for
rule checking, but a very low interval can be problematic for running in
production.

I'm suggesting backporting these doc changes to 8.3 which the first
release to have a **Circuit breakers** section in
https://www.elastic.co/guide/en/kibana/8.3/alerting-production-considerations.html
that is most relevant to the added note in this PR.

---------

Co-authored-by: gchaps <[email protected]>
  • Loading branch information
nickpeihl and gchaps authored May 31, 2023
1 parent bc041fd commit 9d7d6f9
Showing 1 changed file with 3 additions and 1 deletion.
4 changes: 3 additions & 1 deletion docs/maps/asset-tracking-tutorial.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -440,7 +440,9 @@ image::maps/images/asset-tracking-tutorial/construction_zones.png[]
[float]
==== Step 2. Configure an alert

Create a new alert by defining a rule and a connector. The rule includes the conditions that will trigger the alert, and the connector defines what action takes place once the alert is triggered. In this case, each alert will log a message to the Kibana log.
Create a new alert by defining a rule and a connector. The rule includes the conditions that will trigger the alert, and the connector defines what action takes place once the alert is triggered. In this case, each alert will log a message to the {kib} log.

NOTE: For this example, you will set the rule to check every 5 seconds. However, when running in production, consider setting a higher check interval (such as 1 minute) to avoid performance issues. Refer to <<alerting-production-considerations,Alerting production considerations>> for more information.

. Open *{stack-manage-app}*, and then click *{rules-ui}*.
. Click *Create rule*.
Expand Down

0 comments on commit 9d7d6f9

Please sign in to comment.