diff --git a/docs/advanced-settings.asciidoc b/docs/advanced-settings.asciidoc index eb599be309ad0..2d72ac308f004 100644 --- a/docs/advanced-settings.asciidoc +++ b/docs/advanced-settings.asciidoc @@ -15,6 +15,7 @@ adapt to the interval between measurements. Keys are http://en.wikipedia.org/wik `defaultIndex`:: Default is `null`. This property specifies the default index. `metaFields`:: An array of fields outside of `_source`. Kibana merges these fields into the document when displaying the document. +`defaultColumns`:: Default is `_source`. Defines the columns that appear by default on the Discover page. `discover:sampleSize`:: The number of rows to show in the Discover table. `doc_table:highlight`:: Highlight results in Discover and Saved Searches Dashboard. Highlighing makes request slow when working on big documents. Set this property to `false` to disable highlighting. diff --git a/docs/apps.asciidoc b/docs/apps.asciidoc index a17d113147074..747619d14d4e3 100644 --- a/docs/apps.asciidoc +++ b/docs/apps.asciidoc @@ -1,5 +1,5 @@ [[kibana-apps]] -== Kibana Apps added[4.2] +== Kibana Apps The Kibana UI serves as a framework that can contain several different applications. You can switch between these applications by clicking the image:images/app-button.png[App Picker] *App picker* button to display the app bar: diff --git a/docs/area.asciidoc b/docs/area.asciidoc index 5b6419ca76a51..9672af984d744 100644 --- a/docs/area.asciidoc +++ b/docs/area.asciidoc @@ -24,7 +24,7 @@ aggregation returns the percentile rankings for the values in the 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 Aggregation* button. +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 diff --git a/docs/autorefresh.asciidoc b/docs/autorefresh.asciidoc index a97e49346f60c..927aff68f0d7b 100644 --- a/docs/autorefresh.asciidoc +++ b/docs/autorefresh.asciidoc @@ -6,12 +6,12 @@ When a refresh interval is set, it is displayed to the left of the Time Filter i To set the refresh interval: -. Click the *Time Filter* image:images/TimeFilter.jpg[Time Filter] in the upper right corner of the menu bar. +. Click the *Time Filter* image:images/TimeFilter.jpg[Time Filter]. . Click the *Refresh Interval* tab. . Choose a refresh interval from the list. -To automatically refresh the data, click the image:images/autorefresh.png[] *Auto-refresh* button and select an -autorefresh interval: +To automatically refresh the data, click the image:images/autorefresh.png[] *Auto-refresh* button when the time picker +is open and select an autorefresh interval: image::images/autorefresh-intervals.png[] diff --git a/docs/color-formatter.asciidoc b/docs/color-formatter.asciidoc index b03a0d59d07f9..601a4b3d38ff7 100644 --- a/docs/color-formatter.asciidoc +++ b/docs/color-formatter.asciidoc @@ -2,6 +2,10 @@ The `Color` field formatter enables you to specify colors with specific ranges o When you select the `Color` field formatter, Kibana displays the *Range*, *Font Color*, *Background Color*, and *Example* fields. -Click the *Add Color* button to add a range of values to associate with a particular color. You can click in the *Font Color* and *Background Color* fields to display a color picker. You can also enter a specific hex code value in the field. The effect of your current color choices are displayed in the *Example* field. +Click the *Add Color* button to add a range of values to associate with a particular color. You can click in the *Font Color* and +*Background Color* fields to display a color picker. You can also enter a specific hex code value in the field. The effect of your current +color choices are displayed in the *Example* field. -image::images/colorformatter.png[] \ No newline at end of file +image::images/colorformatter.png[] + +//update image diff --git a/docs/dashboard.asciidoc b/docs/dashboard.asciidoc index 1a53742bdf9d7..31d957de8887b 100644 --- a/docs/dashboard.asciidoc +++ b/docs/dashboard.asciidoc @@ -5,7 +5,7 @@ A Kibana _dashboard_ displays a set of saved visualizations in groups that you c dashboard to share or reload at a later time. .Sample dashboard -image:images/NYCTA-Dashboard.jpg[Example dashboard] +image:images/tutorial-dashboard.png[Example dashboard] [float] [[dashboard-getting-started]] @@ -22,9 +22,7 @@ The first time you click the *Dashboard* tab, Kibana displays an empty dashboard image:images/NewDashboard.png[New Dashboard screen] Build your dashboard by adding visualizations. By default, Kibana dashboards use a light color theme. To use a dark color -theme instead, click the *Settings* image:images/SettingsButton.jpg[Gear] button and check the *Use dark theme* box. - -image:images/darktheme.png[Dark Theme Example] +theme instead, click the *Options* button and check the *Use dark theme* box. NOTE: You can change the default theme in the *Advanced* section of the *Settings* tab. @@ -36,9 +34,9 @@ include::autorefresh.asciidoc[] [[adding-visualizations-to-a-dashboard]] ==== Adding Visualizations to a Dashboard -To add a visualization to the dashboard, click the *Add Visualization* image:images/AddVis.png[Plus] button in the -toolbar panel. Select a saved visualization from the list. You can filter the list of visualizations by typing a filter -string into the *Visualization Filter* field. +To add a visualization to the dashboard, click the *Add* button in the toolbar panel. Select a saved visualization +from the list. You can filter the list of visualizations by typing a filter string into the *Visualization Filter* +field. The visualization you select appears in a _container_ on your dashboard. @@ -60,7 +58,7 @@ when you save a dashboard. To disable this behavior, clear the *Store time with Click the *Load Saved Dashboard* button to display a list of existing dashboards. The saved dashboard selector includes a text field to filter by dashboard name and a link to the Object Editor for managing your saved dashboards. You can -also access the Object Editor by clicking *Settings > Edit Saved Objects*. +also access the Object Editor by clicking *Settings > Objects*. [float] [[sharing-dashboards]] @@ -73,8 +71,6 @@ NOTE: A user must have Kibana access in order to view embedded dashboards. To share a dashboard, click the *Share* button image:images/share-dashboard.png[] to display the _Sharing_ panel. -image:images/sharing-panel.png[] - Click the *Copy to Clipboard* button image:images/share-link.png[] to copy the native URL or embed HTML to the clipboard. Click the *Generate short URL* button image:images/share-short-link.png[] to create a shortened URL for sharing or embedding. diff --git a/docs/datatable.asciidoc b/docs/datatable.asciidoc index 6246b19f0f1d6..40da9f83e37f4 100644 --- a/docs/datatable.asciidoc +++ b/docs/datatable.asciidoc @@ -39,9 +39,9 @@ in a name to display on the visualization. *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-aggregations to refine the visualization. Click -*+ Add Sub Aggregation* to define a sub-aggregation, then choose *Split Rows* or *Split Table*, then select a -sub-aggregation from the list of types. +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. diff --git a/docs/discover.asciidoc b/docs/discover.asciidoc index 38db80d39d332..75f6e58ec5158 100644 --- a/docs/discover.asciidoc +++ b/docs/discover.asciidoc @@ -6,7 +6,7 @@ You can also see the number of documents that match the search query and get fie configured for the selected index pattern, the distribution of documents over time is displayed in a histogram at the top of the page. -image:images/Discover-Start-Annotated.jpg[Discover Page] +image::images/Discover-Start-Annotated.jpg[Discover Page] [float] [[set-time-filter]] @@ -43,15 +43,16 @@ sets an interval based on the time range. [[search]] === Searching Your Data You can search the indices that match the current index pattern by submitting a search from the Discover page. -You can enter simple query strings, use the Lucene https://lucene.apache.org/core/2_9_4/queryparsersyntax.html[query -syntax], or use the full JSON-based {ref}/query-dsl.html[Elasticsearch Query DSL]. +You can enter simple query strings, use the +Lucene https://lucene.apache.org/core/2_9_4/queryparsersyntax.html[query syntax], or use the full JSON-based +{ref}/query-dsl.html[Elasticsearch Query DSL]. When you submit a search, the histogram, Documents table, and Fields list are updated to reflect the search results. The total number of hits (matching documents) is shown in the upper right corner of the histogram. The Documents table shows the first five hundred hits. By default, the hits are listed in reverse chronological order, with the newest documents shown first. You can reverse the sort order by by clicking on the Time -column header. You can also sort the table using the values in any indexed field. For more information, see <>. +column header. You can also sort the table using the values in any indexed field. For more information, see +<>. To search your data: @@ -79,9 +80,7 @@ Reference. [float] [[new-search]] ==== Starting a New Search -To clear the current search and start a new search, click the *New Search* button in the Discover toolbar. - -image:images/Discover-New-Search.jpg[New Search] +To clear the current search and start a new search, click the *New* button in the Discover toolbar. [float] [[save-search]] @@ -91,19 +90,18 @@ Saving a search saves both the search query string and the currently selected in To save the current search: -. Click the *Save Search* button image:images/SaveButton.jpg[Save Search button] in the Discover toolbar. +. Click the *Save* button in the Discover toolbar. . Enter a name for the search and click *Save*. [float] [[load-search]] -==== Loading a Saved Search +==== Opening a Saved Search To load a saved search: -. Click the *Load Search* button image:images/LoadButton.jpg[Load Search -button] in the Discover toolbar. -. Select the search you want to load. +. Click the *Open* button in the Discover toolbar. +. Select the search you want to open. -If the saved search is associated with a different index pattern than is currently selected, loading the saved search +If the saved search is associated with a different index pattern than is currently selected, opening the saved search also changes the selected index pattern. [float] @@ -184,13 +182,11 @@ image:images/add-column-button.png[Add Column] *Toggle column in table* button. [float] [[sorting]] ==== Sorting the Document List -You can sort the documents in the Documents table by the values in any indexed field. If a time field is configured for -the selected index pattern, by default the documents are sorted in reverse chronological order. - -To change the sort order: +You can sort the documents in the Documents table by the values in any indexed field. Documents in index patterns that +are configured with time fields are sorted in reverse chronological order by default. -* Click the name of the field you want to sort by. The fields you can use for sorting have a sort button to the right -of the field name. Clicking the field name a second time reverses the sort order. +To change the sort order, click the name of the field you want to sort by. The fields you can use for sorting have a +sort button to the right of the field name. Clicking the field name a second time reverses the sort order. [float] [[adding-columns]] @@ -228,10 +224,8 @@ button image:images/RemoveFieldButton.jpg[Remove Field Button]. From the field list, you can see how many documents in the Documents table contain a particular field, what the top 5 values are, and what percentage of documents contain each value. -To view field data statistics: - -* Click the name of a field in the Fields list. The field can be anywhere in the Fields list--Selected Fields, Popular -Fields, or the list of other fields. +To view field data statistics, click the name of a field in the Fields list. The field can be anywhere in the Fields +list. image:images/Discover-FieldStats.jpg[Field Statistics] diff --git a/docs/duration-formatter.asciidoc b/docs/duration-formatter.asciidoc new file mode 100644 index 0000000000000..36a73f61f6227 --- /dev/null +++ b/docs/duration-formatter.asciidoc @@ -0,0 +1,15 @@ +The `Duration` field formatter can display the numeric value of a field in the following increments: + +* Picoseconds +* Nanoseconds +* Microseconds +* Milliseconds +* Seconds +* Minutes +* Hours +* Days +* Weeks +* Months +* Years + +You can specify these increments with up to 20 decimal places for both input and output formats. diff --git a/docs/filter-pinning.asciidoc b/docs/filter-pinning.asciidoc index 090b009f63e3a..ac1176a245a6b 100644 --- a/docs/filter-pinning.asciidoc +++ b/docs/filter-pinning.asciidoc @@ -1,6 +1,6 @@ === Working with Filters -When you create a filter anywhere in Kibana, the filter conditions display in a green oval under the search text +When you create a filter anywhere in Kibana, the filter conditions display in an oval under the search text entry box: image::images/filter-sample.png[] @@ -10,7 +10,7 @@ Hovering on the filter oval displays the following icons: image::images/filter-allbuttons.png[] Enable Filter image:images/filter-enable.png[]:: Click this icon to disable the filter without removing it. You can -enable the filter again later by clicking the icon again. Disabled filters display a striped shaded color, green for +enable the filter again later by clicking the icon again. Disabled filters display a striped shaded color, grey for inclusion filters and red for exclusion filters. Pin Filter image:images/filter-pin.png[]:: Click this icon to _pin_ a filter. Pinned filters persist across Kibana tabs. You can pin filters from the _Visualize_ tab, click on the _Discover_ or _Dashboard_ tabs, and those filters remain in @@ -18,7 +18,7 @@ place. NOTE: If you have a pinned filter and you're not seeing any query results, that your current tab's index pattern is one that the filter applies to. Toggle Filter image:images/filter-toggle.png[]:: Click this icon to _toggle_ a filter. By default, filters are inclusion -filters, and display in green. Only elements that match the filter are displayed. To change this to an exclusion +filters, and display in grey. Only elements that match the filter are displayed. To change this to an exclusion filters, displaying only elements that _don't_ match, toggle the filter. Exclusion filters display in red. Remove Filter image:images/filter-delete.png[]:: Click this icon to remove a filter entirely. Custom Filter image:images/filter-custom.png[]:: Click this icon to display a text field where you can customize the JSON diff --git a/docs/getting-started.asciidoc b/docs/getting-started.asciidoc index fb058fd4699a5..d2936650d4137 100644 --- a/docs/getting-started.asciidoc +++ b/docs/getting-started.asciidoc @@ -14,10 +14,10 @@ The material in this section assumes you have a working Kibana install connected Video tutorials are also available: -* https://www.elastic.co/blog/kibana-4-video-tutorials-part-1[High-level Kibana 4 introduction, pie charts] +* https://www.elastic.co/blog/kibana-4-video-tutorials-part-1[High-level Kibana introduction, pie charts] * https://www.elastic.co/blog/kibana-4-video-tutorials-part-2[Data discovery, bar charts, and line charts] * https://www.elastic.co/blog/kibana-4-video-tutorials-part-3[Tile maps] -* https://www.elastic.co/blog/kibana-4-video-tutorials-part-4[Embedding Kibana 4 visualizations] +* https://www.elastic.co/blog/kibana-4-video-tutorials-part-4[Embedding Kibana visualizations] [float] [[tutorial-load-dataset]] @@ -76,9 +76,9 @@ The schema for the logs data set has dozens of different fields, but the notable "@timestamp": "date" } -Before we load the Shakespeare data set, we need to set up a {ref}/mapping.html[_mapping_] for the fields. Mapping -divides the documents in the index into logical groups and specifies a field's characteristics, such as the field's -searchability or whether or not it's _tokenized_, or broken up into separate words. +Before we load the Shakespeare and logs data sets, we need to set up {ref}mapping.html[_mappings_] for the fields. +Mapping divides the documents in the index into logical groups and specifies a field's characteristics, such as the +field's searchability or whether or not it's _tokenized_, or broken up into separate words. Use the following command to set up a mapping for the Shakespeare data set: @@ -196,10 +196,10 @@ yellow open logstash-2015.05.20 5 1 4750 0 16.4mb === Defining Your Index Patterns Each set of data loaded to Elasticsearch has an <>. In the previous section, the -Shakespeare data set has an index named `shakespeare`, and the accounts -data set has an index named `bank`. An _index pattern_ is a string with optional wildcards that can match multiple -indices. For example, in the common logging use case, a typical index name contains the date in MM-DD-YYYY -format, and an index pattern for May would look something like `logstash-2015.05*`. +Shakespeare data set has an index named `shakespeare`, and the accounts data set has an index named `bank`. An _index +pattern_ is a string with optional wildcards that can match multiple indices. For example, in the common logging use +case, a typical index name contains the date in MM-DD-YYYY format, and an index pattern for May would look something +like `logstash-2015.05*`. For this tutorial, any pattern that matches the name of an index we've loaded will work. Open a browser and navigate to `localhost:5601`. Click the *Settings* tab, then the *Indices* tab. Click *Add New* to define a new index @@ -219,7 +219,7 @@ contain data. [[tutorial-discovering]] === Discovering Your Data -Click the *Discover* tab to display Kibana's data discovery functions: +Click the *Discover* image:images/discover-compass.png[Compass icon] tab to display Kibana's data discovery functions: image::images/tutorial-discover.png[] @@ -257,7 +257,7 @@ image::images/tutorial-discover-3.png[] The visualization tools available on the *Visualize* tab enable you to display aspects of your data sets in several different ways. -Click on the *Visualize* tab to start: +Click on the *Visualize* image:images/visualize-icon.png[Bar chart icon] tab to start: image::images/tutorial-visualize.png[] @@ -284,7 +284,7 @@ total number of ranges to six. Enter the following ranges: 15000 30999 31000 50000 -Click the green *Apply changes* button image:images/apply-changes-button.png[] to display the chart: +Click the *Apply changes* button image:images/apply-changes-button.png[] to display the chart: image::images/tutorial-visualize-pie-2.png[] @@ -294,7 +294,7 @@ holder's age. Click *Add sub-buckets* at the bottom, then select *Split Slices*. Choose the *Terms* aggregation and the *age* field from the drop-downs. -Click the green *Apply changes* button image:images/apply-changes-button.png[] to add an external ring with the new +Click the *Apply changes* button image:images/apply-changes-button.png[] to add an external ring with the new results. image::images/tutorial-visualize-pie-3.png[] @@ -310,10 +310,10 @@ image::images/tutorial-visualize-bar-1.png[] For the Y-axis metrics aggregation, select *Unique Count*, with *speaker* as the field. For Shakespeare plays, it might be useful to know which plays have the lowest number of distinct speaking parts, if your theater company is short on actors. For the X-Axis buckets, select the *Terms* aggregation with the *play_name* field. For the *Order*, select -*Ascending*, leaving the *Size* at 5. +*Ascending*, leaving the *Size* at 5. Write a description for the axes in the *Custom Label* fields. -Leave the other elements at their default values and click the green *Apply changes* button image:images/apply-changes-button.png[]. Your chart should now look -like this: +Leave the other elements at their default values and click the *Apply changes* button +image:images/apply-changes-button.png[]. Your chart should now look like this: image::images/tutorial-visualize-bar-2.png[] @@ -327,15 +327,18 @@ as well as change many other options for your visualizations, by clicking the *O Now that you have a list of the smallest casts for Shakespeare plays, you might also be curious to see which of these plays makes the greatest demands on an individual actor by showing the maximum number of speeches for a given part. Add a Y-axis aggregation with the *Add metrics* button, then choose the *Max* aggregation for the *speech_number* field. In -the *Options* tab, change the *Bar Mode* drop-down to *grouped*, then click the green *Apply changes* button -image:images/apply-changes-button.png[]. Your -chart should now look like this: +the *Options* tab, change the *Bar Mode* drop-down to *grouped*, then click the *Apply changes* button +image:images/apply-changes-button.png[]. Your chart should now look like this: image::images/tutorial-visualize-bar-3.png[] As you can see, _Love's Labours Lost_ has an unusually high maximum speech number, compared to the other plays, and might therefore make more demands on an actor's memory. +Note how the *Number of speaking parts* Y-axis starts at zero, but the bars don't begin to differentiate until 18. To +make the differences stand out, starting the Y-axis at a value closer to the minimum, check the +*Scale Y-Axis to data bounds* box in the *Options* tab. + Save this chart with the name _Bar Example_. Next, we're going to make a tile map chart to visualize some geographic data. Click on *New Visualization*, then @@ -350,8 +353,8 @@ at the bottom. You'll see a map of the world, since we haven't defined any bucke image::images/tutorial-visualize-map-1.png[] -Select *Geo Coordinates* as the bucket, then click the green *Apply changes* button image:images/apply-changes-button.png[]. Your chart should now look like -this: +Select *Geo Coordinates* as the bucket, then click the *Apply changes* button image:images/apply-changes-button.png[]. +Your chart should now look like this: image::images/tutorial-visualize-map-2.png[] @@ -378,7 +381,7 @@ Write the following text in the field: The Markdown widget uses **markdown** syntax. > Blockquotes in Markdown use the > character. -Click the green *Apply changes* button image:images/apply-changes-button.png[] to display the rendered Markdown in the +Click the *Apply changes* button image:images/apply-changes-button.png[] to display the rendered Markdown in the preview pane: image::images/tutorial-visualize-md-2.png[] diff --git a/docs/images/Discover-Start-Annotated.jpg b/docs/images/Discover-Start-Annotated.jpg index bb3bd9ecfd592..eacdfbaee4c0e 100644 Binary files a/docs/images/Discover-Start-Annotated.jpg and b/docs/images/Discover-Start-Annotated.jpg differ diff --git a/docs/images/NewDashboard.png b/docs/images/NewDashboard.png index bace573f40924..89e816c0458ae 100644 Binary files a/docs/images/NewDashboard.png and b/docs/images/NewDashboard.png differ diff --git a/docs/images/Start-Page.png b/docs/images/Start-Page.png index 756b6b5bdbd2d..6d0544a66303b 100644 Binary files a/docs/images/Start-Page.png and b/docs/images/Start-Page.png differ diff --git a/docs/images/TimeFilter.jpg b/docs/images/TimeFilter.jpg index 1de61b791e5bb..1c8700bc05616 100644 Binary files a/docs/images/TimeFilter.jpg and b/docs/images/TimeFilter.jpg differ diff --git a/docs/images/VizEditor.jpg b/docs/images/VizEditor.jpg index 2dc5241a6988d..8aabfe544a0cd 100644 Binary files a/docs/images/VizEditor.jpg and b/docs/images/VizEditor.jpg differ diff --git a/docs/images/apply-changes-button.png b/docs/images/apply-changes-button.png index c45723877a51c..7ec98e6ccdcb4 100644 Binary files a/docs/images/apply-changes-button.png and b/docs/images/apply-changes-button.png differ diff --git a/docs/images/autorefresh-pause.png b/docs/images/autorefresh-pause.png index 757d3367db58b..5a83c4587c961 100644 Binary files a/docs/images/autorefresh-pause.png and b/docs/images/autorefresh-pause.png differ diff --git a/docs/images/autorefresh.png b/docs/images/autorefresh.png index 76b0c458aef4b..cf24bac5af08f 100644 Binary files a/docs/images/autorefresh.png and b/docs/images/autorefresh.png differ diff --git a/docs/images/discover-compass.png b/docs/images/discover-compass.png new file mode 100644 index 0000000000000..d92f2223afcfb Binary files /dev/null and b/docs/images/discover-compass.png differ diff --git a/docs/images/kibana-status-page.png b/docs/images/kibana-status-page.png index f21be1fbd4cd0..f20a7970ba76d 100644 Binary files a/docs/images/kibana-status-page.png and b/docs/images/kibana-status-page.png differ diff --git a/docs/images/tutorial-dashboard.png b/docs/images/tutorial-dashboard.png index 8f368541cbe75..2a0ec34bcca5a 100644 Binary files a/docs/images/tutorial-dashboard.png and b/docs/images/tutorial-dashboard.png differ diff --git a/docs/images/tutorial-discover-2.png b/docs/images/tutorial-discover-2.png index 6f52c6ae755f5..fdf6477e1375c 100644 Binary files a/docs/images/tutorial-discover-2.png and b/docs/images/tutorial-discover-2.png differ diff --git a/docs/images/tutorial-discover-3.png b/docs/images/tutorial-discover-3.png index 011537d4fad4d..15f164a2f3cc5 100644 Binary files a/docs/images/tutorial-discover-3.png and b/docs/images/tutorial-discover-3.png differ diff --git a/docs/images/tutorial-discover.png b/docs/images/tutorial-discover.png index 5791915486273..f2a7eac1917b4 100644 Binary files a/docs/images/tutorial-discover.png and b/docs/images/tutorial-discover.png differ diff --git a/docs/images/tutorial-timepicker.png b/docs/images/tutorial-timepicker.png index b8117d10bd33c..f1ac7befa451d 100644 Binary files a/docs/images/tutorial-timepicker.png and b/docs/images/tutorial-timepicker.png differ diff --git a/docs/images/tutorial-visualize-bar-1.png b/docs/images/tutorial-visualize-bar-1.png index 54312eb376290..f9acbe8f37209 100644 Binary files a/docs/images/tutorial-visualize-bar-1.png and b/docs/images/tutorial-visualize-bar-1.png differ diff --git a/docs/images/tutorial-visualize-bar-2.png b/docs/images/tutorial-visualize-bar-2.png index 471922df2ac8a..1c047e08485c9 100644 Binary files a/docs/images/tutorial-visualize-bar-2.png and b/docs/images/tutorial-visualize-bar-2.png differ diff --git a/docs/images/tutorial-visualize-bar-3.png b/docs/images/tutorial-visualize-bar-3.png index a117c6a0ed34f..4da21b0eb53cb 100644 Binary files a/docs/images/tutorial-visualize-bar-3.png and b/docs/images/tutorial-visualize-bar-3.png differ diff --git a/docs/images/tutorial-visualize-map-1.png b/docs/images/tutorial-visualize-map-1.png index 01c74787b8c7d..539c54c1b23b7 100644 Binary files a/docs/images/tutorial-visualize-map-1.png and b/docs/images/tutorial-visualize-map-1.png differ diff --git a/docs/images/tutorial-visualize-map-2.png b/docs/images/tutorial-visualize-map-2.png index 0a1ad6008b59a..4b3267043929f 100644 Binary files a/docs/images/tutorial-visualize-map-2.png and b/docs/images/tutorial-visualize-map-2.png differ diff --git a/docs/images/tutorial-visualize-map-3.png b/docs/images/tutorial-visualize-map-3.png index 30a7e18dc94a6..9e57838637cdc 100644 Binary files a/docs/images/tutorial-visualize-map-3.png and b/docs/images/tutorial-visualize-map-3.png differ diff --git a/docs/images/tutorial-visualize-md-1.png b/docs/images/tutorial-visualize-md-1.png index cc57c3e6c1279..55504682a0e5b 100644 Binary files a/docs/images/tutorial-visualize-md-1.png and b/docs/images/tutorial-visualize-md-1.png differ diff --git a/docs/images/tutorial-visualize-md-2.png b/docs/images/tutorial-visualize-md-2.png index 307334f4ff725..c1bbc120aa011 100644 Binary files a/docs/images/tutorial-visualize-md-2.png and b/docs/images/tutorial-visualize-md-2.png differ diff --git a/docs/images/tutorial-visualize-pie-1.png b/docs/images/tutorial-visualize-pie-1.png index cbbdf3a64cdc1..f6445ff6a36cb 100644 Binary files a/docs/images/tutorial-visualize-pie-1.png and b/docs/images/tutorial-visualize-pie-1.png differ diff --git a/docs/images/tutorial-visualize-pie-2.png b/docs/images/tutorial-visualize-pie-2.png index e26df22f37d31..781a30ce8d448 100644 Binary files a/docs/images/tutorial-visualize-pie-2.png and b/docs/images/tutorial-visualize-pie-2.png differ diff --git a/docs/images/tutorial-visualize-pie-3.png b/docs/images/tutorial-visualize-pie-3.png index 5d282ac5b3ef5..340cad28c53de 100644 Binary files a/docs/images/tutorial-visualize-pie-3.png and b/docs/images/tutorial-visualize-pie-3.png differ diff --git a/docs/images/tutorial-visualize.png b/docs/images/tutorial-visualize.png index d02a6946c932a..f5b47d8434a78 100644 Binary files a/docs/images/tutorial-visualize.png and b/docs/images/tutorial-visualize.png differ diff --git a/docs/images/visualize-icon.png b/docs/images/visualize-icon.png new file mode 100644 index 0000000000000..1166eb86134b4 Binary files /dev/null and b/docs/images/visualize-icon.png differ diff --git a/docs/index.asciidoc b/docs/index.asciidoc index 92b8ffd60f5fa..4ef7fe6301462 100644 --- a/docs/index.asciidoc +++ b/docs/index.asciidoc @@ -3,10 +3,11 @@ :ref: http://www.elastic.co/guide/en/elasticsearch/reference/current/ :shield: https://www.elastic.co/guide/en/shield/current +:scyld: X-Pack Security :k4issue: https://github.com/elastic/kibana/issues/ :k4pull: https://github.com/elastic/kibana/pull/ -:version: 5.0 alpha -:esversion: 2.3 +:version: master +:esversion: master include::introduction.asciidoc[] diff --git a/docs/introduction.asciidoc b/docs/introduction.asciidoc index 3721b9210f817..664e73e89d7f2 100644 --- a/docs/introduction.asciidoc +++ b/docs/introduction.asciidoc @@ -1,20 +1,22 @@ [[introduction]] == Introduction -Kibana is an open source analytics and visualization platform designed to work -with Elasticsearch. You use Kibana to search, view, and interact with data -stored in Elasticsearch indices. You can easily perform advanced data analysis +Kibana is an open source analytics and visualization platform designed to work with Elasticsearch. You use Kibana to +search, view, and interact with data stored in Elasticsearch indices. You can easily perform advanced data analysis and visualize your data in a variety of charts, tables, and maps. -Kibana makes it easy to understand large volumes of data. Its simple, -browser-based interface enables you to quickly create and share dynamic -dashboards that display changes to Elasticsearch queries in real time. +Kibana makes it easy to understand large volumes of data. Its simple, browser-based interface enables you to quickly +create and share dynamic dashboards that display changes to Elasticsearch queries in real time. -Setting up Kibana is a snap. You can install Kibana and start exploring your -Elasticsearch indices in minutes -- no code, no additional infrastructure required. +Setting up Kibana is a snap. You can install Kibana and start exploring your Elasticsearch indices in minutes -- no +code, no additional infrastructure required. -NOTE: This guide describes how to use Kibana {version}. For information about what's new -in Kibana {version}, see the <>. +For more information about creating and sharing visualizations and dashboards, see the <> +and <> topics. A complete <> covering several aspects of Kibana's +functionality is also available. + +NOTE: This guide describes how to use Kibana {version}. For information about what's new in Kibana {version}, see +the <>. //// [float] @@ -52,7 +54,3 @@ that displays several visualizations of the TFL data: image:images/TFL-Dashboard.jpg[Dashboard] //// - -For more information about creating and sharing visualizations and dashboards, see the <> -and <> topics. A complete <> covering several aspects of Kibana's -functionality is also available. diff --git a/docs/kibana-repositories.asciidoc b/docs/kibana-repositories.asciidoc index 6a9c2ca196227..a2492d8b680c7 100644 --- a/docs/kibana-repositories.asciidoc +++ b/docs/kibana-repositories.asciidoc @@ -1,7 +1,7 @@ [[setup-repositories]] === Kibana Repositories -Binary packages for Kibana are available for Unix distributions that support the `apt` and `yum` tools.We also have +Binary packages for Kibana are available for Unix distributions that support the `apt` and `yum` tools. We also have repositories available for APT and YUM based distributions. NOTE: Since the packages are created as part of the Kibana build, source packages are not available. @@ -24,23 +24,24 @@ wget -qO - https://packages.elastic.co/GPG-KEY-elasticsearch | sudo apt-key add + . Add the repository definition to your `/etc/apt/sources.list.d/kibana.list` file: + -[source, sh] +["source","sh",subs="attributes"] -------------------------------------------------- -echo "deb http://packages.elastic.co/kibana/{branch}/debian stable main" | sudo tee -a /etc/apt/sources.list.d/kibana.list +echo "deb http://packages.elastic.co/kibana/{version}/debian stable main" | sudo tee -a /etc/apt/sources.list.d/kibana.list -------------------------------------------------- + [WARNING] ================================================== -Use the `echo` method described above to add the Kibana repository. Do not use `add-apt-repository`, as that command +Use the `echo` method described above to add the Kibana repository. Do not use `add-apt-repository`, as that command adds a `deb-src` entry with no corresponding source package. -When the `deb-src` entry, is present, the commands in this procedure generate an error similar to the following: + +When the `deb-src` entry is present, the commands in this procedure generate an error similar to the following: Unable to find expected entry 'main/source/Sources' in Release file (Wrong sources.list entry or malformed file) Delete the `deb-src` entry from the `/etc/apt/sources.list.d/kibana.list` file to clear the error. ================================================== + -. Run `apt-get update` and the repository is ready for use. Install Kibana with the following command: +. Run `apt-get update` to ready the repository. Install Kibana with the following command: + [source,sh] -------------------------------------------------- @@ -79,11 +80,11 @@ rpm --import https://packages.elastic.co/GPG-KEY-elasticsearch + . Create a file named `kibana.repo` in the `/etc/yum.repos.d/` directory with the following contents: + -[source,sh] +["source","sh",subs="attributes"] -------------------------------------------------- -[kibana-{branch}] -name=Kibana repository for {branch}.x packages -baseurl=http://packages.elastic.co/kibana/{branch}/centos +[kibana-{version}] +name=Kibana repository for {version}.x packages +baseurl=http://packages.elastic.co/kibana/{version}/centos gpgcheck=1 gpgkey=http://packages.elastic.co/GPG-KEY-elasticsearch enabled=1 diff --git a/docs/kibana-yml.asciidoc b/docs/kibana-yml.asciidoc index 3e0e4ded41a85..fa4baf0ae4548 100644 --- a/docs/kibana-yml.asciidoc +++ b/docs/kibana-yml.asciidoc @@ -2,9 +2,10 @@ [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 cannot -end in a slash (`/`). +`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 queries. `elasticsearch.preserveHost:`:: *Default: true* When this setting’s value is true Kibana uses the hostname specified in @@ -39,4 +40,5 @@ retrying. error messages. `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: 10000* Set the interval in milliseconds to sample system and process performance metrics. Minimum is 100ms. Defaults to 10 seconds. +`ops.interval`:: *Default: 10000* 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 c4639d36e17ee..a349176a6c01c 100644 --- a/docs/line.asciidoc +++ b/docs/line.asciidoc @@ -50,7 +50,7 @@ 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. -After changing options, click the green *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/pie.asciidoc b/docs/pie.asciidoc index 233b263b1e84d..74345239333d4 100644 --- a/docs/pie.asciidoc +++ b/docs/pie.asciidoc @@ -50,8 +50,8 @@ in a name to display on the visualization. {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-aggregations to refine the visualization. Click *+ Add -Sub Aggregation* to define a sub-aggregation, then choose *Split Slices* to select a sub-aggregation 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 @@ -84,7 +84,7 @@ Select the *Options* tab to change the following aspects of the table: *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 green *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 7e99025451b52..f1548b0ddd632 100644 --- a/docs/plugins.asciidoc +++ b/docs/plugins.asciidoc @@ -1,7 +1,7 @@ [[kibana-plugins]] -== Kibana Plugins added[4.2] +== Kibana Plugins -Add-on functionality for Kibana is implemented with plug-in modules. You can use the `bin/kibana plugin` +Add-on functionality for Kibana is implemented with plug-in modules. You can use the `bin/kibana-plugin` command to manage these modules. You can also install a plugin manually by moving the plugin file to the `installedPlugins` directory and unpacking the plugin files into a new directory. @@ -13,27 +13,22 @@ A list of existing Kibana plugins is available on https://github.com/elastic/kib Use the following command to install a plugin: [source,shell] -bin/kibana plugin --install // +bin/kibana-plugin install -You can also use `-i` instead of `--install`, as in the following example: - -[source,shell] -bin/kibana plugin -i elasticsearch/marvel/latest - -Because the organization given is `elasticsearch`, the plugin management tool automatically downloads the -plugin from `download.elastic.co`. +When you specify a plugin name without a URL, the plugin tool attempts to download the plugin from `download.elastic.co`. [float] -=== Installing Plugins from an Arbitrary URL +==== Installing Plugins from an Arbitrary URL -You can specify a URL to a plugin with the `-u` or `--url` options after the `-i` or `--install` option, as in the -following example: +You can specify a URL to a specific plugin, as in the following example: [source,shell] -bin/kibana plugin -i sample-plugin -u https://some.sample.url/directory -Installing sample-plugin -Attempting to extract from https://some.sample.url/directory -Downloading bytes.................... +$ 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 +Transferring bytes.................... +Transfer complete +Retrieving metadata from plugin archive +Extracting plugin archive Extraction complete Optimizing and caching browser bundles... Plugin installation complete @@ -43,13 +38,17 @@ You can specify URLs that use the HTTP, HTTPS, or `file` protocols. [float] === Installing Plugins to an Arbitrary Directory -Use the `-d` or `--plugin-dir` option to specify a directory for plugins, as in the following example: +Use the `-d` or `--plugin-dir` option after the `install` command to specify a directory for plugins, as in the following +example: [source,shell] -bin/kibana plugin -i elasticsearch/sample-plugin/latest -d +$ bin/kibana-plugin install file:///some/local/path/x-pack.zip -d path/to/directory Installing sample-plugin -Attempting to extract from https://download.elastic.co/elasticsearch/sample-plugin/sample-plugin-latest.tar.gz -Downloading bytes.................... +Attempting to transfer from file:///some/local/path/x-pack.zip +Transferring bytes.................... +Transfer complete +Retrieving metadata from plugin archive +Extracting plugin archive Extraction complete Optimizing and caching browser bundles... Plugin installation complete @@ -59,18 +58,17 @@ NOTE: This command creates the specified directory if it does not already exist. [float] === Removing Plugins -Use the `--remove` or `-r` option to remove a plugin, including any configuration information, as in the following -example: +Use the `remove` command to remove a plugin, including any configuration information, as in the following example: [source,shell] -bin/kibana plugin --remove marvel +$ bin/kibana-plugin remove timelion -You can also remove a plugin manually by deleting the plugin's subdirectory under the `installedPlugins` directory. +You can also remove a plugin manually by deleting the plugin's subdirectory under the `installedPlugins/` directory. [float] === Listing Installed Plugins -Use `--list` or `-l` option to list the currently installed plugins. +Use the `list` command to list the currently installed plugins. [float] === Updating Plugins @@ -81,27 +79,28 @@ To update a plugin, remove the current version and reinstall the plugin. === Configuring the Plugin Manager By default, the plugin manager provides you with feedback on the status of the activity you've asked the plugin manager -to perform. You can control the level of feedback with the `--quiet` and `--silent` options. Use the `--quiet` option to -suppress all non-error output. Use the `--silent` option to suppress all output. +to perform. You can control the level of feedback for the `install` and `remove` commands with the `--quiet` and +`--silent` options. Use the `--quiet` option to suppress all non-error output. Use the `--silent` option to suppress all +output. -By default, plugin manager requests do not time out. Use the `--timeout` option, followed by a time, to change this -behavior, as in the following examples: +By default, plugin manager installation requests do not time out. Use the `--timeout` option, followed by a time, to +change this behavior, as in the following examples: [source,shell] .Waits for 30 seconds before failing -bin/kibana plugin --install username/sample-plugin --timeout 30s +bin/kibana-plugin install --timeout 30s sample-plugin [source,shell] .Waits for 1 minute before failing -bin/kibana plugin --install username/sample-plugin --timeout 1m +bin/kibana-plugin install --timeout 1m sample-plugin [float] ==== Plugins and Custom Kibana Configurations -Use the `-c` or `--config` options to specify the path to the configuration file used to start Kibana. By default, Kibana -uses the configuration file `config/kibana.yml`. When you change your installed plugins, the `bin/kibana plugin` command -restarts the Kibana server. When you are using a customized configuration file, you must specify the -path to that configuration file each time you use the `bin/kibana plugin` command. +Use the `-c` or `--config` options with the `install` and `remove` commands to specify the path to the configuration file +used to start Kibana. By default, Kibana uses the configuration file `config/kibana.yml`. When you change your installed +plugins, the `bin/kibana-plugin` command restarts the Kibana server. When you are using a customized configuration file, +you must specify the path to that configuration file each time you use the `bin/kibana-plugin` command. [float] === Plugin Manager Exit Codes @@ -117,9 +116,14 @@ path to that configuration file each time you use the `bin/kibana plugin` comman == Switching Plugin Functionality The Kibana UI serves as a framework that can contain several different plugins. You can switch between these -plugins by clicking the image:images/app-button.png[Plugin Chooser] *Plugin chooser* button to display icons for the -installed plugins: +plugins by clicking the icons for your desired plugins in the left-hand navigation bar. + +[float] +=== Disabling Plugins -image::images/app-picker.png[] +Use the following command to disable a plugin: + +[source,shell] +./bin/kibana --.enabled=false -Click a plugin's icon to switch to that plugin's functionality. +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 diff --git a/docs/production.asciidoc b/docs/production.asciidoc index 626a7d4f402ac..f911770e236c6 100644 --- a/docs/production.asciidoc +++ b/docs/production.asciidoc @@ -1,6 +1,6 @@ [[production]] == Using Kibana in a Production Environment -* <> +* <> * <> * <> * <> @@ -19,31 +19,29 @@ and an Elasticsearch client node on the same machine. For more information, see [float] [[configuring-kibana-shield]] -=== Configuring Kibana to Work with Shield -If you are using Shield to authenticate Elasticsearch users, you need to provide +=== Configuring Kibana to Work with {scyld} +If you are using {scyld} to authenticate Elasticsearch users, you need to provide the Kibana server with credentials so it can access the `.kibana` index and monitor the cluster. To configure credentials for the Kibana server: -. Assign the `kibana4_server` role to a user in Shield. For more information, see -{shield}/kibana.html#kibana4-server-role[Configuring a Role for the Kibana 4 Server] -in the Shield documentation. +. Assign the `kibana4_server` role to a user in {scyld}. For more information, see +{shield}/kibana.html#kibana4-server-role[Configuring a Role for the Kibana Server] +in the {scyld} documentation. . Set the `kibana_elasticsearch_username` and `kibana_elasticsearch_password` properties in `kibana.yml` to specify the credentials -of the user you assigned the `kibana4_server` -role: +of the user you assigned the `kibana4_server` role: + [source,text] ---- -kibana_elasticsearch_username: kibana4-user -kibana_elasticsearch_password: kibana4-password +kibana_elasticsearch_username: kibana-user +kibana_elasticsearch_password: kibana-password ---- -Kibana 4 users also need access to the `.kibana` index so they can save and load searches, visualizations, and dashboards. -For more information, see {shield}/kibana.html[Using Kibana with Shield] in -the Shield documentation. +Users on release 4.0 and later of Kibana also need access to the `.kibana` index so they can save and load searches, visualizations, and +dashboards. For more information, see {shield}/kibana.html[Using Kibana with {scyld}]. TIP: See <> for important information on Kibana and the dynamic mapping feature in Elasticsearch. @@ -64,7 +62,7 @@ server.ssl.key: /path/to/your/server.key server.ssl.cert: /path/to/your/server.crt ---- -If you are using Shield or a proxy that provides an HTTPS endpoint for Elasticsearch, +If you are using {scyld} or a proxy that provides an HTTPS endpoint for Elasticsearch, you can configure Kibana to access Elasticsearch via HTTPS so communications between the Kibana server and Elasticsearch are encrypted. @@ -89,15 +87,14 @@ ca: /path/to/your/ca/cacert.pem [float] [[controlling-access]] === Controlling access -You can use http://www.elastic.co/overview/shield/[Elasticsearch Shield] -(Shield) to control what Elasticsearch data users can access through Kibana. -Shield provides index-level access control. If a user isn't authorized to run +You can use http://www.elastic.co/overview/shield/[{scyld}] to control what Elasticsearch data users can access through Kibana. +{scyld} provides index-level access control. If a user isn't authorized to run the query that populates a Kibana visualization, the user just sees an empty visualization. -To configure access to Kibana using Shield, you create Shield roles +To configure access to Kibana using {scyld}, you create roles for Kibana using the `kibana4` default role as a starting point. For more -information, see {shield}/kibana.html#using-kibana4-with-shield[Using Kibana 4 with Shield]. +information, see {shield}/kibana.html#using-kibana4-with-shield[Using Kibana with {scyld}]. [float] [[load-balancing]] diff --git a/docs/releasenotes.asciidoc b/docs/releasenotes.asciidoc index 3df3f074eb9e5..a9e965bd22dfb 100644 --- a/docs/releasenotes.asciidoc +++ b/docs/releasenotes.asciidoc @@ -3,21 +3,29 @@ The {version} release of Kibana requires Elasticsearch {esversion} or later. +[float] +[[breaking]] +== Breaking Changes + +// * {k4issue}5591[Issue 5591]: The command-line plugin tool no longer supports Github. + [float] [[enhancements]] == Enhancements -// * {k4issue}5109[Issue 5109]: Adds custom JSON and filter alias naming for filters. -// * {k4issue}1726[Issue 1726]: Adds a color field formatter for value ranges in numeric fields. -// * {k4issue}4342[Issue 4342]: Increased performance for wildcard indices. -// * {k4issue}1600[Issue 1600]: Support for global time zones. -// * {k4pull}5275[Pull Request 5275]: Highlighting values in Discover can now be disabled. -// * {k4issue}5212[Issue 5212]: Adds support for multiple certificate authorities. -// * {k4issue}2716[Issue 2716]: The open/closed position of the spy panel now persists across UI state changes. +// * {k4issue}6387[Issue 6387]: A new look for Kibana: new logo and UI, improved layout and navigation. [float] [[bugfixes]] == Bug Fixes -// * {k4issue}5165[Issue 5165]: Resolves a display error in embedded views. -// * {k4issue}5021[Issue 5021]: Improves visualization dimming for dashboards with auto-refresh. +// * {k4issue}5914[Issue 5914]: Adds ability to aggregate on unindexed fields. + +[float] +[[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 +framework and APIs are not formally documented and not guaranteed to be backward compatible from release to release. + +// * {k4issue}5198[Issue 5198]: Injects buttons from the plugin to the navigation bar. diff --git a/docs/settings.asciidoc b/docs/settings.asciidoc index 476332cf0d346..0f105dc33e06d 100644 --- a/docs/settings.asciidoc +++ b/docs/settings.asciidoc @@ -183,11 +183,13 @@ include::string-formatter.asciidoc[] ==== Numeric Field Formatters -Numeric fields support the `Url`, `String`, `Bytes`, `Number`, `Percentage`, and `Color` formatters. +Numeric fields support the `Url`, `Bytes`, `Duration`, `Number`, `Percentage`, `String`, and `Color` formatters. + +include::url-formatter.asciidoc[] include::string-formatter.asciidoc[] -include::url-formatter.asciidoc[] +include::duration-formatter.asciidoc[] include::color-formatter.asciidoc[] @@ -278,6 +280,7 @@ you'll need to update your `kibana.yml` file. You can also enable SSL and set a include::kibana-yml.asciidoc[] +//// deprecated[4.2, The names of several Kibana server properties changed in the 4.2 release of Kibana. The previous names remain as functional aliases, but are now deprecated and will be removed in a future release of Kibana] [horizontal] @@ -407,6 +410,7 @@ you are using a self-signed certificate so the certificate can be verified. Disa `logging.dest` added[4.2]:: The location where you want to store the Kibana's log output. If not specified, log output is written to standard output and not stored. Specifying a log file suppresses log writes to standard output. + *alias*: `log_file` deprecated[4.2] +//// [[managing-saved-objects]] === Managing Saved Searches, Visualizations, and Dashboards diff --git a/docs/setup.asciidoc b/docs/setup.asciidoc index 543f7df3c38a9..74b87345bfb21 100644 --- a/docs/setup.asciidoc +++ b/docs/setup.asciidoc @@ -3,14 +3,14 @@ You can set up Kibana and start exploring your Elasticsearch indices in minutes. All you need is: -* Elasticsearch master +* Elasticsearch {esversion} * A modern web browser - http://www.elastic.co/subscriptions/matrix#matrix_browsers[Supported Browsers]. * Information about your Elasticsearch installation: ** URL of the Elasticsearch instance you want to connect to. ** Which Elasticsearch indices you want to search. -NOTE: If your Elasticsearch installation is protected by http://www.elastic.co/overview/shield/[Shield] see -{shield}/kibana.html#using-kibana4-with-shield[Shield with Kibana 4] for additional setup instructions. +NOTE: If your Elasticsearch installation is protected by http://www.elastic.co/overview/shield/[{scyld}], see +{shield}/kibana.html#using-kibana4-with-shield[{scyld} with Kibana] for additional setup instructions. [float] [[install]] @@ -18,15 +18,16 @@ NOTE: If your Elasticsearch installation is protected by http://www.elastic.co/o To get Kibana up and running: -. Download the https://www.elastic.co/downloads/kibana[Kibana 4 binary package] for your platform. +. Download the https://www.elastic.co/downloads/kibana[Kibana {version} binary package] for your platform. . Extract the `.zip` or `tar.gz` archive file. +. After installing, run Kibana from the install directory: `bin/kibana` (Linux/MacOSX) or `bin\kibana.bat` (Windows). -// On Unix, you can instead run the package manager suited for your distribution. -// -// [float] -// include::kibana-repositories.asciidoc[] -// -After installing, run Kibana from the install directory: `bin/kibana` (Linux/MacOSX) or `bin\kibana.bat` (Windows). +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. @@ -82,14 +83,14 @@ simply be the name of a single index. reads the index mapping to list all of the fields that contain a timestamp. If your index doesn't have time-based data, disable the *Index contains time-based events* option. + -WARNING: Using event times to create index names is *deprecated* in this release of Kibana. Support for this functionality -will be removed entirely in the next major Kibana release. Elasticsearch 2.1 includes sophisticated date parsing APIs that -Kibana uses to determine date information, removing the need to specify dates in the index pattern name. +WARNING: Using event times to create index names is *deprecated* in this release of Kibana. Starting in the 2.1 +release, Elasticsearch includes sophisticated date parsing APIs that Kibana uses to determine date information, +removing the need to specify dates in the index pattern name. + . Click *Create* to add the index pattern. This first pattern is automatically configured as the default. When you have more than one index pattern, you can designate which one to use as the default from *Settings > Indices*. -Voila! Kibana is now connected to your Elasticsearch data. Kibana displays a read-only list of fields configured for +All done! Kibana is now connected to your Elasticsearch data. Kibana displays a read-only list of fields configured for the matching index. [float] @@ -101,5 +102,5 @@ You're ready to dive in to your data: * Chart and map your data from the <> page. * Create and view custom dashboards from the <> page. -For a brief tutorial that explores these core Kibana concepts, take a look at the <> page. diff --git a/docs/string-formatter.asciidoc b/docs/string-formatter.asciidoc index 0cde079122ba4..63232c0b7fbea 100644 --- a/docs/string-formatter.asciidoc +++ b/docs/string-formatter.asciidoc @@ -2,9 +2,10 @@ The `String` field formatter can apply the following transformations to the fiel * Convert to lowercase * Convert to uppercase +* Convert to title case * Apply the short dots transformation, which replaces the content before a `.` character with the first character of that content, as in the following example: [horizontal] *Original*:: *Becomes* -`com.organizations.project.ClassName`:: `c.o.p.ClassName` \ No newline at end of file +`com.organizations.project.ClassName`:: `c.o.p.ClassName` diff --git a/docs/tilemap.asciidoc b/docs/tilemap.asciidoc index 4d959de0ed258..cc0f965e82002 100644 --- a/docs/tilemap.asciidoc +++ b/docs/tilemap.asciidoc @@ -50,7 +50,7 @@ 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 a range. -After changing options, click the green *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 @@ -123,7 +123,7 @@ 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 options. -After changing options, click the green *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/visualize.asciidoc b/docs/visualize.asciidoc index 780e182b5bf52..c598b2ea47acc 100644 --- a/docs/visualize.asciidoc +++ b/docs/visualize.asciidoc @@ -1,8 +1,8 @@ [[visualize]] == Visualize -You can use the _Visualize_ page to design data visualizations. You can save these visualizations, use -them individually, or combine visualizations into a _dashboard_. A visualization can be based on one of the following +You can use the _Visualize_ page to design data visualizations. You can save these visualizations, use them +individually, or combine visualizations into a _dashboard_. A visualization can be based on one of the following data source types: * A new interactive search @@ -15,9 +15,9 @@ Visualizations are based on the {ref}search-aggregations.html[aggregation] featu [[createvis]] === Creating a New Visualization -To start the New Visualization wizard, click on the *Visualize* tab at the top left of the page. If you are already -creating a visualization, you can click the *New Visualization* button image:images/K4NewDocument.png[New Document -button] in the toolbar to the right of the search bar. The wizard guides you through the following steps: +Click on the *Visualize* image:images/visualize-icon.png[chart icon] tab in the left-hand navigation bar. If you are +already creating a visualization, you can click the *New* button in the toolbar. To set up your visualization, follow +these steps: [float] [[newvis01]] @@ -38,8 +38,8 @@ dashboard. <>:: Use vertical bar charts as a general-purpose chart. You can also load a saved visualization that you created earlier. The saved visualization selector includes a text -field to filter by visualization name and a link to the Object Editor, accessible through *Settings > Edit Saved -Objects*, to manage your saved visualizations. +field to filter by visualization name and a link to the Object Editor, accessible through *Settings > Objects*, to +manage your saved visualizations. If your new visualization is a Markdown widget, selecting that type takes you to a text entry field where you enter the text to display in the widget. For all other types of visualization, selecting the type takes you to data source @@ -128,7 +128,7 @@ inside each bucket, which in this example is a one-hour interval. NOTE: Remember, each subsequent bucket slices the data from the previous bucket. -To render the visualization on the _preview canvas_, click the green *Apply Changes* button at the top right of the +To render the visualization on the _preview canvas_, click the *Apply Changes* button at the top right of the Aggregation Builder. You can learn more about aggregation and how altering the order of aggregations affects your visualizations @@ -143,7 +143,7 @@ include::filter-pinning.asciidoc[] ===== Preview Canvas The preview canvas displays a preview of the visualization you've defined in the aggregation builder. To refresh the -visualization preview, clicking the *Refresh* button image:images/K4Refresh.png[Refresh button] on the toolbar. +visualization preview, clicking the *Apply Changes* image:images/apply-changes-button.png[] button on the toolbar. include::area.asciidoc[] diff --git a/docs/y-axis-aggs.asciidoc b/docs/y-axis-aggs.asciidoc index 1153a1cb478fe..f404abb42dbbb 100644 --- a/docs/y-axis-aggs.asciidoc +++ b/docs/y-axis-aggs.asciidoc @@ -21,6 +21,6 @@ aggregation returns the percentile rankings for the values in the 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 Aggregation* button. +You can add an aggregation by clicking the *+ Add Metrics* button. Enter a string in the *Custom Label* field to change the display label.