This Golang CLI application allows easy interaction with Elasticsearch. It can be used in health checks for clusters, nodes, and indexes in a monitoring and alerting solution (such as Nagios or Sensu). It can also be used for multi-index queries (which is not possible)
- Clone the repository
- Run
make - Configure settings in config.yml
- Download release at https://github.com/harvey-earth/elilogs/releases.
- Copy file from default-config.yml to configuration directory and rename to config.yml.
Configuration can be achieved by settings in the config.yml file. Copy the default-config.yml file to the same file as the binary or at /etc/elilogs.config.yml.
Check is used to check the connection to an Elasticsearch server/cluster. Its primary use is to confirm that initial configuration is working. There is no need to call check before any other commands, as they all test and error handle for connection failures.
elilogs check will test the connection to the Elasticsearch API.
elilogs test -c will download a list of indices to the users ~/.cache/elilogs.txt directory to speed up future calls.
List is used for listing information (namely health) for clusters, nodes, and indexes. It can also output information on pending tasks and snapshots.
elilogs list index [index,...] will list indexes along with the status and health of each.
elilogs list cluster is equivalent to -a and will list information about the cluster, nodes, pending tasks, and snapshots.
Search is used to search multiple indexes for a query string. It returns an exit status of 0 for a successful search with results, 1 for a successful search with no results, and 2 if an error is encountered during the search.
elilogs search "query" will search all indexes for matches to the query string.
elilogs search -i [index,...] query will search the listed index for matches to the query string.