check_logstash

README

check_logstash

An Icinga check plugin to check Logstash.

Usage

Usage:
  check_logstash [flags]
  check_logstash [command]

Available Commands:
  health      Checks the health of the Logstash server
  pipeline    Checks the status of the Logstash Pipelines

Flags:
  -H, --hostname string    Hostname of the Logstash server (default "localhost")
  -p, --port int           Port of the Logstash server (default 9600)
  -s, --secure             Use a HTTPS connection
  -i, --insecure           Skip the verification of the server's TLS certificate
  -b, --bearer string      Specify the Bearer Token for server authentication
  -u, --user string        Specify the user name and password for server authentication <user:password>
      --ca-file string     Specify the CA File for TLS authentication
      --cert-file string   Specify the Certificate File for TLS authentication
      --key-file string    Specify the Key File for TLS authentication
  -t, --timeout int        Timeout in seconds for the CheckPlugin (default 30)
  -h, --help               help for check_logstash
  -v, --version            version for check_logstash

Health

Checks the health status of the Logstash server.

Usage:
  check_logstash health [flags]

Examples:

	$ check_logstash health --hostname 'localhost' --port 8888 --insecure
	OK - Logstash is healthy | status=green process.cpu.percent=0;0.5;3;0;100
	 \_[OK] Heap usage at 12.00%
	 \_[OK] Open file descriptors at 12.00%
	 \_[OK] CPU usage at 5.00%

	$ check_logstash -p 9600 health --cpu-usage-threshold-warn 50 --cpu-usage-threshold-crit 75
	WARNING - CPU usage at 55.00%
	 \_[OK] Heap usage at 12.00%
	 \_[OK] Open file descriptors at 12.00%
	 \_[WARNING] CPU usage at 55.00%

Flags:
      --file-descriptor-threshold-warn string   The percentage relative to the process file descriptor limit on which to be a warning result (default "100")
      --file-descriptor-threshold-crit string   The percentage relative to the process file descriptor limit on which to be a critical result (default "100")
      --heap-usage-threshold-warn string        The percentage relative to the heap size limit on which to be a warning result (default "70")
      --heap-usage-threshold-crit string        The percentage relative to the heap size limit on which to be a critical result (default "80")
      --cpu-usage-threshold-warn string         The percentage of CPU usage on which to be a warning result (default "100")
      --cpu-usage-threshold-crit string         The percentage of CPU usage on which to be a critical result (default "100")
  -h, --help                                    help for health

Pipeline

Checks the status of Logstash pipelines.

Usage:
  check_logstash pipeline [flags]

Examples:

	$ check_logstash pipeline --inflight-events-warn 5 --inflight-events-crit 10
	WARNING - Inflight events
	 \_[WARNING] inflight_events_example-input:9;
	 \_[OK] inflight_events_example-default-connector:4

	$ check_logstash pipeline --inflight-events-warn 5 --inflight-events-crit 10 --pipeline example
	CRITICAL - Inflight events
	 \_[CRITICAL] inflight_events_example:15

Flags:
  -P, --pipeline string               Pipeline Name (default "/")
      --inflight-events-warn string   Warning threshold for inflight events to be a warning result. Use min:max for a range.
      --inflight-events-crit string   Critical threshold for inflight events to be a critical result. Use min:max for a range.
  -h, --help                          help for pipeline

License

Copyright (c) 2022 NETWAYS GmbH

This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with this program. If not, see gnu.org/licenses.