d92010575c
* [DOCS] Adds Lens Inspector and minor edits * Update docs/user/dashboard/lens.asciidoc Co-authored-by: gchaps <33642766+gchaps@users.noreply.github.com> * Removes outdated menus and adds new visual component content * Updates with review comments * Last review comment Co-authored-by: gchaps <33642766+gchaps@users.noreply.github.com>
335 lines
11 KiB
Text
335 lines
11 KiB
Text
[[dashboard]]
|
|
= Dashboard
|
|
|
|
[partintro]
|
|
--
|
|
**_Visualize your data with dashboards._**
|
|
|
|
The best way to understand your data is to visualize it. With dashboards, you can turn your data from one or more <<index-patterns, index patterns>> into a collection of panels
|
|
that bring clarity to your data, tell a story about your data, and allow you to focus on only the data that's important to you.
|
|
|
|
[role="screenshot"]
|
|
image:images/Dashboard_example.png[Example dashboard]
|
|
|
|
Panels display your data in charts, tables, maps, and more, which allow you to compare your data side-by-side to identify patterns and connections. Dashboards support several editors you can use to create panels, and support many types of panels to display your data.
|
|
|
|
[cols="2"]
|
|
|===
|
|
|
|
| <<aggregation-reference,Editors>>
|
|
| Use the *Lens*, *TSVB*, *Vega*, and *Timelion* editors to create visualizations of your data, or create *Aggregation based* visualizations using {es} aggregations.
|
|
*Lens* is the recommended editor.
|
|
|
|
| <<maps,Maps>>
|
|
| Create beautiful displays of your geographical data.
|
|
|
|
| <<xpack-ml-anomalies,Anomaly swim lane>>
|
|
| Display the results from machine learning anomaly detection jobs.
|
|
|
|
| <<xpack-ml-anomalies,Anomaly chart>>
|
|
| Display an anomaly chart from the *Anomaly Explorer*.
|
|
|
|
| <<logs-app,Log stream>>
|
|
| Display a table of live streaming logs.
|
|
|
|
| <<add-controls,Tools>>
|
|
| Add context to your panels with <<add-text,text>>, or add dynamic filters with <<add-controls,*Controls*>>.
|
|
|
|
|===
|
|
|
|
[float]
|
|
[[create-dashboards]]
|
|
== Create dashboards
|
|
|
|
Dashboards provide you with the space where you add panels of your data.
|
|
|
|
[float]
|
|
[[dashboard-minimum-requirements]]
|
|
=== Minimum requirements
|
|
|
|
To create dashboards, you must meet the minimum requirements.
|
|
|
|
* If you need to set up {kib}, use https://www.elastic.co/cloud/elasticsearch-service/signup?baymax=docs-body&elektra=docs[our free trial].
|
|
|
|
* Make sure you have {ref}/getting-started-index.html[data indexed into {es}] and an <<index-patterns,index pattern>>.
|
|
|
|
* When the read-only indicator appears, you have insufficient privileges
|
|
to create or save dashboards, and the options to create and save dashboards are not visible. For more information,
|
|
refer to <<xpack-security-authorization,Granting access to {kib}>>.
|
|
|
|
[float]
|
|
[[open-the-dashboard]]
|
|
=== Open the dashboard
|
|
|
|
Begin with an empty dashboard, or open an existing dashboard.
|
|
|
|
. Open the main menu, then click *Dashboard*.
|
|
|
|
. On the *Dashboards* page, choose one of the following options:
|
|
|
|
* To start with an empty dashboard, click *Create dashboard*.
|
|
|
|
* To open an existing dashboard, click the dashboard *Title* you want to open.
|
|
|
|
[float]
|
|
[[create-panels-with-lens]]
|
|
=== Add panels
|
|
|
|
Create and add panels of your data to the dashboard, or add existing panels from the library.
|
|
|
|
* *Create visualization* — Opens *Lens*, the recommended editor to create visualizations of your data.
|
|
|
|
* *All types* — Select the editor to create the panel, or select the panel type you want to add to the dashboard.
|
|
|
|
* *Add from library* — Add panels from the *Visualize Library*, including search results from <<save-your-search,*Discover*>>. The search results from *Discover* are not aggregated.
|
|
+
|
|
When a panel contains a saved query, both queries are applied.
|
|
|
|
[[tsvb]]
|
|
|
|
[float]
|
|
[[save-panels]]
|
|
=== Save panels
|
|
|
|
Consider where you want to save the panel in {kib}. You can save the panel just on the dashboard you are working on, or save the panel in the *Visualize Library*.
|
|
|
|
[float]
|
|
[[save-to-visualize-library]]
|
|
==== Save to the Visualize Library
|
|
|
|
To use the panel on *Canvas* workpads and other dashboards, save the panel to the *Visualize Library*.
|
|
|
|
. Click *Save to library*.
|
|
|
|
. Enter the *Title* and add any applicable *Tags*.
|
|
|
|
. Make sure that *Add to Dashboard after saving* is selected.
|
|
|
|
. Click *Save and return*.
|
|
+
|
|
When panels are saved in the *Visualize Library*, image:dashboard/images/visualize-library-icon.png[Visualize Library icon] appears in the panel header.
|
|
|
|
[float]
|
|
[[save-to-the-dashboard]]
|
|
==== Save to the dashboard
|
|
|
|
Quickly add the panel and return to the dashboard without specifying the save options or adding the panel to the *Visualize Library*.
|
|
|
|
. Click *Save and return*.
|
|
|
|
. Add more panels to the dashboard, or specify the panel title.
|
|
|
|
.. In the panel header, click *No Title*.
|
|
|
|
.. Select *Show panel title*.
|
|
|
|
.. Enter the *Panel title*.
|
|
|
|
If you change your mind and want to add the panel to the *Visualize Library*:
|
|
|
|
. Open the panel menu, then select *More > Save to library*.
|
|
|
|
. Enter the panel title, then click *Save*.
|
|
|
|
[float]
|
|
[[add-text]]
|
|
== Add context to panels
|
|
|
|
To provide context to your dashboard panels, add *Text* panels that display important information, instructions, images, and more.
|
|
|
|
You create *Text* panels using GitHub-flavored Markdown text. For information about GitHub-flavored Markdown text, click *Help*.
|
|
|
|
. From the dashboard, click *All types*, then select *Text*.
|
|
|
|
. In the *Markdown* field, enter the text, then click *Update*.
|
|
|
|
For example, when you enter:
|
|
|
|
[role="screenshot"]
|
|
image::images/markdown_example_1.png[]
|
|
|
|
The following instructions are displayed:
|
|
|
|
[role="screenshot"]
|
|
image::images/markdown_example_2.png[]
|
|
|
|
Or when you enter:
|
|
|
|
[role="screenshot"]
|
|
image::images/markdown_example_3.png[]
|
|
|
|
The following image is displayed:
|
|
|
|
[role="screenshot"]
|
|
image::images/markdown_example_4.png[]
|
|
|
|
[float]
|
|
[[edit-panels]]
|
|
== Edit panels
|
|
|
|
To make changes to the panel, use the panel menu options.
|
|
|
|
. In the toolbar, click *Edit*.
|
|
|
|
. Open the panel menu, then use the following options:
|
|
|
|
* *Edit lens* — Opens *Lens* so you can make changes to the visualization.
|
|
|
|
* *Edit visualization* — Opens the editor so you can make changes to the panel.
|
|
+
|
|
To make changes without changing the original version, open the panel menu, then click *More > Unlink from library*.
|
|
|
|
* *Edit panel title* — Opens the *Customize panel* window to change the *Panel title*.
|
|
|
|
* *More > Replace panel* — Opens the *Visualize Library* so you can select a new panel to replace the existing panel.
|
|
|
|
* *More > Delete from dashboard* — Removes the panel from the dashboard.
|
|
+
|
|
If you want to use the panel later, make sure that you save the panel to the *Visualize Library*.
|
|
|
|
[float]
|
|
[[search-or-filter-your-data]]
|
|
== Search and filter your data
|
|
|
|
{kib} supports several ways to search your data and apply {es} filters. You can combine the filters with any panel
|
|
filter to display the data want to you see.
|
|
|
|
For more information about {kib} and {es} filters, refer to <<kibana-concepts-analysts,{kib} concepts>>.
|
|
|
|
To apply a panel-level time filter:
|
|
|
|
. Open the panel menu, then select *More > Customize time range*.
|
|
|
|
. Enter the time range you want to view, then click *Add to panel*.
|
|
|
|
[float]
|
|
[[arrange-panels]]
|
|
[[moving-containers]]
|
|
[[resizing-containers]]
|
|
== Arrange panels
|
|
|
|
To compare the data side-by-side, move and arrange the panels.
|
|
|
|
In the toolbar, click *Edit*, then use the following options:
|
|
|
|
* To move, click and hold the panel header, then drag to the new location.
|
|
|
|
* To resize, click the resize control, then drag to the new dimensions.
|
|
|
|
* To maximize to fullscreen, open the panel menu, then click *More > Maximize panel*.
|
|
|
|
[float]
|
|
[[apply-design-options]]
|
|
== Apply design options
|
|
|
|
Apply a set of design options to the entire dashboard.
|
|
|
|
In the toolbar, click *Edit > Options*, then use the following options:
|
|
|
|
* *Use margins between panels* — Specifies a margin of space between each panel.
|
|
|
|
* *Show panel titles* — Specifies the appearance of titles in the header of each panel.
|
|
|
|
* *Sync color pallettes across panels* — Specifies whether the color pallette is applied to all panels.
|
|
|
|
[float]
|
|
[[duplicate-panels]]
|
|
== Duplicate panels
|
|
|
|
To duplicate a panel and the configured functionality, use the clone and copy panel options. Cloned and copied panels replicate all of the functionality from the original panel,
|
|
including renaming, editing, and cloning.
|
|
|
|
[float]
|
|
[[clone-panels]]
|
|
=== Clone panels
|
|
|
|
Cloned panels appear next to the original panel, and move the other panels to provide a space on the dashboard.
|
|
|
|
. In the toolbar, click *Edit*.
|
|
|
|
. Open the panel menu, then select *Clone panel*.
|
|
+
|
|
When cloned panels are saved in the *Visualize Library*, image:dashboard/images/visualize-library-icon.png[Visualize Library icon] appears in the header.
|
|
|
|
[float]
|
|
[[copy-to-dashboard]]
|
|
=== Copy panels
|
|
|
|
Copy panels from one dashboard to another dashboard.
|
|
|
|
. Open the panel menu, then select *More > Copy to dashboard*.
|
|
|
|
. On the *Copy to dashboard* window, select the dashboard, then click *Copy and go to dashboard*.
|
|
|
|
[float]
|
|
[[explore-the-underlying-documents]]
|
|
== Explore the underlying documents
|
|
|
|
You can add additional interactions that allow you to open *Discover* from dashboard panels. To use the interactions, the panel must use only one index pattern.
|
|
|
|
Panel interaction:: Opens the data in *Discover* with the current dashboard filters, but does not take the filters
|
|
saved with the panel.
|
|
+
|
|
To enable panel interactions, refer to <<settings-explore-data-in-context,`xpack.discoverEnhanced.actions.exploreDataInContextMenu.enabled`>>.
|
|
+
|
|
NOTE: In {kib} 7.13 and earlier, the panel interaction is enabled by default.
|
|
|
|
Series interaction::
|
|
Opens the series data in *Discover* from inside the panel.
|
|
+
|
|
To enable series interactions, refer to <<settings-explore-data-in-chart,`xpack.discoverEnhanced.actions.exploreDataInChart.enabled`>>.
|
|
|
|
[float]
|
|
[[download-csv]]
|
|
== Download panel data
|
|
|
|
Download panel data in a CSV file. When you download visualization panels with multiple layers, each layer produces a CSV file, and the file names contain the visualization and layer index names.
|
|
|
|
. Open the panel menu, then select *Inspect*.
|
|
|
|
. Click *Download CSV*, then select the format type from the dropdown:
|
|
|
|
* *Formatted CSV* — Contains human-readable dates and numbers.
|
|
|
|
* *Unformatted* — Best used for computer use.
|
|
|
|
[float]
|
|
[[defer-loading-panels-below-the-fold]]
|
|
== Improve dashboard loading time
|
|
|
|
To improve the dashboard loading time, enable the *Defer loading panels below the fold* *Lab*, which loads the dashboard panels as they become visible on the dashboard.
|
|
|
|
. In the toolbar, click *Labs*.
|
|
+
|
|
To enable *Labs*, contact your administrator, or configure the <<advanced-options,Advanced Settings>>.
|
|
|
|
. To specify how you want to enable the lab, use the following actions:
|
|
|
|
* *{kib}* — Enables the lab in {kib}.
|
|
|
|
* *Browser* — Enables the lab for your browser, and persists after you close the browser.
|
|
|
|
* *Session* — Enables the lab for this browser session, then resets after you close the browser.
|
|
|
|
. Click *Close*.
|
|
|
|
[float]
|
|
[[share-the-dashboard]]
|
|
== Share dashboards
|
|
|
|
To share the dashboard with a larger audience, click *Share* in the toolbar. For detailed information about the sharing options, refer to <<reporting-getting-started,Reporting>>.
|
|
|
|
[float]
|
|
[[import-dashboards]]
|
|
== Export dashboards
|
|
|
|
To automate {kib}, you can export dashboards as NDJSON using the <<saved-objects-api-export, Export objects API>>. It is important to export dashboards with all necessary references.
|
|
|
|
--
|
|
include::tutorial-create-a-dashboard-of-lens-panels.asciidoc[]
|
|
|
|
include::lens-advanced.asciidoc[]
|
|
|
|
include::create-panels-with-editors.asciidoc[]
|
|
|
|
include::make-dashboards-interactive.asciidoc[]
|