When you run Logstash, it automatically captures runtime metrics that you can use 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 pipeline runtime stats.
- Hot threads.
You can use the basic monitoring APIs provided by Logstash to retrieve these metrics. These APIs are available by default without requiring any extra configuration.
Alternatively, you can install X-Pack and configure X-Pack monitoring.
Monitoring is an X-Pack feature under the Basic License and is therefore free to use.
You can use the monitoring UI in X-Pack to view the metrics and gain insight into how your Logstash deployment is running.
The pipeline viewer in X-Pack offers additional visibility into the behavior and performance of complex pipeline configurations. It shows a graph representation of the overall pipeline topology, data flow, and branching logic, overlayed with important metrics, like events per second, for each plugin in the view.
This documentation focuses on the X-Pack monitoring infrastructure and setup in Logstash. For an introduction to monitoring your Elastic stack, including Elasticsearch and Kibana, see Monitoring the Elastic Stack.