telegraf/plugins/inputs/kibana/README.md

56 lines
1.6 KiB
Markdown
Raw Normal View History

2020-01-23 23:33:13 +00:00
# Kibana Input Plugin
2018-08-24 21:58:41 +00:00
2020-01-23 23:33:13 +00:00
The `kibana` plugin queries the [Kibana][] API to obtain the service status.
2018-08-24 21:58:41 +00:00
2020-01-23 23:33:13 +00:00
- Telegraf minimum version: 1.8
- Kibana minimum tested version: 6.0
[Kibana]: https://www.elastic.co/
2018-08-24 21:58:41 +00:00
### Configuration
```toml
[[inputs.kibana]]
2020-01-23 23:33:13 +00:00
## Specify a list of one or more Kibana servers
2018-08-24 21:58:41 +00:00
servers = ["http://localhost:5601"]
## Timeout for HTTP requests
timeout = "5s"
## HTTP Basic Auth credentials
# username = "username"
# password = "pa$$word"
## Optional TLS Config
# tls_ca = "/etc/telegraf/ca.pem"
# tls_cert = "/etc/telegraf/cert.pem"
# tls_key = "/etc/telegraf/key.pem"
## Use TLS but skip chain & host verification
# insecure_skip_verify = false
```
2020-01-23 23:33:13 +00:00
### Metrics
2018-08-24 21:58:41 +00:00
- kibana
2020-01-23 23:33:13 +00:00
- tags:
- name (Kibana reported name)
- source (Kibana server hostname or IP)
- status (Kibana health: green, yellow, red)
- version (Kibana version)
- fields:
- status_code (integer, green=1 yellow=2 red=3 unknown=0)
- heap_total_bytes (integer)
- heap_max_bytes (integer; deprecated in 1.13.3: use `heap_total_bytes` field)
- heap_used_bytes (integer)
- uptime_ms (integer)
- response_time_avg_ms (float)
- response_time_max_ms (integer)
- concurrent_connections (integer)
- requests_per_sec (float)
2018-08-24 21:58:41 +00:00
### Example Output
2020-01-23 23:33:13 +00:00
```
kibana,host=myhost,name=my-kibana,source=localhost:5601,status=green,version=6.5.4 concurrent_connections=8i,heap_max_bytes=447778816i,heap_total_bytes=447778816i,heap_used_bytes=380603352i,requests_per_sec=1,response_time_avg_ms=57.6,response_time_max_ms=220i,status_code=1i,uptime_ms=6717489805i 1534864502000000000
```