Skip to content

Commit 00bdc3b

Browse files
committed
Merge branch 'master' into ml-transforms-api-tests
2 parents 221c920 + 8ad4784 commit 00bdc3b

File tree

50 files changed

+611
-89262
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

50 files changed

+611
-89262
lines changed
Lines changed: 76 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,76 @@
1+
[[dashboard-drilldown]]
2+
=== Dashboard drilldown
3+
4+
The dashboard drilldown allows you to navigate from one dashboard to another dashboard.
5+
For example, you might have a dashboard that shows the overall status of multiple data centers.
6+
You can create a drilldown that navigates from this dashboard to a dashboard
7+
that shows a single data center or server.
8+
9+
This example shows a dashboard panel that contains a pie chart with a configured dashboard drilldown:
10+
11+
[role="screenshot"]
12+
image::images/drilldown_on_piechart.gif[Drilldown on pie chart that navigates to another dashboard]
13+
14+
[float]
15+
[[drilldowns-example]]
16+
==== Try it: Create a dashboard drilldown
17+
18+
Create the *Host Overview* drilldown shown above.
19+
20+
*Set up the dashboards*
21+
22+
. Add the <<gs-get-data-into-kibana, sample web logs>> data set.
23+
24+
. Create a new dashboard, called `Host Overview`, and include these visualizations
25+
from the sample data set:
26+
+
27+
[%hardbreaks]
28+
*[Logs] Heatmap*
29+
*[Logs] Visitors by OS*
30+
*[Logs] Host, Visits, and Bytes Table*
31+
*[Logs] Total Requests and Bytes*
32+
+
33+
TIP: If you don’t see data for a panel, try changing the time range.
34+
35+
. Open the *[Logs] Web traffic* dashboard.
36+
37+
. Set a search and filter.
38+
+
39+
[%hardbreaks]
40+
Search: `extension.keyword:( “gz” or “css” or “deb”)`
41+
Filter: `geo.src : CN`
42+
43+
44+
*Create the drilldown*
45+
46+
47+
. In the dashboard menu bar, click *Edit*.
48+
49+
. In *[Logs] Visitors by OS*, open the panel menu, and then select *Create drilldown*.
50+
51+
. Pick *Go to dashboard* action.
52+
53+
. Give the drilldown a name.
54+
55+
. Select *Host Overview* as the destination dashboard.
56+
57+
. Keep both filters enabled so that the drilldown carries over the global filters and date range.
58+
+
59+
Your input should look similar to this:
60+
+
61+
[role="screenshot"]
62+
image::images/drilldown_create.png[Create drilldown with entries for drilldown name and destination]
63+
64+
. Click *Create drilldown.*
65+
66+
. Save the dashboard.
67+
+
68+
If you don’t save the drilldown, and then navigate away, the drilldown is lost.
69+
70+
. In *[Logs] Visitors by OS*, click the `win 8` slice of the pie, and then select the name of your drilldown.
71+
+
72+
[role="screenshot"]
73+
image::images/drilldown_on_panel.png[Drilldown on pie chart that navigates to another dashboard]
74+
+
75+
You are navigated to your destination dashboard. Verify that the search query, filters,
76+
and time range are carried over.

docs/user/dashboard/dashboard.asciidoc

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -495,6 +495,8 @@ include::edit-dashboards.asciidoc[]
495495

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

498+
include::drilldowns.asciidoc[]
499+
498500
include::share-dashboards.asciidoc[]
499501

500502
include::tutorials.asciidoc[]
Lines changed: 28 additions & 83 deletions
Original file line numberDiff line numberDiff line change
@@ -1,106 +1,51 @@
1-
[float]
21
[[drilldowns]]
3-
=== Use drilldowns for dashboard actions
2+
== Use drilldowns for dashboard actions
43

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

11-
For example, you might have a dashboard that shows the overall status of multiple data centers.
12-
You can create a drilldown that navigates from this dashboard to a dashboard
13-
that shows a single data center or server.
14-
15-
[float]
16-
[[how-drilldowns-work]]
17-
==== How drilldowns work
18-
19-
Drilldowns are user-configurable {kib} actions that are stored with the
20-
dashboard metadata. Drilldowns are specific to the dashboard panel
21-
for which you create them&mdash;they are not shared across panels.
22-
A panel can have multiple drilldowns.
23-
24-
This example shows a dashboard panel that contains a pie chart.
25-
Typically, clicking a pie slice applies the current filter.
26-
When a panel has a drilldown, clicking a pie slice opens a menu with
27-
the default action and your drilldowns. Refer to the <<drilldowns-example, Try it section>>
28-
for instructions on how to create this drilldown.
29-
3010
[role="screenshot"]
3111
image::images/drilldown_on_piechart.gif[Drilldown on pie chart that navigates to another dashboard]
3212

33-
Third-party developers can create drilldowns.
34-
Refer to https://github.com/elastic/kibana/tree/master/x-pack/examples/ui_actions_enhanced_examples[this example plugin]
35-
to learn how to code drilldowns.
36-
37-
[float]
38-
[[create-manage-drilldowns]]
39-
==== Create and manage drilldowns
40-
41-
Your dashboard must be in *Edit* mode to create a drilldown.
42-
Once a panel has at least one drilldown, the menu also includes a *Manage drilldowns* action
43-
for editing and deleting drilldowns.
44-
45-
[role="screenshot"]
46-
image::images/drilldown_menu.png[Panel menu with Create drilldown and Manage drilldown actions]
13+
Drilldowns are specific to the dashboard panel for which you create them—they are not shared across panels. A panel can have multiple drilldowns.
4714

4815
[float]
49-
[[drilldowns-example]]
50-
==== Try it: Create a drilldown
51-
52-
This example shows how to create the *Host Overview* drilldown shown earlier in this doc.
16+
[[actions]]
17+
=== Drilldown actions
5318

54-
*Set up the dashboards*
19+
Drilldowns are user-configurable {kib} actions that are stored with the dashboard metadata.
20+
Kibana provides the following types of actions:
5521

56-
. Add the <<gs-get-data-into-kibana, sample web logs>> data set.
22+
[cols="2"]
23+
|===
5724

58-
. Create a new dashboard, called `Host Overview`, and include these visualizations
59-
from the sample data set:
60-
+
61-
[%hardbreaks]
62-
*[Logs] Heatmap*
63-
*[Logs] Visitors by OS*
64-
*[Logs] Host, Visits, and Bytes Table*
65-
*[Logs] Total Requests and Bytes*
66-
+
67-
TIP: If you don’t see data for a panel, try changing the time range.
25+
a| <<dashboard-drilldown, Dashboard drilldown>>
6826

69-
. Open the *[Logs] Web traffic* dashboard.
27+
| Navigate to a dashboard.
7028

71-
. Set a search and filter.
72-
+
73-
[%hardbreaks]
74-
Search: `extension.keyword:( “gz” or “css” or “deb”)`
75-
Filter: `geo.src : CN`
29+
a| <<url-drilldown, URL drilldown>>
7630

77-
*Create the drilldown*
31+
| Navigate to external or internal URL.
7832

79-
. In the dashboard menu bar, click *Edit*.
33+
|===
8034

81-
. In *[Logs] Visitors by OS*, open the panel menu, and then select *Create drilldown*.
35+
[NOTE]
36+
==============================================
37+
Some action types are paid commercial features, while others are free.
38+
For a comparison of the Elastic subscription levels,
39+
see https://www.elastic.co/subscriptions[the subscription page].
40+
==============================================
8241

83-
. Give the drilldown a name.
84-
85-
. Select *Host Overview* as the destination dashboard.
86-
87-
. Keep both filters enabled so that the drilldown carries over the global filters and date range.
88-
+
89-
Your input should look similar to this:
90-
+
91-
[role="screenshot"]
92-
image::images/drilldown_create.png[Create drilldown with entries for drilldown name and destination]
93-
94-
. Click *Create drilldown.*
42+
[float]
43+
[[code-drilldowns]]
44+
=== Code drilldowns
45+
Third-party developers can create drilldowns.
46+
Refer to {kib-repo}blob/{branch}/x-pack/examples/ui_actions_enhanced_examples[this example plugin]
47+
to learn how to code drilldowns.
9548

96-
. Save the dashboard.
97-
+
98-
If you don’t save the drilldown, and then navigate away, the drilldown is lost.
49+
include::dashboard-drilldown.asciidoc[]
50+
include::url-drilldown.asciidoc[]
9951

100-
. In *[Logs] Visitors by OS*, click the `win 8` slice of the pie, and then select the name of your drilldown.
101-
+
102-
[role="screenshot"]
103-
image::images/drilldown_on_panel.png[Drilldown on pie chart that navigates to another dashboard]
104-
+
105-
You are navigated to your destination dashboard. Verify that the search query, filters,
106-
and time range are carried over.

docs/user/dashboard/explore-dashboard-data.asciidoc

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -16,5 +16,3 @@ The data that displays depends on the element that you inspect.
1616
image:images/Dashboard_inspect.png[Inspect in dashboard]
1717

1818
include::explore-underlying-data.asciidoc[]
19-
20-
include::drilldowns.asciidoc[]
34.9 KB
Loading
22.6 KB
Loading
720 KB
Loading
34.9 KB
Loading
43.5 KB
Loading
29.7 KB
Loading

0 commit comments

Comments
 (0)