jettro / elasticsearch-gui

An angularJS client for elasticsearch as a plugin

Introduction

Welcome to the Gui plugin for elasticsearch. Using this plugin you can explore your elasticsearch index. This plugin gives you a few different ways to start exploring. There is a way to search the repository in a way you would do it on a web site. You can enter keywords, do advanced search, use facets. Another way to explore the index is focussed on learning the structure of the actual executed query. You can enter a number of items to include in the query. You can enter fields, facets, highlighting, limit the indexes, limit the types. Finally there is a way to show some of the data in a graph.

Installation

local installation

You can install the plugin in your own elasticsearch instance using the following command in the elasticsearch folder:

[~/elasticsearch] $ bin/plugin install jettro/elasticsearch-gui 

Next you can browse to you elasticsearch instance: http://localhost:9200/_plugin/gui/index.html

use deployed installation

Since we use mainly JavaScript, it is possible to connect to a remote elasticsearch instance. To facilitate this, elasticsearch returns a specific html header.

That way you can use my installed version of the plugin to connect to your local elasticsearch instance. You can find it at the following url: Remote installed plugin @gridshore

Starting from elasticsearch 1.4 there have been some security measures. One thing is that CORS is now by default disabled. This is smart from security perspective but prevents this plugin from running if you are not coming from the same host as the elasticsearch server. If you still want this to work add the following properties to elasticsearch.yml:

http.cors.enabled: true
http.cors.allow-origin: "http://www.gridshore.nl"

Older versions

Currently we develop agains elasticsearch v2.0. Due to some api changes you cannot use it with older elasticsearch installations. You can however use the older versions in branch v1.1.x and v0.90.8+. On my website you can also access the older version using the url:

Remote installed plugin @gridshore (v1.2) Remote installed plugin @gridshore (v1.1) Remote installed plugin @gridshore (v0.90)

TODO's

• Replace all callbacks with promises.
• Use the resolve function of a routing instead of a initializer function.
• Check startup logic to do the configurations
• While starting, config object is not automaticalle started.

elasticsearch-gui's Issues

add pagination to the results

I want to have pagination to the results of the query functionalities:
{
"from" : 9,
"size" : 20,
"query" : {
...
}
}

Prevent certain indexes from showing by default

Remove the logstash and marvel indexes by default. Make a config menu to store your choice in local storage.

Improve the structure of the ui

• Initial screen is the dashboard, so the dashboard will become the homescreen
• The current home screen will become the search screen
• Remove the statistics screen, it is still not used
• Add the logo's to the about screen and write something about the plugin

Use the new snapshot and restore functionality.

I want to plugin to be able to create snapshots and even restore from a snapshot. We need an option to create the backup repository and register it with elasticsearch. Next to that we need to have a button that creates a snapshot. We also need a button with a list of snapshots that we can go back to.

http://www.elasticsearch.org/guide/en/elasticsearch/reference/master/modules-snapshots.html

Check if we need to replace elastic.js with the elasticsearch.js library

Elasticsearch provides it's own library for interacting with elasticsearch. This might be(come) a better choice. Need to check it out:

http://elasticsearch.github.io/elasticsearch-js/

Replace facets with the new grouping functionality

Upgrade libraries for angular and bootstrap

Beware, we cannot do this before the bootstrap-ui project supports bootstrap 3 and the new angular 1.2

Upgrade to new elasticsearch 1.0 RC

Make it possible to close an index, but also to open it again

To be able to open an index we need to find another mechanism to find all indexes. There are two different methods to find info about the index.

/_cluster/state => shows the closed indexes as well
/_status => shows information about sizing.

Change behavior for selecting highlighting and explain

At the moment you have to explicitly refresh the query to see what the changes are when you select highlighting, explain or the type of query (or, and, phrase). I want to add something like a watch to change this when the value changes. Then the refresh button for the query can also be removed.

Make better dates in the screen where we show the facets

Add _suggest end point to the query possibilities

Show a list with site plugins that is installed

Make every item a link, that way it becomes easy to visit the plugin.

After changing the configuration, the dashboard shows errors

Obtaining information about nodes throws an error:

Cannot call method 'info' of undefined

Implement error handling

At the moment there is no mechanism for error handling. There should be a generic mechanism for client side validation but also for errors when communicating with the server.

prevent empty search in home screen

At the moment an exception is thrown when executing a search without entering text to search for.

Create option to configure number of replicas from the dashboard

In the dashboard we show the amount of shards and replicas. We need a way to change the number of replicas.

Pretty print the query that is shown as a representation of the current selected values.

The help popups in the query screen broke down

The help popups are now empty, must be an issue due to the upgrading of the libraries.

ES client connects to localhost instead of the host it is running on

Installed this plugin and can not run any query because the plugin connects to localhost instead of the host it is running on.

Make it possible to deploy the plugin on github and chose the server to connect to

Github provides a feature to host a website. Since the plugin is pure JavaScript you can make it connect to another elasticsearch server if the port is available to you.

To be able to use that we need a configuration option to provide a url to the server to connect to and make all calls to a backend to use the server url as well.

Add filters to the Queries screen

Demonstrate the effect of filters on the executed query.

Show the aliases for indexes

The fields do not work when json objects are used for a field.

We want to see the properties of json objects when they are indexed

Implement functionality for multi_fields

Multi fields is not working for the facets in the Home screen.

Do something with the new cluster stats api

A new api is now available with a lot of information about the cluster. This might be enough to combine health and nodes info.

http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/cluster-stats.html

Beware, you'll need elasticsearch 0.90.8 to make this work

Make use of _nodes?all=true to give more info about available nodes

http://localhost:9200/_nodes?all=true&pretty

Shows info about configuration, jvm, os, hardware and a lot more.

Make nested fields work with facets

Limit possible types when selecting an index

At the moment you can select all the types, even when one index is selected. It would be better if you can only select the types for the chosen index(es).

Issue in the navbar directive

There is an issue with the current implementation of the navbar. Somehow the status check is performed twice. Seems to be a bug together with the used release of angularjs. Need to bump to released version 1.2.6 of angular and everything is fine.

Add playing with analyzers and see their effect

Available field list shows not all fields of my mapping

Nested fields are not shown in the available field list.

Implement simple_query_string for the search page

In the search page we want to provide a richer search query:

http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/query-dsl-simple-query-string-query.html

Create a new tab for obtaining items by id and show the complete document.

Number of shards and size of the index is not shown on the dashboard

Exclude _default_ type from shown mappings

The default type is a way to specify generic mapping definition for types that will be created in the future. It's a special type that shouldn't be shown on the UI since it doesn't hold data.

Move all configuration into one modal

I want one configuration in a modal that is used in all screens.

Create an easy way to drop an index

In the overview screen make it possible to drop an index

Errors are not removed when switching screens

When errors occur, they are never removed. You cannot click them away. For now removing them on a switch to another tab is good enough.

Create a timed trigger to check if the connection to the elasticsearch instance is running.

We need to create a trigger that checks if the elasticsearch connection is still available.

Show the reason why the cluster state is yellow if possible

If the amount of nodes versus the amount of primary shards and replica's does not fit, we can make the warning more explicit.

Failed to install plugin

Hi,
This is my error:
root@couch1:/usr/share/elasticsearch# bin/plugin -v --install jettro/elasticsearch-gui
-> Installing jettro/elasticsearch-gui...
Trying https://github.com/jettro/elasticsearch-gui/zipball/master... (assuming site plugin)
Failed: SSLHandshakeException[Remote host closed connection during handshake]; nested: EOFException[SSL peer shut down incorrectly];
Failed to install jettro/elasticsearch-gui, reason: failed to download out of all possible locations..., use -verbose to get detailed information
root@couch1:/usr/share/elasticsearch#

Meanwhile I'm able to get it by wget.
BEST
Afshin

Specify whether a node is client or not in the node list

You can currently see what nodes the cluster is composed of. It would be nice to be able to distinguish between nodes that are just clients or not.

The properties to look at are:

1. data: whether the node can hold data
2. master: whether the node can become master

A client node cannot do any of the above.

Add save query to Query screen

We already have the option to save a query in the home screen, I want to have something simular on the query screen.

Check if we can use ignore_unavailable to hide fields of closed indexes

Read docs about breaking changes and create new issues for them

http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.x/breaking-changes.html

Add the option to show the versions of items

It is possible to show the version of the documents. Add this in a way simular to the explain option:
{
"version" : true,
"query" : {
...
}
}

Histogram and data histogram facet select dialog has a bug

The period or interval is not passed from the dialog window to the actual query

Make it possible to store presets in your browser using local storage

Improve the documentation for the plugin

I want to start writing more about what the plugin is meant to do and how you can use it.