Incorporates newest round of feedback. Notable changes:
- Chunking for Settings pages - Updates several screenshots - Autorefresh added - See PR conversation for way more deets
|
@ -62,7 +62,9 @@ _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.
|
||||
*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.
|
||||
*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.
|
||||
|
|
20
docs/autorefresh.asciidoc
Normal file
|
@ -0,0 +1,20 @@
|
|||
=== Automatically Refreshing the Page
|
||||
You can configure a refresh interval to automatically refresh the page with the latest index data. This periodically
|
||||
resubmits the search query.
|
||||
|
||||
When a refresh interval is set, it is displayed to the left of the Time Filter in the menu bar.
|
||||
|
||||
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 *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:
|
||||
|
||||
image::images/autorefresh-intervals.png
|
||||
|
||||
When auto-refresh is enabled, Kibana's top bar displays a pause button and the auto-refresh interval:
|
||||
image:images/autorefresh-pause.png[]. Click the *Pause* button to pause auto-refresh.
|
|
@ -23,6 +23,10 @@ image:images/NewDashboard.jpg[New Dashboard screen]
|
|||
|
||||
Build your dashboard by adding visualizations.
|
||||
|
||||
[float]
|
||||
[[dash-autorefresh]]
|
||||
include::autorefresh.asciidoc[]
|
||||
|
||||
[float]
|
||||
[[adding-visualizations-to-a-dashboard]]
|
||||
==== Adding Visualizations to a Dashboard
|
||||
|
@ -41,7 +45,9 @@ container>>.
|
|||
==== Saving Dashboards
|
||||
|
||||
To save the dashboard, click the *Save Dashboard* button in the toolbar panel, enter a name for the dashboard in the
|
||||
*Save As* field, and click the *Save* button.
|
||||
*Save As* field, and click the *Save* button. By default, dashboards store the time period specified in the time filter
|
||||
when you save a dashboard. To disable this behavior, clear the *Store time with dashboard* box before clicking the
|
||||
*Save* button.
|
||||
|
||||
[float]
|
||||
[[loading-a-saved-dashboard]]
|
||||
|
|
|
@ -10,7 +10,10 @@ 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.
|
||||
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
|
||||
intervals in the histogram.
|
||||
|
|
|
@ -35,13 +35,16 @@ chart--the cursor changes to a plus sign when you hover over a valid start point
|
|||
|
||||
You can use the browser Back button to undo your changes.
|
||||
|
||||
The histogram lists the time range you're currently exploring, as well as the intervals that range is currently using.
|
||||
To change the intervals, click the link and select an interval from the drop-down. The default behavior automatically
|
||||
sets an interval based on the time range.
|
||||
|
||||
[float]
|
||||
[[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
|
||||
http://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl.html[Elasticsearch Query DSL].
|
||||
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
|
||||
|
@ -115,18 +118,8 @@ For more information about index patterns, see <<settings-create-pattern, Creati
|
|||
|
||||
[float]
|
||||
[[auto-refresh]]
|
||||
=== Automatically Refreshing the Page
|
||||
You can configure a refresh interval to automatically refresh the Discover page with the latest
|
||||
index data. This periodically resubmits the search query.
|
||||
|
||||
When a refresh interval is set, it is displayed to the left of the Time Filter in the menu bar.
|
||||
|
||||
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 *Refresh Interval* tab.
|
||||
. Choose a refresh interval from the list.
|
||||
include::autorefresh.asciidoc[]
|
||||
|
||||
[float]
|
||||
[[field-filter]]
|
||||
|
@ -136,7 +129,8 @@ also create negative filters that exclude documents that contain the specified f
|
|||
|
||||
You can add filters from the Fields list or from the Documents table. When you add a filter, it is displayed in the
|
||||
filter bar below the search query. From the filter bar, you can enable or disable a filter, invert the filter (change
|
||||
it from a positive filter to a negative filter and vice-versa), toggle the filter on or off, or remove it entirely.
|
||||
it from a positive filter to a negative filter and vice-versa), toggle the filter on or off, or remove it entirely.
|
||||
Click the small left-facing arrow to the right of the index pattern selection drop-down to collapse the Fields list.
|
||||
|
||||
To add a filter from the Fields list:
|
||||
|
||||
|
@ -169,16 +163,19 @@ You can configure the number of documents shown in the table by setting the `dis
|
|||
in the selected index pattern and the document `_source`. You can <<adding-columns, add fields to the Documents table>>
|
||||
from the Fields list. You can <<sorting, sort the listed documents>> by any indexed field that's included in the table.
|
||||
|
||||
To view a document's field data:
|
||||
To view a document's field data, click the *Expand* button image:images/ExpandButton.jpg[Expand Button] to the left of
|
||||
the document's entry in the first column (the first column is usually Time). Kibana reads the document data from
|
||||
Elasticsearch and displays the document fields in a table. The table contains a row for each field that contains the
|
||||
name of the field, add filter buttons, and the field value.
|
||||
|
||||
image::images/Expanded-Document.png[]
|
||||
|
||||
. Click the *Expand* button image:images/ExpandButton.jpg[Expand Button] to the left of the document's entry in the
|
||||
first column (the first column is usually Time). Kibana reads the document data from Elasticsearch and displays the
|
||||
document fields in a table. The table contains a row for each field that contains the name of the field, add filter
|
||||
buttons, and the field value.
|
||||
. To view the original JSON document (pretty-printed), click the *JSON* tab.
|
||||
. To view the document data as a separate page, click the link. You can bookmark and share this link to provide direct
|
||||
access to a particular document.
|
||||
. To collapse the document details, click the *Collapse* button image:images/CollapseButton.jpg[Collapse Button].
|
||||
. To toggle a particular field's column in the Documents table, click the
|
||||
image:images/add-column-button.png[Add Column] *Toggle column in table* button.
|
||||
|
||||
[float]
|
||||
[[sorting]]
|
||||
|
@ -205,7 +202,8 @@ To add field columns to the Documents table:
|
|||
The added field columns replace the `_source` column in the Documents table. The added fields are also
|
||||
listed in the *Selected Fields* section at the top of the field list.
|
||||
|
||||
To rearrange the field columns in the table, mouse over the header of the column you want to move and click the *Move* button.
|
||||
To rearrange the field columns in the table, mouse over the header of the column you want to move and click the *Move*
|
||||
button.
|
||||
|
||||
image:images/Discover-MoveColumn.jpg[Move Column]
|
||||
|
||||
|
|
Before Width: | Height: | Size: 198 KiB After Width: | Height: | Size: 178 KiB |
BIN
docs/images/Expanded-Document.png
Normal file
After Width: | Height: | Size: 86 KiB |
Before Width: | Height: | Size: 23 KiB After Width: | Height: | Size: 31 KiB |
BIN
docs/images/add-column-button.png
Normal file
After Width: | Height: | Size: 350 B |
BIN
docs/images/autorefresh-intervals.png
Normal file
After Width: | Height: | Size: 24 KiB |
BIN
docs/images/autorefresh-pause.png
Normal file
After Width: | Height: | Size: 2 KiB |
BIN
docs/images/autorefresh.png
Normal file
After Width: | Height: | Size: 5.5 KiB |
BIN
docs/images/viz-fit-bounds.png
Normal file
After Width: | Height: | Size: 655 B |
BIN
docs/images/viz-lat-long-filter.png
Normal file
After Width: | Height: | Size: 493 B |
BIN
docs/images/viz-zoom.png
Normal file
After Width: | Height: | Size: 426 B |
|
@ -21,7 +21,10 @@ 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.
|
||||
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
|
||||
intervals in the histogram.
|
||||
|
|
|
@ -156,7 +156,6 @@ To delete an index pattern:
|
|||
. Click the pattern's *Delete* button.
|
||||
. Confirm that you want to remove the index pattern.
|
||||
|
||||
[float]
|
||||
[[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
|
||||
|
@ -230,7 +229,6 @@ To delete a scripted field:
|
|||
. Click the *Delete* button for the scripted field you want to remove.
|
||||
. Confirm that you really want to delete the field.
|
||||
|
||||
[float]
|
||||
[[advanced-options]]
|
||||
=== Setting Advanced Options
|
||||
The Advanced Settings page enables you to directly edit settings that control
|
||||
|
@ -248,7 +246,10 @@ To set advanced options:
|
|||
. Enter a new value for the option.
|
||||
. Click the *Save* button.
|
||||
|
||||
=== Managing Saved Searches, Visualizations, and Dashboards ===
|
||||
[float]
|
||||
[[managing-saved-objects]]
|
||||
=== Managing Saved Searches, Visualizations, and Dashboards
|
||||
|
||||
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.
|
||||
|
||||
|
@ -300,11 +301,13 @@ To export a set of objects:
|
|||
. Click *Export* to select a location to write the exported JSON.
|
||||
|
||||
To import a set of objects:
|
||||
|
||||
. Go to *Settings > Objects*.
|
||||
. Click *Import* to navigate to the JSON file representing the set of objects to import.
|
||||
. Click *Open* after selecting the JSON file.
|
||||
. If any objects in the set would overwrite objects already present in Kibana, confirm the overwrite.
|
||||
|
||||
[[kibana-server-properties]]
|
||||
=== Setting Kibana Server Properties
|
||||
|
||||
The Kibana server reads properties from the `kibana.yml` file on startup. The default
|
||||
|
@ -363,4 +366,8 @@ so the certificate can be verified. (Otherwise, you have to disable `verify_ssl`
|
|||
|The location where you want to store the process ID file. If not specified, the PID file is stored in
|
||||
`/var/run/kibana.pid`. Default: none.
|
||||
|
||||
|`log_file`
|
||||
|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. Default: none.
|
||||
|
||||
|===
|
||||
|
|
|
@ -15,11 +15,18 @@ https://www.elastic.co/guide/en/shield/current/_shield_with_kibana_4.html[Shield
|
|||
[float]
|
||||
[[install]]
|
||||
=== Install and Start Kibana
|
||||
|
||||
To get Kibana up and running:
|
||||
|
||||
. Download the https://www.elastic.co/downloads/kibana[Kibana 4 binary package] for your platform.
|
||||
. Extract the `.zip` or `tar.gz` archive file.
|
||||
. 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:
|
||||
|
||||
* Red Hat, Centos: `yum install kibana`
|
||||
* Debian: `apt-get install kibana`
|
||||
|
||||
After installing, run Kibana from the install directory: `bin/kibana` (Linux/MacOSX) or `bin\kibana.bat` (Windows).
|
||||
|
||||
That's it! Kibana is now running on port 5601.
|
||||
|
||||
|
|
|
@ -39,7 +39,10 @@ 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.
|
||||
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
|
||||
intervals in the histogram.
|
||||
|
@ -111,9 +114,11 @@ changes* button to keep your visualization in its current state.
|
|||
[[navigating-map]]
|
||||
==== 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 the *Fit Data Bounds* button to automatically crop the map boundaries to the geohash buckets that have at least
|
||||
one result.
|
||||
* Click the *Latitude/Longitude Filter* button, then drag a bounding box across the map, to create a filter for the box
|
||||
coordinates.
|
||||
* 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
|
||||
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
|
||||
map, to create a filter for the box coordinates.
|
||||
|
|
|
@ -53,8 +53,6 @@ You can choose a new or saved search to serve as the data source for your visual
|
|||
an index or a set of indexes. When you select _new search_ on a system with multiple indices configured, select an
|
||||
index pattern from the drop-down to bring up the visualization editor.
|
||||
|
||||
// How is this drop-down populated? Is it just a list of all indices in the cluster? Can I configure the contents?
|
||||
|
||||
When you create a visualization from a saved search and save the visualization, the search is tied to the visualization.
|
||||
When you make changes to the search that is linked to the visualization, the visualization updates automatically.
|
||||
|
||||
|
@ -71,6 +69,10 @@ main elements:
|
|||
|
||||
image:images/VizEditor.jpg[]
|
||||
|
||||
[float]
|
||||
[[viz-autorefresh]]
|
||||
include::autorefresh.asciidoc[]
|
||||
|
||||
[float]
|
||||
[[toolbar-panel]]
|
||||
===== Toolbar
|
||||
|
@ -126,7 +128,8 @@ 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 *Apply* button at the bottom of the aggregation builder.
|
||||
To render the visualization on the _preview canvas_, click the green *Apply Changes* button at the top right of the
|
||||
Aggregation Builder.
|
||||
|
||||
[float]
|
||||
[[preview-canvas]]
|
||||
|
|
|
@ -6,7 +6,11 @@ Elasticsearch documentation for that aggregation.
|
|||
|
||||
*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.
|
||||
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
|
||||
intervals in the histogram.
|
||||
|
@ -17,7 +21,7 @@ a range.
|
|||
that are within a range of dates that you specify. You can specify the ranges for the dates using
|
||||
{ref}/mapping-date-format.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
|
||||
*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
|
||||
remove a range.
|
||||
*Terms*:: A {ref}/search-aggregations-bucket-terms-aggregation.html[_terms_] aggregation enables you to specify the top
|
||||
|
|