Elasticsearch utilities
========================

This section describes the Elasticsearch utilities.

elasticstat
-----------

Elasticstat is a utility for real-time performance monitoring of an Elasticsearch cluster from the command line, much like how the Unix utilities, iostat or vmstat, work.
You can control the frequency of updates via the DELAYINTERVAL optional parameter, which specifies a delay in seconds after each update.

Performance metrics shown are based on the articles `Cluster Health <https://www.elastic.co/guide/en/elasticsearch/guide/current/_cluster_health.html>`_ and
`Monitoring Individual Nodes <https://www.elastic.co/guide/en/elasticsearch/guide/current/_monitoring_individual_nodes.html>`_ from the Elasticsearch Definitive Guide.
Reference these articles for further information about the significance of each metric.

For more information about setting up elasticstat, visit https://github.com/objectrocket/elasticstat.

.. note::

   Ensure you have the correct access control lists (ACLs) in place or you cannot to connect to your instance.

Here's what the basic (non-SSL) usage looks like when you use the connect string ``http://iad1-10140-0.es.objectrocket.com:10140``, ``http://iad1-10140-1.es.objectrocket.com:10140``, ``http://iad1-10140-2.es.objectrocket.com:10140``, ``http://iad1-10140-3.es.objectrocket.com:10140`` on port ``10140`` with the username ``estest``:

.. code-block:: bash

  $ elasticstat -h http://iad1-10140-0.es.objectrocket.com:10140,http://iad1-10140-1.es.objectrocket.com:10140,http://iad1-10140-2.es.objectrocket.com:10140,http://iad1-10140-3.es.objectrocket.com:10140 -u estest -p

If you would like to use Secure Socket Layer (SSL) security, add the ``--ssl`` flag and use the proper SSL connect string:

.. code-block:: bash

  $ elasticstat --ssl -h https://iad1-10140-0.es.objectrocket.com:20140,https://iad1-10140-1.es.objectrocket.com:20140,https://iad1-10140-2.es.objectrocket.com:20140,https://iad1-10140-3.es.objectrocket.com:20140 -u estest -p