- Kibana Guide: other versions:
- What is Kibana?
- What’s new in 8.0
- Kibana concepts
- Quick start
- Set up
- Install Kibana
- Configure Kibana
- Alerting and action settings
- APM settings
- Banners settings
- Enterprise Search settings
- Fleet settings
- i18n settings
- Logging settings
- Logs settings
- Metrics settings
- Monitoring settings
- Reporting settings
- Search sessions settings
- Secure settings
- Security settings
- Spaces settings
- Task Manager settings
- Telemetry settings
- URL drilldown settings
- Start and stop Kibana
- Access Kibana
- Securing access to Kibana
- Add data
- Upgrade Kibana
- Configure security
- Configure reporting
- Configure logging
- Configure monitoring
- Command line tools
- Production considerations
- Discover
- Dashboard and visualizations
- Canvas
- Maps
- Build a map to compare metrics by country or region
- Track, visualize, and alert on assets in real time
- Map custom regions with reverse geocoding
- Heat map layer
- Tile layer
- Vector layer
- Plot big data
- Search geographic data
- Configure map settings
- Connect to Elastic Maps Service
- Import geospatial data
- Troubleshoot
- Reporting and sharing
- Machine learning
- Graph
- Alerting
- Observability
- APM
- Security
- Dev Tools
- Fleet
- Osquery
- Stack Monitoring
- Stack Management
- REST API
- Get features API
- Kibana spaces APIs
- Kibana role management APIs
- User session management APIs
- Saved objects APIs
- Data views API
- Index patterns APIs
- Alerting APIs
- Action and connector APIs
- Cases APIs
- Import and export dashboard APIs
- Logstash configuration management APIs
- Machine learning APIs
- Short URLs APIs
- Get Task Manager health
- Upgrade assistant APIs
- Kibana plugins
- Accessibility
- Release notes
- Developer guide
IMPORTANT: No additional bug fixes or documentation updates
will be released for this version. For the latest information, see the
current release documentation.
Task Manager health API
editTask Manager health API
editRetrieve the health status of the Kibana Task Manager.
Request
editGET <kibana host>:<port>/api/task_manager/_health
Response code
edit-
200
- Indicates a successful call.
Example
editRetrieve 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, "max_poll_inactivity_cycles": 10, "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
On this page
Was this helpful?
Thank you for your feedback.