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

[Docs] Add geo threshold and containment docs #88783

Merged
merged 27 commits into from
Jan 22, 2021
Merged
Show file tree
Hide file tree
Changes from 25 commits
Commits
Show all changes
27 commits
Select commit Hold shift + click to select a range
3d17ef3
Add supporting images
Jan 20, 2021
a8755c9
Differentiate standard stack alerts from experimental
Jan 20, 2021
43f12ce
Add docs for containment and threshold
Jan 20, 2021
8259985
Merge remote-tracking branch 'upstream/master' into docs-geo-alerts
Jan 20, 2021
f5596ca
Update docs/user/alerting/geo-alert-types.asciidoc
kindsun Jan 20, 2021
be4329c
Update docs/user/alerting/geo-alert-types.asciidoc
kindsun Jan 20, 2021
205dc0b
Update docs/user/alerting/geo-alert-types.asciidoc
kindsun Jan 20, 2021
52366ff
Update docs/user/alerting/geo-alert-types.asciidoc
kindsun Jan 20, 2021
0bd7e06
Update docs/user/alerting/geo-alert-types.asciidoc
kindsun Jan 20, 2021
11dc81a
Update docs/user/alerting/geo-alert-types.asciidoc
kindsun Jan 20, 2021
4079ab8
Update docs/user/alerting/geo-alert-types.asciidoc
kindsun Jan 20, 2021
d28567c
Update docs/user/alerting/geo-alert-types.asciidoc
kindsun Jan 20, 2021
fbca00e
Update docs/user/alerting/geo-alert-types.asciidoc
kindsun Jan 20, 2021
1b84202
Update docs/user/alerting/geo-alert-types.asciidoc
kindsun Jan 20, 2021
b834832
Update docs/user/alerting/geo-alert-types.asciidoc
kindsun Jan 20, 2021
8c9d5af
Update docs/user/alerting/geo-alert-types.asciidoc
kindsun Jan 20, 2021
a0dce54
Update docs/user/alerting/geo-alert-types.asciidoc
kindsun Jan 20, 2021
25a2f01
Update docs/user/alerting/geo-alert-types.asciidoc
kindsun Jan 20, 2021
c290361
Merge branch 'docs-geo-alerts' of github.com:aaronjcaldwell/kibana in…
Jan 20, 2021
fbcc2cf
Review feedback
Jan 20, 2021
b618870
Reword general description so it applies accurately to both alert types
Jan 20, 2021
0d7910d
Capitalize entity usages
Jan 20, 2021
383fe84
Actually lowercase entity refs but make consistent
Jan 20, 2021
e96a5b4
Update images to geo point versions instead of geo point/shape
Jan 20, 2021
f17c886
Include geo alerts in alerting docs
Jan 21, 2021
7dc892e
Review feedback
Jan 21, 2021
3d05636
Merge remote-tracking branch 'upstream/master' into docs-geo-alerts
Jan 21, 2021
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
2 changes: 1 addition & 1 deletion docs/user/alerting/alert-types.asciidoc
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
[role="xpack"]
[[alert-types]]
== Alert types
== Standard stack alert types
Copy link
Contributor

Choose a reason for hiding this comment

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

Is this rename really necessary?

As a user, the word "standard" does not provide a lot of meaning and obscures the real contents "alert types". I would recommend leaving this title as is. I think its ok having a title "alert types" and "geo alert types"

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I'll have to think about this one. I'm open to changing the wording, but it seems strange to me to have a top-level category called "Alert types" and then have another called "Geo alert types". I chose "standard" since these alert types are included at the basic license level and aren't hidden behind a feature flag.


{kib} supplies alert types in two ways: some are built into {kib} (these are known as stack alerts), while domain-specific alert types are registered by {kib} apps such as <<xpack-apm,*APM*>>, <<metrics-app,*Metrics*>>, and <<uptime-app,*Uptime*>>.

Expand Down
130 changes: 130 additions & 0 deletions docs/user/alerting/geo-alert-types.asciidoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,130 @@
[role="xpack"]
[[geo-alert-types]]
== Geo alert types

experimental[] Two additional stack alerts are available:
<<alert-type-tracking-threshold>> and <<alert-type-tracking-containment>>. To enable,
add the following configuration to your `kibana.yml`:

```yml
xpack.stack_alerts.enableGeoAlerting: true
```

As with other stack alerts, you need `all` access to the *Stack Alerts* feature
to be able to create and edit either of the geo alerts.
See <<kibana-feature-privileges, feature privileges>> for more information on configuring roles that provide access to this feature.

[float]
=== Requirements to create a geo alert
kindsun marked this conversation as resolved.
Show resolved Hide resolved

To create either a *Tracking threshold* or a *Tracking containment* alert, the
following requirements must be present:

- *Trackable index or index pattern data*: An index containing a `geo_point` field, `date` field,
kindsun marked this conversation as resolved.
Show resolved Hide resolved
and some form of entity identifier. An entity identifier is a `keyword` or `number`
field that consistently identifies the entity to be tracked. The data in this index should be dynamically
updating so that there are entity movements to alert upon.
- *Boundary index or index pattern data*: An index containing `geo_shape` data, such as boundary data and bounding box data.
kindsun marked this conversation as resolved.
Show resolved Hide resolved
This data is presumed to be static (not updating). Shape data matching the query is
harvested once when the alert is created and anytime after when the alert is re-enabled
after disablement.

By design, current interval entity locations (_current_ is determined by `date` in
the *Tracked index or index pattern*) 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 an alert.

[float]
=== Creating a geo alert
Both *threshold* and *containment* alerts can be created by clicking the *Create*
button in the <<alert-management, alert management UI>>.
Complete the <<defining-alerts-general-details, general alert details>>, and
then select either *Tracking threshold* or *Tracking containment*.

[role="screenshot"]
image::images/alert-types-tracking-select.png[Choosing a tracking alert type]

Depending on the specific requirements for the alert, either tracking or containment
kindsun marked this conversation as resolved.
Show resolved Hide resolved
might be appropriate. Select <<alert-type-tracking-threshold>> if the alert is more
focused on generating an alert when an entity crosses a boundary, and you desire the
ability to highlight lines of crossing on a custom map. Select
<<alert-type-tracking-containment>> if an entity should send out constant alerts
while contained within a boundary (this feature is optional) or if the alert is generally
just more focused around activity when an entity exists within a shape.

[NOTE]
==================================================
With recent advances in the alerting framework, most of the features
available in Tracking threshold alerts can be replicated with just
a little more work in Tracking containment alerts. The capabilities of Tracking
threshold alerts may be deprecated or folded into Tracking containment alerts
in the future.
==================================================

[float]
[[alert-type-tracking-threshold]]
=== Tracking threshold
The Tracking threshold alert type runs an {es} query over indices, comparing the latest
entity locations with their previous locations. In the event that an entity has crossed a
boundary from the selected boundary index, an alert may be generated.

[float]
==== Defining the conditions
Tracking threshold has a *Delayed evaluation offset* and 4 clauses that define the
condition to detect, as well as 2 Kuery bars used to provide additional filtering
context for each of the indices.

[role="screenshot"]
image::images/alert-types-tracking-threshold-conditions.png[Five clauses define the condition to detect]


Delayed evaluation offset:: If a data source lags or is intermittent, you may supply
an optional value to evaluate alert conditions following a fixed delay. For instance, if data
is consistently indexed 5-10 minutes following its original timestamp, a *Delayed evaluation
offset* of `10 minutes` would ensure that alertable instances are still captured.
Index (entity):: This clause requires an *index or index pattern*, a *time field* that will be used for the *time window*, and a *`geo_point` field* for tracking.
By:: This clause specifies the field to use in the previously provided
*index or index pattern* for tracking Entities. An entity is a `keyword`
or `number` field that consistently identifies the entity to be tracked.
When entity:: This clause specifies which crossing option to track. The values
*Entered*, *Exited*, and *Crossed* can be selected to indicate which crossing conditions
should trigger an alert. *Entered* alerts on entry into a boundary, *Exited* alerts on exit
from a boundary, and *Crossed* alerts on all boundary crossings whether they be entrances
or exits.
Index (Boundary):: This clause requires an *index or index pattern*, a *`geo_shape` field*
identifying boundaries, and an optional *Human-readable boundary name* for better alerting
messages.

[float]
[[alert-type-tracking-containment]]
=== Tracking containment
The Tracking containment alert type runs an {es} query over indices, determining if any
documents are currently contained within any boundaries from the specified boundary index.
In the event that an entity is contained within a boundary, an alert may be generated.

[float]
==== Defining the conditions
Tracking containment alerts have 3 clauses that define the condition to detect,
as well as 2 Kuery bars used to provide additional filtering context for each of the indices.

[role="screenshot"]
image::images/alert-types-tracking-containment-conditions.png[Five clauses define the condition to detect]

Index (entity):: This clause requires an *index or index pattern*, a *time field* that will be used for the *time window*, and a *`geo_point` field* for tracking.
When entity:: This clause specifies which crossing option to track. The values
*Entered*, *Exited*, and *Crossed* can be selected to indicate which crossing conditions
should trigger an alert. *Entered* alerts on entry into a boundary, *Exited* alerts on exit
from a boundary, and *Crossed* alerts on all boundary crossings whether they be entrances
or exits.
Index (Boundary):: This clause requires an *index or index pattern*, a *`geo_shape` field*
identifying boundaries, and an optional *Human-readable boundary name* for better alerting
messages.

Conditions for how an alert is tracked can be specified uniquely for each individual action.
An alert can be triggered either when a containment condition is met or when an entity
is no longer contained.

[role="screenshot"]
image::images/alert-types-tracking-containment-action-options.png[Five clauses define the condition to detect]
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
1 change: 1 addition & 0 deletions docs/user/alerting/index.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -2,4 +2,5 @@ include::alerting-getting-started.asciidoc[]
include::defining-alerts.asciidoc[]
include::action-types.asciidoc[]
include::alert-types.asciidoc[]
include::geo-alert-types.asciidoc[]
include::alerting-production-considerations.asciidoc[]