From e39929d0354c7d0363ea011f8a1dfd114c3d0010 Mon Sep 17 00:00:00 2001 From: Paul Echeverri Date: Sun, 8 Mar 2015 22:30:42 -0700 Subject: [PATCH] Updates to add Visualize Reference material. --- docs/access.asciidoc | 4 +- docs/area.asciidoc | 62 ++++++++++++++++++++++++++++ docs/datatable.asciidoc | 63 ++++++++++++++++++++++++++++ docs/index.asciidoc | 2 +- docs/line.asciidoc | 35 ++++++++++++++++ docs/markdown.asciidoc | 7 ++++ docs/metric.asciidoc | 24 +++++++++++ docs/pie.asciidoc | 68 ++++++++++++++++++++++++++++++ docs/production.asciidoc | 7 +--- docs/setup.asciidoc | 2 +- docs/tilemap.asciidoc | 75 ++++++++++++++++++++++++++++++++++ docs/vertbar.asciidoc | 47 +++++++++++++++++++++ docs/visualize-config.asciidoc | 20 +++++++++ docs/visualize.asciidoc | 32 +++++++++++++-- docs/x-axis-aggs.asciidoc | 29 +++++++++++++ docs/y-axis-aggs.asciidoc | 18 ++++++++ 16 files changed, 482 insertions(+), 13 deletions(-) create mode 100644 docs/area.asciidoc create mode 100644 docs/datatable.asciidoc create mode 100644 docs/line.asciidoc create mode 100644 docs/markdown.asciidoc create mode 100644 docs/metric.asciidoc create mode 100644 docs/pie.asciidoc create mode 100644 docs/tilemap.asciidoc create mode 100644 docs/vertbar.asciidoc create mode 100644 docs/visualize-config.asciidoc create mode 100644 docs/x-axis-aggs.asciidoc create mode 100644 docs/y-axis-aggs.asciidoc diff --git a/docs/access.asciidoc b/docs/access.asciidoc index 3b57d7ab3904..79752faa0040 100644 --- a/docs/access.asciidoc +++ b/docs/access.asciidoc @@ -7,7 +7,7 @@ specify the port number. For example, `localhost:5601` or `http://YOURDOMAIN.com 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 (*). +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. \ No newline at end of file diff --git a/docs/area.asciidoc b/docs/area.asciidoc new file mode 100644 index 000000000000..a9495a91e665 --- /dev/null +++ b/docs/area.asciidoc @@ -0,0 +1,62 @@ +[[areach]] +=== Area Charts + +This chart's Y axis is the _metrics_ axis. The following aggregations are available for this axis: + +*Count*:: The {ref}/search-aggregations-metrics-valuecount-aggregation.html[_count_] aggregation returns a raw count of +the elements in the selected index pattern. +*Average*:: This aggregation returns the {ref}/search-aggregations-metrics-avg-aggregation.html[_average_] of a numeric +field. Select a field from the drop-down. +*Sum*:: The {ref}/search-aggregations-metrics-sum-aggregation.html[_sum_] aggregation returns the total sum of a numeric +field. Select a field from the drop-down. +*Min*:: The {ref}/search-aggregations-metrics-min-aggregation.html[_min_] aggregation returns the minimum value of a +numeric field. Select a field from the drop-down. +*Max*:: The {ref}/search-aggregations-metrics-max-aggregation.html[_max_] aggregation returns the maximum value of a +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. + +You can add an aggregation by clicking the *+ Add Aggregation* 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 +priority of the incident-reporting aggregation to show the most active dates first. The chronological order might show +a time-dependent pattern in incident count, and sorting by active dates can reveal particular outliers in your data. + +You can click the *Advanced* link to display more customization options for your metrics or bucket aggregation: + +*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: + +[source,shell] +{ "script" : "doc['grade'].value * 1.2" } + +NOTE: In Elasticsearch releases 1.4.3 and later, this functionality requires you to enable +{ref}/modules-scripting[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: + +*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: + +_stacked_:: Stacks the aggregations on top of each other. +_overlap_:: The aggregations overlap, with translucency indicating areas of overlap. +_wiggle_:: Displays the aggregations as a https://en.wikipedia.org/wiki/Streamgraph[streamgraph]. +_percentage_:: Displays each aggregation as a proportion of the total. +_silhouette_:: Displays each aggregation as variance from a central line. + +Checkboxes are available to enable and disable the following behaviors: + +*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. \ No newline at end of file diff --git a/docs/datatable.asciidoc b/docs/datatable.asciidoc new file mode 100644 index 000000000000..b54ac898f790 --- /dev/null +++ b/docs/datatable.asciidoc @@ -0,0 +1,63 @@ +[[datatable]] +=== Data Table + +include::y-axis-aggs.asciidoc[] + +The rows of the data table are called _buckets_. You can define buckets to split the table into rows or to split +the table into additional tables. + +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. +*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. +*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. +You can specify a filter as a query string or in JSON format, just as in the Discover search bar. Click *Add Filter* to +add another filter. +*Significant Terms*:: Displays the results of the experimental +{ref}/search-aggregations-bucket-significantterms-aggregation.html[_significant terms_] aggregation. The value of the +*Size* parameter defines the number of entries this aggregation returns. +*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. + +You can use the up or down arrows to the right of the aggregation's type to change the aggregation's priority. + +You can click the *Advanced* link to display more customization options for your metrics or bucket aggregation: + +*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: + +[source,shell] +{ "script" : "doc['grade'].value * 1.2" } + +NOTE: In Elasticsearch releases 1.4.3 and later, this functionality requires you to enable +{ref}/modules-scripting[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: + +*Per Page*:: This field controls the pagination of the table. The default value is ten rows per page. + +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. \ No newline at end of file diff --git a/docs/index.asciidoc b/docs/index.asciidoc index 7c597e6eb5b0..98903aeb9cd5 100644 --- a/docs/index.asciidoc +++ b/docs/index.asciidoc @@ -19,4 +19,4 @@ include::settings.asciidoc[] include::production.asciidoc[] -include::whats-new.asciidoc[] +include::whats-new.asciidoc[] \ No newline at end of file diff --git a/docs/line.asciidoc b/docs/line.asciidoc new file mode 100644 index 000000000000..31156cedc1fd --- /dev/null +++ b/docs/line.asciidoc @@ -0,0 +1,35 @@ +[[linech]] +=== Line Charts + +This chart's Y axis is the _metrics_ axis. The following aggregations are available for this axis: + +include::y-axis-aggs.asciidoc[] + +Before you choose a buckets aggregation, specify if you are splitting slices within a single chart or splitting into +multiple charts. A multiple chart split must run before any other aggregations. When you split a chart, you can change +if the splits are displayed in a row or a column by clicking the *Rows | Columns* selector. + +include::x-axis-aggs.asciidoc[] + +You can click the *Advanced* link to display more customization options for your metrics or bucket aggregation: + +*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: + +[source,shell] +{ "script" : "doc['grade'].value * 1.2" } + +NOTE: In Elasticsearch releases 1.4.3 and later, this functionality requires you to enable +{ref}/modules-scripting[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: + +*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. \ No newline at end of file diff --git a/docs/markdown.asciidoc b/docs/markdown.asciidoc new file mode 100644 index 000000000000..0d2a0610ae79 --- /dev/null +++ b/docs/markdown.asciidoc @@ -0,0 +1,7 @@ +[[mdwidget]] +=== Markdown Widget + +The Markdown widget is a text entry field that accepts GitHub-flavored Markdown text. Kibana renders the text you enter +in this field and displays the results on the dashboard. You can click the *Help* link to go to the +https://help.github.com/articles/github-flavored-markdown/[help page] for GitHub flavored Markdown. Click *Apply* to +display the rendered text in the Preview pane or *Discard* to revert to a previous version. \ No newline at end of file diff --git a/docs/metric.asciidoc b/docs/metric.asciidoc new file mode 100644 index 000000000000..5ecbb4cd854a --- /dev/null +++ b/docs/metric.asciidoc @@ -0,0 +1,24 @@ +[[metricch]] +=== Metric + +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: + +[source,shell] +{ "script" : "doc['grade'].value * 1.2" } + +NOTE: In Elasticsearch releases 1.4.3 and later, this functionality requires you to enable +{ref}/modules-scripting[dynamic Groovy scripting]. + +The availability of these options varies depending on the aggregation you choose. + +Click *view options* to change the font used to display the metrics. \ No newline at end of file diff --git a/docs/pie.asciidoc b/docs/pie.asciidoc new file mode 100644 index 000000000000..44f3edba4dd9 --- /dev/null +++ b/docs/pie.asciidoc @@ -0,0 +1,68 @@ +[[piech]] +=== Pie Charts + +The slice size of a pie chart is determined by the _metrics_ aggregation. The following aggregations are available for +this axis: + +*Count*:: The {ref}/search-aggregations-metrics-valuecount-aggregation.html[_count_] aggregation returns a raw count of +the elements in the selected index pattern. +*Sum*:: The {ref}/search-aggregations-metrics-sum-aggregation.html[_sum_] aggregation returns the total sum of a 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. + +The _buckets_ aggregations determine what information is being retrieved from your data set. + +Before you choose a buckets aggregation, specify if you are splitting slices within a single chart or splitting into +multiple charts. A multiple chart split must run before any other aggregations. When you split a chart, you can change +if the splits are displayed in a row or a column by clicking the *Rows | Columns* selector. + +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. +*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. +*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. +You can specify a filter as a query string or in JSON format, just as in the Discover search bar. Click *Add Filter* to +add another filter. +*Significant Terms*:: Displays the results of the experimental +{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 +types. + +When multiple aggregations are defined on a chart's axis, you can use the up or down arrows to the right of the +aggregation's type to change the aggregation's priority. + +You can click the *Advanced* link to display more customization options for your metrics or bucket aggregation: + +*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: + +[source,shell] +{ "script" : "doc['grade'].value * 1.2" } + +NOTE: In Elasticsearch releases 1.4.3 and later, this functionality requires you to enable +{ref}/modules-scripting[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: + +*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. \ No newline at end of file diff --git a/docs/production.asciidoc b/docs/production.asciidoc index 2da131424a39..bd26f62bc8bd 100644 --- a/docs/production.asciidoc +++ b/docs/production.asciidoc @@ -117,9 +117,4 @@ cluster.name: "my_cluster" -------- # The Elasticsearch instance to use for all your queries. elasticsearch_url: "http://localhost:9200" --------- - - - - - +-------- \ No newline at end of file diff --git a/docs/setup.asciidoc b/docs/setup.asciidoc index 72a1757f35a9..5f17c73f8b04 100644 --- a/docs/setup.asciidoc +++ b/docs/setup.asciidoc @@ -49,4 +49,4 @@ You're ready to dive in to your data: * Search and browse your data interactively from the <> page. * Chart and map your data from the <> page. -* Create and view custom dashboards from the <> page. +* Create and view custom dashboards from the <> page. \ No newline at end of file diff --git a/docs/tilemap.asciidoc b/docs/tilemap.asciidoc new file mode 100644 index 000000000000..02d6e30f81ca --- /dev/null +++ b/docs/tilemap.asciidoc @@ -0,0 +1,75 @@ +[[tilemap]] +=== Tile Maps + +A tile map displays a geographic area overlaid with circles keyed to the data determined by the buckets you specify. + +The default _metrics_ aggregation for a tile map is the *Count* aggregation. You can select any of the following +aggregations as the metrics aggregation: + +*Count*:: The {ref}/search-aggregations-metrics-valuecount-aggregation.html[_count_] aggregation returns a raw count of +the elements in the selected index pattern. +*Average*:: This aggregation returns the {ref}/search-aggregations-metrics-avg-aggregation.html[_average_] of a numeric +field. Select a field from the drop-down. +*Sum*:: The {ref}/search-aggregations-metrics-sum-aggregation.html[_sum_] aggregation returns the total sum of a numeric +field. Select a field from the drop-down. +*Min*:: The {ref}/search-aggregations-metrics-min-aggregation.html[_min_] aggregation returns the minimum value of a +numeric field. Select a field from the drop-down. +*Max*:: The {ref}/search-aggregations-metrics-max-aggregation.html[_max_] aggregation returns the maximum value of a +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. + +The _buckets_ aggregations determine what information is being retrieved from your data set. + +Before you choose a buckets aggregation, specify if you are splitting the chart or displaying the buckets as *Geo +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. + +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 +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. +*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. +*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. +You can specify a filter as a query string or in JSON format, just as in the Discover search bar. Click *Add Filter* to +add another filter. +*Significant Terms*:: Displays the results of the experimental +{ref}/search-aggregations-bucket-significantterms-aggregation.html[_significant terms_] aggregation. The value of the +*Size* parameter defines the number of entries this aggregation returns. +*Geohash*:: The {ref}/search-aggregations-bucket-geohashgrid-aggregation.html[_geohash_] aggregation displays points +based on the geohash coordinates. + +You can click the *Advanced* link to display more customization options for your metrics or bucket aggregation: + +*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: + +[source,shell] +{ "script" : "doc['grade'].value * 1.2" } + +NOTE: In Elasticsearch releases 1.4.3 and later, this functionality requires you to enable +{ref}/modules-scripting[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: + +*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. \ No newline at end of file diff --git a/docs/vertbar.asciidoc b/docs/vertbar.asciidoc new file mode 100644 index 000000000000..7e84f0924351 --- /dev/null +++ b/docs/vertbar.asciidoc @@ -0,0 +1,47 @@ +[[vertbarch]] +=== Vertical Bar Charts + +This chart's Y axis is the _metrics_ axis. The following aggregations are available for this axis: + +include::y-axis-aggs.asciidoc[] + +The _buckets_ aggregations determine what information is being retrieved from your data set. + +Before you choose a buckets aggregation, specify if you are splitting slices within a single chart or splitting into +multiple charts. A multiple chart split must run before any other aggregations. When you split a chart, you can change +if the splits are displayed in a row or a column by clicking the *Rows | Columns* selector. + +include::x-axis-aggs.asciidoc[] + +You can click the *Advanced* link to display more customization options for your metrics or bucket aggregation: + +*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: + +[source,shell] +{ "script" : "doc['grade'].value * 1.2" } + +NOTE: In Elasticsearch releases 1.4.3 and later, this functionality requires you to enable +{ref}/modules-scripting[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: + +*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: + +_stacked_:: Stacks the aggregations on top of each other. +_percentage_:: Displays each aggregation as a proportion of the total. +_grouped_:: Groups the results horizontally by the lowest-priority sub-aggregation. + +Checkboxes are available to enable and disable the following behaviors: + +*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. \ No newline at end of file diff --git a/docs/visualize-config.asciidoc b/docs/visualize-config.asciidoc new file mode 100644 index 000000000000..01505548b58b --- /dev/null +++ b/docs/visualize-config.asciidoc @@ -0,0 +1,20 @@ +[[vizconf]] +== Visualization Configuration + +This sections deals with the configuration options for visualizations in Kibana. + +include::area.asciidoc[] + +include::datatable.asciidoc[] + +include::line.asciidoc[] + +include::markdown.asciidoc[] + +include::metric.asciidoc[] + +include::pie.asciidoc[] + +include::tilemap.asciidoc[] + +include::vertbar.asciidoc[] \ No newline at end of file diff --git a/docs/visualize.asciidoc b/docs/visualize.asciidoc index fd582f54a25a..24fd51180888 100644 --- a/docs/visualize.asciidoc +++ b/docs/visualize.asciidoc @@ -9,7 +9,7 @@ data source types: * A saved search * An existing saved visualization -Visualizations are based on the {ref}/search-aggregations.html[aggregation] feature introduced in Elasticsearch 1. +Visualizations are based on the {ref}/search-aggregations.html[aggregation] feature introduced in Elasticsearch 1.x. [float] [[createvis]] @@ -23,9 +23,19 @@ button] in the toolbar to the right of the search bar. The wizard guides you thr [[newvis01]] ==== Step 1: Choose the Visualization Type -The New Visualization wizard starts with the following page: +Choose a visualization type when you start the New Visualization wizard: -image:images/NewViz01.jpg[] +[horizontal] +<>:: Use area charts to visualize the total contribution of several different series. +<>:: Use data tables to display the raw data of a composed aggregation. You can display the data +table for several other visualizations by clicking at the bottom of the visualization. +<>:: Use line charts to compare different series. +<>:: Use the Markdown widget to display free-form information or instructions about your +dashboard. +<>:: Use the metric visualization to display a single number on your dashboard. +<>:: Use pie charts to display each source's contribution to a total. +<>:: Use tile maps to associate the results of an aggregation with geographic points. +<>:: 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 @@ -124,3 +134,19 @@ To render the visualization on the _preview canvas_, click the *Apply* button at 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. + +include::area.asciidoc[] + +include::datatable.asciidoc[] + +include::line.asciidoc[] + +include::markdown.asciidoc[] + +include::metric.asciidoc[] + +include::pie.asciidoc[] + +include::tilemap.asciidoc[] + +include::vertbar.asciidoc[] \ No newline at end of file diff --git a/docs/x-axis-aggs.asciidoc b/docs/x-axis-aggs.asciidoc new file mode 100644 index 000000000000..8e108f203151 --- /dev/null +++ b/docs/x-axis-aggs.asciidoc @@ -0,0 +1,29 @@ +The X axis of this chart is the _buckets_ axis. You can define buckets for the X axis, for a split area on the +chart, or for split charts. + +This chart's X axis supports the following aggregations. Click the linked name of each aggregation to visit the main +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. +*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. +*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. +You can specify a filter as a query string or in JSON format, just as in the Discover search bar. Click *Add Filter* to +add another filter. +*Significant Terms*:: Displays the results of the experimental +{ref}/search-aggregations-bucket-significantterms-aggregation.html[_significant terms_] aggregation. + +Once you've specified an X axis aggregation, you can define sub-aggregations to refine the visualization. Click *+ Add +Sub Aggregation* to define a sub-aggregation, then choose *Split Area* or *Split Chart*, then select a sub-aggregation +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 +aggregation's type to change the aggregation's priority. \ No newline at end of file diff --git a/docs/y-axis-aggs.asciidoc b/docs/y-axis-aggs.asciidoc new file mode 100644 index 000000000000..5eb75eb8a7dc --- /dev/null +++ b/docs/y-axis-aggs.asciidoc @@ -0,0 +1,18 @@ +*Count*:: The {ref}/search-aggregations-metrics-valuecount-aggregation.html[_count_] aggregation returns a raw count of +the elements in the selected index pattern. +*Average*:: This aggregation returns the {ref}/search-aggregations-metrics-avg-aggregation.html[_average_] of a numeric +field. Select a field from the drop-down. +*Sum*:: The {ref}/search-aggregations-metrics-sum-aggregation.html[_sum_] aggregation returns the total sum of a numeric +field. Select a field from the drop-down. +*Min*:: The {ref}/search-aggregations-metrics-min-aggregation.html[_min_] aggregation returns the minimum value of a +numeric field. Select a field from the drop-down. +*Max*:: The {ref}/search-aggregations-metrics-max-aggregation.html[_max_] aggregation returns the maximum value of a +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. +*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. + +You can add an aggregation by clicking the *+ Add Aggregation* button. \ No newline at end of file