Monitoring Logstash

When you run Logstash, it automatically captures runtime metrics that you canuse to monitor the health and performance of your Logstash deployment.

The metrics collected by Logstash include:

  • Logstash node info, like pipeline settings, OS info, and JVM info.
  • Plugin info, including a list of installed plugins.
  • Node stats, like JVM stats, process stats, event-related stats, and pipelineruntime stats.
  • Hot threads.

You can use the basic monitoring APIs provided by Logstashto retrieve these metrics. These APIs are available by default withoutrequiring any extra configuration.

Alternatively, you can configure X-Pack monitoring to senddata to a monitoring cluster.

Note

Monitoring is an X-Pack feature under the Basic License and is thereforefree to use.

You can use the monitoring UI in X-Pack to view themetrics and gain insight into how your Logstash deployment is running.

The pipeline viewer in X-Pack offers additionalvisibility into the behavior and performance of complex pipeline configurations.It shows a graph representation of the overall pipeline topology, data flow, andbranching logic, overlaid with important metrics, like events per second, foreach plugin in the view.

This documentation focuses on the X-Pack monitoring infrastructure and setup inLogstash. For an introduction to monitoring your Elastic stack, including Elasticsearchand Kibana, see Monitoring the Elastic Stack.