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

Adds updated doc material for the 4.1 release of Kibana #3813

Merged
merged 10 commits into from
Jun 2, 2015
13 changes: 6 additions & 7 deletions docs/access.asciidoc
Original file line number Diff line number Diff line change
@@ -1,13 +1,12 @@
[[access]]
== Accessing Kibana

Kibana is a web application that you access through port 5601. All you need to
do is point your web browser at the machine where Kibana is running and
specify the port number. For example, `localhost:5601` or `http://YOURDOMAIN.com:5601`.
Kibana is a web application that you access through port 5601. All you need to do is point your web browser at the
machine where Kibana is running and specify the port number. For example, `localhost:5601` or
`http://YOURDOMAIN.com:5601`.

When you access Kibana, the Discover page loads by default with the default index
pattern selected. The time filter is set to the last 15 minutes and the search
query is set to match-all (\*).
When you access Kibana, the Discover page loads by default with the default index pattern selected. The time filter is
set to the last 15 minutes and the search query is set to match-all (\*).

If you don't see any documents, try setting the time filter to a wider time range.
If you still don't see any results, it's possible that you don't *have* any documents.
If you still don't see any results, it's possible that you don't *have* any documents.
20 changes: 14 additions & 6 deletions docs/area.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand All @@ -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:
Expand All @@ -56,7 +61,10 @@ _silhouette_:: Displays each aggregation as variance from a central line.

Checkboxes are available to enable and disable the following behaviors:

*Smooth Lines*:: Check this box to curve the top boundary of the area from point to point.
*Set Y-Axis Extents*:: Check this box and enter values in the *y-max* and *y-min* fields to set the Y axis to specific
values.
*Scale Y-Axis to Data Bounds*:: The default Y axis bounds are zero and the maximum value returned in the data. Check
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.
*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.
20 changes: 20 additions & 0 deletions docs/autorefresh.asciidoc
Original file line number Diff line number Diff line change
@@ -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.
14 changes: 12 additions & 2 deletions docs/dashboard.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ dashboard to share or reload at a later time.
image:images/NYCTA-Dashboard.jpg[Example dashboard]

[float]
[[getting-started]]
[[dashboard-getting-started]]
=== Getting Started

You need at least one saved <<visualize, visualization>> to use a dashboard.
Expand All @@ -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
Expand All @@ -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]]
Expand Down Expand Up @@ -133,3 +139,7 @@ image:images/NYCTA-Statistics.jpg[]

Click the _Edit_ button image:images/EditVis.png[Pencil button] at the top right of a container to open the
visualization in the <<visualize,Visualize>> page.

[float]
[[dashboard-filters]]
include::filter-pinning.asciidoc[]
16 changes: 13 additions & 3 deletions docs/datatable.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -10,13 +10,23 @@ 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.
*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.
Expand Down Expand Up @@ -51,7 +61,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.

Expand All @@ -60,4 +70,4 @@ Checkboxes are available to enable and disable the following behaviors:
*Show metrics for every bucket/level*:: Check this box to display the intermediate results for each bucket aggregation.
*Show partial rows*:: Check this box to display a row even when there is no result.

NOTE: Enabling these behaviors may have a substantial effect on performance.
NOTE: Enabling these behaviors may have a substantial effect on performance.
Loading