Live charts and statistics for ElasticSearch cluster.
|master||0.19.x, 0.20.x → master|
|1.0.0||0.17.x → 0.18.x|
In order to install the plugin, simply run:
bin/plugin -install lukas-vlcek/bigdesk for master version.
To get specific version of bigdesk use:
bin/plugin -install lukas-vlcek/bigdesk/1.0.0
For example, if you are running ES node on
localhost:9200 then you can navigate your browser to
http://localhost:9200/_plugin/bigdesk/ and bigdesk will auto connect to existing node.
You can also checkout bigdesk into your local harddrive (or download and extract zip from github) and simply use it by opening
index.html in your favorite web browser.
How to use bigdesk
Once you open bigdesk in your web broswer, you need to point it to the elasticsearch node REST endpoint. For example if you run elasticsearch locally the REST endpoint would be
http://localhost:9200/ by default. In bigdesk master you can simply specify any endpoint URL in the text field on top of the screen. If you are using bigdesk 1.0.0 (ie. you want to connect bigdesk to elasticearch 0.17.x – 0.18.x) then you need to fill into two different text fields. First you specify
hostname of the elasticsearch node into the first text field and its
port number into the second text field (but in some situations this can be limiting, for example if you run elasticsearch behind firewall).
Then you hit
Connect button (it is called
GO! button in bigdesk 1.0.0) and that’s it.
Now you should see cluster name and list of its nodes. You can switch between nodes in the cluster, new nodes are added and old nodes are removed automatically on the fly.
You can change the bigdesk refresh interval and amount of data that is displayed by charts.
If you are using bigdesk 1.0.0 you can immediately connect to a particular host, add the
go parameters to the query string:
If you are using bigdesk master you can use any of the following URL parameters to immediately connect to a particular host or set history or refresh interval:
endpoint= URL of ES node REST endpoint (you might want to use URL encoded value). Defaults to
refresh= refresh interval in milliseconds. Defaults to
history= number of milliseconds to keep in history. Defaults to
connect= if set to
truebigdesk will try to connect immediately to the endpoint. Defaults to
Example connecting to
http://127.0.0.1:9201 with 3 sec refresh interval:
bigdesk master (this is WIP, actual screen can be different)
Supported web browsers
Bigdesk should work in all modern web browsers as long as they support SVG. It has been tested in Safari, Firefox and Chrome.