<commit_before>h1. BigDesk

Live charts and statistics for ElasticSearch cluster.

|_. bigdesk |_. ElasticSearch |
| master | 0.19.x -> master |
| 1.0.0 | 0.17.x -> 0.18.x |

In order to install the plugin, simply run: <code>bin/plugin -install elasticsearch/elasticsearch-mapper-attachments/</code> for master version.

To get specific version of bigdesk use:  <code>bin/plugin -install elasticsearch/elasticsearch-mapper-attachments/1.0.0</code>

The below screenshot is bigdesk 1.0.0
!https://github.com/lukas-vlcek/bigdesk/raw/master/screenshot.jpg!

Info about cluster nodes:

 * provide info about:
 ** Global info about indices, field and filter caches
 ** JVM details
 ** OS details

 * provides charts:
 ** Size of Field and Filter Caches
 ** File Descriptors and Open Channels
 ** JVM threads
 ** JVM Heap and non-heap memory
 ** OS CPU(%)
 ** OS Mem
 ** OS Swap

User can switch between nodes in the cluster, new nodes are added and old nodes are removed automatically on the fly.

On top of that it is possible to set refresh interval and time window for the charts (no limits, 1 minute, 5 minutes, ... etc)

Supports elasticsearch 0.17.x and 0.18.x

To immediately connect to a particular host, add the <code>host</code>, <code>port</code>, and <code>go</code> parameters to the query string: <code>index.html?host=search.example.com&port=9200&go</code><commit_msg>Add 'How to use bigdesk'<commit_after>h1. BigDesk

Live charts and statistics for ElasticSearch cluster.

|_. bigdesk |_. ElasticSearch |
| master | 0.19.x -> master |
| 1.0.0 | 0.17.x -> 0.18.x |

h3. Installation

In order to install the plugin, simply run: <code>bin/plugin -install elasticsearch/elasticsearch-mapper-attachments/</code> for master version.

To get specific version of bigdesk use:  <code>bin/plugin -install elasticsearch/elasticsearch-mapper-attachments/1.0.0</code>

You can also chekout bigdesk into your local harddrive (or download and extract zip from github) and simply use it by opening <code>index.html</code> in your favorite web browser.

h3. How to use bigdesk

Once you open bigdesk in your web broswer, you need to <b>point it to the elasticsearch node REST endopint<b>. For example if you run elasticsearch locally the REST endpoint would be <code>http://localhost:9200/</code> by default. In bigdesk from 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 <code>hostname</code> of the elasticsearch node into the first text field and its <code>port number</code> into the second text field (but in some situations this can limiting, for example if you run elasticsearch behind firewal).

Then you hit <code>Connect</code> button (it is called <code>START</code> 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 bigdesk <b>refresh inerval</b> and <b>amount of data</b> that is displayed by charts.

If you are using bigdesk 1.0.0 you can immediately connect to a particular host, add the <code>host</code>, <code>port</code>, and <code>go</code> parameters to the query string: <code>index.html?host=search.example.com&port=9200&go</code>

h3. Screenshot

The below screenshot is bigdesk 1.0.0

!https://github.com/lukas-vlcek/bigdesk/raw/master/screenshot.jpg!

Info about cluster nodes:

 * provide info about:
 ** Global info about indices, field and filter caches
 ** JVM details
 ** OS details

 * provides charts:
 ** Size of Field and Filter Caches
 ** File Descriptors and Open Channels
 ** JVM threads
 ** JVM Heap and non-heap memory
 ** OS CPU(%)
 ** OS Mem
 ** OS Swap

h3. 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.
{'fraction_non_alphanumeric': 0.0924640555280119, 'fraction_numerical': 0.01908775409023302, 'mean_word_length': 4.146683673469388, 'pattern_counts': {'":': 0, '<': 45, '<?xml version=': 0, '>': 49, 'https://': 2, 'lorem ipsum': 0, 'www.': 0, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 1, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '7169469', 'n_tokens_mistral': 1249, 'n_tokens_neox': 1205, 'n_words': 528}