Skip to content

Commit

Permalink
[Alerting] Update docs to include new o11y features (#104884)
Browse files Browse the repository at this point in the history
* Update docs to include new o11y features

* PR feedback

* PR feedback

* Bold the headers

* PR feedback
  • Loading branch information
chrisronline authored Jul 14, 2021
1 parent 44441e7 commit 5a08cae
Showing 1 changed file with 22 additions and 3 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -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]
----
Expand All @@ -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]]
Expand Down

0 comments on commit 5a08cae

Please sign in to comment.