Siren Platform User Guide

Console

The Console plugin provides a UI to interact with the REST API of Elasticsearch. Console has two main areas: the editor, where you compose requests to Elasticsearch, and the response pane, which displays the responses to the request.

Figure 10. The Console UI
introduction screen


Console understands commands in a cURL-like syntax. For example the following Console command

GET /_search
{
  "query": {
    "match_all": {}
  }
}

is a simple GET request to Elasticsearch’s _search API. Here is the equivalent command in cURL.

curl -XGET "http://localhost:9200/_search" -H "Content-Type: application/json"-H "Content-Type: application/json" -d'
{
  "query": {
    "match_all": {}
  }
}'

In fact, you can paste the command into Console and it will automatically be converted into the Console syntax.

When typing a command, Console will make context sensitive suggestions. These suggestions can help you explore parameters for each API, or to just speed up typing. Console will suggest APIs, indexes and field names.

Suggestions

After you have typed a command in to the left pane, you can submit it to Elasticsearch by clicking the little green triangle that appears next to the URL line of the request. Notice that as you move the cursor around, the little triangle and wrench icons follow you around. We call this the Action Menu. You can also select multiple requests and submit them all at once.

Action menu

When the response come back, you should see it in the left panel:

Output pane

The console user interface

In this section you will find a more detailed description of the UI of the Console. The basic aspects of the UI are explained in the Console section.

Search results

    No results found