Skip to content
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
66 changes: 40 additions & 26 deletions docs/static/monitoring/monitoring-apis.asciidoc
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
[float]
[discrete]
[[monitoring]]
== APIs for monitoring {ls}

Expand Down Expand Up @@ -34,20 +34,20 @@ NOTE: By default, the monitoring API attempts to bind to `tcp:9600`. If this por
instance, you need to launch Logstash with the `--http.port` flag specified to bind to a different port. See
<<command-line-flags>> for more information.

[float]
[discrete]
[[monitoring-common-options]]
==== Common Options
==== Common options

The following options can be applied to all of the Logstash monitoring APIs.

[float]
===== Pretty Results
[discrete]
===== Pretty results

When appending `?pretty=true` to any request made, the JSON returned
will be pretty formatted (use it for debugging only!).

[float]
===== Human-Readable Output
[discrete]
===== Human-readable output

NOTE: For Logstash {logstash_version}, the `human` option is supported for the <<hot-threads-api>>
only. When you specify `human=true`, the results are returned in plain text instead of
Expand Down Expand Up @@ -88,9 +88,9 @@ Gets node-level JVM info, including info about threads.
See <<monitoring-common-options, Common Options>> for a list of options that can be applied to all
Logstash monitoring APIs.

[float]
[discrete]
[[node-pipeline-info]]
===== Pipeline Info
===== Pipeline info

The following request returns a JSON document that shows pipeline info, such as the number of workers,
batch size, and batch delay:
Expand Down Expand Up @@ -152,9 +152,9 @@ Example response:

If you specify an invalid pipeline ID, the request returns a 404 Not Found error.

[float]
[discrete]
[[node-os-info]]
==== OS Info
==== OS info

The following request returns a JSON document that shows the OS name, architecture, version, and
available processors:
Expand All @@ -177,9 +177,9 @@ Example response:
}
--------------------------------------------------

[float]
[discrete]
[[node-jvm-info]]
==== JVM Info
==== JVM info

The following request returns a JSON document that shows node-level JVM stats, such as the JVM process id, version,
VM info, memory usage, and info about garbage collectors:
Expand Down Expand Up @@ -217,7 +217,7 @@ Example response:


[[plugins-api]]
=== Plugins Info API
=== Plugins info API

The plugins info API gets information about all Logstash plugins that are currently installed.
This API basically returns the output of running the `bin/logstash-plugin list --verbose` command.
Expand Down Expand Up @@ -291,13 +291,15 @@ Gets runtime stats about each Logstash pipeline.
Gets runtime stats about config reload successes and failures.
<<os-stats,`os`>>::
Gets runtime stats about cgroups when Logstash is running in a container.
<<geoip-database-stats,`geoip_download_manager`>>::
Gets stats for databases used with the <<plugins-filters-geoip, Geoip filter plugin>>.

See <<monitoring-common-options, Common Options>> for a list of options that can be applied to all
Logstash monitoring APIs.

[float]
[discrete]
[[jvm-stats]]
==== JVM Stats
==== JVM stats

The following request returns a JSON document containing JVM stats:

Expand Down Expand Up @@ -363,9 +365,9 @@ Example response:
}
--------------------------------------------------

[float]
[discrete]
[[process-stats]]
==== Process Stats
==== Process stats

The following request returns a JSON document containing process stats:

Expand Down Expand Up @@ -396,9 +398,9 @@ Example response:
}
--------------------------------------------------

[float]
[discrete]
[[event-stats]]
==== Event Stats
==== Event stats

The following request returns a JSON document containing event-related statistics
for the Logstash instance:
Expand All @@ -422,9 +424,9 @@ Example response:
}
--------------------------------------------------

[float]
[discrete]
[[pipeline-stats]]
==== Pipeline Stats
==== Pipeline stats

The following request returns a JSON document containing pipeline stats,
including:
Expand Down Expand Up @@ -624,9 +626,9 @@ Example response:
}
--------------------------------------------------

[float]
[discrete]
[[reload-stats]]
==== Reload Stats
==== Reload stats

The following request returns a JSON document that shows info about config reload successes and failures.

Expand All @@ -647,9 +649,9 @@ Example response:
}
--------------------------------------------------

[float]
[discrete]
[[os-stats]]
==== OS Stats
==== OS stats

When Logstash is running in a container, the following request returns a JSON document that
contains cgroup information to give you a more accurate view of CPU load, including whether
Expand Down Expand Up @@ -685,6 +687,18 @@ Example response:
}
--------------------------------------------------

[discrete]
[[geoip-database-stats]]
==== Geoip database stats

You can monitor stats for the geoip databases used with the <<plugins-filters-geoip, Geoip filter plugin>>.

[source,js]
--------------------------------------------------
curl -XGET 'localhost:9600/_node/stats/geoip_download_manager?pretty'
--------------------------------------------------

For more info, see <<plugins-filters-geoip-metrics,Database Metrics>> in the Geoip filter plugin docs.

[[hot-threads-api]]
=== Hot Threads API
Expand Down