Skip to content

Commit 090fdba

Browse files
Merge branch 'master' into import-export-doc
2 parents 4b37585 + 835964b commit 090fdba

File tree

48 files changed

+5370
-305
lines changed

Some content is hidden

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

48 files changed

+5370
-305
lines changed

CONTRIBUTING.md

Lines changed: 11 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -661,18 +661,23 @@ To build the docs, you must clone the [elastic/docs](https://github.com/elastic/
661661
repo as a sibling of your kibana repo. Follow the instructions in that project's
662662
README for getting the docs tooling set up.
663663

664-
**To build the docs and open them in your browser:**
664+
**To build the Kibana docs and open them in your browser:**
665+
666+
```bash
667+
./docs/build_docs --doc kibana/docs/index.asciidoc --chunk 1 --open
668+
```
669+
or
665670

666671
```bash
667672
node scripts/docs.js --open
668673
```
669674

670-
### Release Notes Process
675+
### Release Notes process
671676

672677
Part of this process only applies to maintainers, since it requires access to GitHub labels.
673678

674-
Kibana publishes major, minor and patch releases periodically through the year. During this process we run a script against this repo to collect the applicable PRs against that release and generate [Release Notes](https://www.elastic.co/guide/en/kibana/current/release-notes.html).
675-
To include your change in the Release Notes:
679+
Kibana publishes [Release Notes](https://www.elastic.co/guide/en/kibana/current/release-notes.html) for major and minor releases. To generate the Release Notes, the writers run a script against this repo to collect the merged PRs against the release.
680+
To include your PRs in the Release Notes:
676681

677682
1. In the title, summarize what the PR accomplishes in language that is meaningful to the user. In general, use present tense (for example, Adds, Fixes) in sentence case.
678683
2. Label the PR with the targeted version (ex: `v7.3.0`).
@@ -681,9 +686,9 @@ To include your change in the Release Notes:
681686
* For an external-facing fix, use `release_note:fix`. Exception: docs, build, and test fixes do not go in the Release Notes. Neither fixes for issues that were only on `master` and never have been released.
682687
* For a deprecated feature, use `release_note:deprecation`.
683688
* For a breaking change, use `release_note:breaking`.
684-
* To **NOT** include your changes in the Release Notes, please use `release_note:skip`.
689+
* To **NOT** include your changes in the Release Notes, use `release_note:skip`.
685690

686-
We also produce a blog post that details more important breaking API changes every minor and major release. If the PR includes a breaking API change, apply the label `release_note:dev_docs`. Additionally add a brief summary of the break at the bottom of the PR using the format below:
691+
We also produce a blog post that details more important breaking API changes in every major and minor release. When your PR includes a breaking API change, add the `release_note:dev_docs` label, and add a brief summary of the break at the bottom of the PR using the format below:
687692

688693
```
689694
# Dev Docs
Lines changed: 108 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,108 @@
1+
[[drilldowns]]
2+
== Use drilldowns for dashboard actions
3+
4+
Drilldowns, also known as custom actions, allow you to configure a
5+
workflow for analyzing and troubleshooting your data.
6+
Using a drilldown, you can navigate from one dashboard to another,
7+
taking the current time range, filters, and other parameters with you,
8+
so the context remains the same. You can continue your analysis from a new perspective.
9+
10+
For example, you might have a dashboard that shows the overall status of multiple data centers.
11+
You can create a drilldown that navigates from this dashboard to a dashboard
12+
that shows a single data center or server.
13+
14+
[float]
15+
[[how-drilldowns-work]]
16+
=== How drilldowns work
17+
18+
Drilldowns are {kib} actions that you configure and store
19+
in the dashboard saved object. Drilldowns are specific to the dashboard panel
20+
for which you create them—they are not shared across panels.
21+
A panel can have multiple drilldowns.
22+
23+
This example shows a dashboard panel that contains a pie chart.
24+
Typically, clicking a pie slice applies the current filter.
25+
When a panel has a drilldown, clicking a pie slice opens a menu with
26+
the default action and your drilldowns. Refer to the <<drilldowns-example, Try it section>>
27+
for instructions on how to create this drilldown.
28+
29+
[role="screenshot"]
30+
image::images/drilldown_on_piechart.gif[Drilldown on pie chart that navigates to another dashboard]
31+
32+
Third-party developers can create drilldowns.
33+
Refer to https://github.com/elastic/kibana/tree/master/x-pack/examples/ui_actions_enhanced_examples[this example plugin]
34+
to learn how to code drilldowns.
35+
36+
[float]
37+
[[create-manage-drilldowns]]
38+
=== Create and manage drilldowns
39+
40+
Your dashboard must be in *Edit* mode to create a drilldown.
41+
Once a panel has at least one drilldown, the menu also includes a *Manage drilldowns* action
42+
for editing and deleting drilldowns.
43+
44+
[role="screenshot"]
45+
image::images/drilldown_menu.png[Panel menu with Create drilldown and Manage drilldown actions]
46+
47+
[float]
48+
[[drilldowns-example]]
49+
=== Try it: Create a drilldown
50+
51+
This example shows how to create the *Host Overview* drilldown shown earlier in this doc.
52+
53+
[float]
54+
==== Set up the dashboards
55+
56+
. Add the <<get-data-in, sample web logs>> data set.
57+
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.
68+
69+
. Open the *[Logs] Web traffic* dashboard.
70+
71+
. Set a search and filter.
72+
+
73+
[%hardbreaks]
74+
Search: `extension.keyword:( “gz” or “css” or “deb”)`
75+
Filter: `geo.src : CN`
76+
77+
[float]
78+
==== Create the drilldown
79+
80+
81+
. In the dashboard menu bar, click *Edit*.
82+
83+
. In *[Logs] Visitors by OS*, open the panel menu, and then select *Create drilldown*.
84+
85+
. Give the drilldown a name.
86+
87+
. Select *Host Overview* as the destination dashboard.
88+
89+
. Keep both filters enabled so that the drilldown carries over the global filters and date range.
90+
+
91+
Your input should look similar to this:
92+
+
93+
[role="screenshot"]
94+
image::images/drilldown_create.png[Create drilldown with entries for drilldown name and destination]
95+
96+
. Click *Create drilldown.*
97+
98+
. Save the dashboard.
99+
+
100+
If you don’t save the drilldown, and then navigate away, the drilldown is lost.
101+
102+
. In *[Logs] Visitors by OS*, click the `win 8` slice of the pie, and then select the name of your drilldown.
103+
+
104+
[role="screenshot"]
105+
image::images/drilldown_on_panel.png[Drilldown on pie chart that navigates to another dashboard]
106+
+
107+
You are navigated to your destination dashboard. Verify that the search query, filters,
108+
and time range are carried over.
85.6 KB
Loading
52.2 KB
Loading
40.6 KB
Loading
856 KB
Loading

docs/settings/telemetry-settings.asciidoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ See our https://www.elastic.co/legal/privacy-statement[Privacy Statement] to lea
2929
| Set to `'server'` to report the cluster statistics from the {kib} server.
3030
If the server fails to connect to our endpoint at https://telemetry.elastic.co/, it assumes
3131
it is behind a firewall and falls back to `'browser'` to send it from users' browsers
32-
when they are navigating through {kib}. Defaults to 'browser'.
32+
when they are navigating through {kib}. Defaults to `'server'`.
3333

3434
| `telemetry.optIn`
3535
| Set to `true` to automatically opt into reporting cluster statistics. You can also opt out through

docs/user/alerting/action-types/pre-configured-connectors.asciidoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ two out-of-the box connectors: <<slack-action-type, Slack>> and <<webhook-action
2828
my-slack1: <1>
2929
actionTypeId: .slack <2>
3030
name: 'Slack #xyz' <3>
31-
config: <4>
31+
secrets: <4>
3232
webhookUrl: 'https://hooks.slack.com/services/abcd/efgh/ijklmnopqrstuvwxyz'
3333
webhook-service:
3434
actionTypeId: .webhook

docs/user/dashboard.asciidoc

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -159,6 +159,8 @@ When you're finished adding and arranging the panels, save the dashboard.
159159

160160
. Enter the dashboard *Title* and optional *Description*, then *Save* the dashboard.
161161

162+
include::{kib-repo-dir}/drilldowns/drilldowns.asciidoc[]
163+
162164
[[sharing-dashboards]]
163165
== Share the dashboard
164166

src/plugins/telemetry/server/config.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -56,7 +56,7 @@ export const configSchema = schema.object({
5656
})
5757
),
5858
sendUsageFrom: schema.oneOf([schema.literal('server'), schema.literal('browser')], {
59-
defaultValue: 'browser',
59+
defaultValue: 'server',
6060
}),
6161
});
6262

0 commit comments

Comments
 (0)