mirror of
https://github.com/elastic/kibana.git
synced 2025-04-25 02:09:32 -04:00
5a9129e22d
## Summary Resolves: https://github.com/elastic/kibana/issues/151463 Removes all reference to ephemeral tasks from the task manager plugin. As well as unit and E2E tests while maintaining backwards compatibility for `xpack.task_manager.ephemeral_tasks` flag to no-op if set. This PR has some dependencies from the PR to remove ephemeral task support from the alerting and actions plugin (https://github.com/elastic/kibana/pull/197421). So it should be merged after the other PR. Deprecates the following configuration settings: - xpack.task_manager.ephemeral_tasks.enabled - xpack.task_manager.ephemeral_tasks.request_capacity The user doesn't have to change anything on their end if they don't wish to. This deprecation is made so if the above settings are defined, kibana will simply do nothing. ### Checklist - [x] [Unit or functional tests](https://www.elastic.co/guide/en/kibana/master/development-tests.html) were updated or added to match the most common scenarios
68 lines
3.2 KiB
Text
68 lines
3.2 KiB
Text
[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
|
|
|
|
|
|
|
|
`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 500 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.max_workers`::
|
|
deprecated:[8.16.0]
|
|
The maximum number of tasks that this Kibana instance will run simultaneously. Defaults to 10.
|
|
Starting in 8.0, it will not be possible to set the value greater than 100.
|
|
|
|
`xpack.task_manager.monitored_stats_health_verbose_log.enabled`::
|
|
This flag will enable automatic warn and error logging if task manager self detects a performance issue, such as the time between when a task is scheduled to execute and when it actually executes. Defaults to false.
|
|
|
|
`xpack.task_manager.monitored_stats_health_verbose_log.warn_delayed_task_start_in_seconds`::
|
|
The amount of seconds we allow a task to delay before printing a warning server log. Defaults to 60.
|
|
|
|
`xpack.task_manager.event_loop_delay.monitor`::
|
|
Enables event loop delay monitoring, which will log a warning when a task causes an event loop delay which exceeds the `warn_threshold` setting. Defaults to true.
|
|
|
|
`xpack.task_manager.event_loop_delay.warn_threshold`::
|
|
Sets the amount of event loop delay during a task execution which will cause a warning to be logged. Defaults to 5000 milliseconds (5 seconds).
|
|
|
|
`xpack.task_manager.capacity`::
|
|
Controls the number of tasks that can be run at one time. The minimum value is 5 and the maximum is 50. Defaults to 10.
|
|
|
|
[float]
|
|
[[task-manager-health-settings]]
|
|
==== Task Manager Health settings
|
|
|
|
Settings that configure the <<task-manager-health-monitoring>> endpoint.
|
|
|
|
`xpack.task_manager.monitored_task_execution_thresholds`::
|
|
Configures the threshold of failed task executions at which point the `warn` or
|
|
`error` health status is set under each task type execution status
|
|
(under `stats.runtime.value.execution.result_frequency_percent_as_number[${task type}].status`).
|
|
+
|
|
This setting allows configuration of both the default level and a
|
|
custom task type specific level. By default, this setting is configured to mark
|
|
the health of every task type as `warning` when it exceeds 80% failed executions,
|
|
and as `error` at 90%.
|
|
+
|
|
Custom configurations allow you to reduce this threshold to catch failures sooner
|
|
for task types that you might consider critical, such as alerting tasks.
|
|
+
|
|
This value can be set to any number between 0 to 100, and a threshold is hit
|
|
when the value *exceeds* this number. This means that you can avoid setting the
|
|
status to `error` by setting the threshold at 100, or hit `error` the moment
|
|
any task fails by setting the threshold to 0 (as it will exceed 0 once a
|
|
single failure occurs).
|