Skip to content

Commit

Permalink
Merge branch 'master' into dev/ff-setup
Browse files Browse the repository at this point in the history
  • Loading branch information
kibanamachine authored Jul 28, 2021
2 parents 692c987 + 4b8b103 commit 4877f1c
Show file tree
Hide file tree
Showing 692 changed files with 23,759 additions and 11,367 deletions.
7 changes: 5 additions & 2 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,9 @@ target
*.iml
*.log

# Ignore example plugin builds
/examples/*/build

# Ignore certain functional test runner artifacts
/test/*/failure_debug
/test/*/screenshots/diff
Expand Down Expand Up @@ -76,6 +79,6 @@ report.asciidoc
.yarn-local-mirror

# Bazel
bazel
bazel-*
/bazel
/bazel-*
.bazelrc.user
4 changes: 2 additions & 2 deletions api_docs/alerting.json
Original file line number Diff line number Diff line change
Expand Up @@ -701,7 +701,7 @@
"description": [],
"signature": [
"() => Set<",
"RegistryAlertType",
"RegistryRuleType",
">"
],
"source": {
Expand Down Expand Up @@ -1330,7 +1330,7 @@
"description": [],
"signature": [
"() => Set<",
"RegistryAlertType",
"RegistryRuleType",
">"
],
"source": {
Expand Down
16 changes: 8 additions & 8 deletions api_docs/triggers_actions_ui.json
Original file line number Diff line number Diff line change
Expand Up @@ -2187,10 +2187,10 @@
},
{
"parentPluginId": "triggersActionsUi",
"id": "def-public.TriggersAndActionsUiServices.alertTypeRegistry",
"id": "def-public.TriggersAndActionsUiServices.ruleTypeRegistry",
"type": "Object",
"tags": [],
"label": "alertTypeRegistry",
"label": "ruleTypeRegistry",
"description": [],
"signature": [
"{ get: (id: string) => ",
Expand Down Expand Up @@ -2535,10 +2535,10 @@
},
{
"parentPluginId": "triggersActionsUi",
"id": "def-public.AlertTypeRegistryContract",
"id": "def-public.RuleTypeRegistryContract",
"type": "Type",
"tags": [],
"label": "AlertTypeRegistryContract",
"label": "RuleTypeRegistryContract",
"description": [],
"signature": [
"{ get: (id: string) => ",
Expand Down Expand Up @@ -3623,10 +3623,10 @@
},
{
"parentPluginId": "triggersActionsUi",
"id": "def-public.TriggersAndActionsUIPublicPluginSetup.alertTypeRegistry",
"id": "def-public.TriggersAndActionsUIPublicPluginSetup.ruleTypeRegistry",
"type": "Object",
"tags": [],
"label": "alertTypeRegistry",
"label": "ruleTypeRegistry",
"description": [],
"signature": [
"TypeRegistry",
Expand Down Expand Up @@ -3684,10 +3684,10 @@
},
{
"parentPluginId": "triggersActionsUi",
"id": "def-public.TriggersAndActionsUIPublicPluginStart.alertTypeRegistry",
"id": "def-public.TriggersAndActionsUIPublicPluginStart.ruleTypeRegistry",
"type": "Object",
"tags": [],
"label": "alertTypeRegistry",
"label": "ruleTypeRegistry",
"description": [],
"signature": [
"TypeRegistry",
Expand Down
131 changes: 67 additions & 64 deletions docs/apm/correlations.asciidoc
Original file line number Diff line number Diff line change
@@ -1,73 +1,73 @@
[role="xpack"]
[[correlations]]
=== Find latency and error correlations
=== Find transaction latency and failure correlations

**Correlations** surface attributes of your data that are potentially correlated with high-latency or erroneous transactions.
By default, a number of attributes commonly known to cause performance issues, like version,
infrastructure, and location, are included, but all 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.
Correlations surface attributes of your data that are potentially correlated
with high-latency or erroneous transactions. For example, if you are a site
reliability engineer who is responsible for keeping production systems up and
running, you want to understand what is causing slow transactions. Identifying
attributes that are responsible for higher latency transactions can potentially
point you toward the root cause. You may find a correlation with a particular
piece of hardware, like a host or pod. Or, perhaps a set of users, based on IP
address or region, is facing increased latency due to local data center issues.

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 set of users, based on IP address or region, is facing increased latency due to local data center issues.
To find correlations, select a service on the *Services* page in the {apm-app}
and click **View correlations**.

[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 filtering transactions containing the selected value.
* `-` creates a new query in the APM app to filter out transactions containing the selected value.
NOTE: Queries within the {apm-app} are also applied to the correlations.

[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
{ref}/search-aggregations-bucket-significantterms-aggregation.html[significant terms aggregation]
score 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.
==== Find high transaction latency correlations

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.
The correlations on the *Latency* tab help you discover which attributes are
contributing to increased transaction latency.

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

Select the `+` filter to create 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.

As you sift through high-latency transactions, you'll likely notice other interesting attributes.
Return to the correlations fly-out and select *Customize fields* to search on these new attributes.
You may need to do this a few times–each time filtering out more and more noise and bringing you
closer to a diagnosis.
image::apm/images/correlations-hover.png[Latency correlations]

The progress bar indicates the status of the asynchronous analysis, which
performs statistical searches across a large number of attributes. For large
time ranges and services with high transaction throughput this might take some
time. To improve performance, reduce the time range on the service overview
page.

The latency distribution chart visualizes the overall latency of the
transactions in the service. If there are attributes that have a statistically
significant correlation with slow response times, they are listed in a table
below the chart. The table is sorted by correlation coefficients that range from
0 to 1. Attributes with higher correlation values are more likely to contribute
to high latency transactions. By default, the attribute with the highest
correlation value is added to the chart. To see the latency distribution for
other attributes, hover over their row in the table.

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

* `+` creates a new query in the {apm-app} for filtering transactions containing
the selected value.
* `-` creates a new query in the {apm-app} to filter out transactions containing
the selected value.

In this example screenshot, transactions with the field
`labels.orderPriceRange` and value `large` are skewed to the right with slower
response times than the overall latency distribution. If you select the `+`
filter in the appropriate row of the table, it creates a new query in the
{apm-app} for transactions with this attribute. With the "noise" now filtered
out, you can begin viewing sample traces to continue your investigation.

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

The correlations on the *Error rate* tab help you discover which fields are
contributing to failed transactions.

Correlations help you discover which fields are contributing to failed transactions.
By default, a number of attributes commonly known to cause performance issues,
like version, infrastructure, and location, are included, but all 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.

The Error rate over time chart visualizes the change in error rate over the selected time frame.
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
{ref}/search-aggregations-bucket-significantterms-aggregation.html[significant terms aggregation]
score that powers correlations.
Expand All @@ -83,7 +83,7 @@ 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]

Select the `+` filter to create a new query in the APM app for transactions with
Select the `+` filter to create 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.

Expand All @@ -94,16 +94,14 @@ closer to a diagnosis.

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

Correlations are only as good as the data they're searching for.
By default, a handful of attributes commonly known to cause performance issues are included.
During the course of an investigation however, you may to need to add and remove fields from
this list multiple times as you narrow in on a diagnosis.
By default, a handful of attributes commonly known to cause performance issues
are included in the analysis on the *Error rate* tab. You can add and remove
fields under the **Customize fields** dropdown.

Add and remove fields under the **Customize fields** dropdown.
The following fields are selected by default.
To keep the default list manageable, only the first six matching fields with wildcards are used.
The following fields are selected by default. To keep the default list
manageable, only the first six matching fields with wildcards are used.

**Frontend (RUM) agent:**

Expand All @@ -120,4 +118,9 @@ To keep the default list manageable, only the first six matching fields with wil
* `service.node.name`
* `service.version`

TIP: Want to start over? Select **reset** to clear your customizations.
[TIP]
====
* Want to start over? Select **reset** to clear your customizations.
* The *Latency* tab does not have a **Customize fields** dropdown, since it
automatically considers all relevant fields in the transactions.
====
Binary file modified 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 removed docs/apm/images/correlations.png
Binary file not shown.
8 changes: 8 additions & 0 deletions docs/concepts/index.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -115,6 +115,14 @@ Following are some example KQL queries. For more detailed examples, refer to <<
| `machine.os:win*`
|===

[float]
[[autocomplete-suggestions]]
==== Suggestions for autocomplete

Beginning in 7.14, {kib} uses the {ref}/search-terms-enum.html[terms enum API] for autocomplete. {kib} returns results faster, but suggestions are approximate, sorted alphabetically, and can be outside the selected time range, even if `autocomplete:useTimeFilter` is enabled (as the terms enum API applies time filtering on an index-level, rather than document-level).

Previously, {kib} used the {ref}/search-aggregations-bucket-terms-aggregation.html[terms aggregation API], which is slower, but suggestions included all values that matched your query, and optionally, your time range, and were sorted by popularity. To revert to using the terms aggregation API, go to <<advanced-options, Advanced Settings>>, and set `autocomplete:valueSuggestionMethod` to `terms_agg`.

[float]
==== Additional filters with AND

Expand Down
5 changes: 2 additions & 3 deletions docs/developer/advanced/development-basepath.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -3,9 +3,9 @@

In dev mode, {kib} by default runs behind a proxy which adds a random path component to its URL.

You can set this explicitly using `server.basePath` in <<settings>>.
You can set this explicitly using <<server-basePath,`server.basePath`>>. This setting cannot end in a slash (/).

Use the server.rewriteBasePath setting to tell {kib} if it should remove the basePath from requests it receives, and to prevent a deprecation warning at startup. This setting cannot end in a slash (/).
Use <<server-rewriteBasePath,`server.rewriteBasePath`>> to tell {kib} if it should remove the basePath from requests it receives, and to prevent a deprecation warning at startup.

If you want to turn off the basepath when in development mode, start {kib} with the `--no-base-path` flag

Expand All @@ -15,4 +15,3 @@ yarn start --no-base-path
----



Original file line number Diff line number Diff line change
Expand Up @@ -141,6 +141,7 @@ readonly links: {
readonly luceneQuerySyntax: string;
readonly percolate: string;
readonly queryDsl: string;
readonly autocompleteChanges: string;
};
readonly date: {
readonly dateMath: string;
Expand Down
Loading

0 comments on commit 4877f1c

Please sign in to comment.