Merge branch 'master' into index_pattern_server_api_2

elastic · Jun 9, 2020 · 5beadc0 · 5beadc0
2 parents f96d3c3 + a3df86d
commit 5beadc0
Show file tree

Hide file tree

Showing 471 changed files with 72,137 additions and 63,840 deletions.
diff --git a/.eslintrc.js b/.eslintrc.js
@@ -91,7 +91,6 @@ module.exports = {
     {
       files: ['x-pack/plugins/canvas/**/*.{js,ts,tsx}'],
       rules: {
-        'react-hooks/exhaustive-deps': 'off',
         'jsx-a11y/click-events-have-key-events': 'off',
       },
     },

diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -661,18 +661,23 @@ To build the docs, you must clone the [elastic/docs](https://github.com/elastic/
 repo as a sibling of your kibana repo. Follow the instructions in that project's
 README for getting the docs tooling set up.
 
-**To build the docs and open them in your browser:**
+**To build the Kibana docs and open them in your browser:**
+
+```bash
+./docs/build_docs --doc kibana/docs/index.asciidoc --chunk 1 --open
+```
+or
 
 ```bash
 node scripts/docs.js --open
 ```
 
-### Release Notes Process
+### Release Notes process
 
 Part of this process only applies to maintainers, since it requires access to GitHub labels.
 
-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).
-To include your change in the Release Notes:
+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.
+To include your PRs in the Release Notes:
 
 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.
 2. Label the PR with the targeted version (ex: `v7.3.0`).
@@ -681,9 +686,9 @@ To include your change in the Release Notes:
     * 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.
     * For a deprecated feature, use `release_note:deprecation`.
     * For a breaking change, use `release_note:breaking`.
-    * To **NOT** include your changes in the Release Notes, please use `release_note:skip`.
+    * To **NOT** include your changes in the Release Notes, use `release_note:skip`.
 
-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:
+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:
 
 ```
 # Dev Docs

diff --git a/docs/dev-tools/console/console.asciidoc b/docs/dev-tools/console/console.asciidoc
@@ -44,7 +44,7 @@ curl -XGET "http://localhost:9200/_search" -d'
 ----------------------------------
 
 When you paste the command into Console, {kib} automatically converts it
-to Console syntax.  Alternatively, if you want to want to see Console syntax in cURL, 
+to Console syntax.  Alternatively, if you want to see Console syntax in cURL, 
 click the action icon (image:dev-tools/console/images/wrench.png[]) and select *Copy as cURL*.
 
 [float]

diff --git a/docs/drilldowns/drilldowns.asciidoc b/docs/drilldowns/drilldowns.asciidoc
@@ -0,0 +1,108 @@
+[[drilldowns]]
+== 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,
+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 {kib} actions that you configure and store
+in the dashboard saved object. 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]
+
+[float]
+[[drilldowns-example]]
+=== Try it: Create a drilldown
+
+This example shows how to create the *Host Overview* drilldown shown earlier in this doc.
+
+[float]
+==== Set up the dashboards
+
+. Add the <<get-data-in, 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`
+
+[float]
+==== Create the drilldown
+
+
+. In the dashboard menu bar, click *Edit*.
+
+. In *[Logs] Visitors by OS*, open the panel menu, and then select *Create drilldown*.
+
+. 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.
diff --git a/docs/drilldowns/images/drilldown_create.png b/docs/drilldowns/images/drilldown_create.png
diff --git a/docs/drilldowns/images/drilldown_menu.png b/docs/drilldowns/images/drilldown_menu.png
diff --git a/docs/drilldowns/images/drilldown_on_panel.png b/docs/drilldowns/images/drilldown_on_panel.png
diff --git a/docs/drilldowns/images/drilldown_on_piechart.gif b/docs/drilldowns/images/drilldown_on_piechart.gif
diff --git a/docs/settings/alert-action-settings.asciidoc b/docs/settings/alert-action-settings.asciidoc
@@ -1,6 +1,6 @@
 [role="xpack"]
 [[alert-action-settings-kb]]
-=== Alerting and action settings in Kibana
+=== Alerting and action settings in {kib}
 ++++
 <titleabbrev>Alerting and action settings</titleabbrev>
 ++++

diff --git a/docs/settings/apm-settings.asciidoc b/docs/settings/apm-settings.asciidoc
@@ -12,7 +12,7 @@ It is enabled by default.
 
 [float]
 [[apm-indices-settings-kb]]
-==== APM Indices
+==== APM indices
 
 // This content is reused in the APM app documentation.
 // Any changes made in this file will be seen there as well.

diff --git a/docs/settings/dev-settings.asciidoc b/docs/settings/dev-settings.asciidoc
@@ -1,6 +1,6 @@
 [role="xpack"]
 [[dev-settings-kb]]
-=== Development tools settings in Kibana
+=== Development tools settings in {kib}
 ++++
 <titleabbrev>Development tools settings</titleabbrev>
 ++++
@@ -21,7 +21,7 @@ They are enabled by default.
 
 [float]
 [[profiler-settings]]
-==== {searchprofiler} Settings
+==== {searchprofiler} settings
 
 [cols="2*<"]
 |===

diff --git a/docs/settings/graph-settings.asciidoc b/docs/settings/graph-settings.asciidoc
@@ -1,6 +1,6 @@
 [role="xpack"]
 [[graph-settings-kb]]
-=== Graph settings in Kibana
+=== Graph settings in {kib}
 ++++
 <titleabbrev>Graph settings</titleabbrev>
 ++++

diff --git a/docs/settings/i18n-settings.asciidoc b/docs/settings/i18n-settings.asciidoc
@@ -1,12 +1,15 @@
 [role="xpack"]
 [[i18n-settings-kb]]
-=== i18n settings in Kibana
+=== i18n settings in {kib}
+++++
+<titleabbrev>i18n settings</titleabbrev>
+++++
 
 You do not need to configure any settings to run Kibana in English.
 
 [float]
 [[general-i18n-settings-kb]]
-==== General i18n Settings
+==== General i18n settings
 
 `i18n.locale`::
   {kib} supports the following locales:

diff --git a/docs/settings/infrastructure-ui-settings.asciidoc b/docs/settings/infrastructure-ui-settings.asciidoc
@@ -1,6 +1,6 @@
 [role="xpack"]
 [[infrastructure-ui-settings-kb]]
-=== Metrics settings in Kibana
+=== Metrics settings in {kib}
 ++++
 <titleabbrev>Metrics settings</titleabbrev>
 ++++
@@ -11,4 +11,4 @@ You do not need to configure any settings to use the Metrics app in {kib}. It is
 [[general-infra-ui-settings-kb]]
 ==== General Metrics settings
 
-include::general-infra-logs-ui-settings.asciidoc[]
+include::general-infra-logs-ui-settings.asciidoc[]
diff --git a/docs/settings/logs-ui-settings.asciidoc b/docs/settings/logs-ui-settings.asciidoc
@@ -1,6 +1,6 @@
 [role="xpack"]
 [[logs-ui-settings-kb]]
-=== Logs app settings in Kibana
+=== Logs settings in {kib}
 ++++
 <titleabbrev>Logs settings</titleabbrev>
 ++++

diff --git a/docs/settings/ml-settings.asciidoc b/docs/settings/ml-settings.asciidoc
@@ -1,12 +1,12 @@
 [role="xpack"]
 [[ml-settings-kb]]
-=== Machine learning settings in Kibana
+=== Machine learning settings in {kib}
 ++++
 <titleabbrev>Machine learning settings</titleabbrev>
 ++++
 
 You do not need to configure any settings to use {kib} {ml-features}. They are
-enabled by default. 
+enabled by default.
 
 [[general-ml-settings-kb]]
 ==== General {ml} settings
@@ -26,4 +26,4 @@ enabled by default.
 [[advanced-ml-settings-kb]]
 ==== Advanced {ml} settings
 
-Refer to <<kibana-ml-settings,Advanced {ml} settings in {kib}>>.
+Refer to <<kibana-ml-settings,Advanced {ml} settings in {kib}>>.
diff --git a/docs/settings/monitoring-settings.asciidoc b/docs/settings/monitoring-settings.asciidoc
@@ -1,6 +1,6 @@
 [role="xpack"]
 [[monitoring-settings-kb]]
-=== Monitoring settings in Kibana
+=== Monitoring settings in {kib}
 ++++
 <titleabbrev>Monitoring settings</titleabbrev>
 ++++

diff --git a/docs/settings/reporting-settings.asciidoc b/docs/settings/reporting-settings.asciidoc
@@ -1,6 +1,6 @@
 [role="xpack"]
 [[reporting-settings-kb]]
-=== Reporting settings in Kibana
+=== Reporting settings in {kib}
 ++++
 <titleabbrev>Reporting settings</titleabbrev>
 ++++

diff --git a/docs/settings/security-settings.asciidoc b/docs/settings/security-settings.asciidoc
@@ -1,6 +1,6 @@
 [role="xpack"]
 [[security-settings-kb]]
-=== Security settings in Kibana
+=== Security settings in {kib}
 ++++
 <titleabbrev>Security settings</titleabbrev>
 ++++

diff --git a/docs/settings/settings-xkb.asciidoc b/docs/settings/settings-xkb.asciidoc
@@ -1,9 +1,9 @@
 [role="xpack"]
 [[settings-xpack-kb]]
-== {xpack} Settings in {kib}
+== {xpack} settings in {kib}
 [subs="attributes"]
 ++++
-<titleabbrev>{xpack} Settings</titleabbrev>
+<titleabbrev>{xpack} settings</titleabbrev>
 ++++
 
 include::{asciidoc-dir}/../../shared/settings.asciidoc[]

diff --git a/docs/settings/telemetry-settings.asciidoc b/docs/settings/telemetry-settings.asciidoc
@@ -1,5 +1,5 @@
 [[telemetry-settings-kbn]]
-=== Telemetry settings in Kibana
+=== Telemetry settings in {kib}
 ++++
 <titleabbrev>Telemetry settings</titleabbrev>
 ++++
@@ -29,7 +29,7 @@ See our https://www.elastic.co/legal/privacy-statement[Privacy Statement] to lea
   | Set to `'server'` to report the cluster statistics from the {kib} server.
   If the server fails to connect to our endpoint at https://telemetry.elastic.co/, it assumes
   it is behind a firewall and falls back to `'browser'` to send it from users' browsers
-  when they are navigating through {kib}. Defaults to 'browser'.
+  when they are navigating through {kib}. Defaults to `'server'`.
 
 | `telemetry.optIn`
   | Set to `true` to automatically opt into reporting cluster statistics. You can also opt out through

diff --git a/docs/setup/access.asciidoc b/docs/setup/access.asciidoc
@@ -1,5 +1,5 @@
 [[access]]
-== Accessing Kibana
+== Access {kib}
 
 Kibana is a web application that you access through port 5601. All you need to do is point your web browser at the
 machine where Kibana is running and specify the port number. For example, `localhost:5601` or `http://YOURDOMAIN.com:5601`.
@@ -13,7 +13,7 @@ If you still don't see any results, it's possible that you don't *have* any docu
 
 [float]
 [[status]]
-=== Checking Kibana Status
+=== Check {kib} status
 
 You can reach the Kibana server's status page by navigating to the status endpoint, for example, `localhost:5601/status`. The status page displays
 information about the server's resource usage and lists the installed plugins.

diff --git a/docs/setup/connect-to-elasticsearch.asciidoc b/docs/setup/connect-to-elasticsearch.asciidoc
@@ -1,5 +1,5 @@
 [[connect-to-elasticsearch]]
-== Adding data
+== Add data to {kib}
 
 To start working with your data in {kib}, you can:
 

diff --git a/docs/setup/docker.asciidoc b/docs/setup/docker.asciidoc
@@ -1,5 +1,5 @@
 [[docker]]
-== Running Kibana on Docker
+=== Install Kibana with Docker
 Docker images for Kibana are available from the Elastic Docker registry. The
 base image is https://hub.docker.com/_/centos/[centos:7].
 
@@ -16,7 +16,7 @@ Elastic license levels.
 
 [float]
 [[pull-image]]
-=== Pulling the image
+=== Pull the image
 
 Obtaining Kibana for Docker is as simple as issuing a +docker pull+ command
 against the Elastic Docker registry.
@@ -40,7 +40,7 @@ available under the Apache 2.0 license. To download the images, go to
 https://www.docker.elastic.co[www.docker.elastic.co].
 
 [float]
-=== Running Kibana on Docker for development
+=== Run Kibana on Docker for development
 Kibana can be quickly started and connected to a local Elasticsearch container for development
 or testing use with the following command:
 --------------------------------------------
@@ -50,7 +50,7 @@ endif::[]
 
 [float]
 [[configuring-kibana-docker]]
-=== Configuring Kibana on Docker
+=== Configure Kibana on Docker
 
 The Docker images provide several methods for configuring Kibana. The
 conventional approach is to provide a `kibana.yml` file as described in