Merge branch '5.0' into 5.0.0-alpha4

docs/advanced-settings.asciidoc

@@ -11,8 +11,8 @@ compatible with other configuration settings. Deleting a custom setting removes
 `dateFormat`:: The format to use for displaying pretty-formatted dates.
 `dateFormat:tz`:: The timezone that Kibana uses. The default value of `Browser` uses the timezone detected by the browser.
 `dateFormat:scaled`:: These values define the format used to render ordered time-based data. Formatted timestamps must
-`dateFormat:dow`:: This property defines what day weeks should start on.
 adapt to the interval between measurements. Keys are http://en.wikipedia.org/wiki/ISO_8601#Time_intervals[ISO8601 intervals].
+`dateFormat:dow`:: This property defines what day weeks should start on.
 `defaultIndex`:: Default is `null`. This property specifies the default index.
 `defaultColumns`:: Default is `_source`. Defines the columns that appear by default on the Discover page.
 `metaFields`:: An array of fields outside of `_source`. Kibana merges these fields into the document when displaying the

docs/area.asciidoc

@@ -3,32 +3,32 @@
 
 This chart's Y axis is the _metrics_ axis. The following aggregations are available for this axis:
 
-*Count*:: The {ref}/search-aggregations-metrics-valuecount-aggregation.html[_count_] aggregation returns a raw count of 
+*Count*:: The {ref}/search-aggregations-metrics-valuecount-aggregation.html[_count_] aggregation returns a raw count of
 the elements in the selected index pattern.
-*Average*:: This aggregation returns the {ref}/search-aggregations-metrics-avg-aggregation.html[_average_] of a numeric 
+*Average*:: This aggregation returns the {ref}/search-aggregations-metrics-avg-aggregation.html[_average_] of a numeric
 field. Select a field from the drop-down.
-*Sum*:: The {ref}/search-aggregations-metrics-sum-aggregation.html[_sum_] aggregation returns the total sum of a numeric 
+*Sum*:: The {ref}/search-aggregations-metrics-sum-aggregation.html[_sum_] aggregation returns the total sum of a numeric
 field. Select a field from the drop-down.
-*Min*:: The {ref}/search-aggregations-metrics-min-aggregation.html[_min_] aggregation returns the minimum value of a 
+*Min*:: The {ref}/search-aggregations-metrics-min-aggregation.html[_min_] aggregation returns the minimum value of a
 numeric field. Select a field from the drop-down.
-*Max*:: The {ref}/search-aggregations-metrics-max-aggregation.html[_max_] aggregation returns the maximum value of a 
+*Max*:: The {ref}/search-aggregations-metrics-max-aggregation.html[_max_] aggregation returns the maximum value of a
 numeric field. Select a field from the drop-down.
-*Unique Count*:: The {ref}/search-aggregations-metrics-cardinality-aggregation.html[_cardinality_] aggregation returns 
+*Unique Count*:: The {ref}/search-aggregations-metrics-cardinality-aggregation.html[_cardinality_] aggregation returns
 the number of unique values in a field. Select a field from the drop-down.
-*Percentiles*:: The {ref}/search-aggregations-metrics-percentile-aggregation.html[_percentile_] aggregation divides the 
-values in a numeric field into percentile bands that you specify. Select a field from the drop-down, then specify one 
-or more ranges in the *Percentiles* fields. Click the *X* to remove a percentile field. Click *+ Add* to add a 
+*Percentiles*:: The {ref}/search-aggregations-metrics-percentile-aggregation.html[_percentile_] aggregation divides the
+values in a numeric field into percentile bands that you specify. Select a field from the drop-down, then specify one
+or more ranges in the *Percentiles* fields. Click the *X* to remove a percentile field. Click *+ Add* to add a
 percentile field.
-*Percentile Rank*:: The {ref}/search-aggregations-metrics-percentile-rank-aggregation.html[_percentile ranks_] 
-aggregation returns the percentile rankings for the values in the numeric field you specify. Select a numeric field 
+*Percentile Rank*:: The {ref}/search-aggregations-metrics-percentile-rank-aggregation.html[_percentile ranks_]
+aggregation returns the percentile rankings for the values in the numeric field you specify. Select a numeric field
 from the drop-down, then specify one or more percentile rank values in the *Values* fields. Click the *X* to remove a
 values field. Click *+Add* to add a values field.
 
 You can add an aggregation by clicking the *+ Add Metrics* button.
 
 include::x-axis-aggs.asciidoc[]
-For example, a chart of dates with incident counts can display dates in chronological order, or you can raise the 
-priority of the incident-reporting aggregation to show the most active dates first. The chronological order might show 
+For example, a chart of dates with incident counts can display dates in chronological order, or you can raise the
+priority of the incident-reporting aggregation to show the most active dates first. The chronological order might show
 a time-dependent pattern in incident count, and sorting by active dates can reveal particular outliers in your data.
 
 include::color-picker.asciidoc[]
@@ -37,20 +37,20 @@ You can click the *Advanced* link to display more customization options for your
 
 *Exclude Pattern*:: Specify a pattern in this field to exclude from the results.
 *Include Pattern*:: Specify a pattern in this field to include in the results.
-*JSON Input*:: A text field where you can add specific JSON-formatted properties to merge with the aggregation 
+*JSON Input*:: A text field where you can add specific JSON-formatted properties to merge with the aggregation
 definition, as in the following example:
 
 [source,shell]
 { "script" : "doc['grade'].value * 1.2" }
 
-NOTE: In Elasticsearch releases 1.4.3 and later, this functionality requires you to enable 
+NOTE: In Elasticsearch releases 1.4.3 and later, this functionality requires you to enable
 {ref}/modules-scripting.html[dynamic Groovy scripting].
 
 The availability of these options varies depending on the aggregation you choose.
 
 Select the *Options* tab to change the following aspects of the chart:
 
-*Chart Mode*:: When you have multiple Y-axis aggregations defined for your chart, you can use this drop-down to affect 
+*Chart Mode*:: When you have multiple Y-axis aggregations defined for your chart, you can use this drop-down to affect
 how the aggregations display on the chart:
 
 _stacked_:: Stacks the aggregations on top of each other.
@@ -62,12 +62,11 @@ _silhouette_:: Displays each aggregation as variance from a central line.
 Checkboxes are available to enable and disable the following behaviors:
 
 *Smooth Lines*:: Check this box to curve the top boundary of the area from point to point.
-*Set Y-Axis Extents*:: Check this box and enter values in the *y-max* and *y-min* fields to set the Y axis to specific 
-values. 
-*Scale Y-Axis to Data Bounds*:: The default Y axis bounds are zero and the maximum value returned in the data. Check 
+*Set Y-Axis Extents*:: Check this box and enter values in the *y-max* and *y-min* fields to set the Y axis to specific
+values.
+*Scale Y-Axis to Data Bounds*:: The default Y axis bounds are zero and the maximum value returned in the data. Check
 this box to change both upper and lower bounds to match the values returned in the data.
 *Show Tooltip*:: Check this box to enable the display of tooltips.
-*Show Legend*:: Check this box to enable the display of a legend next to the chart.
 
 [float]
 [[area-viewing-detailed-information]]

docs/console.asciidoc

@@ -0,0 +1,172 @@
+[[console-kibana]]
+== Console for Kibana
+
+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.
+Enter the address of your Elasticsearch server in the text box on the top of screen. The default value of this address
+is `localhost:9200`.
+
+.The Console UI
+image::images/introduction_screen.png[Screenshot]
+
+Console understands commands in a cURL-like syntax. For example the following Console command
+
+[source,js]
+----------------------------------
+GET /_search
+{
+  "query": {
+    "match_all": {}
+  }
+}
+----------------------------------
+
+is a simple `GET` request to Elasticsearch's `_search API`. Here is the equivalent command in cURL.
+
+[source,bash]
+----------------------------------
+curl -XGET "http://localhost:9200/_search" -d'
+{
+  "query": {
+    "match_all": {}
+  }
+}'
+----------------------------------
+
+In fact, you can paste the above command into Console and it will automatically be converted into the Console syntax.
+
+When typing a command, Console will make context sensitive <<suggestions,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]]
+.API suggestions
+image::images/introduction_suggestion.png["Suggestions",width=400,align="center"]
+
+Once 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,Action Menu>>. You can also select
+ multiple requests and submit them all at once.
+
+[[action_menu]]
+.The Action Menu
+image::images/introduction_action_menu.png["The Action Menu",width=400,align="center"]
+
+When the response come back, you should see it in the left hand panel:
+
+.The Output Pane
+image::images/introduction_output.png[Screenshot]
+
+Console allows you to easily switch between Elasticsearch instances. By default it will connect to `localhost:9200`
+but you can easily change this by entering a different url in the Server input:
+
+.The Server Input
+image::images/introduction_server.png["Server",width=400,align="center"]
+
+[NOTE]
+Console is a development tool and is configured by default to run on a laptop. If you install it on a server please
+look at the <<securing_console>> for instructions on how make it secure.
+
+[[console-ui]]
+== The Console UI
+
+In this section you will find a more detailed description of UI of Console. The basic aspects of the UI are explained
+in the <<console-kibana>> section.
+
+[[multi-req]]
+=== Multiple Requests Support
+
+The Console editor allows writing multiple requests below each other. As shown in the <<console-kibana>> section, you
+can submit a request to Elasticsearch by positioning the cursor and using the <<action_menu,Action Menu>>. Similarly
+you can select multiple requests in one go:
+
+.Selecting Multiple Requests
+image::images/multiple_requests.png[Multiple Requests]
+
+Console will send the request one by one to Elasticsearch and show the output on the right pane as Elasticsearch responds.
+This is very handy when debugging an issue or trying query combinations in multiple scenarios.
+
+Selecting multiple requests also allows you to auto format and copy them as cURL in one go.
+
+
+[[auto_formatting]]
+=== Auto Formatting
+
+Console allows you to auto format messy requests. To do so, position the cursor on the request you would like to format
+and select Auto Indent from the action menu:
+
+.Auto Indent a request
+image::images/auto_format_before.png["Auto format before",width=500,align="center"]
+
+Console will adjust the JSON body of the request and it will now look like this:
+
+.A formatted request
+image::images/auto_format_after.png["Auto format after",width=500,align="center"]
+
+If you select Auto Indent on a request that is already perfectly formatted, Console will collapse the
+request body to a single line per document. This is very handy when working with Elasticsearch's bulk APIs:
+
+.One doc per line
+image::images/auto_format_bulk.png["Auto format bulk",width=550,align="center"]
+
+
+[[keyboard_shortcuts]]
+=== Keyboard shortcuts
+
+Console comes with a set of nifty keyboard shortcuts making working with it even more efficient. Here is an overview:
+
+==== General editing
+
+Ctrl/Cmd + I:: Auto indent current request.
+Ctrl + Space:: Open Auto complete (even if not typing).
+Ctrl/Cmd + Enter:: Submit request.
+Ctrl/Cmd + Up/Down:: Jump to the previous/next request start or end.
+Ctrl/Cmd + Alt + L:: Collapse/expand current scope.
+Ctrl/Cmd + Option + 0:: Collapse all scopes but the current one. Expand by adding a shift.
+
+==== When auto-complete is visible
+
+Down arrow:: Switch focus to auto-complete menu. Use arrows to further select a term.
+Enter/Tab::  Select the currently selected or the top most term in auto-complete menu.
+Esc:: Close auto-complete menu.
+
+
+=== History
+
+Console maintains a list of the last 500 requests that were successfully executed by Elasticsearch. The history
+is available by clicking the clock icon on the top right side of the window. The icons opens the history panel
+where you can see the old requests. You can also select a request here and it will be added to the editor at
+the current cursor position.
+
+.History Panel
+image::images/history.png["History Panel"]
+
+
+=== Settings
+
+Console has multiple settings you can set. All of them are available in the Settings panel. To open the panel
+click on the cog icon on the top right.
+
+.Settings Panel
+image::images/settings.png["Setting Panel"]
+
+[[securing_console]]
+=== Securing Console
+
+Console is meant to be used as a local development tool. As such, it will send requests to any host & port combination,
+just as a local curl command would. To overcome the CORS limitations enforced by browsers, Console's Node.js backend
+serves as a proxy to send requests on behalf of the browser. However, if put on a server and exposed to the internet
+this can become a security risk. In those cases, we highly recommend you lock down the proxy by setting the
+`console.proxyFilter` setting. The setting accepts a list of regular expressions that are evaluated against each URL
+ the proxy is requested to retrieve. If none of the regular expressions match the proxy will reject the request.
+
+Here is an example configuration the only allows Console to connect to localhost:
+
+[source,yaml]
+--------
+sense.proxyFilter:
+  - ^https?://(localhost|127\.0\.0\.1|\[::0\]).*
+--------
+
+Restart Kibana for these changes to take effect.
+