diff --git a/docs/advanced-settings.asciidoc b/docs/advanced-settings.asciidoc index 3480997d8e5df..fae631b0e46c7 100644 --- a/docs/advanced-settings.asciidoc +++ b/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 diff --git a/docs/area.asciidoc b/docs/area.asciidoc index 07baabd2d730b..f64a5922aae51 100644 --- a/docs/area.asciidoc +++ b/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]] diff --git a/docs/console.asciidoc b/docs/console.asciidoc new file mode 100644 index 0000000000000..4eb23dce1989c --- /dev/null +++ b/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 <>. 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 <>. 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 <> 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 <> section. + +[[multi-req]] +=== Multiple Requests Support + +The Console editor allows writing multiple requests below each other. As shown in the <> section, you +can submit a request to Elasticsearch by positioning the cursor and using the <>. 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. + diff --git a/docs/datatable.asciidoc b/docs/datatable.asciidoc index 0c63d610b64d9..b5130b5813135 100644 --- a/docs/datatable.asciidoc +++ b/docs/datatable.asciidoc @@ -8,39 +8,39 @@ the table into additional tables. Each bucket type supports the following aggregations: -*Date Histogram*:: A {ref}search-aggregations-bucket-datehistogram-aggregation.html[_date histogram_] is built from a -numeric field and organized by date. You can specify a time frame for the intervals in seconds, minutes, hours, days, -weeks, months, or years. You can also specify a custom interval frame by selecting *Custom* as the interval and -specifying a number and a time unit in the text field. Custom interval time units are *s* for seconds, *m* for minutes, -*h* for hours, *d* for days, *w* for weeks, and *y* for years. Different units support different levels of precision, +*Date Histogram*:: A {ref}search-aggregations-bucket-datehistogram-aggregation.html[_date histogram_] is built from a +numeric field and organized by date. You can specify a time frame for the intervals in seconds, minutes, hours, days, +weeks, months, or years. You can also specify a custom interval frame by selecting *Custom* as the interval and +specifying a number and a time unit in the text field. Custom interval time units are *s* for seconds, *m* for minutes, +*h* for hours, *d* for days, *w* for weeks, and *y* for years. Different units support different levels of precision, down to one second. -*Histogram*:: A standard {ref}search-aggregations-bucket-histogram-aggregation.html[_histogram_] is built from a -numeric field. Specify an integer interval for this field. Select the *Show empty buckets* checkbox to include empty +*Histogram*:: A standard {ref}search-aggregations-bucket-histogram-aggregation.html[_histogram_] is built from a +numeric field. Specify an integer interval for this field. Select the *Show empty buckets* checkbox to include empty intervals in the histogram. -*Range*:: With a {ref}search-aggregations-bucket-range-aggregation.html[_range_] aggregation, you can specify ranges -of values for a numeric field. Click *Add Range* to add a set of range endpoints. Click the red *(x)* symbol to remove +*Range*:: With a {ref}search-aggregations-bucket-range-aggregation.html[_range_] aggregation, you can specify ranges +of values for a numeric field. Click *Add Range* to add a set of range endpoints. Click the red *(x)* symbol to remove a range. -*Date Range*:: A {ref}search-aggregations-bucket-daterange-aggregation.html[_date range_] aggregation reports values -that are within a range of dates that you specify. You can specify the ranges for the dates using -{ref}common-options.html#date-math[_date math_] expressions. Click *Add Range* to add a set of range endpoints. +*Date Range*:: A {ref}search-aggregations-bucket-daterange-aggregation.html[_date range_] aggregation reports values +that are within a range of dates that you specify. You can specify the ranges for the dates using +{ref}common-options.html#date-math[_date math_] expressions. Click *Add Range* to add a set of range endpoints. Click the red *(/)* symbol to remove a range. *IPv4 Range*:: The {ref}search-aggregations-bucket-iprange-aggregation.html[_IPv4 range_] aggregation enables you to -specify ranges of IPv4 addresses. Click *Add Range* to add a set of range endpoints. Click the red *(/)* symbol to +specify ranges of IPv4 addresses. Click *Add Range* to add a set of range endpoints. Click the red *(/)* symbol to remove a range. -*Terms*:: A {ref}search-aggregations-bucket-terms-aggregation.html[_terms_] aggregation enables you to specify the top +*Terms*:: A {ref}search-aggregations-bucket-terms-aggregation.html[_terms_] aggregation enables you to specify the top or bottom _n_ elements of a given field to display, ordered by count or a custom metric. -*Filters*:: You can specify a set of {ref}search-aggregations-bucket-filters-aggregation.html[_filters_] for the data. -You can specify a filter as a query string or in JSON format, just as in the Discover search bar. Click *Add Filter* to -add another filter. Click the image:images/labelbutton.png[] *label* button to open the label field, where you can type +*Filters*:: You can specify a set of {ref}search-aggregations-bucket-filters-aggregation.html[_filters_] for the data. +You can specify a filter as a query string or in JSON format, just as in the Discover search bar. Click *Add Filter* to +add another filter. Click the image:images/labelbutton.png[] *label* button to open the label field, where you can type in a name to display on the visualization. -*Significant Terms*:: Displays the results of the experimental -{ref}search-aggregations-bucket-significantterms-aggregation.html[_significant terms_] aggregation. The value of the +*Significant Terms*:: Displays the results of the experimental +{ref}search-aggregations-bucket-significantterms-aggregation.html[_significant terms_] aggregation. The value of the *Size* parameter defines the number of entries this aggregation returns. -*Geohash*:: The {ref}search-aggregations-bucket-geohashgrid-aggregation.html[_geohash_] aggregation displays points +*Geohash*:: The {ref}search-aggregations-bucket-geohashgrid-aggregation.html[_geohash_] aggregation displays points based on the geohash coordinates. -Once you've specified a bucket type aggregation, you can define sub-buckets to refine the visualization. Click -*+ Add sub-buckets* to define a sub-bucket, then choose *Split Rows* or *Split Table*, then select an +Once you've specified a bucket type aggregation, you can define sub-buckets to refine the visualization. Click +*+ Add sub-buckets* to define a sub-bucket, then choose *Split Rows* or *Split Table*, then select an aggregation from the list of types. You can use the up or down arrows to the right of the aggregation's type to change the aggregation's priority. @@ -51,13 +51,13 @@ 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. diff --git a/docs/getting-started.asciidoc b/docs/getting-started.asciidoc index db3c479c284d1..ee555edda7e6b 100644 --- a/docs/getting-started.asciidoc +++ b/docs/getting-started.asciidoc @@ -6,7 +6,7 @@ key Kibana functionality. By the end of this tutorial, you will have: * Loaded a sample data set into your Elasticsearch installation * Defined at least one index pattern -* Used the <> functionality to explore your data +* Use the <> functionality to explore your data * Set up some <> to graphically represent your data * Assembled visualizations into a <> diff --git a/docs/images/auto_format_after.png b/docs/images/auto_format_after.png new file mode 100644 index 0000000000000..018e82951b64f Binary files /dev/null and b/docs/images/auto_format_after.png differ diff --git a/docs/images/auto_format_before.png b/docs/images/auto_format_before.png new file mode 100644 index 0000000000000..2535aa1af5240 Binary files /dev/null and b/docs/images/auto_format_before.png differ diff --git a/docs/images/auto_format_bulk.png b/docs/images/auto_format_bulk.png new file mode 100644 index 0000000000000..92cb688473ab7 Binary files /dev/null and b/docs/images/auto_format_bulk.png differ diff --git a/docs/images/introduction_action_menu.png b/docs/images/introduction_action_menu.png new file mode 100644 index 0000000000000..6bded9a28cc93 Binary files /dev/null and b/docs/images/introduction_action_menu.png differ diff --git a/docs/images/introduction_output.png b/docs/images/introduction_output.png new file mode 100644 index 0000000000000..e86729c6fbb6e Binary files /dev/null and b/docs/images/introduction_output.png differ diff --git a/docs/images/introduction_screen.png b/docs/images/introduction_screen.png new file mode 100644 index 0000000000000..216d1c5503dfd Binary files /dev/null and b/docs/images/introduction_screen.png differ diff --git a/docs/images/introduction_server.png b/docs/images/introduction_server.png new file mode 100644 index 0000000000000..6cc807ed766e9 Binary files /dev/null and b/docs/images/introduction_server.png differ diff --git a/docs/images/introduction_suggestion.png b/docs/images/introduction_suggestion.png new file mode 100644 index 0000000000000..c19da4ef50b1d Binary files /dev/null and b/docs/images/introduction_suggestion.png differ diff --git a/docs/images/multiple_requests.png b/docs/images/multiple_requests.png new file mode 100644 index 0000000000000..e4fd010d54b4b Binary files /dev/null and b/docs/images/multiple_requests.png differ diff --git a/docs/images/readme_api_suggestions.png b/docs/images/readme_api_suggestions.png new file mode 100644 index 0000000000000..fd8f3daed1950 Binary files /dev/null and b/docs/images/readme_api_suggestions.png differ diff --git a/docs/images/readme_auto_formatting_mix.png b/docs/images/readme_auto_formatting_mix.png new file mode 100644 index 0000000000000..d3b57ad0122be Binary files /dev/null and b/docs/images/readme_auto_formatting_mix.png differ diff --git a/docs/images/readme_copy_as_curl.png b/docs/images/readme_copy_as_curl.png new file mode 100644 index 0000000000000..e0e2e643fde3d Binary files /dev/null and b/docs/images/readme_copy_as_curl.png differ diff --git a/docs/images/readme_errors.png b/docs/images/readme_errors.png new file mode 100644 index 0000000000000..eac60214cb91f Binary files /dev/null and b/docs/images/readme_errors.png differ diff --git a/docs/images/readme_multiple_requests.png b/docs/images/readme_multiple_requests.png new file mode 100644 index 0000000000000..4f41104e5ed38 Binary files /dev/null and b/docs/images/readme_multiple_requests.png differ diff --git a/docs/images/readme_scope_collapsing.png b/docs/images/readme_scope_collapsing.png new file mode 100644 index 0000000000000..dda87ddb88d31 Binary files /dev/null and b/docs/images/readme_scope_collapsing.png differ diff --git a/docs/index.asciidoc b/docs/index.asciidoc index bd9c82d734521..ce40264563d18 100644 --- a/docs/index.asciidoc +++ b/docs/index.asciidoc @@ -6,9 +6,9 @@ :scyld: X-Pack Security :k4issue: https://github.com/elastic/kibana/issues/ :k4pull: https://github.com/elastic/kibana/pull/ -:version: master -:esversion: master -:packageversion: master +:version: 5.0.0-alpha +:esversion: 5.0.0-alpha +:packageversion: 5.0.0-alpha include::introduction.asciidoc[] @@ -18,6 +18,8 @@ include::getting-started.asciidoc[] include::plugins.asciidoc[] +include::console.asciidoc[] + include::access.asciidoc[] include::discover.asciidoc[] diff --git a/docs/kibana-yml.asciidoc b/docs/kibana-yml.asciidoc index 43272c0d73291..5cda11a363c02 100644 --- a/docs/kibana-yml.asciidoc +++ b/docs/kibana-yml.asciidoc @@ -2,45 +2,44 @@ [horizontal] `server.port:`:: *Default: 5601* Kibana is served by a back end server. This setting specifies the port to use. `server.host:`:: *Default: "0.0.0.0"* This setting specifies the IP address of the back end server. -`server.basePath:`:: Enables you to specify a path to mount Kibana at if you are running behind a proxy. This setting +`server.basePath:`:: Enables you to specify a path to mount Kibana at if you are running behind a proxy. This setting cannot end in a slash (`/`). `server.maxPayloadBytes:`:: *Default: 1048576* The maximum payload size in bytes for incoming server requests. -`server.name:`:: *Default: "your-hostname"* A human-readable display name that identifies this Kibana instance. -`elasticsearch.url:`:: *Default: "http://localhost:9200"* The URL of the Elasticsearch instance to use for all your +`server.name:`:: *Default: "your-hostname"* A human-readable display name that identifies this Kibana instance. +`elasticsearch.url:`:: *Default: "http://localhost:9200"* The URL of the Elasticsearch instance to use for all your queries. -`elasticsearch.preserveHost:`:: *Default: true* When this setting’s value is true Kibana uses the hostname specified in -the `server.host` setting. When the value of this setting is `false`, Kibana uses the hostname of the host that connects +`elasticsearch.preserveHost:`:: *Default: true* When this setting’s value is true Kibana uses the hostname specified in +the `server.host` setting. When the value of this setting is `false`, Kibana uses the hostname of the host that connects to this Kibana instance. -`kibana.index:`:: *Default: ".kibana"* Kibana uses an index in Elasticsearch to store saved searches, visualizations and +`kibana.index:`:: *Default: ".kibana"* Kibana uses an index in Elasticsearch to store saved searches, visualizations and dashboards. Kibana creates a new index if the index doesn’t already exist. `kibana.defaultAppId:`:: *Default: "discover"* The default application to load. -`elasticsearch.username:` and `elasticsearch.password:`:: If your Elasticsearch is protected with basic authentication, -these settings provide the username and password that the Kibana server uses to perform maintenance on the Kibana index at +`elasticsearch.username:` and `elasticsearch.password:`:: If your Elasticsearch is protected with basic authentication, +these settings provide the username and password that the Kibana server uses to perform maintenance on the Kibana index at startup. Your Kibana users still need to authenticate with Elasticsearch, which is proxied through the Kibana server. -`server.ssl.cert:` and `server.ssl.key:`:: Paths to the PEM-format SSL certificate and SSL key files, respectively. These +`server.ssl.cert:` and `server.ssl.key:`:: Paths to the PEM-format SSL certificate and SSL key files, respectively. These files enable SSL for outgoing requests from the Kibana server to the browser. -`elasticsearch.ssl.cert:` and `elasticsearch.ssl.key:`:: Optional settings that provide the paths to the PEM-format SSL +`elasticsearch.ssl.cert:` and `elasticsearch.ssl.key:`:: Optional settings that provide the paths to the PEM-format SSL certificate and key files. These files validate that your Elasticsearch backend uses the same key files. -`elasticsearch.ssl.ca:`:: Optional setting that enables you to specify a path to the PEM file for the certificate +`elasticsearch.ssl.ca:`:: Optional setting that enables you to specify a path to the PEM file for the certificate authority for your Elasticsearch instance. -`elasticsearch.ssl.verify:`:: *Default: true* To disregard the validity of SSL certificates, change this setting’s value +`elasticsearch.ssl.verify:`:: *Default: true* To disregard the validity of SSL certificates, change this setting’s value to `false`. -`elasticsearch.pingTimeout:`:: *Default: the value of the `elasticsearch.requestTimeout` setting* Time in milliseconds to +`elasticsearch.pingTimeout:`:: *Default: the value of the `elasticsearch.requestTimeout` setting* Time in milliseconds to wait for Elasticsearch to respond to pings. -`elasticsearch.requestTimeout:`:: *Default: 30000* Time in milliseconds to wait for responses from the back end or +`elasticsearch.requestTimeout:`:: *Default: 30000* Time in milliseconds to wait for responses from the back end or Elasticsearch. This value must be a positive integer. `elasticsearch.requestHeadersWhitelist:`:: *Default: `[ 'authorization' ]`* List of Kibana client-side headers to send to Elasticsearch. To send *no* client-side headers, set this value to [] (an empty list). -`elasticsearch.shardTimeout:`:: *Default: 0* Time in milliseconds for Elasticsearch to wait for responses from shards. Set -to 0 to disable. -`elasticsearch.startupTimeout:`:: *Default: 5000* Time in milliseconds to wait for Elasticsearch at Kibana startup before +`elasticsearch.shardTimeout:`:: *Default: 0* Time in milliseconds for Elasticsearch to wait for responses from shards. Set to 0 to disable. +`elasticsearch.startupTimeout:`:: *Default: 5000* Time in milliseconds to wait for Elasticsearch at Kibana startup before retrying. `pid.file:`:: Specifies the path where Kibana creates the process ID file. `logging.dest:`:: *Default: `stdout`* Enables you specify a file where Kibana stores log output. `logging.silent:`:: *Default: false* Set the value of this setting to `true` to suppress all logging output. -`logging.quiet:`:: *Default: false* Set the value of this setting to `true` to suppress all logging output other than +`logging.quiet:`:: *Default: false* Set the value of this setting to `true` to suppress all logging output other than error messages. -`logging.verbose`:: *Default: false* Set the value of this setting to `true` to log all events, including system usage +`logging.verbose`:: *Default: false* Set the value of this setting to `true` to log all events, including system usage information and all requests. `ops.interval`:: *Default: 5000* Set the interval in milliseconds to sample system and process performance metrics. The minimum value is 100. diff --git a/docs/line.asciidoc b/docs/line.asciidoc index a349176a6c01c..42b9e7f850570 100644 --- a/docs/line.asciidoc +++ b/docs/line.asciidoc @@ -46,7 +46,6 @@ affect the representation of your data and create a potential for ambiguity. *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. *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. *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. diff --git a/docs/pie.asciidoc b/docs/pie.asciidoc index b46c2dc27e3e5..f3acb2c5c322b 100644 --- a/docs/pie.asciidoc +++ b/docs/pie.asciidoc @@ -1,14 +1,14 @@ [[pie-chart]] === Pie Charts -The slice size of a pie chart is determined by the _metrics_ aggregation. The following aggregations are available for +The slice size of a pie chart is determined by the _metrics_ aggregation. 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. -*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. -*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. Enter a string in the *Custom Label* field to change the display label. @@ -16,45 +16,45 @@ Enter a string in the *Custom Label* field to change the display label. The _buckets_ aggregations determine what information is being retrieved from your data set. Before you choose a buckets aggregation, specify if you are splitting slices within a single chart or splitting into -multiple charts. A multiple chart split must run before any other aggregations. When you split a chart, you can change +multiple charts. A multiple chart split must run before any other aggregations. When you split a chart, you can change if the splits are displayed in a row or a column by clicking the *Rows | Columns* selector. You can specify any of the following bucket aggregations for your pie chart: -*Date Histogram*:: A {ref}search-aggregations-bucket-datehistogram-aggregation.html[_date histogram_] is built from a -numeric field and organized by date. You can specify a time frame for the intervals in seconds, minutes, hours, days, -weeks, months, or years. You can also specify a custom interval frame by selecting *Custom* as the interval and -specifying a number and a time unit in the text field. Custom interval time units are *s* for seconds, *m* for minutes, -*h* for hours, *d* for days, *w* for weeks, and *y* for years. Different units support different levels of precision, +*Date Histogram*:: A {ref}search-aggregations-bucket-datehistogram-aggregation.html[_date histogram_] is built from a +numeric field and organized by date. You can specify a time frame for the intervals in seconds, minutes, hours, days, +weeks, months, or years. You can also specify a custom interval frame by selecting *Custom* as the interval and +specifying a number and a time unit in the text field. Custom interval time units are *s* for seconds, *m* for minutes, +*h* for hours, *d* for days, *w* for weeks, and *y* for years. Different units support different levels of precision, down to one second. -*Histogram*:: A standard {ref}search-aggregations-bucket-histogram-aggregation.html[_histogram_] is built from a -numeric field. Specify an integer interval for this field. Select the *Show empty buckets* checkbox to include empty +*Histogram*:: A standard {ref}search-aggregations-bucket-histogram-aggregation.html[_histogram_] is built from a +numeric field. Specify an integer interval for this field. Select the *Show empty buckets* checkbox to include empty intervals in the histogram. -*Range*:: With a {ref}search-aggregations-bucket-range-aggregation.html[_range_] aggregation, you can specify ranges -of values for a numeric field. Click *Add Range* to add a set of range endpoints. Click the red *(x)* symbol to remove +*Range*:: With a {ref}search-aggregations-bucket-range-aggregation.html[_range_] aggregation, you can specify ranges +of values for a numeric field. Click *Add Range* to add a set of range endpoints. Click the red *(x)* symbol to remove a range. -*Date Range*:: A {ref}search-aggregations-bucket-daterange-aggregation.html[_date range_] aggregation reports values -that are within a range of dates that you specify. You can specify the ranges for the dates using -{ref}common-options.html#date-math[_date math_] expressions. Click *Add Range* to add a set of range endpoints. +*Date Range*:: A {ref}search-aggregations-bucket-daterange-aggregation.html[_date range_] aggregation reports values +that are within a range of dates that you specify. You can specify the ranges for the dates using +{ref}common-options.html#date-math[_date math_] expressions. Click *Add Range* to add a set of range endpoints. Click the red *(/)* symbol to remove a range. *IPv4 Range*:: The {ref}search-aggregations-bucket-iprange-aggregation.html[_IPv4 range_] aggregation enables you to -specify ranges of IPv4 addresses. Click *Add Range* to add a set of range endpoints. Click the red *(/)* symbol to +specify ranges of IPv4 addresses. Click *Add Range* to add a set of range endpoints. Click the red *(/)* symbol to remove a range. -*Terms*:: A {ref}search-aggregations-bucket-terms-aggregation.html[_terms_] aggregation enables you to specify the top +*Terms*:: A {ref}search-aggregations-bucket-terms-aggregation.html[_terms_] aggregation enables you to specify the top or bottom _n_ elements of a given field to display, ordered by count or a custom metric. -*Filters*:: You can specify a set of {ref}search-aggregations-bucket-filters-aggregation.html[_filters_] for the data. -You can specify a filter as a query string or in JSON format, just as in the Discover search bar. Click *Add Filter* to -add another filter. Click the image:images/labelbutton.png[] *label* button to open the label field, where you can type +*Filters*:: You can specify a set of {ref}search-aggregations-bucket-filters-aggregation.html[_filters_] for the data. +You can specify a filter as a query string or in JSON format, just as in the Discover search bar. Click *Add Filter* to +add another filter. Click the image:images/labelbutton.png[] *label* button to open the label field, where you can type in a name to display on the visualization. -*Significant Terms*:: Displays the results of the experimental -{ref}search-aggregations-bucket-significantterms-aggregation.html[_significant terms_] aggregation. The value of the +*Significant Terms*:: Displays the results of the experimental +{ref}search-aggregations-bucket-significantterms-aggregation.html[_significant terms_] aggregation. The value of the *Size* parameter defines the number of entries this aggregation returns. -After defining an initial bucket aggregation, you can define sub-buckets to refine the visualization. Click *+ Add -sub-buckets* to define a sub-aggregation, then choose *Split Slices* to select a sub-bucket from the list of +After defining an initial bucket aggregation, you can define sub-buckets to refine the visualization. Click *+ Add +sub-buckets* to define a sub-aggregation, then choose *Split Slices* to select a sub-bucket from the list of types. -When multiple aggregations are defined on a chart's axis, you can use the up or down arrows to the right of the +When multiple aggregations are defined on a chart's axis, you can use the up or down arrows to the right of the aggregation's type to change the aggregation's priority. include::color-picker.asciidoc[] @@ -65,13 +65,13 @@ 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. @@ -80,9 +80,8 @@ Select the *Options* tab to change the following aspects of the table: *Donut*:: Display the chart as a sliced ring instead of a sliced pie. *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. -After changing options, click the *Apply changes* button to update your visualization, or the grey *Discard +After changing options, click the *Apply changes* button to update your visualization, or the grey *Discard changes* button to keep your visualization in its current state. [float] diff --git a/docs/plugins.asciidoc b/docs/plugins.asciidoc index f1548b0ddd632..d6e086e53ddd0 100644 --- a/docs/plugins.asciidoc +++ b/docs/plugins.asciidoc @@ -23,8 +23,8 @@ When you specify a plugin name without a URL, the plugin tool attempts to downlo You can specify a URL to a specific plugin, as in the following example: [source,shell] -$ bin/kibana-plugin install https://download.elastic.co/kibana/x-pack/x-pack-5.0.0-snapshot.zip -Attempting to transfer from https://download.elastic.co/kibana/x-pack//x-pack-5.0.0-snapshot.zip +$ bin/kibana-plugin install https://download.elastic.co/kibana/x-pack/x-pack-5.0.0-alpha3.zip +Attempting to transfer from https://download.elastic.co/kibana/x-pack//x-pack-5.0.0-alpha3.zip Transferring bytes.................... Transfer complete Retrieving metadata from plugin archive @@ -126,4 +126,4 @@ Use the following command to disable a plugin: [source,shell] ./bin/kibana --.enabled=false -You can find a plugin's plugin ID as the value of the `name` property in the plugin's `package.json` file. \ No newline at end of file +You can find a plugin's plugin ID as the value of the `name` property in the plugin's `package.json` file. diff --git a/docs/releasenotes.asciidoc b/docs/releasenotes.asciidoc index ceb585f470bab..69a78d1af27d7 100644 --- a/docs/releasenotes.asciidoc +++ b/docs/releasenotes.asciidoc @@ -37,7 +37,7 @@ The {version} release of Kibana requires Elasticsearch {esversion} or later. [[plugins-apis]] == Plugins, APIs, and Development Infrastructure -NOTE: The items in this section are not a complete list of the internal changes relating to development in Kibana. Plugin +NOTE: The items in this section are not a complete list of the internal changes relating to development in Kibana. Plugin framework and APIs are not formally documented and not guaranteed to be backward compatible from release to release. * {k4pull}7069[Pull Request 7069]: Adds `preInit` functionality. diff --git a/docs/settings.asciidoc b/docs/settings.asciidoc index 1b99bec2a9307..51ae6716105b0 100644 --- a/docs/settings.asciidoc +++ b/docs/settings.asciidoc @@ -1,55 +1,55 @@ [[settings]] == Settings -To use Kibana, you have to tell it about the Elasticsearch indices that you want to explore by configuring one or more +To use Kibana, you have to tell it about the Elasticsearch indices that you want to explore by configuring one or more index patterns. You can also: -* Create scripted fields that are computed on the fly from your data. You can browse and visualize scripted fields, but +* Create scripted fields that are computed on the fly from your data. You can browse and visualize scripted fields, but you cannot search them. -* Set advanced options such as the number of rows to show in a table and how many of the most popular fields to show. +* Set advanced options such as the number of rows to show in a table and how many of the most popular fields to show. Use caution when modifying advanced options, as it's possible to set values that are incompatible with one another. * Configure Kibana for a production environment [float] [[settings-create-pattern]] === Creating an Index Pattern to Connect to Elasticsearch -An _index pattern_ identifies one or more Elasticsearch indices that you want to explore with Kibana. Kibana looks for +An _index pattern_ identifies one or more Elasticsearch indices that you want to explore with Kibana. Kibana looks for index names that match the specified pattern. -An asterisk (*) in the pattern matches zero or more characters. For example, the pattern `myindex-*` matches all -indices whose names start with `myindex-`, such as `myindex-1` and `myindex-2`. +An asterisk (*) in the pattern matches zero or more characters. For example, the pattern `myindex-*` matches all +indices whose names start with `myindex-`, such as `myindex-1` and `myindex-2`. An index pattern can also simply be the name of a single index. To create an index pattern to connect to Elasticsearch: . Go to the *Settings > Indices* tab. -. Specify an index pattern that matches the name of one or more of your Elasticsearch indices. By default, Kibana +. Specify an index pattern that matches the name of one or more of your Elasticsearch indices. By default, Kibana guesses that you're you're working with log data being fed into Elasticsearch by Logstash. + -NOTE: When you switch between top-level tabs, Kibana remembers where you were. For example, if you view a particular -index pattern from the Settings tab, switch to the Discover tab, and then go back to the Settings tab, Kibana displays -the index pattern you last looked at. To get to the create pattern form, click the *Add* button in the Index Patterns +NOTE: When you switch between top-level tabs, Kibana remembers where you were. For example, if you view a particular +index pattern from the Settings tab, switch to the Discover tab, and then go back to the Settings tab, Kibana displays +the index pattern you last looked at. To get to the create pattern form, click the *Add* button in the Index Patterns list. -. If your index contains a timestamp field that you want to use to perform time-based comparisons, select the *Index -contains time-based events* option and select the index field that contains the timestamp. Kibana reads the index +. If your index contains a timestamp field that you want to use to perform time-based comparisons, select the *Index +contains time-based events* option and select the index field that contains the timestamp. Kibana reads the index mapping to list all of the fields that contain a timestamp. -. By default, Kibana restricts wildcard expansion of time-based index patterns to indices with data within the currently +. By default, Kibana restricts wildcard expansion of time-based index patterns to indices with data within the currently selected time range. Click *Do not expand index pattern when search* to disable this behavior. -. Click *Create* to add the index pattern. +. Click *Create* to add the index pattern. -. To designate the new pattern as the default pattern to load when you view the Discover tab, click the *favorite* -button. +. To designate the new pattern as the default pattern to load when you view the Discover tab, click the *favorite* +button. -NOTE: When you define an index pattern, indices that match that pattern must exist in Elasticsearch. Those indices must +NOTE: When you define an index pattern, indices that match that pattern must exist in Elasticsearch. Those indices must contain data. -To use an event time in an index name, enclose the static text in the pattern and specify the date format using the +To use an event time in an index name, enclose the static text in the pattern and specify the date format using the tokens described in the following table. -For example, `[logstash-]YYYY.MM.DD` matches all indices whose names have a timestamp of the form `YYYY.MM.DD` appended +For example, `[logstash-]YYYY.MM.DD` matches all indices whose names have a timestamp of the form `YYYY.MM.DD` appended to the prefix `logstash-`, such as `logstash-2015.01.31` and `logstash-2015-02-01`. [float] @@ -108,32 +108,32 @@ to the prefix `logstash-`, such as `logstash-2015.01.31` and `logstash-2015-02-0 [float] [[set-default-pattern]] === Setting the Default Index Pattern -The default index pattern is loaded by automatically when you view the *Discover* tab. Kibana displays a star to the -left of the name of the default pattern in the Index Patterns list on the *Settings > Indices* tab. The first pattern +The default index pattern is loaded by automatically when you view the *Discover* tab. Kibana displays a star to the +left of the name of the default pattern in the Index Patterns list on the *Settings > Indices* tab. The first pattern you create is automatically designated as the default pattern. To set a different pattern as the default index pattern: . Go to the *Settings > Indices* tab. . Select the pattern you want to set as the default in the Index Patterns list. -. Click the pattern's *Favorite* button. +. Click the pattern's *Favorite* button. -NOTE: You can also manually set the default index pattern in *Advanced > Settings*. +NOTE: You can also manually set the default index pattern in *Advanced > Settings*. [float] [[reload-fields]] === Reloading the Index Fields List -When you add an index mapping, Kibana automatically scans the indices that match the pattern to display a list of the -index fields. You can reload the index fields list to pick up any newly-added fields. +When you add an index mapping, Kibana automatically scans the indices that match the pattern to display a list of the +index fields. You can reload the index fields list to pick up any newly-added fields. -Reloading the index fields list also resets Kibana's popularity counters for the fields. The popularity counters keep -track of the fields you've used most often within Kibana and are used to sort fields within lists. +Reloading the index fields list also resets Kibana's popularity counters for the fields. The popularity counters keep +track of the fields you've used most often within Kibana and are used to sort fields within lists. To reload the index fields list: . Go to the *Settings > Indices* tab. . Select an index pattern from the Index Patterns list. -. Click the pattern's *Reload* button. +. Click the pattern's *Reload* button. [float] [[delete-pattern]] @@ -147,11 +147,11 @@ To delete an index pattern: [[managing-fields]] === Managing Fields -The fields for the index pattern are listed in a table. Click a column header to sort the table by that column. Click -the *Controls* button in the rightmost column for a given field to edit the field's properties. You can manually set +The fields for the index pattern are listed in a table. Click a column header to sort the table by that column. Click +the *Controls* button in the rightmost column for a given field to edit the field's properties. You can manually set the field's format from the *Format* drop-down. Format options vary based on the field's type. -You can also set the field's popularity value in the *Popularity* text entry box to any desired value. Click the +You can also set the field's popularity value in the *Popularity* text entry box to any desired value. Click the *Update Field* button to confirm your changes or *Cancel* to return to the list of fields. Kibana has https://www.elastic.co/blog/kibana-4-1-field-formatters[field formatters] for the following field types: @@ -193,23 +193,23 @@ include::duration-formatter.asciidoc[] include::color-formatter.asciidoc[] -The `Bytes`, `Number`, and `Percentage` formatters enable you to choose the display formats of numbers in this field using +The `Bytes`, `Number`, and `Percentage` formatters enable you to choose the display formats of numbers in this field using the https://adamwdraper.github.io/Numeral-js/[numeral.js] standard format definitions. [float] [[create-scripted-field]] === Creating a Scripted Field -Scripted fields compute data on the fly from the data in your Elasticsearch indices. Scripted field data is shown on +Scripted fields compute data on the fly from the data in your Elasticsearch indices. Scripted field data is shown on the Discover tab as part of the document data, and you can use scripted fields in your visualizations. Scripted field values are computed at query time so they aren't indexed and cannot be searched. NOTE: Kibana cannot query scripted fields. -WARNING: Computing data on the fly with scripted fields can be very resource intensive and can have a direct impact on -Kibana's performance. Keep in mind that there's no built-in validation of a scripted field. If your scripts are +WARNING: Computing data on the fly with scripted fields can be very resource intensive and can have a direct impact on +Kibana's performance. Keep in mind that there's no built-in validation of a scripted field. If your scripts are buggy, you'll get exceptions whenever you try to view the dynamically generated data. -Scripted fields use the Lucene expression syntax. For more information, +Scripted fields use the Lucene expression syntax. For more information, see http://www.elastic.co/guide/en/elasticsearch/reference/current/modules-scripting.html#_lucene_expressions_scripts[ Lucene Expressions Scripts]. @@ -224,15 +224,15 @@ To create a scripted field: . Go to *Settings > Indices* . Select the index pattern you want to add a scripted field to. . Go to the pattern's *Scripted Fields* tab. -. Click *Add Scripted Field*. +. Click *Add Scripted Field*. . Enter a name for the scripted field. . Enter the expression that you want to use to compute a value on the fly from your index data. . Click *Save Scripted Field*. -For more information about scripted fields in Elasticsearch, see +For more information about scripted fields in Elasticsearch, see http://www.elastic.co/guide/en/elasticsearch/reference/current/modules-scripting.html[Scripting]. -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]. [float] @@ -244,7 +244,7 @@ To modify a scripted field: . Click the *Edit* button for the scripted field you want to change. . Make your changes and then click *Save Scripted Field* to update the field. -WARNING: Keep in mind that there's no built-in validation of a scripted field. If your scripts are buggy, you'll get +WARNING: Keep in mind that there's no built-in validation of a scripted field. If your scripts are buggy, you'll get exceptions whenever you try to view the dynamically generated data. [float] @@ -258,15 +258,15 @@ To delete a scripted field: [[advanced-options]] === Setting Advanced Options -The *Advanced Settings* page enables you to directly edit settings that control the behavior of the Kibana application. -For example, you can change the format used to display dates, specify the default index pattern, and set the precision -for displayed decimal values. +The *Advanced Settings* page enables you to directly edit settings that control the behavior of the Kibana application. +For example, you can change the format used to display dates, specify the default index pattern, and set the precision +for displayed decimal values. To set advanced options: . Go to *Settings > Advanced*. . Click the *Edit* button for the option you want to modify. -. Enter a new value for the option. +. Enter a new value for the option. . Click the *Save* button. include::advanced-settings.asciidoc[] @@ -274,8 +274,8 @@ include::advanced-settings.asciidoc[] [[kibana-server-properties]] === Setting Kibana Server Properties -The Kibana server reads properties from the `kibana.yml` file on startup. The default settings configure Kibana to run -on `localhost:5601`. To change the host or port number, or connect to Elasticsearch running on a different machine, +The Kibana server reads properties from the `kibana.yml` file on startup. The default settings configure Kibana to run +on `localhost:5601`. To change the host or port number, or connect to Elasticsearch running on a different machine, you'll need to update your `kibana.yml` file. You can also enable SSL and set a variety of other options. include::kibana-yml.asciidoc[] @@ -288,7 +288,7 @@ deprecated[4.2, The names of several Kibana server properties changed in the 4.2 `server.port` added[4.2]:: The port that the Kibana server runs on. + *alias*: `port` deprecated[4.2] -+ ++ *default*: `5601` `server.host` added[4.2]:: The host to bind the Kibana server to. @@ -306,7 +306,7 @@ deprecated[4.2, The names of several Kibana server properties changed in the 4.2 `elasticsearch.preserveHost` added[4.2]:: By default, the host specified in the incoming request from the browser is specified as the host in the corresponding request Kibana sends to Elasticsearch. If you set this option to `false`, Kibana uses the host specified in `elasticsearch_url`. + *alias*: `elasticsearch_preserve_host` deprecated[4.2] -+ ++ *default*: `true` `elasticsearch.ssl.cert` added[4.2]:: This parameter specifies the path to the SSL certificate for Elasticsearch instances that require a client certificate. @@ -328,25 +328,25 @@ deprecated[4.2, The names of several Kibana server properties changed in the 4.2 `elasticsearch.pingTimeout` added[4.2]:: This parameter specifies the maximum wait time in milliseconds for ping responses by Elasticsearch. + *alias*: `ping_timeout` deprecated[4.2] -+ ++ *default*: `1500` `elasticsearch.startupTimeout` added[4.2]:: This parameter specifies the maximum wait time in milliseconds for Elasticsearch discovery at Kibana startup. Kibana repeats attempts to discover an Elasticsearch cluster after the specified time elapses. + *alias*: `startup_timeout` deprecated[4.2] -+ ++ *default*: `5000` `kibana.index` added[4.2]:: The name of the index where saved searched, visualizations, and dashboards will be stored.. + *alias*: `kibana_index` deprecated[4.2] -+ ++ *default*: `.kibana` `kibana.defaultAppId` added[4.2]:: The page that will be displayed when you launch Kibana: `discover`, `visualize`, `dashboard`, or `settings`. + *alias*: `default_app_id` deprecated[4.2] -+ ++ *default*: `"discover"` `logging.silent` added[4.2]:: Set this value to `true` to suppress all logging output. @@ -373,7 +373,7 @@ deprecated[4.2, The names of several Kibana server properties changed in the 4.2 `elasticsearch.requestTimeout` added[4.2]:: How long to wait for responses from the Kibana backend or Elasticsearch, in milliseconds. + *alias*: `request_timeout` deprecated[4.2] -+ ++ *default*: `500000` `elasticsearch.requestHeadersWhitelist:` added[5.0]:: List of Kibana client-side headers to send to Elasticsearch. To send *no* client-side headers, set this value to [] (an empty list). @@ -383,16 +383,16 @@ deprecated[4.2, The names of several Kibana server properties changed in the 4.2 `elasticsearch.shardTimeout` added[4.2]:: How long Elasticsearch should wait for responses from shards. Set to 0 to disable. + *alias*: `shard_timeout` deprecated[4.2] -+ ++ *default*: `0` `elasticsearch.ssl.verify` added[4.2]:: Indicates whether or not to validate the Elasticsearch SSL certificate. Set to false to disable SSL verification. + *alias*: `verify_ssl` deprecated[4.2] -+ ++ *default*: `true` -`elasticsearch.ssl.ca`:: An array of paths to the CA certificates for your Elasticsearch instance. Specify if +`elasticsearch.ssl.ca`:: An array of paths to the CA certificates for your Elasticsearch instance. Specify if you are using a self-signed certificate so the certificate can be verified. Disable `elasticsearch.ssl.verify` otherwise. + *alias*: `ca` deprecated[4.2] @@ -417,36 +417,36 @@ you are using a self-signed certificate so the certificate can be verified. Disa //// [[managing-saved-objects]] -=== Managing Saved Searches, Visualizations, and Dashboards +=== Managing Saved Searches, Visualizations, and Dashboards -You can view, edit, and delete saved searches, visualizations, and dashboards from *Settings > Objects*. You can also +You can view, edit, and delete saved searches, visualizations, and dashboards from *Settings > Objects*. You can also export or import sets of searches, visualizations, and dashboards. -Viewing a saved object displays the selected item in the *Discover*, *Visualize*, or *Dashboard* page. To view a saved +Viewing a saved object displays the selected item in the *Discover*, *Visualize*, or *Dashboard* page. To view a saved object: . Go to *Settings > Objects*. -. Select the object you want to view. +. Select the object you want to view. . Click the *View* button. -Editing a saved object enables you to directly modify the object definition. You can change the name of the object, add -a description, and modify the JSON that defines the object's properties. +Editing a saved object enables you to directly modify the object definition. You can change the name of the object, add +a description, and modify the JSON that defines the object's properties. If you attempt to access an object whose index has been deleted, Kibana displays its Edit Object page. You can: -* Recreate the index so you can continue using the object. +* Recreate the index so you can continue using the object. * Delete the object and recreate it using a different index. -* Change the index name referenced in the object's `kibanaSavedObjectMeta.searchSourceJSON` to point to an existing -index pattern. This is useful if the index you were working with has been renamed. +* Change the index name referenced in the object's `kibanaSavedObjectMeta.searchSourceJSON` to point to an existing +index pattern. This is useful if the index you were working with has been renamed. -WARNING: No validation is performed for object properties. Submitting invalid changes will render the object unusable. -Generally, you should use the *Discover*, *Visualize*, or *Dashboard* pages to create new objects instead of directly -editing existing ones. +WARNING: No validation is performed for object properties. Submitting invalid changes will render the object unusable. +Generally, you should use the *Discover*, *Visualize*, or *Dashboard* pages to create new objects instead of directly +editing existing ones. To edit a saved object: . Go to *Settings > Objects*. -. Select the object you want to edit. +. Select the object you want to edit. . Click the *Edit* button. . Make your changes to the object definition. . Click the *Save Object* button. @@ -454,18 +454,18 @@ To edit a saved object: To delete a saved object: . Go to *Settings > Objects*. -. Select the object you want to delete. +. Select the object you want to delete. . Click the *Delete* button. . Confirm that you really want to delete the object. To export a set of objects: . Go to *Settings > Objects*. -. Select the type of object you want to export. You can export a set of dashboards, searches, or visualizations. +. Select the type of object you want to export. You can export a set of dashboards, searches, or visualizations. . Click the selection box for the objects you want to export, or click the *Select All* box. . Click *Export* to select a location to write the exported JSON. -WARNING: Exported dashboards do not include their associated index patterns. Re-create the index patterns manually before +WARNING: Exported dashboards do not include their associated index patterns. Re-create the index patterns manually before importing saved dashboards to a Kibana instance running on another Elasticsearch cluster. To import a set of objects: diff --git a/docs/setup.asciidoc b/docs/setup.asciidoc index 74b87345bfb21..e84ece6ddd4ca 100644 --- a/docs/setup.asciidoc +++ b/docs/setup.asciidoc @@ -24,10 +24,8 @@ To get Kibana up and running: On Unix, you can instead run the package manager suited for your distribution. -//// [float] include::kibana-repositories.asciidoc[] -//// That's it! Kibana is now running on port 5601. diff --git a/docs/tilemap.asciidoc b/docs/tilemap.asciidoc index 8bcf21cdf5c53..c052ff66b5e29 100644 --- a/docs/tilemap.asciidoc +++ b/docs/tilemap.asciidoc @@ -3,72 +3,72 @@ A tile map displays a geographic area overlaid with circles keyed to the data determined by the buckets you specify. -The default _metrics_ aggregation for a tile map is the *Count* aggregation. You can select any of the following +The default _metrics_ aggregation for a tile map is the *Count* aggregation. You can select any of the following aggregations as the metrics aggregation: -*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. Enter a string in the *Custom Label* field to change the display label. The _buckets_ aggregations determine what information is being retrieved from your data set. -Before you choose a buckets aggregation, specify if you are splitting the chart or displaying the buckets as *Geo +Before you choose a buckets aggregation, specify if you are splitting the chart or displaying the buckets as *Geo Coordinates* on a single chart. A multiple chart split must run before any other aggregations. Tile maps use the *Geohash* aggregation as their initial aggregation. Select a field, typically coordinates, from the -drop-down. The *Precision* slider determines the granularity of the results displayed on the map. See the documentation -for the {ref}/search-aggregations-bucket-geohashgrid-aggregation.html#_cell_dimensions_at_the_equator[geohash grid] +drop-down. The *Precision* slider determines the granularity of the results displayed on the map. See the documentation +for the {ref}/search-aggregations-bucket-geohashgrid-aggregation.html#_cell_dimensions_at_the_equator[geohash grid] aggregation for details on the area specified by each precision level. Kibana supports a maximum geohash length of 7. -NOTE: Higher precisions increase memory usage for the browser displaying Kibana as well as for the underlying +NOTE: Higher precisions increase memory usage for the browser displaying Kibana as well as for the underlying Elasticsearch cluster. -Once you've specified a buckets aggregation, you can define sub-aggregations to refine the visualization. Tile maps -only support sub-aggregations as split charts. Click *+ Add Sub Aggregation*, then *Split Chart* to select a +Once you've specified a buckets aggregation, you can define sub-aggregations to refine the visualization. Tile maps +only support sub-aggregations as split charts. Click *+ Add Sub Aggregation*, then *Split Chart* to select a sub-aggregation from the list of types: -*Date Histogram*:: A {ref}search-aggregations-bucket-datehistogram-aggregation.html[_date histogram_] is built from a -numeric field and organized by date. You can specify a time frame for the intervals in seconds, minutes, hours, days, -weeks, months, or years. You can also specify a custom interval frame by selecting *Custom* as the interval and -specifying a number and a time unit in the text field. Custom interval time units are *s* for seconds, *m* for minutes, -*h* for hours, *d* for days, *w* for weeks, and *y* for years. Different units support different levels of precision, +*Date Histogram*:: A {ref}search-aggregations-bucket-datehistogram-aggregation.html[_date histogram_] is built from a +numeric field and organized by date. You can specify a time frame for the intervals in seconds, minutes, hours, days, +weeks, months, or years. You can also specify a custom interval frame by selecting *Custom* as the interval and +specifying a number and a time unit in the text field. Custom interval time units are *s* for seconds, *m* for minutes, +*h* for hours, *d* for days, *w* for weeks, and *y* for years. Different units support different levels of precision, down to one second. -*Histogram*:: A standard {ref}search-aggregations-bucket-histogram-aggregation.html[_histogram_] is built from a -numeric field. Specify an integer interval for this field. Select the *Show empty buckets* checkbox to include empty +*Histogram*:: A standard {ref}search-aggregations-bucket-histogram-aggregation.html[_histogram_] is built from a +numeric field. Specify an integer interval for this field. Select the *Show empty buckets* checkbox to include empty intervals in the histogram. -*Range*:: With a {ref}search-aggregations-bucket-range-aggregation.html[_range_] aggregation, you can specify ranges -of values for a numeric field. Click *Add Range* to add a set of range endpoints. Click the red *(x)* symbol to remove +*Range*:: With a {ref}search-aggregations-bucket-range-aggregation.html[_range_] aggregation, you can specify ranges +of values for a numeric field. Click *Add Range* to add a set of range endpoints. Click the red *(x)* symbol to remove a range. -After changing options, click the *Apply changes* button to update your visualization, or the grey *Discard +After changing options, click the *Apply changes* button to update your visualization, or the grey *Discard changes* button to keep your visualization in its current state. -*Date Range*:: A {ref}search-aggregations-bucket-daterange-aggregation.html[_date range_] aggregation reports values -that are within a range of dates that you specify. You can specify the ranges for the dates using -{ref}common-options.html#date-math[_date math_] expressions. Click *Add Range* to add a set of range endpoints. +*Date Range*:: A {ref}search-aggregations-bucket-daterange-aggregation.html[_date range_] aggregation reports values +that are within a range of dates that you specify. You can specify the ranges for the dates using +{ref}common-options.html#date-math[_date math_] expressions. Click *Add Range* to add a set of range endpoints. Click the red *(/)* symbol to remove a range. *IPv4 Range*:: The {ref}search-aggregations-bucket-iprange-aggregation.html[_IPv4 range_] aggregation enables you to -specify ranges of IPv4 addresses. Click *Add Range* to add a set of range endpoints. Click the red *(/)* symbol to +specify ranges of IPv4 addresses. Click *Add Range* to add a set of range endpoints. Click the red *(/)* symbol to remove a range. -*Terms*:: A {ref}search-aggregations-bucket-terms-aggregation.html[_terms_] aggregation enables you to specify the top +*Terms*:: A {ref}search-aggregations-bucket-terms-aggregation.html[_terms_] aggregation enables you to specify the top or bottom _n_ elements of a given field to display, ordered by count or a custom metric. -*Filters*:: You can specify a set of {ref}search-aggregations-bucket-filters-aggregation.html[_filters_] for the data. -You can specify a filter as a query string or in JSON format, just as in the Discover search bar. Click *Add Filter* to -add another filter. Click the image:images/labelbutton.png[] *label* button to open the label field, where you can type +*Filters*:: You can specify a set of {ref}search-aggregations-bucket-filters-aggregation.html[_filters_] for the data. +You can specify a filter as a query string or in JSON format, just as in the Discover search bar. Click *Add Filter* to +add another filter. Click the image:images/labelbutton.png[] *label* button to open the label field, where you can type in a name to display on the visualization. -*Significant Terms*:: Displays the results of the experimental -{ref}search-aggregations-bucket-significantterms-aggregation.html[_significant terms_] aggregation. The value of the +*Significant Terms*:: Displays the results of the experimental +{ref}search-aggregations-bucket-significantterms-aggregation.html[_significant terms_] aggregation. The value of the *Size* parameter defines the number of entries this aggregation returns. -*Geohash*:: The {ref}search-aggregations-bucket-geohashgrid-aggregation.html[_geohash_] aggregation displays points +*Geohash*:: The {ref}search-aggregations-bucket-geohashgrid-aggregation.html[_geohash_] aggregation displays points based on the geohash coordinates. NOTE: By default, the *Change precision on map zoom* box is checked. Uncheck the box to disable this behavior. @@ -79,13 +79,13 @@ 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. @@ -95,14 +95,14 @@ Select the *Options* tab to change the following aspects of the chart: *Map type*:: Select one of the following options from the drop-down. *_Scaled Circle Markers_*:: Scale the size of the markers based on the metric aggregation's value. *_Shaded Circle Markers_*:: Displays the markers with different shades based on the metric aggregation's value. -*_Shaded Geohash Grid_*:: Displays the rectangular cells of the geohash grid instead of circular markers, with different +*_Shaded Geohash Grid_*:: Displays the rectangular cells of the geohash grid instead of circular markers, with different shades based on the metric aggregation's value. -*_Heatmap_*:: A heat map applies blurring to the circle markers and applies shading based on the amount of overlap. +*_Heatmap_*:: A heat map applies blurring to the circle markers and applies shading based on the amount of overlap. Heatmaps have the following options: * *Radius*: Sets the size of the individual heatmap dots. * *Blur*: Sets the amount of blurring for the heatmap dots. -* *Maximum zoom*: Tilemaps in Kibana support 18 zoom levels. This slider defines the maximum zoom level at which the +* *Maximum zoom*: Tilemaps in Kibana support 18 zoom levels. This slider defines the maximum zoom level at which the heatmap dots appear at full intensity. * *Minimum opacity*: Sets the opacity cutoff for the dots. * *Show Tooltip*: Check this box to have a tooltip with the values for a given dot when the cursor is on that dot. @@ -116,12 +116,12 @@ Map Service (WMS) standard. Specify the following elements: layers. * *WMS version*: The WMS version used by this map service. * *WMS format*: The image format used by this map service. The two most common formats are `image/png` and `image/jpeg`. -* *WMS attribution*: An optional, user-defined string that identifies the map source. Maps display the attribution string +* *WMS attribution*: An optional, user-defined string that identifies the map source. Maps display the attribution string in the lower right corner. -* *WMS styles*: A comma-separated list of the styles to use in this visualization. Each map server provides its own styling +* *WMS styles*: A comma-separated list of the styles to use in this visualization. Each map server provides its own styling options. -After changing options, click the *Apply changes* button to update your visualization, or the grey *Discard +After changing options, click the *Apply changes* button to update your visualization, or the grey *Discard changes* button to keep your visualization in its current state. [float] @@ -129,12 +129,12 @@ changes* button to keep your visualization in its current state. ==== Navigating the Map Once your tilemap visualization is ready, you can explore the map in several ways: -* Click and hold anywhere on the map and move the cursor to move the map center. Hold Shift and drag a bounding box -across the map to zoom in on the selection. +* Click and hold anywhere on the map and move the cursor to move the map center. Hold Shift and drag a bounding box +across the map to zoom in on the selection. * Click the *Zoom In/Out* image:images/viz-zoom.png[] buttons to change the zoom level manually. -* Click the *Fit Data Bounds* image:images/viz-fit-bounds.png[] button to automatically crop the map boundaries to the +* Click the *Fit Data Bounds* image:images/viz-fit-bounds.png[] button to automatically crop the map boundaries to the geohash buckets that have at least one result. -* Click the *Latitude/Longitude Filter* image:images/viz-lat-long-filter.png[] button, then drag a bounding box across the +* Click the *Latitude/Longitude Filter* image:images/viz-lat-long-filter.png[] button, then drag a bounding box across the map, to create a filter for the box coordinates. [float] diff --git a/docs/vertbar.asciidoc b/docs/vertbar.asciidoc index e98362e964723..8b9938de4a5fd 100644 --- a/docs/vertbar.asciidoc +++ b/docs/vertbar.asciidoc @@ -3,24 +3,24 @@ 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. @@ -31,7 +31,7 @@ Enter a string in the *Custom Label* field to change the display label. The _buckets_ aggregations determine what information is being retrieved from your data set. Before you choose a buckets aggregation, specify if you are splitting slices within a single chart or splitting into -multiple charts. A multiple chart split must run before any other aggregations. When you split a chart, you can change +multiple charts. A multiple chart split must run before any other aggregations. When you split a chart, you can change if the splits are displayed in a row or a column by clicking the *Rows | Columns* selector. include::x-axis-aggs.asciidoc[] @@ -44,20 +44,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* to change the following aspects of the table: -*Bar Mode*:: When you have multiple Y-axis aggregations defined for your chart, you can use this drop-down to affect +*Bar 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. @@ -67,8 +67,7 @@ _grouped_:: Groups the results horizontally by the lowest-priority sub-aggregati Checkboxes are available to enable and disable the following behaviors: *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. -*Scale Y-Axis to Data Bounds*:: The default Y axis bounds are zero and the maximum value returned in the data. Check +*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. [float]