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: Self-managed deployments are Elastic Stack deployments managed without the assistance of an orchestrator. Availability Generally available This functionality is generally available and ready for production usage. This documentation corresponds to the latest patch available for each minor version. If you're not using the latest patch, check the release notes for changes.

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: Elastic Cloud Hosted lets you manage and configure one or more deployments of the versioned Elastic Stack, hosted on Elastic Cloud. Availability Generally available This functionality is generally available and ready for production usage. Self-managed deployments are Elastic Stack deployments managed without the assistance of an orchestrator. Availability Generally available This functionality is generally available and ready for production usage. This documentation corresponds to the latest patch available for each minor version. If you're not using the latest patch, check the release notes for changes.

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

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

Datatype: int

Default: 1000

xpack.task_manager.max_workers The Elastic Stack includes Elastic's core products such as Elasticsearch, Kibana, Logstash, and Beats. Availability Deprecated since 8.16 This functionality is deprecated. You can still use it, but it'll be removed in a future Elastic Stack update. This documentation corresponds to the latest patch available for each minor version. If you're not using the latest patch, check the release notes for changes.

The maximum number of tasks that this Kibana instance will run simultaneously. The maximum value is 100.

Datatype: int

Default: 10

Deprecation details

This setting was deprecated in 8.16.0.

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.

Datatype: bool

Default: 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.

Datatype: int

Default: 60

xpack.task_manager.monitored_stats_health_verbose_log.level The Elastic Stack includes Elastic's core products such as Elasticsearch, Kibana, Logstash, and Beats. Availability Generally available since 8.6 This functionality is generally available and ready for production usage. Unless stated otherwise on the page, this functionality is available when your Elastic Stack is deployed on Elastic Cloud Hosted, Elastic Cloud Enterprise, Elastic Cloud on Kubernetes, and self-managed environments. This documentation corresponds to the latest patch available for each minor version. If you're not using the latest patch, check the release notes for changes.

The log level used when verbose health logging is enabled. Set to debug for detailed output or info for higher-level summaries.

Datatype: enum

Default: debug

Options:

debug
info

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.

Datatype: bool

Default: 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.

Datatype: int

Default: 5000

xpack.task_manager.version_conflict_threshold The Elastic Stack includes Elastic's core products such as Elasticsearch, Kibana, Logstash, and Beats. Availability Generally available since 7.11 This functionality is generally available and ready for production usage. Unless stated otherwise on the page, this functionality is available when your Elastic Stack is deployed on Elastic Cloud Hosted, Elastic Cloud Enterprise, Elastic Cloud on Kubernetes, and self-managed environments. This documentation corresponds to the latest patch available for each minor version. If you're not using the latest patch, check the release notes for changes.

The percentage threshold of workers experiencing version conflicts above which Task Manager shifts its polling interval to avoid overloading Elasticsearch. Accepts values between 50 and 100.

Datatype: int

Default: 80

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.

Datatype: int

Default: 10

Task Manager health settings

Settings that configure the Health monitoring endpoint.

xpack.task_manager.ephemeral_tasks.enabled The Elastic Stack includes Elastic's core products such as Elasticsearch, Kibana, Logstash, and Beats. Availability Removed in 9.0 This functionality was removed. You can no longer use it if you're running on this version or a later one. Deprecated from 8.8 to 9.0 This functionality is deprecated. You can still use it, but it'll be removed in a future Elastic Stack update. Generally available from 7.15 to 8.7 This functionality is generally available and ready for production usage. Unless stated otherwise on the page, this functionality is available when your Elastic Stack is deployed on Elastic Cloud Hosted, Elastic Cloud Enterprise, Elastic Cloud on Kubernetes, and self-managed environments. This documentation corresponds to the latest patch available for each minor version. If you're not using the latest patch, check the release notes for changes.

Set to true to enable ephemeral tasks, which ran actions inline without persisting them to Elasticsearch.

Datatype: bool

Default: false

Deprecation details

Ephemeral tasks were deprecated in 8.8 and removed in 9.0. This setting has no effect on Kibana 9.0 and later.

xpack.task_manager.ephemeral_tasks.request_capacity The Elastic Stack includes Elastic's core products such as Elasticsearch, Kibana, Logstash, and Beats. Availability Removed in 9.0 This functionality was removed. You can no longer use it if you're running on this version or a later one. Deprecated from 8.8 to 9.0 This functionality is deprecated. You can still use it, but it'll be removed in a future Elastic Stack update. Generally available from 7.15 to 8.7 This functionality is generally available and ready for production usage. Unless stated otherwise on the page, this functionality is available when your Elastic Stack is deployed on Elastic Cloud Hosted, Elastic Cloud Enterprise, Elastic Cloud on Kubernetes, and self-managed environments. This documentation corresponds to the latest patch available for each minor version. If you're not using the latest patch, check the release notes for changes.

The maximum number of ephemeral task requests that can be queued.

Datatype: int

Default: 10

Deprecation details

Ephemeral tasks were deprecated in 8.8 and removed in 9.0. This setting has no effect on Kibana 9.0 and later.

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

Datatype: int