Task Manager health APIedit
Retrieve the health status of the Kibana Task Manager.
Requestedit
GET <kibana host>:<port>/api/task_manager/_health
Response codeedit
-
200
- Indicates a successful call.
Exampleedit
Retrieve the health status of the Kibana Task Manager:
$ curl -X GET api/task_manager/_health
The API returns the following:
{ "id": "15415ecf-cdb0-4fef-950a-f824bd277fe4", "timestamp": "2021-02-16T11:38:10.077Z", "status": "OK", "last_update": "2021-02-16T11:38:09.934Z", "stats": { "configuration": { "timestamp": "2021-02-16T11:29:05.055Z", "value": { "request_capacity": 1000, "monitored_aggregated_stats_refresh_rate": 60000, "monitored_stats_running_average_window": 50, "monitored_task_execution_thresholds": { "default": { "error_threshold": 90, "warn_threshold": 80 }, "custom": {} }, "poll_interval": 3000, "max_workers": 10 }, "status": "OK" }, "runtime": { "timestamp": "2021-02-16T11:38:09.934Z", "value": { "polling": { "last_successful_poll": "2021-02-16T11:38:09.934Z", "last_polling_delay": "2021-02-16T11:29:05.053Z", "duration": { "p50": 0, "p90": 0, "p95": 0, "p99": 0 }, "claim_conflicts": { "p50": 0, "p90": 0, "p95": 0, "p99": 0 }, "claim_mismatches": { "p50": 0, "p90": 0, "p95": 0, "p99": 0 }, "result_frequency_percent_as_number": { "Failed": 0, "NoAvailableWorkers": 0, "NoTasksClaimed": 0, "RanOutOfCapacity": 0, "RunningAtCapacity": 0, "PoolFilled": 0 } }, "drift": { "p50": 0, "p90": 0, "p95": 0, "p99": 0 }, "load": { "p50": 0, "p90": 0, "p95": 0, "p99": 0 }, "execution": { "duration": {}, "result_frequency_percent_as_number": {} } }, "status": "OK" }, "workload": { "timestamp": "2021-02-16T11:38:05.826Z", "value": { "count": 26, "task_types": {}, "schedule": [], "overdue": 0, "estimated_schedule_density": [] }, "status": "OK" } } }
The health API response is described in Making sense of Task Manager health stats.
The health monitoring API exposes three sections:
-
configuration
is described in detail under Evaluate the Configuration -
workload
is described in detail under Evaluate the Workload -
runtime
is described in detail under Evaluate the Runtime