---
title: Telegraf Documentation
description: Telegraf plugin for collecting metrics from Kibana
url: https://docs.influxdata.com/telegraf/v1/input-plugins/kibana/
estimated_tokens: 1592
product: Telegraf
version: v1
---

-   Telegraf v1.8.0+

# Kibana Input Plugin

This plugin collects metrics about service status from [Kibana](https://www.elastic.co/kibana) instances via the server’s API.

This plugin requires Kibana version 6.0+.

**Introduced in:** Telegraf v1.8.0 **Tags:** applications, server **OS support:** all

## Global configuration options

Plugins support additional global and plugin configuration settings for tasks such as modifying metrics, tags, and fields, creating aliases, and configuring plugin ordering. See [CONFIGURATION.md](/telegraf/v1/configuration/#plugins) for more details.

## Configuration

```toml
# Read status information from one or more Kibana servers
[[inputs.kibana]]
  ## Specify a list of one or more Kibana servers
  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

  ## If 'use_system_proxy' is set to true, Telegraf will check env vars such as
  ## HTTP_PROXY, HTTPS_PROXY, and NO_PROXY (or their lowercase counterparts).
  ## If 'use_system_proxy' is set to false (default) and 'http_proxy_url' is
  ## provided, Telegraf will use the specified URL as HTTP proxy.
  # use_system_proxy = false
  # http_proxy_url = "http://localhost:8888"
```

## Metrics

-   kibana
    -   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)
        -   heap\_size\_limit (integer)
        -   uptime\_ms (integer)
        -   response\_time\_avg\_ms (float)
        -   response\_time\_max\_ms (integer)
        -   concurrent\_connections (integer)
        -   requests\_per\_sec (float)

## Example Output

```text
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
```

## Run example environment

Requires the following tools:

-   [Docker](https://docs.docker.com/get-docker/)
-   [Docker Compose](https://docs.docker.com/compose/install/)

From the root of this project execute the following script: `./plugins/inputs/kibana/test_environment/run_test_env.sh`

This will build the latest Telegraf and then start up Kibana and Elasticsearch, Telegraf will begin monitoring Kibana’s status and write its results to the file `/tmp/metrics.out` in the Telegraf container.

Then you can attach to the telegraf container to inspect the file `/tmp/metrics.out` to see if the status is being reported.

The Visual Studio Code [Remote - Containers](https://marketplace.visualstudio.com/items?itemName=ms-vscode-remote.remote-containers) extension provides an easy user interface to attach to the running container.

#### Related

-   [Configure plugins](/telegraf/v1/configure_plugins/)
-   [Kibana Plugin Source](https://github.com/influxdata/telegraf/tree/v1.38.4/plugins/inputs/kibana/README.md)