2015-01-23 18:54:40 +01:00
[[visualize]]
2016-10-25 03:41:32 +02:00
= Visualize
2015-02-10 04:18:12 +01:00
2016-10-25 03:41:32 +02:00
[partintro]
--
2020-01-21 21:01:28 +01:00
_Visualize_ enables you to create visualizations of the data from your {es} indices, which you can then add to dashboards for analysis.
2015-02-10 04:18:12 +01:00
2020-01-21 21:01:28 +01:00
{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.
2015-02-10 04:18:12 +01:00
2020-06-12 16:39:36 +02:00
To begin, open the menu, go to *Visualize*, then click *Create visualization*.
2020-03-10 22:37:17 +01:00
2019-11-21 20:57:21 +01:00
[float]
2020-03-10 22:37:17 +01:00
[[visualization-types]]
== Types of visualizations
{kib} supports several types of visualizations.
2015-02-10 04:18:12 +01:00
2020-01-21 21:01:28 +01:00
<<lens,Lens>>::
Quickly build several types of basic visualizations by simply dragging and dropping the data fields you want to display.
2020-03-10 22:37:17 +01:00
<<most-frequent,Most frequently used visualizations>>::
2020-01-21 21:01:28 +01:00
2020-03-10 22:37:17 +01:00
* *Line, area, and bar charts* — Compares different series in X/Y charts.
2020-01-21 21:01:28 +01:00
2020-03-10 22:37:17 +01:00
* *Pie chart* — Displays each source contribution to a total.
2020-01-21 21:01:28 +01:00
2020-03-10 22:37:17 +01:00
* *Data table* — Flattens aggregations into table format.
2020-01-21 21:01:28 +01:00
2020-03-10 22:37:17 +01:00
* *Metric* — Displays a single number.
2020-01-21 21:01:28 +01:00
2020-03-10 22:37:17 +01:00
* *Goal and gauge* — Displays a number with progress indicators.
2020-01-21 21:01:28 +01:00
2020-03-10 22:37:17 +01:00
* *Tag cloud* — Displays words in a cloud, where the size of the word corresponds to its importance.
2020-01-21 21:01:28 +01:00
2020-03-10 22:37:17 +01:00
<<TSVB,TSVB>>:: Visualizes time series data using pipeline aggregations.
<<timelion,Timelion>>:: Computes and combine data from multiple time series
2016-10-25 22:32:38 +02:00
data sets.
2020-01-21 21:01:28 +01:00
2020-03-10 22:37:17 +01:00
<<visualize-maps, Maps>>::
2020-06-17 16:31:37 +02:00
* *<<maps,Maps>>* — Displays geospatial data in {kib}.
2020-03-10 22:37:17 +01:00
2020-03-11 15:25:20 +01:00
* <<heat-map,Heat map>>:: Display shaded cells within a matrix.
2020-01-21 21:01:28 +01:00
2020-03-10 22:37:17 +01:00
<<for-dashboard,Dashboard tools>>::
2020-01-21 21:01:28 +01:00
2020-03-10 22:37:17 +01:00
* *Markdown widget* — Displays free-form information or instructions.
2020-01-21 21:01:28 +01:00
2020-03-10 22:37:17 +01:00
* *Controls* — Adds interactive inputs to a dashboard.
2020-01-21 21:01:28 +01:00
2020-03-10 22:37:17 +01:00
<<vega-graph,Vega>>:: Completes control over query and display.
2019-11-21 20:57:21 +01:00
2020-03-10 22:37:17 +01:00
[float]
[[choose-your-data]]
== Choose your data
Specify a search query to retrieve the data for your visualization, or used rolled up data.
* To enter new search criteria, select the <<index-patterns, index pattern>> for the indices that
2020-01-21 21:01:28 +01:00
contain the data you want to visualize. The visualization builder opens
2016-10-25 20:14:50 +02:00
with a wildcard query that matches all of the documents in the selected
2016-10-25 22:32:38 +02:00
indices.
2020-03-10 22:37:17 +01:00
* To build a visualization from a saved search, click the name of the saved
2020-01-21 21:01:28 +01:00
search you want to use. The visualization builder opens and loads the
2016-10-25 22:32:38 +02:00
selected query.
2016-10-25 20:14:50 +02:00
+
NOTE: When you build a visualization from a saved search, any subsequent
2020-03-10 22:37:17 +01:00
modifications to the saved search are reflected in the
visualization. To disable automatic updates, delete the visualization
on the *Saved Object* page.
* To build a visualization using <<rollup-index-pattern,rolled up data>>, select
the index pattern that includes the data. Rolled up data is summarized into
time buckets that can be split into sub buckets for numeric field values or
terms. To lower granularity, use a time aggregation that uses and combines
several time buckets. For an example, refer to <<rollup-data-tutorial,Create and visualize rolled up data>>.
2016-10-25 20:14:50 +02:00
2020-01-31 18:11:07 +01:00
[float]
[[vis-inspector]]
== Inspect visualizations
Many visualizations allow you to inspect the query and data behind the visualization.
. In the {kib} toolbar, click *Inspect*.
. To download the data, click *Download CSV*, then choose one of the following options:
* *Formatted CSV* - Downloads the data in table format.
* *Raw CSV* - Downloads the data as provided.
. To view the requests for collecting data, select *Requests* from the *View*
dropdown.
[float]
[[save-visualize]]
== Save visualizations
To use your visualizations in <<dashboard, dashboards>>, you must save them.
. In the {kib} toolbar, click *Save*.
. Enter the visualization *Title* and optional *Description*, then *Save* the visualization.
To access the saved visualization, go to *Management > {kib} > Saved Objects*.
[float]
[[save-visualization-read-only-access]]
==== Read only access
When you have insufficient privileges to save visualizations, the following indicator is
displayed and the *Save* button is not visible.
For more information, refer to <<xpack-security-authorization>>.
[role="screenshot"]
image::visualize/images/read-only-badge.png[Example of Visualize's read only access indicator in Kibana's header]
[float]
[[visualize-share-options]]
== Share visualizations
When you've finished your visualization, you can share it outside of {kib}.
From the *Share* menu, you can:
* Embed the code in a web page. Users must have {kib} access
to view an embedded visualization.
* Share a direct link to a {kib} visualization.
* Generate a PDF report.
* Generate a PNG report.
2020-01-21 21:01:28 +01:00
2019-11-21 20:57:21 +01:00
--
2020-01-21 21:01:28 +01:00
include::{kib-repo-dir}/visualize/aggregations.asciidoc[]
2019-11-19 17:24:22 +01:00
include::{kib-repo-dir}/visualize/lens.asciidoc[]
2019-11-21 20:57:21 +01:00
include::{kib-repo-dir}/visualize/most-frequent.asciidoc[]
2015-03-09 06:30:42 +01:00
2019-11-21 20:57:21 +01:00
include::{kib-repo-dir}/visualize/tsvb.asciidoc[]
2020-08-11 19:22:46 +02:00
2019-11-21 20:57:21 +01:00
include::{kib-repo-dir}/visualize/timelion.asciidoc[]
2015-03-09 06:30:42 +01:00
2019-09-11 21:59:38 +02:00
include::{kib-repo-dir}/visualize/tilemap.asciidoc[]
2017-06-30 05:49:26 +02:00
2019-11-21 20:57:21 +01:00
include::{kib-repo-dir}/visualize/for-dashboard.asciidoc[]
2017-05-09 18:44:03 +02:00
2019-09-11 21:59:38 +02:00
include::{kib-repo-dir}/visualize/vega.asciidoc[]