-
Notifications
You must be signed in to change notification settings - Fork 8.2k
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] improving production documentation for task manager and alerting #87484
Merged
bmcconaghy
merged 3 commits into
elastic:master
from
bmcconaghy:improve_alerting_production_docs
Jan 6, 2021
+44
−9
Merged
Changes from 2 commits
Commits
Show all changes
3 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
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,35 @@ | ||
[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.max_poll_inactivity_cycles` | ||
| How many poll interval cycles can work take before it's timed out. Defaults to 10. | ||
|
||
| `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 | ||
bmcconaghy marked this conversation as resolved.
Show resolved
Hide resolved
|
||
* 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
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I'm not sure we should include this.
I don't expect customers to change this - if they go too low it might restart TM prematurely and we've yet to see a deployment where the default wasn't sufficient
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
OK will remove.