|
1 | | -[float] |
2 | 1 | [[drilldowns]] |
3 | | -=== Use drilldowns for dashboard actions |
| 2 | +== Use drilldowns for dashboard actions |
4 | 3 |
|
5 | 4 | Drilldowns, also known as custom actions, allow you to configure a |
6 | 5 | 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, |
8 | 7 | taking the current time range, filters, and other parameters with you, |
9 | 8 | so the context remains the same. You can continue your analysis from a new perspective. |
10 | 9 |
|
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—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 | | - |
30 | 10 | [role="screenshot"] |
31 | 11 | image::images/drilldown_on_piechart.gif[Drilldown on pie chart that navigates to another dashboard] |
32 | 12 |
|
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. |
47 | 14 |
|
48 | 15 | [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 |
53 | 18 |
|
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: |
55 | 21 |
|
56 | | -. Add the <<gs-get-data-into-kibana, sample web logs>> data set. |
| 22 | +[cols="2"] |
| 23 | +|=== |
57 | 24 |
|
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>> |
68 | 26 |
|
69 | | -. Open the *[Logs] Web traffic* dashboard. |
| 27 | +| Navigate to a dashboard. |
70 | 28 |
|
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>> |
76 | 30 |
|
77 | | -*Create the drilldown* |
| 31 | +| Navigate to external or internal URL. |
78 | 32 |
|
79 | | -. In the dashboard menu bar, click *Edit*. |
| 33 | +|=== |
80 | 34 |
|
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 | +============================================== |
82 | 41 |
|
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. |
95 | 48 |
|
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[] |
99 | 51 |
|
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. |
0 commit comments