Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Doc updates for 5.0alpha #6753

Closed
wants to merge 5 commits into from
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions docs/advanced-settings.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
2 changes: 1 addition & 1 deletion docs/apps.asciidoc
Original file line number Diff line number Diff line change
@@ -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:
Expand Down
2 changes: 1 addition & 1 deletion docs/area.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
6 changes: 3 additions & 3 deletions docs/autorefresh.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -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].
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

All of the images in this section seem to be from the old design with the dark toolbar.

. 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[]

Expand Down
8 changes: 6 additions & 2 deletions docs/color-formatter.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -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[]
image::images/colorformatter.png[]

//update image
16 changes: 6 additions & 10 deletions docs/dashboard.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -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]]
Expand All @@ -22,9 +22,7 @@ The first time you click the *Dashboard* tab, Kibana displays an empty dashboard
image:images/NewDashboard.png[New Dashboard screen]
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This screenshot needs to be updated. There is no longer a + sign button:

screen shot 2016-04-04 at 4 06 00 pm


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.

Expand All @@ -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.

Expand All @@ -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]]
Expand All @@ -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.
Expand Down
6 changes: 3 additions & 3 deletions docs/datatable.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand Down
42 changes: 18 additions & 24 deletions docs/discover.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -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]]
Expand Down Expand Up @@ -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 <<sorting,
Sorting the Documents Table>>.
column header. You can also sort the table using the values in any indexed field. For more information, see
<<sorting,Sorting the Documents Table>>.

To search your data:

Expand Down Expand Up @@ -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]]
Expand All @@ -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]
Expand Down Expand Up @@ -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]]
Expand Down Expand Up @@ -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]

Expand Down
15 changes: 15 additions & 0 deletions docs/duration-formatter.asciidoc
Original file line number Diff line number Diff line change
@@ -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.
6 changes: 3 additions & 3 deletions docs/filter-pinning.asciidoc
Original file line number Diff line number Diff line change
@@ -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[]
Expand All @@ -10,15 +10,15 @@ 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
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
Expand Down
Loading