-
Notifications
You must be signed in to change notification settings - Fork 8.3k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
[DOCS] improving production documentation for task manager and alerti…
…ng (#87484) * improving production documentation for task manager and alerting * calling it Kibana Task Manager to be more explicit * addressing PR feedback
- Loading branch information
1 parent
a9820a5
commit 7efcdb8
Showing
6 changed files
with
44 additions
and
9 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,32 @@ | ||
[role="xpack"] | ||
[[task-manager-settings-kb]] | ||
=== Task Manager settings in {kib} | ||
++++ | ||
<titleabbrev>Task Manager settings</titleabbrev> | ||
++++ | ||
|
||
Task Manager runs background tasks by polling for work on an interval. You can configure its behavior to tune for performance and throughput. | ||
|
||
[float] | ||
[[task-manager-settings]] | ||
==== Task Manager settings | ||
|
||
[cols="2*<"] | ||
|=== | ||
| `xpack.task_manager.max_attempts` | ||
| The maximum number of times a task will be attempted before being abandoned as failed. Defaults to 3. | ||
|
||
| `xpack.task_manager.poll_interval` | ||
| How often, in milliseconds, the task manager will look for more work. Defaults to 3000 and cannot be lower than 100. | ||
|
||
| `xpack.task_manager.request_capacity` | ||
| How many requests can Task Manager buffer before it rejects new requests. Defaults to 1000. | ||
|
||
| `xpack.task_manager.index` | ||
| The name of the index used to store task information. Defaults to `.kibana_task_manager`. | ||
|
||
| `xpack.task_manager.max_workers` | ||
| The maximum number of tasks that this Kibana instance will run simultaneously. Defaults to 10. | ||
|
||
|
||
|=== |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
14 changes: 8 additions & 6 deletions
14
...rting/alerting-scale-performance.asciidoc → ...erting-production-considerations.asciidoc
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,28 +1,30 @@ | ||
[role="xpack"] | ||
[[alerting-scale-performance]] | ||
== Scale and performance | ||
[[alerting-production-considerations]] | ||
== Production considerations | ||
|
||
{kib} alerting run both alert checks and actions as persistent background tasks. This has two major benefits: | ||
{kib} alerting run both alert checks and actions as persistent background tasks managed by the Kibana Task Manager. This has two major benefits: | ||
|
||
* *Persistence*: all task state and scheduling is stored in {es}, so if {kib} is restarted, alerts and actions will pick up where they left off. | ||
* *Persistence*: all task state and scheduling is stored in {es}, so if {kib} is restarted, alerts and actions will pick up where they left off. Task definitions for alerts and actions are stored in the index specified by `xpack.task_manager.index` (defaults to `.kibana_task_manager`). It is important to have at least 1 replica of this index for production deployments, since if you lose this index all scheduled alerts and actions are also lost. | ||
* *Scaling*: multiple {kib} instances can read from and update the same task queue in {es}, allowing the alerting and action load to be distributed across instances. In cases where a {kib} instance no longer has capacity to run alert checks or actions, capacity can be increased by adding additional {kib} instances. | ||
|
||
[float] | ||
=== Running background alert checks and actions | ||
|
||
{kib} background tasks are managed by: | ||
|
||
* Polling an {es} task index for overdue tasks at 3 second intervals. | ||
* Polling an {es} task index for overdue tasks at 3 second intervals. This interval can be changed using the `xpack.task_manager.poll_interval` setting. | ||
* Tasks are then claiming them by updating them in the {es} index, using optimistic concurrency control to prevent conflicts. Each {kib} instance can run a maximum of 10 concurrent tasks, so a maximum of 10 tasks are claimed each interval. | ||
* Tasks are run on the {kib} server. | ||
* In the case of alerts which are recurring background checks, upon completion the task is scheduled again according to the <<defining-alerts-general-details, check interval>>. | ||
|
||
[IMPORTANT] | ||
============================================== | ||
Because tasks are polled at 3 second intervals and only 10 tasks can run concurrently per {kib} instance, it is possible for alert and action tasks to be run late. This can happen if: | ||
Because by default tasks are polled at 3 second intervals and only 10 tasks can run concurrently per {kib} instance, it is possible for alert and action tasks to be run late. This can happen if: | ||
* Alerts use a small *check interval*. The lowest interval possible is 3 seconds, though intervals of 30 seconds or higher are recommended. | ||
* Many alerts or actions must be *run at once*. In this case pending tasks will queue in {es}, and be pulled 10 at a time from the queue at 3 second intervals. | ||
* *Long running tasks* occupy slots for an extended time, leaving fewer slots for other tasks. | ||
For details on the settings that can influence the performance and throughput of Task Manager, see {task-manager-settings}. | ||
============================================== |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters