Skip to content

Commit

Permalink
Merge branch 'master' into exceptions-viewer-2
Browse files Browse the repository at this point in the history
  • Loading branch information
elasticmachine committed Jun 9, 2020
2 parents 2f8eb18 + 4f2c199 commit 77fd167
Show file tree
Hide file tree
Showing 760 changed files with 78,935 additions and 68,838 deletions.
1 change: 0 additions & 1 deletion .eslintrc.js
Original file line number Diff line number Diff line change
Expand Up @@ -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',
},
},
Expand Down
17 changes: 11 additions & 6 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -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`).
Expand All @@ -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
Expand Down
2 changes: 1 addition & 1 deletion docs/dev-tools/console/console.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -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]
Expand Down
6 changes: 6 additions & 0 deletions docs/development/core/public/kibana-plugin-core-public.md
Original file line number Diff line number Diff line change
Expand Up @@ -132,6 +132,12 @@ The plugin integrates with the core system via lifecycle events: `setup`<!-- -->
| [URLMeaningfulParts](./kibana-plugin-core-public.urlmeaningfulparts.md) | We define our own typings because the current version of @<!-- -->types/node declares properties to be optional "hostname?: string". Although, parse call returns "hostname: null \| string". |
| [UserProvidedValues](./kibana-plugin-core-public.userprovidedvalues.md) | Describes the values explicitly set by user. |

## Variables

| Variable | Description |
| --- | --- |
| [URL\_MAX\_LENGTH](./kibana-plugin-core-public.url_max_length.md) | The max URL length allowed by the current browser. Should be used to display warnings to users when query parameters cause URL to exceed this limit. |

## Type Aliases

| Type Alias | Description |
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](./index.md) &gt; [kibana-plugin-core-public](./kibana-plugin-core-public.md) &gt; [URL\_MAX\_LENGTH](./kibana-plugin-core-public.url_max_length.md)

## URL\_MAX\_LENGTH variable

The max URL length allowed by the current browser. Should be used to display warnings to users when query parameters cause URL to exceed this limit.

<b>Signature:</b>

```typescript
URL_MAX_LENGTH: number
```
Original file line number Diff line number Diff line change
@@ -0,0 +1,44 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](./index.md) &gt; [kibana-plugin-plugins-data-public](./kibana-plugin-plugins-data-public.md) &gt; [getSearchParamsFromRequest](./kibana-plugin-plugins-data-public.getsearchparamsfromrequest.md)

## getSearchParamsFromRequest() function

<b>Signature:</b>

```typescript
export declare function getSearchParamsFromRequest(searchRequest: SearchRequest, dependencies: {
injectedMetadata: CoreStart['injectedMetadata'];
uiSettings: IUiSettingsClient;
}): {
rest_total_hits_as_int: boolean;
ignore_unavailable: boolean;
ignore_throttled: boolean;
max_concurrent_shard_requests: any;
preference: any;
timeout: string | undefined;
index: any;
body: any;
};
```

## Parameters

| Parameter | Type | Description |
| --- | --- | --- |
| searchRequest | <code>SearchRequest</code> | |
| dependencies | <code>{</code><br/><code> injectedMetadata: CoreStart['injectedMetadata'];</code><br/><code> uiSettings: IUiSettingsClient;</code><br/><code>}</code> | |

<b>Returns:</b>

`{
rest_total_hits_as_int: boolean;
ignore_unavailable: boolean;
ignore_throttled: boolean;
max_concurrent_shard_requests: any;
preference: any;
timeout: string | undefined;
index: any;
body: any;
}`

This file was deleted.

This file was deleted.

This file was deleted.

Original file line number Diff line number Diff line change
Expand Up @@ -40,6 +40,7 @@
| [getEsPreference(uiSettings, sessionId)](./kibana-plugin-plugins-data-public.getespreference.md) | |
| [getQueryLog(uiSettings, storage, appName, language)](./kibana-plugin-plugins-data-public.getquerylog.md) | |
| [getSearchErrorType({ message })](./kibana-plugin-plugins-data-public.getsearcherrortype.md) | |
| [getSearchParamsFromRequest(searchRequest, dependencies)](./kibana-plugin-plugins-data-public.getsearchparamsfromrequest.md) | |
| [getTime(indexPattern, timeRange, options)](./kibana-plugin-plugins-data-public.gettime.md) | |
| [plugin(initializerContext)](./kibana-plugin-plugins-data-public.plugin.md) | |

Expand Down Expand Up @@ -67,7 +68,6 @@
| [IndexPatternTypeMeta](./kibana-plugin-plugins-data-public.indexpatterntypemeta.md) | |
| [IRequestTypesMap](./kibana-plugin-plugins-data-public.irequesttypesmap.md) | |
| [IResponseTypesMap](./kibana-plugin-plugins-data-public.iresponsetypesmap.md) | |
| [ISearchContext](./kibana-plugin-plugins-data-public.isearchcontext.md) | |
| [ISearchOptions](./kibana-plugin-plugins-data-public.isearchoptions.md) | |
| [ISearchStrategy](./kibana-plugin-plugins-data-public.isearchstrategy.md) | Search strategy interface contains a search method that takes in a request and returns a promise that resolves to a response. |
| [ISyncSearchRequest](./kibana-plugin-plugins-data-public.isyncsearchrequest.md) | |
Expand Down Expand Up @@ -157,5 +157,4 @@
| [TabbedAggRow](./kibana-plugin-plugins-data-public.tabbedaggrow.md) | \* |
| [TimefilterContract](./kibana-plugin-plugins-data-public.timefiltercontract.md) | |
| [TimeHistoryContract](./kibana-plugin-plugins-data-public.timehistorycontract.md) | |
| [TSearchStrategyProvider](./kibana-plugin-plugins-data-public.tsearchstrategyprovider.md) | Search strategy provider creates an instance of a search strategy with the request handler context bound to it. This way every search strategy can use whatever information they require from the request context. |

This file was deleted.

108 changes: 108 additions & 0 deletions docs/drilldowns/drilldowns.asciidoc
Original file line number Diff line number Diff line change
@@ -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.
Binary file added docs/drilldowns/images/drilldown_create.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/drilldowns/images/drilldown_menu.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/drilldowns/images/drilldown_on_panel.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/drilldowns/images/drilldown_on_piechart.gif
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
2 changes: 1 addition & 1 deletion docs/settings/alert-action-settings.asciidoc
Original file line number Diff line number Diff line change
@@ -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>
++++
Expand Down
2 changes: 1 addition & 1 deletion docs/settings/apm-settings.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
4 changes: 2 additions & 2 deletions docs/settings/dev-settings.asciidoc
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
[role="xpack"]
[[dev-settings-kb]]
=== Development tools settings in Kibana
=== Development tools settings in {kib}
++++
<titleabbrev>Development tools settings</titleabbrev>
++++
Expand All @@ -21,7 +21,7 @@ They are enabled by default.

[float]
[[profiler-settings]]
==== {searchprofiler} Settings
==== {searchprofiler} settings

[cols="2*<"]
|===
Expand Down
2 changes: 1 addition & 1 deletion docs/settings/graph-settings.asciidoc
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
[role="xpack"]
[[graph-settings-kb]]
=== Graph settings in Kibana
=== Graph settings in {kib}
++++
<titleabbrev>Graph settings</titleabbrev>
++++
Expand Down
7 changes: 5 additions & 2 deletions docs/settings/i18n-settings.asciidoc
Original file line number Diff line number Diff line change
@@ -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:
Expand Down
4 changes: 2 additions & 2 deletions docs/settings/infrastructure-ui-settings.asciidoc
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
[role="xpack"]
[[infrastructure-ui-settings-kb]]
=== Metrics settings in Kibana
=== Metrics settings in {kib}
++++
<titleabbrev>Metrics settings</titleabbrev>
++++
Expand All @@ -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[]
Loading

0 comments on commit 77fd167

Please sign in to comment.