mirror of
https://github.com/elastic/kibana.git
synced 2025-06-28 11:05:39 -04:00
# Backport This will backport the following commits from `main` to `9.0`: - [[docs] Fix various syntax and rendering errors (#218883)](https://github.com/elastic/kibana/pull/218883) <!--- Backport version: 9.6.6 --> ### Questions ? Please refer to the [Backport tool documentation](https://github.com/sorenlouv/backport) <!--BACKPORT [{"author":{"name":"Colleen McGinnis","email":"colleen.mcginnis@elastic.co"},"sourceCommit":{"committedDate":"2025-05-22T08:10:07Z","message":"[docs] Fix various syntax and rendering errors (#218883)\n\nFixes various syntax and rendering errors that might include:\n\n* Fixing broken images\n* Hardcoding book-level substitution values\n* Fixing incorrectly closed blocks (admonitions, tab sets, code blocks,\ndropdowns etc.)\n* Fixing poorly migrated complex tables\n* Fixing poorly migrated lists\n* Fixing poorly migrated tab sets\n* Removing inline text formatting from directive titles where they won't\nbe rendered (for example, inline `code` formatting in dropdown titles)\n* Specifying if a version is trying to communicate if a feature was\nadded, deprecated, or coming (for example, during migration\n`deprecated:[8.15.0]` became `[8.15.0]`, which doesn't give any\ninformation about _what_ happened in 8.15.0)\n* Note: I used an `{admonition}` for this, but you can change it to\nprose or some other kind of admonition if you want.\n* Fixing nested dropdowns / definition lists\n* Fixing poorly migrated footnotes\n* Updating references to prerelease `9.0.0` versions (using a repo-level\nsubstitution until there is a solution to\nhttps://github.com/elastic/docs-builder/issues/737)\n\nLinks to pages that were updated:\n\n| Before | After |\n|---|---|\n| https://www.elastic.co/docs/extend/kibana/development-documentation |\nhttps://docs-v3-preview.elastic.dev/elastic/kibana/pull/218883/extend/development-documentation\n|\n| https://www.elastic.co/docs/extend/kibana/development-security |\nhttps://docs-v3-preview.elastic.dev/elastic/kibana/pull/218883/extend/development-security\n|\n| https://www.elastic.co/docs/extend/kibana/development-tests |\nhttps://docs-v3-preview.elastic.dev/elastic/kibana/pull/218883/extend/development-tests\n|\n|\nhttps://www.elastic.co/docs/extend/kibana/external-plugin-functional-tests\n|\nhttps://docs-v3-preview.elastic.dev/elastic/kibana/pull/218883/extend/external-plugin-functional-tests\n|\n| https://www.elastic.co/docs/extend/kibana/external-plugin-localization\n|\nhttps://docs-v3-preview.elastic.dev/elastic/kibana/pull/218883/extend/external-plugin-localization\n|\n| https://www.elastic.co/docs/extend/kibana/interpreting-ci-failures |\nhttps://docs-v3-preview.elastic.dev/elastic/kibana/pull/218883/extend/interpreting-ci-failures\n|\n| https://www.elastic.co/docs/extend/kibana/plugin-list |\nhttps://docs-v3-preview.elastic.dev/elastic/kibana/pull/218883/extend/plugin-list\n|\n| https://www.elastic.co/docs/extend/kibana/sample-data |\nhttps://docs-v3-preview.elastic.dev/elastic/kibana/pull/218883/extend/sample-data\n|\n| https://www.elastic.co/docs/extend/kibana/saved-objects-service |\nhttps://docs-v3-preview.elastic.dev/elastic/kibana/pull/218883/extend/saved-objects-service\n|\n| https://www.elastic.co/docs/extend/kibana/sharing-saved-objects |\nhttps://docs-v3-preview.elastic.dev/elastic/kibana/pull/218883/extend/sharing-saved-objects\n|\n| https://www.elastic.co/docs/extend/kibana/stability |\nhttps://docs-v3-preview.elastic.dev/elastic/kibana/pull/218883/extend/stability\n|\n| https://www.elastic.co/docs/reference/kibana/advanced-settings |\nhttps://docs-v3-preview.elastic.dev/elastic/kibana/pull/218883/reference/advanced-settings\n|\n|\nhttps://www.elastic.co/docs/reference/kibana/configuration-reference/ai-assistant-settings\n|\nhttps://docs-v3-preview.elastic.dev/elastic/kibana/pull/218883/reference/configuration-reference/ai-assistant-settings\n|\n|\nhttps://www.elastic.co/docs/reference/kibana/configuration-reference/fleet-settings\n|\nhttps://docs-v3-preview.elastic.dev/elastic/kibana/pull/218883/reference/configuration-reference/fleet-settings\n|\n|\nhttps://www.elastic.co/docs/reference/kibana/configuration-reference/general-settings\n|\nhttps://docs-v3-preview.elastic.dev/elastic/kibana/pull/218883/reference/configuration-reference/general-settings\n|\n|\nhttps://www.elastic.co/docs/reference/kibana/configuration-reference/monitoring-settings\n|\nhttps://docs-v3-preview.elastic.dev/elastic/kibana/pull/218883/reference/configuration-reference/monitoring-settings\n|\n|\nhttps://www.elastic.co/docs/reference/kibana/configuration-reference/reporting-settings\n|\nhttps://docs-v3-preview.elastic.dev/elastic/kibana/pull/218883/reference/configuration-reference/reporting-settings\n|\n|\nhttps://www.elastic.co/docs/reference/kibana/configuration-reference/task-manager-settings\n|\nhttps://docs-v3-preview.elastic.dev/elastic/kibana/pull/218883/reference/configuration-reference/task-manager-settings\n|\n|\nhttps://www.elastic.co/docs/reference/kibana/connectors-kibana/cases-webhook-action-type\n|\nhttps://docs-v3-preview.elastic.dev/elastic/kibana/pull/218883/reference/connectors-kibana/cases-webhook-action-type\n|\n|\nhttps://www.elastic.co/docs/reference/kibana/connectors-kibana/email-action-type\n|\nhttps://docs-v3-preview.elastic.dev/elastic/kibana/pull/218883/reference/connectors-kibana/email-action-type\n|\n|\nhttps://www.elastic.co/docs/reference/kibana/connectors-kibana/pre-configured-connectors\n|\nhttps://docs-v3-preview.elastic.dev/elastic/kibana/pull/218883/reference/connectors-kibana/pre-configured-connectors\n|\n|\nhttps://www.elastic.co/docs/reference/kibana/connectors-kibana/servicenow-action-type\n|\nhttps://docs-v3-preview.elastic.dev/elastic/kibana/pull/218883/reference/connectors-kibana/servicenow-action-type\n|\n|\nhttps://www.elastic.co/docs/reference/kibana/connectors-kibana/servicenow-itom-action-type\n|\nhttps://docs-v3-preview.elastic.dev/elastic/kibana/pull/218883/reference/connectors-kibana/servicenow-itom-action-type\n|\n|\nhttps://www.elastic.co/docs/reference/kibana/connectors-kibana/servicenow-sir-action-type\n|\nhttps://docs-v3-preview.elastic.dev/elastic/kibana/pull/218883/reference/connectors-kibana/servicenow-sir-action-type\n|\n|\nhttps://www.elastic.co/docs/reference/kibana/connectors-kibana/thehive-action-type\n|\nhttps://docs-v3-preview.elastic.dev/elastic/kibana/pull/218883/reference/connectors-kibana/thehive-action-type\n|\n|\nhttps://www.elastic.co/docs/reference/kibana/connectors-kibana/webhook-action-type\n|\nhttps://docs-v3-preview.elastic.dev/elastic/kibana/pull/218883/reference/connectors-kibana/webhook-action-type\n|\n| https://www.elastic.co/docs/reference/kibana/kibana-audit-events |\nhttps://docs-v3-preview.elastic.dev/elastic/kibana/pull/218883/reference/kibana-audit-events\n|\n| https://www.elastic.co/docs/reference/kibana/kibana-plugins |\nhttps://docs-v3-preview.elastic.dev/elastic/kibana/pull/218883/reference/kibana-plugins\n|\n| https://www.elastic.co/docs/release-kibana/notes/index |\nhttps://docs-v3-preview.elastic.dev/elastic/kibana/pull/218883/release-notes/index\n|\n\n---------\n\nCo-authored-by: wajihaparvez <wajiha.parvez@elastic.co>","sha":"fbda17de2dbcf4289b1c269bdec0cb1d626bc7ad","branchLabelMapping":{"^v9.1.0$":"main","^v(\\d+).(\\d+).\\d+$":"$1.$2"}},"sourcePullRequest":{"labels":["Team:Docs","release_note:skip","backport missing","docs","documentation","backport:version","v9.1.0","v9.0.2"],"title":"[docs] Fix various syntax and rendering errors","number":218883,"url":"https://github.com/elastic/kibana/pull/218883","mergeCommit":{"message":"[docs] Fix various syntax and rendering errors (#218883)\n\nFixes various syntax and rendering errors that might include:\n\n* Fixing broken images\n* Hardcoding book-level substitution values\n* Fixing incorrectly closed blocks (admonitions, tab sets, code blocks,\ndropdowns etc.)\n* Fixing poorly migrated complex tables\n* Fixing poorly migrated lists\n* Fixing poorly migrated tab sets\n* Removing inline text formatting from directive titles where they won't\nbe rendered (for example, inline `code` formatting in dropdown titles)\n* Specifying if a version is trying to communicate if a feature was\nadded, deprecated, or coming (for example, during migration\n`deprecated:[8.15.0]` became `[8.15.0]`, which doesn't give any\ninformation about _what_ happened in 8.15.0)\n* Note: I used an `{admonition}` for this, but you can change it to\nprose or some other kind of admonition if you want.\n* Fixing nested dropdowns / definition lists\n* Fixing poorly migrated footnotes\n* Updating references to prerelease `9.0.0` versions (using a repo-level\nsubstitution until there is a solution to\nhttps://github.com/elastic/docs-builder/issues/737)\n\nLinks to pages that were updated:\n\n| Before | After |\n|---|---|\n| https://www.elastic.co/docs/extend/kibana/development-documentation |\nhttps://docs-v3-preview.elastic.dev/elastic/kibana/pull/218883/extend/development-documentation\n|\n| https://www.elastic.co/docs/extend/kibana/development-security |\nhttps://docs-v3-preview.elastic.dev/elastic/kibana/pull/218883/extend/development-security\n|\n| https://www.elastic.co/docs/extend/kibana/development-tests |\nhttps://docs-v3-preview.elastic.dev/elastic/kibana/pull/218883/extend/development-tests\n|\n|\nhttps://www.elastic.co/docs/extend/kibana/external-plugin-functional-tests\n|\nhttps://docs-v3-preview.elastic.dev/elastic/kibana/pull/218883/extend/external-plugin-functional-tests\n|\n| https://www.elastic.co/docs/extend/kibana/external-plugin-localization\n|\nhttps://docs-v3-preview.elastic.dev/elastic/kibana/pull/218883/extend/external-plugin-localization\n|\n| https://www.elastic.co/docs/extend/kibana/interpreting-ci-failures |\nhttps://docs-v3-preview.elastic.dev/elastic/kibana/pull/218883/extend/interpreting-ci-failures\n|\n| https://www.elastic.co/docs/extend/kibana/plugin-list |\nhttps://docs-v3-preview.elastic.dev/elastic/kibana/pull/218883/extend/plugin-list\n|\n| https://www.elastic.co/docs/extend/kibana/sample-data |\nhttps://docs-v3-preview.elastic.dev/elastic/kibana/pull/218883/extend/sample-data\n|\n| https://www.elastic.co/docs/extend/kibana/saved-objects-service |\nhttps://docs-v3-preview.elastic.dev/elastic/kibana/pull/218883/extend/saved-objects-service\n|\n| https://www.elastic.co/docs/extend/kibana/sharing-saved-objects |\nhttps://docs-v3-preview.elastic.dev/elastic/kibana/pull/218883/extend/sharing-saved-objects\n|\n| https://www.elastic.co/docs/extend/kibana/stability |\nhttps://docs-v3-preview.elastic.dev/elastic/kibana/pull/218883/extend/stability\n|\n| https://www.elastic.co/docs/reference/kibana/advanced-settings |\nhttps://docs-v3-preview.elastic.dev/elastic/kibana/pull/218883/reference/advanced-settings\n|\n|\nhttps://www.elastic.co/docs/reference/kibana/configuration-reference/ai-assistant-settings\n|\nhttps://docs-v3-preview.elastic.dev/elastic/kibana/pull/218883/reference/configuration-reference/ai-assistant-settings\n|\n|\nhttps://www.elastic.co/docs/reference/kibana/configuration-reference/fleet-settings\n|\nhttps://docs-v3-preview.elastic.dev/elastic/kibana/pull/218883/reference/configuration-reference/fleet-settings\n|\n|\nhttps://www.elastic.co/docs/reference/kibana/configuration-reference/general-settings\n|\nhttps://docs-v3-preview.elastic.dev/elastic/kibana/pull/218883/reference/configuration-reference/general-settings\n|\n|\nhttps://www.elastic.co/docs/reference/kibana/configuration-reference/monitoring-settings\n|\nhttps://docs-v3-preview.elastic.dev/elastic/kibana/pull/218883/reference/configuration-reference/monitoring-settings\n|\n|\nhttps://www.elastic.co/docs/reference/kibana/configuration-reference/reporting-settings\n|\nhttps://docs-v3-preview.elastic.dev/elastic/kibana/pull/218883/reference/configuration-reference/reporting-settings\n|\n|\nhttps://www.elastic.co/docs/reference/kibana/configuration-reference/task-manager-settings\n|\nhttps://docs-v3-preview.elastic.dev/elastic/kibana/pull/218883/reference/configuration-reference/task-manager-settings\n|\n|\nhttps://www.elastic.co/docs/reference/kibana/connectors-kibana/cases-webhook-action-type\n|\nhttps://docs-v3-preview.elastic.dev/elastic/kibana/pull/218883/reference/connectors-kibana/cases-webhook-action-type\n|\n|\nhttps://www.elastic.co/docs/reference/kibana/connectors-kibana/email-action-type\n|\nhttps://docs-v3-preview.elastic.dev/elastic/kibana/pull/218883/reference/connectors-kibana/email-action-type\n|\n|\nhttps://www.elastic.co/docs/reference/kibana/connectors-kibana/pre-configured-connectors\n|\nhttps://docs-v3-preview.elastic.dev/elastic/kibana/pull/218883/reference/connectors-kibana/pre-configured-connectors\n|\n|\nhttps://www.elastic.co/docs/reference/kibana/connectors-kibana/servicenow-action-type\n|\nhttps://docs-v3-preview.elastic.dev/elastic/kibana/pull/218883/reference/connectors-kibana/servicenow-action-type\n|\n|\nhttps://www.elastic.co/docs/reference/kibana/connectors-kibana/servicenow-itom-action-type\n|\nhttps://docs-v3-preview.elastic.dev/elastic/kibana/pull/218883/reference/connectors-kibana/servicenow-itom-action-type\n|\n|\nhttps://www.elastic.co/docs/reference/kibana/connectors-kibana/servicenow-sir-action-type\n|\nhttps://docs-v3-preview.elastic.dev/elastic/kibana/pull/218883/reference/connectors-kibana/servicenow-sir-action-type\n|\n|\nhttps://www.elastic.co/docs/reference/kibana/connectors-kibana/thehive-action-type\n|\nhttps://docs-v3-preview.elastic.dev/elastic/kibana/pull/218883/reference/connectors-kibana/thehive-action-type\n|\n|\nhttps://www.elastic.co/docs/reference/kibana/connectors-kibana/webhook-action-type\n|\nhttps://docs-v3-preview.elastic.dev/elastic/kibana/pull/218883/reference/connectors-kibana/webhook-action-type\n|\n| https://www.elastic.co/docs/reference/kibana/kibana-audit-events |\nhttps://docs-v3-preview.elastic.dev/elastic/kibana/pull/218883/reference/kibana-audit-events\n|\n| https://www.elastic.co/docs/reference/kibana/kibana-plugins |\nhttps://docs-v3-preview.elastic.dev/elastic/kibana/pull/218883/reference/kibana-plugins\n|\n| https://www.elastic.co/docs/release-kibana/notes/index |\nhttps://docs-v3-preview.elastic.dev/elastic/kibana/pull/218883/release-notes/index\n|\n\n---------\n\nCo-authored-by: wajihaparvez <wajiha.parvez@elastic.co>","sha":"fbda17de2dbcf4289b1c269bdec0cb1d626bc7ad"}},"sourceBranch":"main","suggestedTargetBranches":["9.0"],"targetPullRequestStates":[{"branch":"main","label":"v9.1.0","branchLabelMappingKey":"^v9.1.0$","isSourceBranch":true,"state":"MERGED","url":"https://github.com/elastic/kibana/pull/218883","number":218883,"mergeCommit":{"message":"[docs] Fix various syntax and rendering errors (#218883)\n\nFixes various syntax and rendering errors that might include:\n\n* Fixing broken images\n* Hardcoding book-level substitution values\n* Fixing incorrectly closed blocks (admonitions, tab sets, code blocks,\ndropdowns etc.)\n* Fixing poorly migrated complex tables\n* Fixing poorly migrated lists\n* Fixing poorly migrated tab sets\n* Removing inline text formatting from directive titles where they won't\nbe rendered (for example, inline `code` formatting in dropdown titles)\n* Specifying if a version is trying to communicate if a feature was\nadded, deprecated, or coming (for example, during migration\n`deprecated:[8.15.0]` became `[8.15.0]`, which doesn't give any\ninformation about _what_ happened in 8.15.0)\n* Note: I used an `{admonition}` for this, but you can change it to\nprose or some other kind of admonition if you want.\n* Fixing nested dropdowns / definition lists\n* Fixing poorly migrated footnotes\n* Updating references to prerelease `9.0.0` versions (using a repo-level\nsubstitution until there is a solution to\nhttps://github.com/elastic/docs-builder/issues/737)\n\nLinks to pages that were updated:\n\n| Before | After |\n|---|---|\n| https://www.elastic.co/docs/extend/kibana/development-documentation |\nhttps://docs-v3-preview.elastic.dev/elastic/kibana/pull/218883/extend/development-documentation\n|\n| https://www.elastic.co/docs/extend/kibana/development-security |\nhttps://docs-v3-preview.elastic.dev/elastic/kibana/pull/218883/extend/development-security\n|\n| https://www.elastic.co/docs/extend/kibana/development-tests |\nhttps://docs-v3-preview.elastic.dev/elastic/kibana/pull/218883/extend/development-tests\n|\n|\nhttps://www.elastic.co/docs/extend/kibana/external-plugin-functional-tests\n|\nhttps://docs-v3-preview.elastic.dev/elastic/kibana/pull/218883/extend/external-plugin-functional-tests\n|\n| https://www.elastic.co/docs/extend/kibana/external-plugin-localization\n|\nhttps://docs-v3-preview.elastic.dev/elastic/kibana/pull/218883/extend/external-plugin-localization\n|\n| https://www.elastic.co/docs/extend/kibana/interpreting-ci-failures |\nhttps://docs-v3-preview.elastic.dev/elastic/kibana/pull/218883/extend/interpreting-ci-failures\n|\n| https://www.elastic.co/docs/extend/kibana/plugin-list |\nhttps://docs-v3-preview.elastic.dev/elastic/kibana/pull/218883/extend/plugin-list\n|\n| https://www.elastic.co/docs/extend/kibana/sample-data |\nhttps://docs-v3-preview.elastic.dev/elastic/kibana/pull/218883/extend/sample-data\n|\n| https://www.elastic.co/docs/extend/kibana/saved-objects-service |\nhttps://docs-v3-preview.elastic.dev/elastic/kibana/pull/218883/extend/saved-objects-service\n|\n| https://www.elastic.co/docs/extend/kibana/sharing-saved-objects |\nhttps://docs-v3-preview.elastic.dev/elastic/kibana/pull/218883/extend/sharing-saved-objects\n|\n| https://www.elastic.co/docs/extend/kibana/stability |\nhttps://docs-v3-preview.elastic.dev/elastic/kibana/pull/218883/extend/stability\n|\n| https://www.elastic.co/docs/reference/kibana/advanced-settings |\nhttps://docs-v3-preview.elastic.dev/elastic/kibana/pull/218883/reference/advanced-settings\n|\n|\nhttps://www.elastic.co/docs/reference/kibana/configuration-reference/ai-assistant-settings\n|\nhttps://docs-v3-preview.elastic.dev/elastic/kibana/pull/218883/reference/configuration-reference/ai-assistant-settings\n|\n|\nhttps://www.elastic.co/docs/reference/kibana/configuration-reference/fleet-settings\n|\nhttps://docs-v3-preview.elastic.dev/elastic/kibana/pull/218883/reference/configuration-reference/fleet-settings\n|\n|\nhttps://www.elastic.co/docs/reference/kibana/configuration-reference/general-settings\n|\nhttps://docs-v3-preview.elastic.dev/elastic/kibana/pull/218883/reference/configuration-reference/general-settings\n|\n|\nhttps://www.elastic.co/docs/reference/kibana/configuration-reference/monitoring-settings\n|\nhttps://docs-v3-preview.elastic.dev/elastic/kibana/pull/218883/reference/configuration-reference/monitoring-settings\n|\n|\nhttps://www.elastic.co/docs/reference/kibana/configuration-reference/reporting-settings\n|\nhttps://docs-v3-preview.elastic.dev/elastic/kibana/pull/218883/reference/configuration-reference/reporting-settings\n|\n|\nhttps://www.elastic.co/docs/reference/kibana/configuration-reference/task-manager-settings\n|\nhttps://docs-v3-preview.elastic.dev/elastic/kibana/pull/218883/reference/configuration-reference/task-manager-settings\n|\n|\nhttps://www.elastic.co/docs/reference/kibana/connectors-kibana/cases-webhook-action-type\n|\nhttps://docs-v3-preview.elastic.dev/elastic/kibana/pull/218883/reference/connectors-kibana/cases-webhook-action-type\n|\n|\nhttps://www.elastic.co/docs/reference/kibana/connectors-kibana/email-action-type\n|\nhttps://docs-v3-preview.elastic.dev/elastic/kibana/pull/218883/reference/connectors-kibana/email-action-type\n|\n|\nhttps://www.elastic.co/docs/reference/kibana/connectors-kibana/pre-configured-connectors\n|\nhttps://docs-v3-preview.elastic.dev/elastic/kibana/pull/218883/reference/connectors-kibana/pre-configured-connectors\n|\n|\nhttps://www.elastic.co/docs/reference/kibana/connectors-kibana/servicenow-action-type\n|\nhttps://docs-v3-preview.elastic.dev/elastic/kibana/pull/218883/reference/connectors-kibana/servicenow-action-type\n|\n|\nhttps://www.elastic.co/docs/reference/kibana/connectors-kibana/servicenow-itom-action-type\n|\nhttps://docs-v3-preview.elastic.dev/elastic/kibana/pull/218883/reference/connectors-kibana/servicenow-itom-action-type\n|\n|\nhttps://www.elastic.co/docs/reference/kibana/connectors-kibana/servicenow-sir-action-type\n|\nhttps://docs-v3-preview.elastic.dev/elastic/kibana/pull/218883/reference/connectors-kibana/servicenow-sir-action-type\n|\n|\nhttps://www.elastic.co/docs/reference/kibana/connectors-kibana/thehive-action-type\n|\nhttps://docs-v3-preview.elastic.dev/elastic/kibana/pull/218883/reference/connectors-kibana/thehive-action-type\n|\n|\nhttps://www.elastic.co/docs/reference/kibana/connectors-kibana/webhook-action-type\n|\nhttps://docs-v3-preview.elastic.dev/elastic/kibana/pull/218883/reference/connectors-kibana/webhook-action-type\n|\n| https://www.elastic.co/docs/reference/kibana/kibana-audit-events |\nhttps://docs-v3-preview.elastic.dev/elastic/kibana/pull/218883/reference/kibana-audit-events\n|\n| https://www.elastic.co/docs/reference/kibana/kibana-plugins |\nhttps://docs-v3-preview.elastic.dev/elastic/kibana/pull/218883/reference/kibana-plugins\n|\n| https://www.elastic.co/docs/release-kibana/notes/index |\nhttps://docs-v3-preview.elastic.dev/elastic/kibana/pull/218883/release-notes/index\n|\n\n---------\n\nCo-authored-by: wajihaparvez <wajiha.parvez@elastic.co>","sha":"fbda17de2dbcf4289b1c269bdec0cb1d626bc7ad"}},{"branch":"9.0","label":"v9.0.2","branchLabelMappingKey":"^v(\\d+).(\\d+).\\d+$","isSourceBranch":false,"state":"NOT_CREATED"}]}] BACKPORT--> Co-authored-by: Colleen McGinnis <colleen.mcginnis@elastic.co> Co-authored-by: wajihaparvez <wajiha.parvez@elastic.co>
63 lines
3.4 KiB
Markdown
63 lines
3.4 KiB
Markdown
---
|
|
navigation_title: "Task Manager settings"
|
|
mapped_pages:
|
|
- https://www.elastic.co/guide/en/kibana/current/task-manager-settings-kb.html
|
|
applies_to:
|
|
deployment:
|
|
self: all
|
|
---
|
|
|
|
# Task Manager settings in {{kib}} [task-manager-settings-kb]
|
|
|
|
|
|
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 [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`
|
|
: :::{admonition} Deprecated in 8.16.0
|
|
This setting was deprecated in 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.
|
|
|
|
|
|
## Task Manager Health settings [task-manager-health-settings]
|
|
|
|
Settings that configure the [Health monitoring](docs-content://deploy-manage/monitor/kibana-task-manager-health-monitoring.md) 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).
|
|
|
|
|