Logstash APIs
1.0

Base URL 
http://api.example.com

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:

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

The APIs that retrieve these metrics are available by default, with no extra configuration needed.

highlight#highlightFromAnchor" href="#topic-documentation-source-and-versions"> Documentation source and versions

This documentation is derived from the main branch of the logstash repository. It is provided under license Attribution-NonCommercial-NoDerivatives 4.0 International.

This is version 1.0 of this API documentation. Last update on Apr 14, 2025.