NAME

es-status.pl - Simple ElaticSearch Status Checks

VERSION

version 8.6

SYNOPSIS

es-status.pl --health --verbose --color

Options: --help print help --manual print full manual

Query Modes: --health Display overall cluster health (--verbose shows more detail) --node Display node details (--verbose shows more detail) --segments Display segmentation details (--verbose shows more detail) --settings Display index settings (--verbose shows more detail)

--all               Run all handlers!

From CLI::Helpers:

--data-file         Path to a file to write lines tagged with 'data => 1'
--tags              A comma separated list of tags to display
--color             Boolean, enable/disable color, default use git settings
--verbose           Incremental, increase verbosity (Alias is -v)
--debug             Show developer output
--debug-class       Show debug messages originating from a specific package, default: main
--quiet             Show no output (for cron)
--syslog            Generate messages to syslog as well
--syslog-facility   Default "local0"
--syslog-tag        The program name, default is the script name
--syslog-debug      Enable debug messages to syslog if in use, default false
--nopaste           Use App::Nopaste to paste output to configured paste service
--nopaste-public    Defaults to false, specify to use public paste services
--nopaste-service   Comma-separated App::Nopaste service, defaults to Shadowcat

DESCRIPTION

This script is designed to help you get information about the state of the ElasticSearh cluster in a hurry.

OPTIONS

help

Print this message and exit

manual

Print this message and exit

all

Runs all the ES Checks at once, this includes: health, node, and segments Used in combination with --verbose for more detail

./es-status.pl --all --verbose

health

Displays the cluster health, use --verbose to get more information

./es-status.pl --health --verbose

node

Displays the details on index segmentation, use --verbose to get more information

./es-status.pl --node --verbose

segments

Displays the details on index segmentation, use --verbose to get more information

./es-status.pl --segments --verbose

settings

Displays the details on index settings, use --verbose to get more information

./es-status.pl --settings --verbose

AUTHOR

Brad Lhotsky <brad@divisionbyzero.net>

COPYRIGHT AND LICENSE

This software is Copyright (c) 2023 by Brad Lhotsky.

This is free software, licensed under:

The (three-clause) BSD License