github-mirrors/kibana
1
0
Fork 0
mirror of https://github.com/elastic/kibana.git synced 2025-04-24 17:59:23 -04:00
Code Issues Projects Releases Packages Wiki Activity

[Alerting] Update docs to include new o11y features (#104884)

Browse source 
* Update docs to include new o11y features

* PR feedback

* PR feedback

* Bold the headers

* PR feedback
This commit is contained in:
Chris Roberson 2021-07-14 13:17:12 -04:00 • committed by GitHub
parent 44441e7ae0
commit 5a08cae8f0
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 22 additions and 3 deletions
Download patch file Download diff file Expand all files Collapse all files

25
docs/user/production-considerations/task-manager-health-monitoring.asciidoc
View file

@ -57,8 +57,12 @@ xpack.task_manager.monitored_task_execution_thresholds:
The health API is best consumed by via the `/api/task_manager/_health` endpoint.
Additionally, the metrics are logged in the {kib} `DEBUG` logger at a regular cadence.
To enable Task Manager DEBUG logging in your {kib} instance, add the following to your `kibana.yml`:
Additionally, there are two ways to consume these metrics:
*Debug logging*
The metrics are logged in the {kib} `DEBUG` logger at a regular cadence.
To enable Task Manager debug logging in your {kib} instance, add the following to your `kibana.yml`:
[source,yml]
----
@ -69,7 +73,22 @@ logging:
level: debug
----
These stats are logged based the number of milliseconds set in your <<task-manager-settings,`xpack.task_manager.poll_interval`>> setting, which means it could add substantial noise to your logs. Only enable this level of logging temporarily.
These stats are logged based on the number of milliseconds set in your <<task-manager-settings,`xpack.task_manager.poll_interval`>> setting, which could add substantial noise to your logs. Only enable this level of logging temporarily.
*Automatic logging*
By default, the health API runs at a regular cadence, and each time it runs, it attempts to self evaluate its performance. If this self evaluation yields a potential problem,
a message will log to the {kib} server log. In addition, the health API will look at how long tasks have waited to start (from when they were scheduled to start). If this number exceeds a configurable threshold (<<task-manager-settings,`xpack.task_manager.monitored_stats_health_verbose_log.warn_delayed_task_start_in_seconds`>>), the same message as above will log to the {kib} server log.
This message looks like:
[source,log]
----
Detected potential performance issue with Task Manager. Set 'xpack.task_manager.monitored_stats_health_verbose_log.enabled: true' in your Kibana.yml to enable debug logging`
----
If this message appears, set <<task-manager-settings,`xpack.task_manager.monitored_stats_health_verbose_log.enabled`>> to `true` in your `kibana.yml`. This will start logging the health metrics at either a `warn` or `error` log level, depending on the detected severity of the potential problem.
[float]
[[making-sense-of-task-manager-health-stats]]