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

[Stack Monitoring] health api note (#147210)

Browse source 
## Summary

Added note about the health API in runbooks
This commit is contained in:
Kevin Lacabane 2022-12-12 15:41:32 +01:00 • committed by GitHub
parent 5ae469d54c
commit a3a90f3dd2
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
2 changed files with 10 additions and 4 deletions
Download patch file Download diff file Expand all files Collapse all files

9
x-pack/plugins/monitoring/dev_docs/runbook/diagnostic_queries.md
View file

@ -1,4 +1,9 @@
If the stack monitoring UI isn't showing data for any cluster, it may first be useful to survey the available data using a query like this:
If the stack monitoring UI isn't showing data for any cluster or missing key metrics, it may first be useful to survey the available data.
If troubleshooting a cluster with a version >= 8.3.1, the [Stack Monitoring health API](https://github.com/elastic/kibana/tree/main/x-pack/plugins/monitoring/server/routes/api/v1/_health) is the recommended way to get an overview of the available data and possible metrics collection issues.
The API is included in the [support-diagnostics utility](https://github.com/elastic/support-diagnostics) so if a bundle is provided in the issue you're working on, the API response would already be available in `kibana_stack_monitoring_health.json`. Otherwise, one can ask for the API response instead of the raw queries.
If troubleshooting an older version, the following queries would be good starters:
```Kibana Dev Tools
POST .monitoring-*,*:.monitoring-*,metrics-*,*:metrics-*/_search
@ -117,4 +122,4 @@ POST .monitoring-*,*:.monitoring-*,metrics-*,*:metrics-*/_search
}
}
}
```
```

5
x-pack/plugins/monitoring/server/routes/api/v1/_health/README.md
View file

@ -2,7 +2,7 @@
A endpoint that makes a handful of pre-determined queries to determine the health/status of stack monitoring for the configured kibana.
GET /api/monitoring/v1/_health
**GET /api/monitoring/v1/_health**
parameters:
- (optional) min: start date of the queries, in ms or YYYY-MM-DD hh:mm:ss
- (optional) max: end date of the queries, in ms or YYYY-MM-DD hh:mm:ss
@ -10,4 +10,5 @@ parameters:
The response includes sections that can provide useful informations in a debugging context:
- settings: a subset of the kibana.yml settings relevant to stack monitoring
- monitoredClusters: a representation of the monitoring documents available to the running kibana. It exposes which metricsets are collected by what collection mode and when was the last time it was ingested. The query groups the metricsets by products and can help identifying missing documents that could explain why a page is not loading or crashing
- monitoredClusters: a representation of the monitoring documents available to the running kibana. It exposes which metricsets are collected by what collection mode and when was the last time it was ingested. The query groups the metricsets by products and can help identify missing documents that could explain why a page is not loading or crashing
- metricbeatErrors: a list of errors encountered by metricbeat processes when collecting data