Whatson, an Elasticsearch Consulting Detective
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
_site
LICENSE
README.md
plugin-descriptor.properties
screenshot-init.png
screenshot-segments.png

README.md

Whatson — ES Consulting Detective

Whatson is an elasticsearch plugin to visualize the state of a cluster. It's inpired by other excellent plugins:

And designed to give a more compact view of key cluster stats especially useful for large clusters with lots of nodes or lots of indices.

"Hosted" Version

Whatson can be used directly from its GitHub Pages site without installation. Just click the icon next to "Not Connected" on the top navbar and configure the elasticsearch host Whatson should connect to. Boom.

http://whatson.xyu.io/

Installation

To install Whatson run the Elasticsearch plugin installer on any node:

bin/plugin install xyu/elasticsearch-whatson/0.1.3

Access the plugin by going to the Whatson plugin site. (E.g. http://localhost:9200/_plugin/whatson/)

Whatson will automatically connects to the host the plugin is running on with a refresh interval of 5 seconds. To connect to a different cluster or to use another refresh interval click on the status indicator to the right of the cluster name on the topmost bar.

Usage

When Whatson starts available data nodes, indices and their shards will be shown.

Whatson

The nodes section will show a bar chart of available disk on each node. The bars are color coded as follows:

  • Gray — Free disk space on node
  • Brown — Disk used on node for everything but Elasticsearch
  • Blue — Disk used by Elasticsearch (all shards green)
  • Yellow — Disk used by Elasticsearch (some shards on node is in a relocating state)
  • Orange — Disk used by Elasticsearch (some shards on node is in a recovery / initializing state)

The red line drawn across the graph shows the percentage of deleted docs on each node.

The indices section will show a bar chart showing size of each index in the cluster color coded by the state of the index (green / yellow / red). The primary size is shown in a darker shade as compared to the total index size.

Below each index shards contained within the index will be shown colored corresponding to the size of the primary shard. If any shard exists in an error state they will be colored as follows:

  • Yellow — Some shards are in a relocating state
  • Orange — Some shards are in a recovery or initializing state
  • Red — Some shards are unassigned

The red line drawn across the graph shows the percentage of deleted docs in each index.

To inspect the state of underlaying Lucene segments first select a index or shard within an index. Once selected something like the following will be shown.

Segments Visualization

Segments are drawn on a logarithmic scale based on the byte size of the segment and should resemble the visualizations in the Visualizing Lucene’s Segment Merges blog post by Mike McCandless. The bars are color coded as follows:

  • Yellow — Uncommitted segments, those that exist in the NRT IndexReader only
  • Brown — Segments that have been committed (Lucene committed)
  • Blue — Segments that have both been committed and are in the NRT IndexReader
  • Green — Segments that have both been committed and are in the NRT IndexReader. In addition these immutable segments are identical to those on the primary shard instance which means they can be recovered from local disk upon a node restart.

The red line drawn across the graph shows the percentage of deleted docs within each segment.

Release Notes

0.1.4

  • Elasticsearch 2.x compatablity

0.1.3

  • Improve shard segment graphs
  • Show elected master node in nodes section
  • Fix handling of unassigned shards and empty indices
  • Fix handling of relocating shards
  • Show shard details during reallocation and recovery
  • General UI improvements

0.1.2

  • Make it easier to select small shards
  • Prompt for ES host before trying to connect when running in "stand alone" mode

0.1.1

  • Compatibility with API changes in Elasticsearch 1.x
  • UI tweaks

0.1.0

  • Initial Release

Who's Using Whatson?