mirror of
https://github.com/elastic/kibana.git
synced 2025-04-23 17:28:26 -04:00
Adds updated doc material for the 4.1 release of Kibana, including new
aggregations, changes to the UI, and new functionality for visualizations.
This commit is contained in:
parent
c657b4f93d
commit
d23414c0e3
12 changed files with 124 additions and 32 deletions
|
@ -15,9 +15,14 @@ numeric field. Select a field from the drop-down.
|
|||
numeric field. Select a field from the drop-down.
|
||||
*Unique Count*:: The {ref}/search-aggregations-metrics-cardinality-aggregation.html[_cardinality_] aggregation returns
|
||||
the number of unique values in a field. Select a field from the drop-down.
|
||||
*Percentile*:: The {ref}/search-aggregations-metrics-percentile-rank-aggregation.html[_percentile_] aggregation returns
|
||||
the percentile rank of values in a numeric field. Select a field from the drop-down, then specify a range in the
|
||||
*Percentiles* fields. Click the *X* to remove a percentile field. Click *+ Add Percent* to add a percentile field.
|
||||
*Percentiles*:: The {ref}/search-aggregations-metrics-percentile-aggregation.html[_percentile_] aggregation divides the
|
||||
values in a numeric field into percentile bands that you specify. Select a field from the drop-down, then specify one
|
||||
or more ranges in the *Percentiles* fields. Click the *X* to remove a percentile field. Click *+ Add* to add a
|
||||
percentile field.
|
||||
*Percentile Rank*:: The {ref}/search-aggregations-metrics-percentile-rank-aggregation.html[_percentile ranks_]
|
||||
aggregation returns the percentile rankings for the values in the numeric field you specify. Select a numeric field
|
||||
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.
|
||||
|
||||
|
@ -43,7 +48,7 @@ NOTE: In Elasticsearch releases 1.4.3 and later, this functionality requires you
|
|||
|
||||
The availability of these options varies depending on the aggregation you choose.
|
||||
|
||||
Select *view options* to change the following aspects of the table:
|
||||
Select the *Options* tab to change the following aspects of the chart:
|
||||
|
||||
*Chart Mode*:: When you have multiple Y-axis aggregations defined for your chart, you can use this drop-down to affect
|
||||
how the aggregations display on the chart:
|
||||
|
@ -56,6 +61,7 @@ _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.
|
||||
*Scale Y-Axis to Data Bounds*:: The default Y axis bounds are zero and the maximum value returned in the data. Check
|
||||
|
|
|
@ -17,6 +17,13 @@ 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.
|
||||
*Date Range*:: A {ref}/search-aggregations-bucket-daterange-aggregation.html[_date range_] aggregation reports values
|
||||
that are within a range of dates that you specify. You can specify the ranges for the dates using
|
||||
{ref}/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
|
||||
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
|
||||
or bottom _n_ elements of a given field to display, ordered by count or a custom metric.
|
||||
*Filters*:: You can specify a set of {ref}/search-aggregations-bucket-filters-aggregation.html[_filters_] for the data.
|
||||
|
@ -51,7 +58,7 @@ NOTE: In Elasticsearch releases 1.4.3 and later, this functionality requires you
|
|||
|
||||
The availability of these options varies depending on the aggregation you choose.
|
||||
|
||||
Select *view options* to change the following aspects of the table:
|
||||
Select the *Options* tab to change the following aspects of the table:
|
||||
|
||||
*Per Page*:: This field controls the pagination of the table. The default value is ten rows per page.
|
||||
|
||||
|
|
|
@ -87,20 +87,16 @@ If the saved search is associated with a different index pattern than is current
|
|||
[float]
|
||||
[[select-pattern]]
|
||||
==== Changing Which Indices You're Searching
|
||||
When you submit a search request, the indices that match the currently-selected index pattern are searched. The current index pattern is shown below the search field. To change which indices you are searching, select a different index pattern.
|
||||
|
||||
To select a different index pattern:
|
||||
|
||||
. Click the *Settings* button image:images/SettingsButton.jpg[Settings
|
||||
button] in the Discover toolbar.
|
||||
. Select the pattern you want to use from the Index Pattern list.
|
||||
When you submit a search request, the indices that match the currently-selected index pattern are searched. The current
|
||||
index pattern is shown below the search field. To change which indices you are searching, click the name of the current
|
||||
index pattern to display a list of the configured index patterns and select a different index pattern.
|
||||
|
||||
For more information about index patterns, see <<settings-create-pattern, Creating an Index Pattern>>.
|
||||
|
||||
[float]
|
||||
[[auto-refresh]]
|
||||
=== Automatically Refreshing the Page
|
||||
You can configure a refresh interval to automatically refresh the Discover page with the latest
|
||||
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.
|
||||
|
|
|
@ -27,9 +27,27 @@ NOTE: In Elasticsearch releases 1.4.3 and later, this functionality requires you
|
|||
{ref}/modules-scripting.html[dynamic Groovy scripting].
|
||||
|
||||
The availability of these options varies depending on the aggregation you choose.
|
||||
Select *view options* to change the following aspects of the table:
|
||||
|
||||
Select the *Options* tab to change the following aspects of the chart:
|
||||
|
||||
*Y-Axis Scale*:: You can select *linear*, *log*, or *square root* scales for the chart's Y axis.
|
||||
*Smooth Lines*:: Check this box to curve the line from point to point.
|
||||
*Show Connecting Lines*:: Check this box to draw lines between the points on the chart.
|
||||
*Show Circles*:: Check this box to draw each data point on the chart as a small circle.
|
||||
*Show Tooltip*:: Check this box to enable the display of tooltips.
|
||||
*Show Legend*:: Check this box to enable the display of a legend next to the chart.
|
||||
*Scale Y-Axis to Data Bounds*:: The default Y axis bounds are zero and the maximum value returned in the data. Check
|
||||
this box to change both upper and lower bounds to match the values returned in the data.
|
||||
*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
|
||||
changes* button to keep your visualization in its current state.
|
||||
|
||||
[float]
|
||||
[[bubble-chart]]
|
||||
=== Bubble Charts
|
||||
You can convert a line chart visualization to a bubble chart by performing the following steps:
|
||||
|
||||
. Click *Add Metrics* for the visualization's Y axis, then select *Dot Size*.
|
||||
. Select a metric aggregation from the drop-down list.
|
||||
. In the *Options* tab, uncheck the *Show Connecting Lines* box.
|
||||
. Click the *Apply changes* button.
|
|
@ -6,10 +6,6 @@ A metric visualization displays a single number for each aggregation you select:
|
|||
include::y-axis-aggs.asciidoc[]
|
||||
You can click the *Advanced* link to display more customization options:
|
||||
|
||||
*Exclude Pattern*:: Specify a pattern in this field to exclude from the results.
|
||||
*Exclude Pattern Flags*:: A standard set of Java flags for the exclusion pattern.
|
||||
*Include Pattern*:: Specify a pattern in this field to include in the results.
|
||||
*Include Pattern Flags*:: A standard set of Java flags for the inclusion pattern.
|
||||
*JSON Input*:: A text field where you can add specific JSON-formatted properties to merge with the aggregation
|
||||
definition, as in the following example:
|
||||
|
||||
|
@ -21,4 +17,4 @@ NOTE: In Elasticsearch releases 1.4.3 and later, this functionality requires you
|
|||
|
||||
The availability of these options varies depending on the aggregation you choose.
|
||||
|
||||
Click *view options* to change the font used to display the metrics.
|
||||
Click the *Options* tab to change the font used to display the metrics.
|
|
@ -28,6 +28,13 @@ 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.
|
||||
*Date Range*:: A {ref}/search-aggregations-bucket-daterange-aggregation.html[_date range_] aggregation reports values
|
||||
that are within a range of dates that you specify. You can specify the ranges for the dates using
|
||||
{ref}/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
|
||||
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
|
||||
or bottom _n_ elements of a given field to display, ordered by count or a custom metric.
|
||||
*Filters*:: You can specify a set of {ref}/search-aggregations-bucket-filters-aggregation.html[_filters_] for the data.
|
||||
|
@ -61,8 +68,11 @@ NOTE: In Elasticsearch releases 1.4.3 and later, this functionality requires you
|
|||
|
||||
The availability of these options varies depending on the aggregation you choose.
|
||||
|
||||
Select *view options* to change the following aspects of the table:
|
||||
Select the *Options* tab to change the following aspects of the table:
|
||||
|
||||
*Donut*:: Display the chart as a sliced ring instead of a sliced pie.
|
||||
*Show Tooltip*:: Check this box to enable the display of tooltips.
|
||||
*Show Legend*:: Check this box to enable the display of a legend next to the chart.
|
||||
*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
|
||||
changes* button to keep your visualization in its current state.
|
|
@ -156,6 +156,16 @@ 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
|
||||
the *Controls* button in the rightmost column for a given field to edit the field's properties. You can manually set
|
||||
the field's format from the *Format* drop-down. Format options vary based on the field's type.
|
||||
|
||||
You can also set the field's popularity value in the *Popularity* text entry box to any desired value. Click the
|
||||
*Update Field* button to confirm your changes or *Cancel* to return to the list of fields.
|
||||
|
||||
[float]
|
||||
[[create-scripted-field]]
|
||||
=== Creating a Scripted Field
|
||||
|
@ -239,8 +249,8 @@ To set advanced options:
|
|||
. Click the *Save* button.
|
||||
|
||||
=== Managing Saved Searches, Visualizations, and Dashboards ===
|
||||
You can view, edit, and delete saved searches, visualizations,
|
||||
and dashboards from *Settings > Objects*.
|
||||
You can view, edit, and delete saved searches, visualizations, and dashboards from *Settings > Objects*. You can also
|
||||
export or import sets of searches, visualizations, and dashboards.
|
||||
|
||||
Viewing a saved object displays the selected item in the *Discover*, *Visualize*,
|
||||
or *Dashboard* page. To view a saved object:
|
||||
|
@ -282,6 +292,19 @@ To delete a saved object:
|
|||
. Click the *Delete* button.
|
||||
. Confirm that you really want to delete the object.
|
||||
|
||||
To export a set of objects:
|
||||
|
||||
. Go to *Settings > Objects*.
|
||||
. Select the type of object you want to export. You can export a set of dashboards, searches, or visualizations.
|
||||
. Click the selection box for the objects you want to export, or click the *Select All* box.
|
||||
. Click *Export* to select a location to write the exported JSON.
|
||||
|
||||
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.
|
||||
|
||||
=== Setting Kibana Server Properties
|
||||
|
||||
The Kibana server reads properties from the `kibana.yml` file on startup. The default
|
||||
|
|
|
@ -25,7 +25,10 @@ Before you choose a buckets aggregation, specify if you are splitting the chart
|
|||
Coordinates* on a single chart. A multiple chart split must run before any other aggregations.
|
||||
|
||||
Tile maps use the *Geohash* aggregation as their initial aggregation. Select a field, typically coordinates, from the
|
||||
drop-down. The *Precision* slider determines the granularity of the results displayed on the map.
|
||||
drop-down. The *Precision* slider determines the granularity of the results displayed on the map. See the documentation
|
||||
for the {ref}/search-aggregations-bucket-geohashgrid-aggregation.html#_cell_dimensions_at_the_equator[geohash grid]
|
||||
aggregation for details on the area specified by each precision level. As of the 4.1 release, Kibana supports a maximum
|
||||
geohash length of 7.
|
||||
|
||||
Once you've specified a buckets aggregation, you can define sub-aggregations to refine the visualization. Tile maps
|
||||
only support sub-aggregations as split charts. Click *+ Add Sub Aggregation*, then *Split Chart* to select a
|
||||
|
@ -40,6 +43,15 @@ 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
|
||||
changes* button to keep your visualization in its current state.
|
||||
*Date Range*:: A {ref}/search-aggregations-bucket-daterange-aggregation.html[_date range_] aggregation reports values
|
||||
that are within a range of dates that you specify. You can specify the ranges for the dates using
|
||||
{ref}/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
|
||||
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
|
||||
or bottom _n_ elements of a given field to display, ordered by count or a custom metric.
|
||||
*Filters*:: You can specify a set of {ref}/search-aggregations-bucket-filters-aggregation.html[_filters_] for the data.
|
||||
|
@ -68,8 +80,19 @@ NOTE: In Elasticsearch releases 1.4.3 and later, this functionality requires you
|
|||
|
||||
The availability of these options varies depending on the aggregation you choose.
|
||||
|
||||
Select *view options* to change the following aspects of the table:
|
||||
Select the *Options* tab to change the following aspects of the chart:
|
||||
|
||||
*Shaded Circle Markers*:: Displays the markers with different shades based on the metric aggregation's value.
|
||||
*Scaled Circle Markers*:: Scale the size of the markers based on the metric aggregation's value.
|
||||
*Desaturate Map*:: Desaturate the map's color in order to make the markers stand out more clearly.
|
||||
*Shaded Geohash Grid*:: Displays the rectangular cells of the geohash grid instead of circular markers, with different
|
||||
shades based on the metric aggregation's value.
|
||||
*Desaturate map tiles*:: Desaturate the map's color in order to make the markers stand out more clearly.
|
||||
|
||||
After changing options, click the green *Apply changes* button to update your visualization, or the grey *Discard
|
||||
changes* button to keep your visualization in its current state.
|
||||
|
||||
==== Navigating the Map
|
||||
Once your tilemap visualization is ready, you can explore the map in several ways. Click and hold anywhere on the map
|
||||
and move the cursor to move the map center. Hold Shift and drag a bounding box across the map to zoom in on the
|
||||
selection. Click the *Fit Data Bounds* button to automatically crop the map boundaries to the geohash buckets that have
|
||||
at least one result.
|
|
@ -30,7 +30,7 @@ NOTE: In Elasticsearch releases 1.4.3 and later, this functionality requires you
|
|||
|
||||
The availability of these options varies depending on the aggregation you choose.
|
||||
|
||||
Select *view options* to change the following aspects of the table:
|
||||
Select the *Options* to change the following aspects of the table:
|
||||
|
||||
*Bar Mode*:: When you have multiple Y-axis aggregations defined for your chart, you can use this drop-down to affect
|
||||
how the aggregations display on the chart:
|
||||
|
|
|
@ -91,7 +91,7 @@ Use the aggregation builder on the left of the page to configure the {ref}/searc
|
|||
visualization. Buckets are analogous to SQL `GROUP BY` statements. For more information on aggregations, see the main
|
||||
{ref}/search-aggregations.html[Elasticsearch aggregations reference].
|
||||
|
||||
In bar or line chart visualizations, use _metrics_ for the y-axis and _buckets_ are used for the x-axis, segment bar
|
||||
Bar or line chart visualizations use _metrics_ for the y-axis and _buckets_ are used for the x-axis, segment bar
|
||||
colors, and row/column splits. For pie charts, use the metric for the slice size and the bucket for the number of
|
||||
slices.
|
||||
|
||||
|
|
|
@ -13,6 +13,13 @@ 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.
|
||||
*Date Range*:: A {ref}/search-aggregations-bucket-daterange-aggregation.html[_date range_] aggregation reports values
|
||||
that are within a range of dates that you specify. You can specify the ranges for the dates using
|
||||
{ref}/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
|
||||
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
|
||||
or bottom _n_ elements of a given field to display, ordered by count or a custom metric.
|
||||
*Filters*:: You can specify a set of {ref}/search-aggregations-bucket-filters-aggregation.html[_filters_] for the data.
|
||||
|
|
|
@ -12,7 +12,13 @@ numeric field. Select a field from the drop-down.
|
|||
the number of unique values in a field. Select a field from the drop-down.
|
||||
*Standard Deviation*:: The {ref}/search-aggregations-metrics-extendedstats-aggregation.html[_extended stats_]
|
||||
aggregation returns the standard deviation of data in a numeric field. Select a field from the drop-down.
|
||||
*Percentile*:: The {ref}/search-aggregations-metrics-percentile-rank-aggregation.html[_percentile_] aggregation returns
|
||||
the percentile rank of values in a numeric field. Select a field from the drop-down, then specify a range in the *Percentiles* fields. Click the *X* to remove a percentile field. Click *+ Add Percent* to add a percentile field.
|
||||
*Percentiles*:: The {ref}/search-aggregations-metrics-percentile-aggregation.html[_percentile_] aggregation divides the
|
||||
values in a numeric field into percentile bands that you specify. Select a field from the drop-down, then specify one
|
||||
or more ranges in the *Percentiles* fields. Click the *X* to remove a percentile field. Click *+ Add* to add a
|
||||
percentile field.
|
||||
*Percentile Rank*:: The {ref}/search-aggregations-metrics-percentile-rank-aggregation.html[_percentile ranks_]
|
||||
aggregation returns the percentile rankings for the values in the numeric field you specify. Select a numeric field
|
||||
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.
|
Loading…
Add table
Add a link
Reference in a new issue