Skip to content

Commit

Permalink
[DOCS] Dashboard: Includes Add Panel and Inspector (#20582)
Browse files Browse the repository at this point in the history
* [DOCS] Dashboard: Includes Add Panel and Inspector

* [DOCS] Dashboard: Incorporated review comments
  • Loading branch information
gchaps committed Jul 10, 2018
1 parent 4621914 commit 676c0bd
Show file tree
Hide file tree
Showing 5 changed files with 49 additions and 45 deletions.
94 changes: 49 additions & 45 deletions docs/dashboard.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -15,86 +15,90 @@ image:images/Dashboard_example.png[Example dashboard]
[[dashboard-getting-started]]
== Building a Dashboard

If you haven't yet indexed data into {es} or created an index pattern,
you'll be prompted to do so as you follow the steps for creating a dashboard.
Or, you can use one of the prebuilt sample data sets, available from the
Kibana home page.

. In the side navigation, click *Dashboard*.
. Click *Create new dashboard.*
. Click *Create new dashboard.*
. Click *Add*.

[[adding-visualizations-to-a-dashboard]]
. To add a visualization, select its name from the list of visualizations
or click *Add new visualization* to create one.
If you have a large number of visualizations, you can filter the list.
. Use *Add Panels* to add visualizations and saved searches to the dashboard.
If you have a large number of visualizations, you can filter the lists.
+
[role="screenshot"]
image:images/Dashboard_add_visualization.png[Example add visualization to dashboard]

. To add a saved search, click the *Saved Search* tab, and then select a name from the list.

[[saving-dashboards]]
. When you're finished adding and arranging the dashboard content,
go to the menu bar, click *Save*, and enter
a name. Optionally, you can store the time period specified in the time
filter by selecting *Store time with dashboard*.
. When you're finished adding and arranging the panels,
go to the menu bar and click *Save*.

. In *Save Dashboard*, enter a dashboard title and optionally a description.

By default, Kibana dashboards use a light color theme. To use a dark color theme,
click *Options* and select *Use dark theme*. To set the dark theme as the default, go
to *Management > Advanced Settings* and set `dashboard:defaultDarkTheme`
to `On`.
. To store the time period specified in the time filter, enable *Store time
with dashboard*.

. Click *Save*.

[[loading-a-saved-dashboard]]
TIP: You can import, export, and delete dashboards in *Kibana > Management >
Saved Objects > Dashboards*.
To import, export, and delete dashboards, see <<managing-saved-objects>>.

[float]
=== Changing the Color Theme ===

By default, Kibana dashboards use the light color theme. To use the dark color theme:

. Go to the menu bar and click *Edit*.
. Click *Options* in the menu bar.
. Select *Use dark theme*.

To set the dark theme as the default, go to *Management > Advanced Settings*.
Scroll down to *Dashboard* and toggle *Dark Theme* to *On*.

[[customizing-your-dashboard]]
== Arranging Dashboard Elements

The visualizations and searches in a dashboard are stored in panels that you can move,
resize, and delete. To start editing, open the dashboard and click *Edit*
in the menu bar.

[role="screenshot"]
image:images/Dashboard_Resize_Menu.png[Example dashboard]
resize, edit, and delete. To start editing, click *Edit* in the menu bar.

[[moving-containers]]
To move a panel, click and hold the
header of a panel and drag to the new location.
* To move a panel, click and hold the panel header and drag to the new location.

[[resizing-containers]]
To resize a panel, click the resize control on the lower right and drag
* To resize a panel, click the resize control on the lower right and drag
to the new dimensions.

[[removing-containers]]
Additional commands for managing the
panel and its contents are in the gear menu in the upper right.
Additional commands for managing the panel and its contents
are in the gear menu in the upper right.

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

NOTE: Deleting a panel from a
dashboard does *not* delete the saved visualization or search.

[[viewing-detailed-information]]
== Viewing Visualization Data
== Inspecting a Visualization from the Dashboard

If your visualization supports it, you can display the raw data behind
the visualization using the Expand/Collapse button.
Many visualizations allow you to inspect the data and requests behind the
visualization.

In the dashboard, expand the visualization's panel menu (or gear menu if in
*Edit* mode) and select *Inspect*.

The initial view shows the underlying data for the visualization. To view the
requests that were made for the visualization, choose *Requests* from the *View*
menu.

The views you'll see depend on the element that you inspect.

. Open the dashboard.
. Hover over the visualization and click the *Expand* button in the lower
left.
+
The underlying data is displayed in a table. You can also view
the raw Elasticsearch request, the response in JSON, and the request statistics.
These statistics show the query duration, request duration, total number
of matching records, and the index that was searched.
+
[role="screenshot"]
image:images/Dashboard_visualization_data.png[Example of visualization data]

To export the visualization data as a comma separated values
(CSV) file, click *Raw* or *Formatted* at the bottom of the data
table. *Raw* exports the response data as provided. *Formatted*
exports the response data using applicable Kibana <<managing-fields,field
formatters>>.

To return to the visualization, click the *Collapse* button in the lower left
corner.

[[sharing-dashboards]]
== Sharing a Dashboard
Expand Down
Binary file modified docs/images/Dashboard_Resize_Menu.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/images/Dashboard_add_visualization.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/images/Dashboard_example.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/images/Dashboard_visualization_data.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 676c0bd

Please sign in to comment.