c69f860bfe
* Merge pull request #1 from Yury-Fridlyand/dev-update-sql-relevance-docs Update SQL plugin relevance functions documentation. Co-authored-by: MaxKsyunz <[email protected]> Signed-off-by: Yury Fridlyand <[email protected]> * Address PR feedback. Signed-off-by: Yury Fridlyand <[email protected]> * Address PR feedback by @joshuali925. Signed-off-by: Yury Fridlyand <[email protected]> * Remove PPL page from Observability Plugin. Add link to Observability page. Make some simple formatting changes Signed-off-by: Naarcha-AWS <[email protected]> * Reword paragraph Signed-off-by: Naarcha-AWS <[email protected]> * Adds SQL and PPL API and other SQL plugin changes Signed-off-by: Fanit Kolchina <[email protected]> * Formatting changes Signed-off-by: Fanit Kolchina <[email protected]> * Incorporates editorial comments Signed-off-by: Fanit Kolchina <[email protected]> Signed-off-by: Yury Fridlyand <[email protected]> Signed-off-by: Naarcha-AWS <[email protected]> Signed-off-by: Fanit Kolchina <[email protected]> Co-authored-by: Yury Fridlyand <[email protected]> Co-authored-by: MaxKsyunz <[email protected]> Co-authored-by: Fanit Kolchina <[email protected]>
51 lines
1.4 KiB
Markdown
51 lines
1.4 KiB
Markdown
---
|
|
layout: default
|
|
title: Monitoring
|
|
parent: SQL and PPL
|
|
nav_order: 95
|
|
---
|
|
|
|
# Monitoring
|
|
|
|
By a stats endpoint, you are able to collect metrics for the plugin
|
|
within the interval. Note that only node level statistics collecting is
|
|
implemented for now. In other words, you only get the metrics for the
|
|
node you're accessing. Cluster level statistics have yet to be
|
|
implemented.
|
|
|
|
## Node Stats
|
|
|
|
### Description
|
|
|
|
The meaning of fields in the response is as follows:
|
|
|
|
| Field name| Description|
|
|
| ------------------------- | ------------------------------------------------------------- |
|
|
| request_total| Total count of request|
|
|
| request_count| Total count of request within the interval|
|
|
|failed_request_count_syserr|Count of failed request due to system error within the interval|
|
|
|failed_request_count_cuserr| Count of failed request due to bad request within the interval|
|
|
| failed_request_count_cb| Indicate if plugin is being circuit broken within the interval|
|
|
|
|
|
|
### Example
|
|
|
|
SQL query:
|
|
|
|
```console
|
|
>> curl -H 'Content-Type: application/json' -X GET localhost:9200/_plugins/_sql/stats
|
|
```
|
|
|
|
Result set:
|
|
|
|
```json
|
|
{
|
|
"failed_request_count_cb": 0,
|
|
"failed_request_count_cuserr": 0,
|
|
"circuit_breaker": 0,
|
|
"request_total": 0,
|
|
"request_count": 0,
|
|
"failed_request_count_syserr": 0
|
|
}
|
|
```
|