From f166212504a34a5b6960482d974d085a6ee02925 Mon Sep 17 00:00:00 2001 From: Karen Metts Date: Tue, 22 Jun 2021 19:06:07 -0400 Subject: [PATCH 1/2] Doc: Add geoip database API to node stats --- .../monitoring/monitoring-apis.asciidoc | 66 +++++++++++-------- 1 file changed, 40 insertions(+), 26 deletions(-) diff --git a/docs/static/monitoring/monitoring-apis.asciidoc b/docs/static/monitoring/monitoring-apis.asciidoc index 5b26b551931..6643d7f2e27 100644 --- a/docs/static/monitoring/monitoring-apis.asciidoc +++ b/docs/static/monitoring/monitoring-apis.asciidoc @@ -1,4 +1,4 @@ -[float] +[discrete] [[monitoring]] == APIs for monitoring {ls} @@ -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 <> 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 <> only. When you specify `human=true`, the results are returned in plain text instead of @@ -88,9 +88,9 @@ Gets node-level JVM info, including info about threads. See <> 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: @@ -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: @@ -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: @@ -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. @@ -291,13 +291,15 @@ Gets runtime stats about each Logstash pipeline. Gets runtime stats about config reload successes and failures. <>:: Gets runtime stats about cgroups when Logstash is running in a container. +<>:: +Gets stats for databases used with the <>. See <> 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: @@ -363,9 +365,9 @@ Example response: } -------------------------------------------------- -[float] +[discrete] [[process-stats]] -==== Process Stats +==== Process stats The following request returns a JSON document containing process stats: @@ -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: @@ -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: @@ -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. @@ -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 @@ -685,6 +687,18 @@ Example response: } -------------------------------------------------- +[discrete] +[[geoip-database-stats]] +==== Geoip database stats + +You can monitor stats for the geoip databases used with the <>. + +[source,js] +-------------------------------------------------- +curl -XGET 'localhost:9600/_node/stats/geoip?pretty' +-------------------------------------------------- + +For more info, see <>. [[hot-threads-api]] === Hot Threads API From 9290f8885c343f25656bc9e7e01704de752bcda3 Mon Sep 17 00:00:00 2001 From: Karen Metts Date: Wed, 23 Jun 2021 14:13:19 -0400 Subject: [PATCH 2/2] Incorporate review comments and add deep link to geoip input --- docs/static/monitoring/monitoring-apis.asciidoc | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/docs/static/monitoring/monitoring-apis.asciidoc b/docs/static/monitoring/monitoring-apis.asciidoc index 6643d7f2e27..cc3b3200f38 100644 --- a/docs/static/monitoring/monitoring-apis.asciidoc +++ b/docs/static/monitoring/monitoring-apis.asciidoc @@ -291,7 +291,7 @@ Gets runtime stats about each Logstash pipeline. Gets runtime stats about config reload successes and failures. <>:: Gets runtime stats about cgroups when Logstash is running in a container. -<>:: +<>:: Gets stats for databases used with the <>. See <> for a list of options that can be applied to all @@ -695,10 +695,10 @@ You can monitor stats for the geoip databases used with the <>. +For more info, see <> in the Geoip filter plugin docs. [[hot-threads-api]] === Hot Threads API