Table of Contents
Introduction
Monitoring Kibana instances is crucial to ensuring optimal performance, identifying potential bottlenecks, and promptly addressing issues that may impact the platform's accessibility and functionality. Regular monitoring allows for proactive maintenance, enabling organizations to deliver a seamless and responsive user experience while ensuring the stability and reliability of their ELK stack.
In this article, we'll detail how to use the Telegraf agent to collect performance metrics from your Kibana instance and forward them to a data source.
Getting Started with the Telegraf Agent
Telegraf is a plugin-driven server agent built on InfluxDB and can collect and send metrics/events from databases, systems, devices, and a range of popular technologies. Telegraf is written in Go, compiles into a single binary with no external dependencies, and requires minimal memory footprint. It is compatible with many operating systems and has many helpful output plugins and input plugins for collecting and forwarding a wide variety of performance metrics.
Install Telegraf (Linux/Redhat)
/etc/telegraf/.wget https://dl.influxdata.com/telegraf/releases/telegraf_1.21.2-1_amd64.deb
sudo dpkg -i telegraf_1.21.2-1_amd64.deb
RedHat/CentOS
wget https://dl.influxdata.com/telegraf/releases/telegraf-1.21.4-1.x86_64.rpm
sudo yum localinstall telegraf-1.21.4-1.x86_64.rpm
Configure an Output
You can configure Telegraf to output to various sources, such as Kafka, Graphite, InfluxDB, Prometheus, SQL, NoSQL, and more.
In this example, we will configure telegraf with a Graphite output. If you're not currently hosting your data source, start a 14-day free trial with Hosted Graphite by MetricFire to follow these next steps.
A Hosted Graphite account will provide the data source, include Hosted Grafana as a visualization tool, and offer an alerting feature.
To configure the Graphite output, locate the downloaded telegraf configuration file at /etc/telegraf/telegraf.conf and open it in your preferred text editor. Then, you will need to make the following changes to the file:
Locate and comment out the line:
# [[outputs.influxdb]]
Then, uncomment the line:
[[outputs.graphite]]
Next, uncomment and edit the server line to:
servers = ["carbon.hostedgraphite.com:2003"]
Finally, uncomment and edit the prefix line to:
prefix = "<YOUR_API_KEY>.telegraf"
Allow Telegraf to Connect to Your Kibana Instance
- If you don't already have Kibana installed, this is a helpful installation article (Debian)
- Locate the config file, generally located at this path in Linux: /etc/kibana/kibana.yml
- Uncomment and modify the following lines, then save the changes:
server.port: 5601
server.host: "localhost"
- Next, make sure to allow a local connection for port 5601: sudo ufw allow 5601
- Finally, just restart the Kibana service: sudo service kibana restart or sudo systemctl restart kibana
Configure the Kibana Input Plugin
Telegraf has many input plugins that can collect a wide range of data from many popular technologies and 3rd party sources. In this example, we'll demonstrate how to configure the Kibana plugin.
Open your telegraf.conf file, and uncomment the [[inputs.kibana]] line:
[[inputs.kibana]]
Then you can uncomment the 'servers' and 'timeout' lines; the defaults are:
servers = ["http://localhost:5601"]
timeout = "5s"
Save your changes, and then start Telegraf using the following command to see if there are any configuration errors in the output:
telegraf --config telegraf.conf
Telegraf will now be forwarding the following metrics to your data source; this is what they look like in the Graphite format:
telegraf.<host>.localhost:5601.<version>.kibana.concurrent_connections
telegraf.<host>.localhost:5601.<version>.kibana.heap_max_bytes
telegraf.<host>.localhost:5601.<version>.kibana.heap_size_limit
telegraf.<host>.localhost:5601.<version>.kibana.heap_total_bytes
telegraf.<host>.localhost:5601.<version>.kibana.heap_used_bytes
telegraf.<host>.localhost:5601.<version>.kibana.requests_per_sec
telegraf.<host>.localhost:5601.<version>.kibana.response_time_avg_ms
telegraf.<host>.localhost:5601.<version>.kibana.response_time_max_ms
telegraf.<host>.localhost:5601.<version>.kibana.status_code
telegraf.<host>.localhost:5601.<version>.kibana.uptime_ms
See the official GitHub repository for more information and configuration options for the Elasticsearch input plugin.
Use Hosted Graphite by MetricFire to Create Custom Dashboards and Alerts
MetricFire is a monitoring platform that enables you to gather, visualize, analyze, and alert on metrics from sources such as servers, databases, networks, devices, and applications. Using MetricFire, you can effortlessly identify problems and optimize resources within your infrastructure. Hosted Graphite by MetricFire removes the burden of self-hosting your monitoring solution, allowing you more time and freedom to work on your most important tasks.
- Once you have signed up for a Hosted Graphite account and used the above steps to configure your server with the Telegraf Agent, metrics will be forwarded, timestamped, ingested, and aggregated into the Hosted Graphite backend.
- They will be sent and stored in the Graphite format of metric.name.path <numeric-value> <unix-timestamp> provides a tree-like data structure and makes them easy to query.
- These metrics can be found in your Hosted Graphite account, where you can use them to build custom Alerts and Grafana dashboards.
Create Dashboards in Hosted Graphite's Hosted Grafana
In the Hosted Graphite UI, navigate to Dashboards => Primary Dashboards and select the + button to build a new panel:
Then you can use the query UI to select a graphite metric path (the default data source will be the hosted graphite backend if you are accessing Grafana through your Hosted Graphite account):
The Hosted Graphite datasource also supports wildcard (*) searches to grab all metrics that match a specified path.
Now you can apply Graphite functions to these metrics, like aliasByNode(), to reformat the metric names on the graph:
Grafana has many additional options, like configuring dashboard variables and annotations. You can also use different visualizations, modify the display, set the units of measurement, and much more.
Hosted Graphite also has a pre-configured dashboard for Telegraf metrics in their Dashboard Library. Once this dashboard is generated in your account, you can identify it in your Primary Dashboards to see system metrics (CPU, mem, disk) displayed. These system performance metrics come standard with a Telegraf => Graphite configuration:
See the Hosted Graphite dashboard docs for more details.
Creating Graphite Alerts
In the Hosted Graphite UI, navigate to Alerts => Graphite Alerts to create a new alert. Name the alert, add one of your graphite metrics to the alerting metric field, and add a description of what this alert is:
Then, select the Criteria tab, which will set the threshold, and select a notification channel. The default notification channel is the email you used to sign up for the Hosted Graphite account. Still, you can easily configure a channel for Slack, PagerDuty, Microsoft Teams, and more. See the Hosted Graphite docs for more details on notification channels:
Conclusion
Monitoring Kibana is essential for businesses to promptly detect and address performance issues, ensuring a consistent user experience and efficient data visualization. Proactive monitoring enables organizations to maintain the reliability of their Kibana instances, supporting informed decision-making and safeguarding the integrity of data analysis processes crucial for business insights.
Tools like dashboards and alerts complement this monitoring by providing real-time visualization, proactive identification of issues, historical trend analysis, and facilitating informed decision-making, all of which are essential for maintaining a robust and efficient network infrastructure.
Sign up for a free trial, and start monitoring your infrastructure today! You can also book a demo and talk to the MetricFire team directly about your monitoring needs.
