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.

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] URL Drilldown #76529

Merged
merged 21 commits into from
Sep 10, 2020
Merged
Show file tree
Hide file tree
Changes from 11 commits
Commits
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
78 changes: 78 additions & 0 deletions docs/user/dashboard/dashboard-drilldown.asciidoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,78 @@
[[dashboard-drilldown]]
=== Dashboard Drilldown
Dosant marked this conversation as resolved.
Show resolved Hide resolved

The dashboard drilldown allows you to navigate from one dashboard to another dashboard.

Dosant marked this conversation as resolved.
Show resolved Hide resolved
For example, you might have a dashboard that shows the overall status of multiple data centers.
You can create a drilldown that navigates from this dashboard to a dashboard
that shows a single data center or server.

This example shows a dashboard panel that contains a pie chart with a configured dashboard drilldown:

[role="screenshot"]
image::images/drilldown_on_piechart.gif[Drilldown on pie chart that navigates to another dashboard]

[float]
[[drilldowns-example]]
==== Try it: Create a dashboard drilldown

This example shows how to create the *Host Overview* drilldown shown earlier in this doc.
Dosant marked this conversation as resolved.
Show resolved Hide resolved


*Set up the dashboards*

. Add the <<gs-get-data-into-kibana, sample web logs>> data set.

. Create a new dashboard, called `Host Overview`, and include these visualizations
from the sample data set:
+
[%hardbreaks]
*[Logs] Heatmap*
*[Logs] Visitors by OS*
*[Logs] Host, Visits, and Bytes Table*
*[Logs] Total Requests and Bytes*
+
TIP: If you don’t see data for a panel, try changing the time range.

. Open the *[Logs] Web traffic* dashboard.

. Set a search and filter.
+
[%hardbreaks]
Search: `extension.keyword:( “gz” or “css” or “deb”)`
Filter: `geo.src : CN`


*Create the drilldown*


. In the dashboard menu bar, click *Edit*.

. In *[Logs] Visitors by OS*, open the panel menu, and then select *Create drilldown*.

. Pick *Go to dashboard* action.

. Give the drilldown a name.

. Select *Host Overview* as the destination dashboard.

. Keep both filters enabled so that the drilldown carries over the global filters and date range.
+
Your input should look similar to this:
+
[role="screenshot"]
image::images/drilldown_create.png[Create drilldown with entries for drilldown name and destination]

. Click *Create drilldown.*

. Save the dashboard.
+
If you don’t save the drilldown, and then navigate away, the drilldown is lost.

. In *[Logs] Visitors by OS*, click the `win 8` slice of the pie, and then select the name of your drilldown.
+
[role="screenshot"]
image::images/drilldown_on_panel.png[Drilldown on pie chart that navigates to another dashboard]
+
You are navigated to your destination dashboard. Verify that the search query, filters,
and time range are carried over.
2 changes: 2 additions & 0 deletions docs/user/dashboard/dashboard.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -463,6 +463,8 @@ include::edit-dashboards.asciidoc[]

include::explore-dashboard-data.asciidoc[]

include::drilldowns.asciidoc[]

include::share-dashboards.asciidoc[]

include::tutorials.asciidoc[]
Expand Down
82 changes: 27 additions & 55 deletions docs/user/dashboard/drilldowns.asciidoc
Original file line number Diff line number Diff line change
@@ -1,20 +1,19 @@
[float]
[[drilldowns]]
=== Use drilldowns for dashboard actions
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This page duplicates content from other pages. I'd change it to focus on the actions. How to create the drilldown appears in the individual sections. Here is the structure that I recommend:

Use drilldowns for dashboard actions

Drilldowns, also known as custom actions, allow you to configure a workflow for analyzing and troubleshooting your data. For example, using a drilldown, you can navigate from one dashboard to another, taking the current time range, filters, and other parameters with you, so the context remains the same. You can continue your analysis from a new perspective.

Drilldowns are specific to the dashboard panel for which you create them—they are not shared across panels. A panel can have multiple drilldowns.

Drilldown actions

Drilldowns are user-configurable Kibana actions that are stored with the dashboard metadata.
Kibana provides the following types of actions:

Dashboard drilldown Navigate to a dashboard.
URL drilldown Navigate to external or internal URL.

Note: Some action types are paid commercial features, while others are free. For a comparison of the Elastic subscription levels, see the subscription page.

Code drilldowns

Third-party developers can create drilldowns. Refer to this example plugin to learn how to code drilldowns.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Updated as suggested. The only thing that gets left out in this case is general "ho to manage drilldown", but I guess this is fine.

== Use drilldowns for dashboard actions

Drilldowns, also known as custom actions, allow you to configure a
workflow for analyzing and troubleshooting your data.
Using a drilldown, you can navigate from one dashboard to another,
For example, using a drilldown, you can navigate from one dashboard to another,
taking the current time range, filters, and other parameters with you,
so the context remains the same. You can continue your analysis from a new perspective.

For example, you might have a dashboard that shows the overall status of multiple data centers.
You might have a dashboard that shows the overall status of multiple data centers.
You can create a drilldown that navigates from this dashboard to a dashboard
that shows a single data center or server.

[float]
[[how-drilldowns-work]]
==== How drilldowns work
=== How drilldowns work

Drilldowns are user-configurable {kib} actions that are stored with the
dashboard metadata. Drilldowns are specific to the dashboard panel
Expand All @@ -24,8 +23,7 @@ A panel can have multiple drilldowns.
This example shows a dashboard panel that contains a pie chart.
Typically, clicking a pie slice applies the current filter.
When a panel has a drilldown, clicking a pie slice opens a menu with
the default action and your drilldowns. Refer to the <<drilldowns-example, Try it section>>
for instructions on how to create this drilldown.
the default action and your drilldowns.

[role="screenshot"]
image::images/drilldown_on_piechart.gif[Drilldown on pie chart that navigates to another dashboard]
Expand All @@ -36,7 +34,7 @@ to learn how to code drilldowns.

[float]
[[create-manage-drilldowns]]
==== Create and manage drilldowns
=== Create and manage drilldowns

Your dashboard must be in *Edit* mode to create a drilldown.
Once a panel has at least one drilldown, the menu also includes a *Manage drilldowns* action
Expand All @@ -46,61 +44,35 @@ for editing and deleting drilldowns.
image::images/drilldown_menu.png[Panel menu with Create drilldown and Manage drilldown actions]

[float]
[[drilldowns-example]]
==== Try it: Create a drilldown

This example shows how to create the *Host Overview* drilldown shown earlier in this doc.

*Set up the dashboards*

. Add the <<gs-get-data-into-kibana, sample web logs>> data set.
[[actions]]
=== Drilldown actions

. Create a new dashboard, called `Host Overview`, and include these visualizations
from the sample data set:
+
[%hardbreaks]
*[Logs] Heatmap*
*[Logs] Visitors by OS*
*[Logs] Host, Visits, and Bytes Table*
*[Logs] Total Requests and Bytes*
+
TIP: If you don’t see data for a panel, try changing the time range.
You can pick a drilldown action:

. Open the *[Logs] Web traffic* dashboard.

. Set a search and filter.
+
[%hardbreaks]
Search: `extension.keyword:( “gz” or “css” or “deb”)`
Filter: `geo.src : CN`
[role="screenshot"]
image::images/drilldown_pick_an_action.png[Pick a drilldown action]

*Create the drilldown*
Drilldown action defines behavior of your drilldown. {kib} provides the following types of actions:

. In the dashboard menu bar, click *Edit*.
[cols="2"]
|===

. In *[Logs] Visitors by OS*, open the panel menu, and then select *Create drilldown*.
a| <<dashboard-drilldown, Dashboard drilldown>>

. Give the drilldown a name.
| Navigate to a dashboard.

. Select *Host Overview* as the destination dashboard.
a| <<url-drilldown, URL drilldown>>

. Keep both filters enabled so that the drilldown carries over the global filters and date range.
+
Your input should look similar to this:
+
[role="screenshot"]
image::images/drilldown_create.png[Create drilldown with entries for drilldown name and destination]
| Navigate to external or internal URL.

. Click *Create drilldown.*
|===

. Save the dashboard.
+
If you don’t save the drilldown, and then navigate away, the drilldown is lost.
[NOTE]
==============================================
Some action types are paid commercial features, while others are free.
For a comparison of the Elastic subscription levels,
see https://www.elastic.co/subscriptions[the subscription page].
==============================================

. In *[Logs] Visitors by OS*, click the `win 8` slice of the pie, and then select the name of your drilldown.
+
[role="screenshot"]
image::images/drilldown_on_panel.png[Drilldown on pie chart that navigates to another dashboard]
+
You are navigated to your destination dashboard. Verify that the search query, filters,
and time range are carried over.
include::dashboard-drilldown.asciidoc[]
include::url-drilldown.asciidoc[]
2 changes: 0 additions & 2 deletions docs/user/dashboard/explore-dashboard-data.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -16,5 +16,3 @@ The data that displays depends on the element that you inspect.
image:images/Dashboard_inspect.png[Inspect in dashboard]

include::explore-underlying-data.asciidoc[]

include::drilldowns.asciidoc[]
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading