Skip to content

Commit

Permalink
Merge branch 'master' of github.com:elastic/kibana into implement/def…
Browse files Browse the repository at this point in the history
…ault-v8-theme
  • Loading branch information
spalger committed Mar 16, 2021
2 parents 54792ae + 70bdb28 commit 2498543
Show file tree
Hide file tree
Showing 342 changed files with 5,348 additions and 2,254 deletions.
8 changes: 4 additions & 4 deletions api_docs/charts.json
Original file line number Diff line number Diff line change
Expand Up @@ -9,26 +9,26 @@
"children": [
{
"type": "Object",
"label": "{ onChange, color: selectedColor, id, label }",
"label": "{\n onChange,\n color: selectedColor,\n label,\n useLegacyColors = true,\n colorIsOverwritten = true,\n}",
"isRequired": true,
"signature": [
"ColorPickerProps"
],
"description": [],
"source": {
"path": "src/plugins/charts/public/static/components/color_picker.tsx",
"lineNumber": 83
"lineNumber": 108
}
}
],
"signature": [
"({ onChange, color: selectedColor, id, label }: ColorPickerProps) => JSX.Element"
"({ onChange, color: selectedColor, label, useLegacyColors, colorIsOverwritten, }: ColorPickerProps) => JSX.Element"
],
"description": [],
"label": "ColorPicker",
"source": {
"path": "src/plugins/charts/public/static/components/color_picker.tsx",
"lineNumber": 83
"lineNumber": 108
},
"tags": [],
"returnComment": [],
Expand Down
91 changes: 91 additions & 0 deletions docs/apm/correlations.asciidoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,91 @@
[role="xpack"]
[[correlations]]
=== Find latency and error correlations

**Correlations** surface attributes of your data that are potentially correlated with high-latency or erroneous transactions.
Surfaced attributes are user-defined, meaning that they are completely customizable to your APM data.
Find something interesting? A quick click of a button will auto-query your data as you work to resolve the underlying issue.

For example, a site reliability engineer, who is responsible for keeping production systems up and running,
notices an increase in latency in certain transactions.
Analyzing metadata or tags that exist in high-latency transactions but not in lower-latency transactions
can potentially point towards the root cause.
They may find that a particular piece of hardware, like a host or pod, has failed, increasing latency.
Or, perhaps a set of users, based on IP address or region, is physically too far away from the nearest
data center, increasing latency.

[discrete]
[[view-correlations]]
=== View correlations

With a service selected, click **View correlations**:

[role="screenshot"]
image::apm/images/correlations.png[Correlations]

Queries within the APM app apply to the correlations shown in the correlations fly-out.

If a correlated field seems noteworthy, use the **Filter** quick links:

* `+` creates a new query in the APM app for transactions containing the selected value.
* `-` creates a new query in the APM app for transactions without the selected value.

[discrete]
[[correlations-latency]]
==== Find high-latency correlations

Correlations help you discover which fields are contributing to increased service latency.

A latency distribution chart visualizes the overall latency of the selected service's transactions.
Correlated attributes are sorted by _Impact_–a visual representation of the score for the underlying
aggregation that powers correlations.
Attributes with a high impact, or attributes present in a large percentage of slow transactions,
may contribute to increased latency.

To find high-latency correlations, hover over each potentially correlated attribute to
compare the latency distribution of transactions with and without the selected attribute.

For example, in the screenshot below, the field `user_agent.name` and value `HeadlessChrome`
exists primarily in higher-latency transactions between 3.7 and 8.7 seconds.

[role="screenshot"]
image::apm/images/correlations-hover.png[Correlations hover effect]

Selecting the `+` filter creates a new query in the APM app for transactions with
`user_agent.name: HeadlessChrome`. With the "noise" now filtered out,
you can begin viewing sample traces to continue your investigation.

[discrete]
[[correlations-error-rate]]
==== Find error rate correlations

Correlations help you discover which fields are contributing to failed transactions.

The Error rate over time chart visualizes the change in error rate over the selected time frame.
Correlated attributes are sorted by _Impact_–a visual representation of the score for the underlying
aggregation that powers correlations.
Attributes with a high impact, or attributes present in a large percentage of failed transactions,
may contribute to increased error rates.

To find error rate correlations, hover over each potentially correlated attribute to
compare the error rate distribution of transactions with and without the selected attribute.

For example, in the screenshot below, the field `url.original` and value `http://localhost:3100...`
existed in 100% of failed transactions between 6:00 and 10:30.

[role="screenshot"]
image::apm/images/error-rate-hover.png[Correlations errors hover effect]

Selecting the `+` filter creates a new query in the APM app for transactions with
`url.original: http://localhost:3100...`. With the "noise" now filtered out,
you can begin viewing sample traces to continue your investigation.

[discrete]
[[correlations-custom-fields]]
==== Customize fields

Correlations are only as good as the data they're searching for.
By default, a handful of potentially useful fields are selected, like `lables`, `service.version`, and `host.ip`.
You can remove and add fields to this list under the **Customize fields** dropdown.

TIP: Want to start over? Select **reset** to clear your customizations.
3 changes: 3 additions & 0 deletions docs/apm/how-to-guides.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@ Learn how to perform common APM app tasks.
* <<apm-alerts>>
* <<custom-links>>
* <<filters>>
* <<correlations>>
* <<machine-learning-integration>>
* <<advanced-queries>>
* <<transactions-annotations>>
Expand All @@ -22,6 +23,8 @@ include::custom-links.asciidoc[]

include::filters.asciidoc[]

include::correlations.asciidoc[]

include::machine-learning.asciidoc[]

include::advanced-queries.asciidoc[]
Expand Down
Binary file added docs/apm/images/correlations-hover.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/apm/images/correlations.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/apm/images/error-rate-hover.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
10 changes: 5 additions & 5 deletions docs/canvas/canvas-edit-workpads.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -22,13 +22,13 @@ each element instead of updating them manually.

For example, to change the index pattern for a set of charts:

Specify the variable options.

. Specify the variable options.
+
[role="screenshot"]
image::images/specify_variable_syntax.png[Image describing how to specify the variable syntax]

Copy the variable, then apply it to each element you want to update in the *Expression editor*.

+
. Copy the variable, then apply it to each element you want to update in the *Expression editor*.
+
[role="screenshot"]
image::images/copy_variable_syntax.png[Image demonstrating expression editor]

Expand Down
4 changes: 2 additions & 2 deletions docs/canvas/canvas-present-workpad.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ image::images/canvas-autoplay-interval.png[Element autoplay interval]
[role="screenshot"]
image::images/canvas-fullscreen.png[Image showing how to enter fullscreen mode from view dropdown]

. When you are ready to exit fullscreen mode, press the Esc (Escape) key.
. When you are ready to exit fullscreen mode, press Esc.

[float]
[[zoom-in-out]]
Expand Down Expand Up @@ -48,4 +48,4 @@ Change how often the data refreshes on your workpad.
[role="screenshot"]
image::images/canvas-refresh-interval.png[Element data refresh interval]
+
To manually refresh the data, click image:canvas/images/canvas-refresh-data.png[].
To manually refresh the data, click image:canvas/images/canvas-refresh-data.png[Canvas refresh data button].
4 changes: 2 additions & 2 deletions docs/canvas/canvas-share-workpad.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ Want to export multiple workpads? Go to the *Canvas* home page, select the workp
[[add-workpad-website]]
=== Share the workpad on a website

beta[] Canvas allows you to create _shareables_, which are workpads that you download and securely share on any website.
beta[] *Canvas* allows you to create _shareables_, which are workpads that you download and securely share on any website.
To customize the behavior of the workpad on your website, you can choose to autoplay the pages or hide the workpad toolbar.

. Click *Share > Share on a website*.
Expand All @@ -32,7 +32,7 @@ To customize the behavior of the workpad on your website, you can choose to auto

. To customize the workpad behavior to autoplay the pages or hide the toolbar, use the inline parameters.
+
To make sure that your data remains secure, the data in the JSON file is not connected to {kib}. Canvas does not display elements that manipulate the data on the workpad.
To make sure that your data remains secure, the data in the JSON file is not connected to {kib}. *Canvas* does not display elements that manipulate the data on the workpad.
+
[role="screenshot"]
image::canvas/images/canvas-embed_workpad.gif[Image showing how to share the workpad on a website]
Expand Down
17 changes: 8 additions & 9 deletions docs/canvas/canvas-tutorial.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -2,17 +2,16 @@
[[canvas-tutorial]]
== Tutorial: Create a workpad for monitoring sales

To get up and running with Canvas, add the Sample eCommerce orders data, then use the data to create a workpad for monitoring sales at an eCommerce store.
To familiarize yourself with *Canvas*, add the Sample eCommerce orders data, then use the data to create a workpad for monitoring sales at an eCommerce store.

[float]
=== Before you begin
=== Open and set up Canvas

For this tutorial, you'll need to add the <<add-sample-data, Sample eCommerce orders data>>.
To create a workpad of the eCommerce store data, add the data set, then create the workpad.

[float]
=== Create your workpad
. On the {kib} *Home* page, click *Try our sample data*.

Your first step to working with Canvas is to create a workpad.
. From *Sample eCommerce orders data*, click *Add data*.

. Open the main menu, then click *Canvas*.

Expand Down Expand Up @@ -59,7 +58,7 @@ The query selects the total price field and sets it to the sum_total_price field

.. Change the *Label* to `Total sales`.

. The error is gone, but the element could use some formatting. To format the number, use the Canvas expression language.
. The error is gone, but the element could use some formatting. To format the number, use the *Canvas* expression language.

.. Click *Expression editor*.
+
Expand Down Expand Up @@ -118,12 +117,12 @@ Your workpad is complete!

[float]
=== What's next?
Now that you know the Canvas basics, you're ready to explore on your own.
Now that you know the basics, you're ready to explore on your own.

Here are some things to try:

* Play with the {kibana-ref}/add-sample-data.html[sample Canvas workpads].

* Build presentations of your own data with <<create-workpads,workpads>>.

* Deep dive into the {kibana-ref}/canvas-function-reference.html[expression language and functions] that drive Canvas.
* Deep dive into the {kibana-ref}/canvas-function-reference.html[expression language and functions] that drive *Canvas*.
Binary file modified docs/canvas/images/canvas-gs-example.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](./index.md) &gt; [kibana-plugin-plugins-data-server](./kibana-plugin-plugins-data-server.md) &gt; [IScopedSearchClient](./kibana-plugin-plugins-data-server.iscopedsearchclient.md) &gt; [cancelSession](./kibana-plugin-plugins-data-server.iscopedsearchclient.cancelsession.md)

## IScopedSearchClient.cancelSession property

<b>Signature:</b>

```typescript
cancelSession: IScopedSearchSessionsClient['cancel'];
```
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](./index.md) &gt; [kibana-plugin-plugins-data-server](./kibana-plugin-plugins-data-server.md) &gt; [IScopedSearchClient](./kibana-plugin-plugins-data-server.iscopedsearchclient.md) &gt; [deleteSession](./kibana-plugin-plugins-data-server.iscopedsearchclient.deletesession.md)

## IScopedSearchClient.deleteSession property

<b>Signature:</b>

```typescript
deleteSession: IScopedSearchSessionsClient['delete'];
```
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](./index.md) &gt; [kibana-plugin-plugins-data-server](./kibana-plugin-plugins-data-server.md) &gt; [IScopedSearchClient](./kibana-plugin-plugins-data-server.iscopedsearchclient.md) &gt; [extendSession](./kibana-plugin-plugins-data-server.iscopedsearchclient.extendsession.md)

## IScopedSearchClient.extendSession property

<b>Signature:</b>

```typescript
extendSession: IScopedSearchSessionsClient['extend'];
```
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](./index.md) &gt; [kibana-plugin-plugins-data-server](./kibana-plugin-plugins-data-server.md) &gt; [IScopedSearchClient](./kibana-plugin-plugins-data-server.iscopedsearchclient.md) &gt; [findSessions](./kibana-plugin-plugins-data-server.iscopedsearchclient.findsessions.md)

## IScopedSearchClient.findSessions property

<b>Signature:</b>

```typescript
findSessions: IScopedSearchSessionsClient['find'];
```
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](./index.md) &gt; [kibana-plugin-plugins-data-server](./kibana-plugin-plugins-data-server.md) &gt; [IScopedSearchClient](./kibana-plugin-plugins-data-server.iscopedsearchclient.md) &gt; [getSession](./kibana-plugin-plugins-data-server.iscopedsearchclient.getsession.md)

## IScopedSearchClient.getSession property

<b>Signature:</b>

```typescript
getSession: IScopedSearchSessionsClient['get'];
```
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](./index.md) &gt; [kibana-plugin-plugins-data-server](./kibana-plugin-plugins-data-server.md) &gt; [IScopedSearchClient](./kibana-plugin-plugins-data-server.iscopedsearchclient.md)

## IScopedSearchClient interface

<b>Signature:</b>

```typescript
export interface IScopedSearchClient extends ISearchClient
```
## Properties
| Property | Type | Description |
| --- | --- | --- |
| [cancelSession](./kibana-plugin-plugins-data-server.iscopedsearchclient.cancelsession.md) | <code>IScopedSearchSessionsClient['cancel']</code> | |
| [deleteSession](./kibana-plugin-plugins-data-server.iscopedsearchclient.deletesession.md) | <code>IScopedSearchSessionsClient['delete']</code> | |
| [extendSession](./kibana-plugin-plugins-data-server.iscopedsearchclient.extendsession.md) | <code>IScopedSearchSessionsClient['extend']</code> | |
| [findSessions](./kibana-plugin-plugins-data-server.iscopedsearchclient.findsessions.md) | <code>IScopedSearchSessionsClient['find']</code> | |
| [getSession](./kibana-plugin-plugins-data-server.iscopedsearchclient.getsession.md) | <code>IScopedSearchSessionsClient['get']</code> | |
| [saveSession](./kibana-plugin-plugins-data-server.iscopedsearchclient.savesession.md) | <code>IScopedSearchSessionsClient['save']</code> | |
| [updateSession](./kibana-plugin-plugins-data-server.iscopedsearchclient.updatesession.md) | <code>IScopedSearchSessionsClient['update']</code> | |
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](./index.md) &gt; [kibana-plugin-plugins-data-server](./kibana-plugin-plugins-data-server.md) &gt; [IScopedSearchClient](./kibana-plugin-plugins-data-server.iscopedsearchclient.md) &gt; [saveSession](./kibana-plugin-plugins-data-server.iscopedsearchclient.savesession.md)

## IScopedSearchClient.saveSession property

<b>Signature:</b>

```typescript
saveSession: IScopedSearchSessionsClient['save'];
```
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](./index.md) &gt; [kibana-plugin-plugins-data-server](./kibana-plugin-plugins-data-server.md) &gt; [IScopedSearchClient](./kibana-plugin-plugins-data-server.iscopedsearchclient.md) &gt; [updateSession](./kibana-plugin-plugins-data-server.iscopedsearchclient.updatesession.md)

## IScopedSearchClient.updateSession property

<b>Signature:</b>

```typescript
updateSession: IScopedSearchSessionsClient['update'];
```
Original file line number Diff line number Diff line change
Expand Up @@ -52,6 +52,7 @@
| [IFieldSubType](./kibana-plugin-plugins-data-server.ifieldsubtype.md) | |
| [IFieldType](./kibana-plugin-plugins-data-server.ifieldtype.md) | |
| [IndexPatternAttributes](./kibana-plugin-plugins-data-server.indexpatternattributes.md) | Interface for an index pattern saved object |
| [IScopedSearchClient](./kibana-plugin-plugins-data-server.iscopedsearchclient.md) | |
| [ISearchOptions](./kibana-plugin-plugins-data-server.isearchoptions.md) | |
| [ISearchSessionService](./kibana-plugin-plugins-data-server.isearchsessionservice.md) | |
| [ISearchSetup](./kibana-plugin-plugins-data-server.isearchsetup.md) | |
Expand Down
Loading

0 comments on commit 2498543

Please sign in to comment.