Task Manager settings in Kibana

Task Manager runs background tasks by polling for work on an interval. You can configure its behavior to tune for performance and throughput.

Task Manager settings

xpack.task_manager.max_attempts

Supported on:

The maximum number of times a task will be attempted before being abandoned as failed.

Datatype: int

Default: 3

xpack.task_manager.poll_interval

Supported on:

How often, in milliseconds, the task manager will look for more work. Cannot be lower than 100.

Datatype: int

Default: 500

xpack.task_manager.request_capacity

Supported on:

How many requests can Task Manager buffer before it rejects new requests.

Datatype: int

Default: 1000

xpack.task_manager.max_workers

Supported on:

The maximum number of tasks that this Kibana instance will run simultaneously. Starting in 8.0, it will not be possible to set the value greater than 100.

Datatype: int

Default: 10

Deprecation details

This setting was deprecated in 8.16.0.

xpack.task_manager.monitored_stats_health_verbose_log.enabled

Supported on:

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.

Datatype: bool

Default: false

xpack.task_manager.monitored_stats_health_verbose_log.warn_delayed_task_start_in_seconds

Supported on:

The amount of seconds we allow a task to delay before printing a warning server log.

Datatype: int

Default: 60

xpack.task_manager.event_loop_delay.monitor

Supported on:

Enables event loop delay monitoring, which will log a warning when a task causes an event loop delay which exceeds the warn_threshold setting.

Datatype: bool

Default: true

xpack.task_manager.event_loop_delay.warn_threshold

Supported on:

Sets the amount of event loop delay during a task execution which will cause a warning to be logged.

Datatype: int

Default: 5000

xpack.task_manager.capacity

Supported on:

Controls the number of tasks that can be run at one time. The minimum value is 5 and the maximum is 50.

Datatype: int

Default: 10

Task Manager health settings

Settings that configure the Health monitoring endpoint.

xpack.task_manager.monitored_task_execution_thresholds

Supported on:

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).

Datatype: int