Skip to content

Commit

Permalink
Merge branch 'master' of github.com:elastic/kibana into apm-api-test-…
Browse files Browse the repository at this point in the history
…ml-anomalies
  • Loading branch information
cauemarcondes committed Sep 10, 2020
2 parents f956173 + ad62fa0 commit 30abf62
Show file tree
Hide file tree
Showing 35 changed files with 486 additions and 89,240 deletions.
76 changes: 76 additions & 0 deletions docs/user/dashboard/dashboard-drilldown.asciidoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,76 @@
[[dashboard-drilldown]]
=== Dashboard drilldown

The dashboard drilldown allows you to navigate from one dashboard to another dashboard.
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

Create the *Host Overview* drilldown shown above.

*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 @@ -495,6 +495,8 @@ include::edit-dashboards.asciidoc[]

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

include::drilldowns.asciidoc[]

include::share-dashboards.asciidoc[]

include::tutorials.asciidoc[]
Expand Down
111 changes: 28 additions & 83 deletions docs/user/dashboard/drilldowns.asciidoc
Original file line number Diff line number Diff line change
@@ -1,106 +1,51 @@
[float]
[[drilldowns]]
=== Use drilldowns for dashboard actions
== 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 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

Drilldowns are user-configurable {kib} actions that are stored with the
dashboard metadata. Drilldowns are specific to the dashboard panel
for which you create them&mdash;they are not shared across panels.
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.

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

Third-party developers can create drilldowns.
Refer to https://github.com/elastic/kibana/tree/master/x-pack/examples/ui_actions_enhanced_examples[this example plugin]
to learn how to code drilldowns.

[float]
[[create-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
for editing and deleting drilldowns.

[role="screenshot"]
image::images/drilldown_menu.png[Panel menu with Create drilldown and Manage drilldown actions]
Drilldowns are specific to the dashboard panel for which you create them—they are not shared across panels. A panel can have multiple drilldowns.

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

This example shows how to create the *Host Overview* drilldown shown earlier in this doc.
[[actions]]
=== Drilldown actions

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

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

. 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.
a| <<dashboard-drilldown, Dashboard drilldown>>

. Open the *[Logs] Web traffic* dashboard.
| Navigate to a dashboard.

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

*Create the drilldown*
| Navigate to external or internal URL.

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

. In *[Logs] Visitors by OS*, open the panel menu, and then select *Create drilldown*.
[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].
==============================================

. 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.*
[float]
[[code-drilldowns]]
=== Code drilldowns
Third-party developers can create drilldowns.
Refer to {kib-repo}blob/{branch}/x-pack/examples/ui_actions_enhanced_examples[this example plugin]
to learn how to code drilldowns.

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

. 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: 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

0 comments on commit 30abf62

Please sign in to comment.