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.

Sign up for GitHub

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

[DOCS] Empty dashboard screen #55727

Merged
merged 3 commits into from
Jan 27, 2020
Merged

[DOCS] Empty dashboard screen #55727

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
1e0a9f3
[DOCS] AdEmpty dashboard screen redesign
KOTungseth Jan 23, 2020
4f385c6
Review comments f from Gail
KOTungseth Jan 27, 2020
704a65a
Comments from Gaiail pt 2
KOTungseth Jan 27, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Binary file added docs/images/Dashboard_add_new_visualization.png
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
156 changes: 82 additions & 74 deletions docs/user/dashboard.asciidoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,25 +4,23 @@
[partintro]
--

A {kib} _dashboard_ is a collection of visualizations, searches, and
maps, typically in real-time. Dashboards provide
at-a-glance insights into your data and enable you to drill down into details.
A _dashboard_ is a collection of visualizations, searches, and
maps, typically in real-time. Dashboards provide
at-a-glance insights into your data and enable you to drill down into details.

To start working with dashboards, click *Dashboard* in the side navigation.
With *Dashboard*, you can:

* <<dashboard-create-new-dashboard, Create a dashboard>>
* <<customizing-your-dashboard, Arrange dashboard elements>>
* <<dashboard-customize-filter, Customize time ranges>>
* <<sharing-dashboards, Share a dashboard>>
* <<import-dashboards, Import and export dashboards>>
* <<viewing-detailed-information, Inspect and edit dashboard elements>>
* Add visualizations, saved searches, and maps for side-by-side analysis

* Arrange dashboard elements to display exactly how you want

* Customize time ranges to display only the data you want

* Inspect and edit dashboard elements to find out exactly what kind of data is displayed

[role="screenshot"]
image:images/Dashboard_example.png[Example dashboard]


[float]
[[dashboard-read-only-access]]
=== [xpack]#Read only access#
Expand All @@ -32,56 +30,61 @@ then you don't have sufficient privileges to create and save dashboards. The but
dashboards are not visible. For more information, see <<xpack-security-authorization>>.

[role="screenshot"]
image::images/dashboard-read-only-badge.png[Example of Dashboard's read only access indicator in Kibana's header]
image::images/dashboard-read-only-badge.png[Example of Dashboard read only access indicator in Kibana header]

[float]
[[dashboard-getting-started]]
=== Interact with dashboards
--

[[dashboard-create-new-dashboard]]
== Create a dashboard

When you open *Dashboard*, you're presented an overview of your dashboards.
If you don't have any dashboards, you can add
To create a dashboard, you must have data indexed into {es}, an index pattern
to retrieve the data from {es}, and
visualizations, saved searches, or maps. If these don't exist, you're prompted to
add them as you create the dashboard, or you can add
<<add-sample-data, sample data sets>>,
which include pre-built dashboards.
which include pre-built dashboards.

Once you open a dashboard, you can filter the data
by entering a search query, changing the time filter, or clicking
in the visualizations, searches, and maps. If a dashboard element has a stored query,
both queries are applied.
To begin, open *Dashboard*, then click *Create new dashboard.*

--
[float]
[[dashboard-add-elements]]
=== Add elements

[[dashboard-create-new-dashboard]]
== Create a dashboard
The visualizations, saved searches, and maps are stored as elements in panels
that you can move and resize.

To create a dashboard, you must have data indexed into {es}, an index pattern
to retrieve the data from {es}, and
visualizations, saved searches, or maps. If these don't exist, you're prompted to
add them as you create the dashboard.
You can add elements from multiple indices, and the same element can appear in
multiple dashboards.

For an end-to-end example, see <<tutorial-build-dashboard, Building your own dashboard>>.
To create an element:

. Click *Create new*.
. On the *New Visualization* window, click the visualization type.
+
[role="screenshot"]
image:images/Dashboard_add_new_visualization.png[Example add new visualization to dashboard]
+
For information on how to create visualizations, see <<visualize,Visualize>>.
+
For information on how to create Maps, see <<maps,Elastic Maps>>.

To add an existing element:

. Open *Dashboard.*
. Click *Create new dashboard.*
. Click *Add*.
. Use *Add panels* to add elements to the dashboard.

. On the *Add panels* flyout, select the panel.
+
The visualizations, saved searches, and maps
are stored in panels that you can move and resize. A
menu in the upper right of the panel has options for customizing
the panel. You can add elements from
multiple indices, and the same element can appear in multiple dashboards.
When a dashboard element has a stored query,
KOTungseth marked this conversation as resolved.
Show resolved Hide resolved
both queries are applied.
+
[role="screenshot"]
image:images/Dashboard_add_visualization.png[Example add visualization to dashboard]

. When you're finished adding and arranging the panels,
*Save* the dashboard.

[float]
[[customizing-your-dashboard]]
=== Arrange dashboard elements

In *Edit* mode, you can move, resize, customize, and delete panels to suit your needs.
In *Edit* mode, you can move, resize, customize, and delete panels to suit your needs.

[[moving-containers]]
* To move a panel, click and hold the panel header and drag to the new location.
Expand All @@ -95,37 +98,64 @@ to the new dimensions.
* To delete a panel, open the panel menu and select *Delete from dashboard.* Deleting a panel from a
dashboard does *not* delete the saved visualization or search.

[float]
[[viewing-detailed-information]]
=== Inspect and edit elements

Many dashboard elements allow you to drill down into the data and requests
behind the element.

From the panel menu, select *Inspect*.
The data that displays depends on the element that you inspect.

[role="screenshot"]
image:images/Dashboard_inspect.png[Inspect in dashboard]

To open an element for editing, put the dashboard in *Edit* mode,
and then select *Edit visualization* from the panel menu. The changes you make appear in
every dashboard that uses the element.

[float]
[[dashboard-customize-filter]]
=== Customize time ranges

You can configure each visualization, saved search, and map on your dashboard
for a specific time range. For example, you might want one visualization to show
the monthly trend for CPU usage and another to show the current CPU usage.
the monthly trend for CPU usage and another to show the current CPU usage.

From the panel menu, select *Customize time range* to expose a time filter
dedicated to that panel. Panels that are not restricted by a specific
From the panel menu, select *Customize time range* to expose a time filter
dedicated to that panel. Panels that are not restricted by a specific
time range are controlled by the
global time filter.

[role="screenshot"]
image:images/time_range_per_panel.gif[Time range per dashboard panel]

[float]
[[save-dashboards]]
=== Save the dashboard

When you're finished adding and arranging the panels, save the dashboard.

. In the {kib} toolbar, click *Save*.

. Enter the dashboard *Title* and optional *Description*, then *Save* the dashboard.

[[sharing-dashboards]]
=== Share a dashboard
=== Share the dashboard

[[embedding-dashboards]]
When you've finished your dashboard, you can share it with your teammates.
Share your dashboard outside of {kib}.

From the *Share* menu, you can:

* Embed the code in a web page. Users must have Kibana access
* Embed the code in a web page. Users must have {kib} access
to view an embedded dashboard.
* Share a direct link to a {kib} dashboard
* Generate a PDF report
* Generate a PNG report

TIP: You can create a link to a dashboard by title by doing this: +
TIP: To create a link to a dashboard by title, use: +
`${domain}/${basepath?}/app/kibana#/dashboards?title=${yourdashboardtitle}`

TIP: When sharing a link to a dashboard snapshot, use the *Short URL*. Snapshot
Expand All @@ -134,29 +164,7 @@ tools. To create a short URL, you must have write access to {kib}.

[float]
[[import-dashboards]]
=== Import and export dashboards

To import and export dashboards, go to *Management > Saved Objects*. For details,
see <<managing-saved-objects, Managing saved objects>>.

[float]
[[viewing-detailed-information]]
=== Inspect and edit elements

Many dashboard elements allow you to drill down into the data and requests
behind the element. Open the menu in the upper right of the panel and select *Inspect*.
The views you see depend on the element that you inspect.

[role="screenshot"]
image:images/Dashboard_inspect.png[Inspect in dashboard]

To open an element for editing, put the dashboard in *Edit* mode,
and then select *Edit* from the panel menu. The changes you make appear in
every dashboard that uses the element.






=== Export the dashboard

To export the dashboard, go to *Management > Saved Objects*. For more information,
see <<managing-saved-objects, Managing saved objects>>.