IMPORTANT: No additional bug fixes or documentation updates will be released for this version. For the latest information, see the current release documentation.
« Create an Elasticsearch query rule Rule action variables »
Elastic Docs ›Kibana Guide [8.12] ›Alerting ›Rule types

Create a tracking containment rule

edit

Create a tracking containment rule

edit

The tracking containment rule alerts when an entity is contained or no longer contained within a boundary.

Requirements

edit

To create a tracking containment rule, the following requirements must be present:

  • Entities index: An index containing a geo_point or geo_shape field, date field, and entity identifier. An entity identifier is a keyword, number, or ip field that identifies the entity. Entity data is expected to be updating so that there are entity movements to alert upon.
  • Boundaries index: An index containing geo_shape data. Boundaries data is expected to be static (not updating). Boundaries are collected once when the rule is created and anytime after when boundary configuration is modified.

Entity locations are queried to determine if they are contained within any monitored boundaries. Entity data should be somewhat "real time", meaning the dates of new documents aren’t older than the current time minus the amount of the interval. If data older than now - <current interval> is ingested, it won’t trigger a rule.

Actions

edit

A rule can be triggered either when a containment condition is met or when an entity is no longer contained.

Action frequency options for an action
« Create an Elasticsearch query rule Rule action variables »