Skip to content

Commit

Permalink
[DOCS] Updates to heat map page (elastic#55097)
Browse files Browse the repository at this point in the history
  • Loading branch information
KOTungseth committed Jan 21, 2020
1 parent ce34962 commit c033c45
Show file tree
Hide file tree
Showing 9 changed files with 212 additions and 151 deletions.
43 changes: 32 additions & 11 deletions docs/user/visualize.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -3,9 +3,9 @@

[partintro]
--
_Visualize_ enables you to create visualizations of the data from your Elasticsearch indices, which you can then add to dashboards for analysis.
_Visualize_ enables you to create visualizations of the data from your {es} indices, which you can then add to dashboards for analysis.

{kib} visualizations are based on Elasticsearch queries. By using a series of {es} {ref}/search-aggregations.html[aggregations] to extract and process your data, you can create charts that show you the trends, spikes, and dips you need to know about.
{kib} visualizations are based on {es} queries. By using a series of {es} {ref}/search-aggregations.html[aggregations] to extract and process your data, you can create charts that show you the trends, spikes, and dips you need to know about.

[float]
[[create-a-visualization]]
Expand All @@ -15,52 +15,72 @@ _Visualize_ enables you to create visualizations of the data from your Elasticse
. Click *Create new visualization*.
. Choose the visualization type:
+
* *Basic charts*
<<lens,Lens>>:: Quickly build several types of basic visualizations by simply dragging and dropping the data fields you want to display.
* Basic charts
[horizontal]
<<lens,Lens>>::
Quickly build several types of basic visualizations by simply dragging and dropping the data fields you want to display.

* *<<most-frequent,Most frequently used visualizations>>*
[horizontal]
Line&comma; area, and bar charts:: Compare different series in X/Y charts.

Pie chart:: Display each source contribution to a total.

Data table:: Flattens aggregations into table format.

Metric:: Display a single number.

Goal and gauge:: Display a number with progress indicators.
Heat maps:: Display shaded cells within a matrix.

Tag cloud:: Display words in a cloud, where the size of the word corresponds to its importance.

* *Time series optimized*
[horizontal]
<<TSVB,TSVB>>:: Visualize time series data using pipeline aggregations.

<<timelion,Timelion>>:: Compute and combine data from multiple time series
data sets.

* *Maps*
[horizontal]
<<maps, Elastic maps>>:: The most powerful way of visualizing map data in {kib}.
<<tilemap,_Coordinate map_>>:: Displays points on a map using a geohash aggregation.
<<regionmap,_Region map_>>:: Merge any structured map data onto a shape.
* *<<for-dashboard, For use in dashboards>>*
<<maps,Elastic Maps>>:: The most powerful way of visualizing map data in {kib}.

<<tilemap,Coordinate map>>:: Displays points on a map using a geohash aggregation.

<<regionmap,Region map>>:: Merge any structured map data onto a shape.

<<heatmap,Heat map>>:: Display shaded cells within a matrix.

* *<<for-dashboard,Dashboard tools>>*
[horizontal]
<<for-dashboard,Controls>>:: Provides the ability to add interactive inputs to a Dashboard.

<<for-dashboard,Markdown widget>>:: Display free-form information or instructions.

* *For developers*
[horizontal]
<<vega-graph,Vega>>:: Complete control over query and display.

. Specify a search query to retrieve the data for your visualization:
** To enter new search criteria, select the <<index-patterns, index pattern>> for the indices that
contain the data you want to visualize. This opens the visualization builder
contain the data you want to visualize. The visualization builder opens
with a wildcard query that matches all of the documents in the selected
indices.
** To build a visualization from a saved search, click the name of the saved
search you want to use. This opens the visualization builder and loads the
search you want to use. The visualization builder opens and loads the
selected query.
+
NOTE: When you build a visualization from a saved search, any subsequent
modifications to the saved search are automatically reflected in the
visualization. To disable automatic updates, you can disconnect a visualization
from the saved search.


--
include::{kib-repo-dir}/visualize/visualize_rollup_data.asciidoc[]

include::{kib-repo-dir}/visualize/aggregations.asciidoc[]

include::{kib-repo-dir}/visualize/lens.asciidoc[]

include::{kib-repo-dir}/visualize/most-frequent.asciidoc[]
Expand All @@ -70,6 +90,7 @@ include::{kib-repo-dir}/visualize/timelion.asciidoc[]

include::{kib-repo-dir}/visualize/tilemap.asciidoc[]
include::{kib-repo-dir}/visualize/regionmap.asciidoc[]
include::{kib-repo-dir}/visualize/heatmap.asciidoc[]

include::{kib-repo-dir}/visualize/for-dashboard.asciidoc[]

Expand Down
144 changes: 60 additions & 84 deletions docs/visualize/aggregations.asciidoc

Large diffs are not rendered by default.

40 changes: 40 additions & 0 deletions docs/visualize/heatmap.asciidoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,40 @@
[[heatmap]]
== Heat map

Heat maps are graphical representations of data where the individual values are represented as colors.

NOTE: Heat map has been replaced with <<maps>>, which offers more functionality and is easier to use.

[float]
[[heatmap-aggregation]]
=== Supported aggregations

Heat maps support the following aggregations:

* <<visualize-metric-aggregations,Metric>>

* <<visualize-parent-pipeline-aggregations,Parent pipeline>>

* <<visualize-sibling-pipeline-aggregations,Sibling pipeline>>

* <<visualize-bucket-aggregations,Bucket>>

[float]
[[navigate-heatmap]]
=== Change the color ranges

When only one color displays on the heat map, you might need to change the color ranges.

To specify the number of color ranges:

. Click *Options*.

. Enter the *Number of colors* to display.

To specify custom ranges:

. Click *Options*.

. Select *Use custom ranges*.

. Enter the ranges to display.
16 changes: 15 additions & 1 deletion docs/visualize/lens.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@

beta[]

*Lens* provides you with a simple and fast way to create visualizations from your Elasticsearch data. With Lens, you can:
*Lens* provides you with a simple and fast way to create visualizations from your {es} data. With Lens, you can:

* Quickly build visualizations by dragging and dropping data fields.

Expand All @@ -14,6 +14,20 @@ beta[]

* Save your visualization for use in a dashboard.

[float]
[[lens-aggregation]]
=== Supported aggregations

Lens supports the following aggregations:

* <<visualize-metric-aggregations,Metric>>

* <<visualize-parent-pipeline-aggregations,Parent pipeline>>

* <<visualize-sibling-pipeline-aggregations,Sibling pipeline>>

* <<visualize-bucket-aggregations,Bucket>>

[float]
[[drag-drop]]
=== Drag and drop
Expand Down
12 changes: 12 additions & 0 deletions docs/visualize/metric.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -2,3 +2,15 @@
=== Metric

Click the *Options* tab to display the font size slider.

[float]
[[metric-aggregation]]
==== Supported aggregations

Metric support the following aggregations:

* <<visualize-metric-aggregations,Metric>>

* <<visualize-sibling-pipeline-aggregations,Sibling pipeline>>

* <<visualize-bucket-aggregations,Bucket>>
38 changes: 24 additions & 14 deletions docs/visualize/most-frequent.asciidoc
Original file line number Diff line number Diff line change
@@ -1,30 +1,42 @@
[[most-frequent]]
== Most frequently used visualizations

The most frequently used visualizations allow you to plot aggregated data from a <<save-open-search, saved search>> or <<index-patterns, index pattern>>. They all support a single level of
Elasticsearch {es} {ref}/search-aggregations-metrics.html[metric] aggregations, and one or more
levels of {es} {ref}/search-aggregations-bucket.html[bucket] aggregations.
The most frequently used visualizations allow you to plot aggregated data from a <<save-open-search, saved search>> or <<index-patterns, index pattern>>.

The most frequently used visualizations include:

* Line, area, and bar charts
* Pie charts
* Data tables
* Metrics, goals, and gauges
* Heat maps
* Tag clouds
* Pie chart
* Data table
* Metric, goal, and gauge
* Tag cloud

[float]
[[frequently-used-viz-aggregation]]
=== Supported aggregations

The most frequently used visualizations support the following aggregations:

* <<visualize-metric-aggregations,Metric>>

* <<visualize-parent-pipeline-aggregations,Parent pipeline>>

* <<visualize-sibling-pipeline-aggregations,Sibling pipeline>>

* <<visualize-bucket-aggregations,Bucket>>
>>>>>>> 0ac60494d6... [DOCS] Updates to heat map page (#55097)

[float]
=== Configure your visualization

You configure visualizations using the default editor, which is broken into metrics and buckets, and includes a default count
metric. Each visualization supports different configurations for what the metrics and buckets
represent. For example, a bar chart allows you to add an X-axis:
You configure visualizations using the default editor. Each visualization supports different configurations of the metrics and buckets.

For example, a bar chart allows you to add an x-axis:

[role="screenshot"]
image::images/add-bucket.png["",height=478]

A common configuration for the X-axis is to use a {es} {ref}/search-aggregations-bucket-datehistogram-aggregation.html[date histogram] aggregation:
A common configuration for the x-axis is to use a {es} {ref}/search-aggregations-bucket-datehistogram-aggregation.html[date histogram] aggregation:

[role="screenshot"]
image::images/visualize-date-histogram.png[]
Expand Down Expand Up @@ -58,5 +70,3 @@ Each visualization also has its own customization options. Most visualizations a

[role="screenshot"]
image::images/color-picker.png[An array of color dots that users can select,height=267]

include::aggregations.asciidoc[]
15 changes: 8 additions & 7 deletions docs/visualize/regionmap.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -18,17 +18,18 @@ To create a region map, you configure an inner join that joins the result of an
and a reference vector file based on a shared key.

[float]
==== Data
[[region-map-aggregation]]
=== Supported aggregations

[float]
===== Metrics
Region maps support the following aggregations:

Select any of the supported _Metric_ or _Sibling Pipeline Aggregations_.
* <<visualize-metric-aggregations,Metric>>

[float]
===== Buckets
* <<visualize-sibling-pipeline-aggregations,Sibling pipeline>>

* <<visualize-bucket-aggregations,Terms bucket aggregation>>

Configure a _Terms_ aggregation. The term is the _key_ that is used to join the results to the vector data on the map.
Use the _key_ term to join the results to the vector data on the map.

[float]
==== Options
Expand Down
31 changes: 3 additions & 28 deletions docs/visualize/tilemap.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -17,36 +17,11 @@ in `kibana.yml`.
[[coordinate-map-aggregation]]
=== Supported aggregations

Coordinate maps support the metric and bucket aggregations.
Coordinate maps support the following aggregations:

[float]
===== Metric aggregations

The following metric aggregations are supported:

{ref}/search-aggregations-metrics-valuecount-aggregation.html[Count]:: Returns a raw count of
the elements in the index pattern. The default metrics aggregation for a coordinate map is *Count*.

{ref}/search-aggregations-metrics-avg-aggregation.html[Average]:: Returns the average of a numeric
field.

{ref}/search-aggregations-metrics-sum-aggregation.html[Sum]:: Returns the total sum of a numeric
field.

{ref}/search-aggregations-metrics-min-aggregation.html[Min]:: Returns the minimum value of a
numeric field.

{ref}/search-aggregations-metrics-max-aggregation.html[Max]:: Returns the maximum value of a
numeric field.

{ref}/search-aggregations-metrics-cardinality-aggregation.html[Unique Count]:: Returns
the number of unique values in a field.

[float]
[[coordinate-bucket-aggregation]]
===== Bucket aggregation
* <<visualize-metric-aggregations,Metric>>

Coordinate maps support the {ref}/search-aggregations-bucket-geohashgrid-aggregation.html[_geohash_] bucket aggregation.
* <<visualize-bucket-aggregations,Geohash Bucket aggregation>>

When you deselect *Change precision on map zoom*, the *Precision* slider appears. The *Precision* slider determines the granularity of the results displayed on the map. For details on the area specified by each precision level, refer to {ref}/search-aggregations-bucket-geohashgrid-aggregation.html#_cell_dimensions_at_the_equator[geohash grid].

Expand Down
24 changes: 18 additions & 6 deletions docs/visualize/tsvb.asciidoc
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
[[TSVB]]
== TSVB

TSVB is a time series data visualizer that allows you to use the full power of the
Elasticsearch aggregation framework. With TSVB, you can combine an infinite
TSVB is a time series data visualizer that allows you to use the full power of the
Elasticsearch aggregation framework. With TSVB, you can combine an infinite
number of aggregations to display complex data.

NOTE: In Elasticsearch version 7.3.0 and later, the time series data visualizer is now referred to as TSVB instead of Time Series Visual Builder.
Expand Down Expand Up @@ -43,6 +43,18 @@ Table:: Display data from multiple time series by defining the field group to sh
[role="screenshot"]
image:images/tsvb-table.png["Table visualization"]

[float]
[[tsvb-aggregation]]
=== Supported aggregations

TSVB supports the following aggregations:

* <<visualize-metric-aggregations,Metric>>

* <<visualize-parent-pipeline-aggregations,Parent pipeline>>

* <<visualize-sibling-pipeline-aggregations,Sibling pipeline>>

[float]
[[create-tsvb-visualization]]
=== Create TSVB visualizations
Expand All @@ -60,7 +72,7 @@ To create a single metric, add multiple data series with multiple aggregations.
. Specify the data series labels and colors.

.. Select *Data*.
+
+
If you are using the *Table* visualization, select *Columns*.

.. In the *Label* field, enter a name for the data series, which is used on legends and titles.
Expand All @@ -79,7 +91,7 @@ For series that are grouped by a term, you can specify a mustache variable of `{

.. To add another metric, click *+*.
+
When you add more than one metric, the last metric value is displayed, which is indicated by the eye icon.
When you add more than one metric, the last metric value is displayed, which is indicated by the eye icon.

. To specify the format and display options, select *Options*.

Expand All @@ -95,7 +107,7 @@ Change the data that you want to display and choose the style options for the pa

. Select *Panel options*.

. Under *Data*, specify how much of the data that you want to display in the visualization.
. Under *Data*, specify how much of the data that you want to display in the visualization.

. Under *Style*, specify how you want the visualization to look.

Expand All @@ -113,7 +125,7 @@ If you are using the Time Series visualization, add annotation data sources.
[[tsvb-enter-markdown]]
==== Enter Markdown text

Edit the source for the Markdown visualization.
Edit the source for the Markdown visualization.

. Select *Markdown*.

Expand Down

0 comments on commit c033c45

Please sign in to comment.