-
Notifications
You must be signed in to change notification settings - Fork 8.3k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge remote-tracking branch 'upstream/master' into fix/EMT-662-host-…
…list-policy-response-link
- Loading branch information
Showing
639 changed files
with
8,854 additions
and
6,205 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,36 +1,61 @@ | ||
[role="xpack"] | ||
[[machine-learning-integration]] | ||
=== integration | ||
=== Machine learning integration | ||
|
||
++++ | ||
<titleabbrev>Integrate with machine learning</titleabbrev> | ||
++++ | ||
|
||
The Machine Learning integration initiates a new job predefined to calculate anomaly scores on APM transaction durations. | ||
Jobs can be created per transaction type, and are based on the service's average response time. | ||
The Machine learning integration initiates a new job predefined to calculate anomaly scores on APM transaction durations. | ||
With this integration, you can quickly pinpoint anomalous transactions and see the health of | ||
any upstream and downstream services. | ||
|
||
After a machine learning job is created, results are shown in two places: | ||
Machine learning jobs are created per environment, and are based on a service's average response time. | ||
Because jobs are created at the environment level, | ||
you can add new services to your existing environments without the need for additional machine learning jobs. | ||
|
||
The transaction duration graph will show the expected bounds and add an annotation when the anomaly score is 75 or above. | ||
After a machine learning job is created, results are shown in two places: | ||
|
||
* The transaction duration chart will show the expected bounds and add an annotation when the anomaly score is 75 or above. | ||
+ | ||
[role="screenshot"] | ||
image::apm/images/apm-ml-integration.png[Example view of anomaly scores on response times in the APM app] | ||
|
||
Service maps will display a color-coded anomaly indicator based on the detected anomaly score. | ||
|
||
* Service maps will display a color-coded anomaly indicator based on the detected anomaly score. | ||
+ | ||
[role="screenshot"] | ||
image::apm/images/apm-service-map-anomaly.png[Example view of anomaly scores on service maps in the APM app] | ||
|
||
[float] | ||
[[create-ml-integration]] | ||
=== Create a new machine learning job | ||
=== Enable anomaly detection | ||
|
||
To enable machine learning anomaly detection: | ||
|
||
. From the Services overview, Traces overview, or Service Map tab, | ||
select **Anomaly detection**. | ||
|
||
. Click **Create ML Job**. | ||
|
||
To enable machine learning anomaly detection, first choose a service to monitor. | ||
Then, select **Integrations** > **Enable ML anomaly detection** and click **Create job**. | ||
. Machine learning jobs are created at the environment level. | ||
Select all of the service environments that you want to enable anomaly detection in. | ||
Anomalies will surface for all services and transaction types within the selected environments. | ||
|
||
. Click **Create Jobs**. | ||
|
||
That's it! After a few minutes, the job will begin calculating results; | ||
it might take additional time for results to appear on your graph. | ||
Jobs can be managed in *Machine Learning jobs management*. | ||
it might take additional time for results to appear on your service maps. | ||
Existing jobs can be managed in *Machine Learning jobs management*. | ||
|
||
APM specific anomaly detection wizards are also available for certain Agents. | ||
See the machine learning {ml-docs}/ootb-ml-jobs-apm.html[APM anomaly detection configurations] for more information. | ||
|
||
[float] | ||
[[warning-ml-integration]] | ||
=== Anomaly detection warning | ||
|
||
To make machine learning as easy as possible to set up, | ||
the APM app will warn you when filtered to an environment without a machine learning job. | ||
|
||
[role="screenshot"] | ||
image::apm/images/apm-anomaly-alert.png[Example view of anomaly alert in the APM app] |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -4,6 +4,9 @@ | |
|
||
## AssistanceAPIResponse interface | ||
|
||
> Warning: This API is now obsolete. | ||
> | ||
> | ||
<b>Signature:</b> | ||
|
||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -4,6 +4,9 @@ | |
|
||
## AssistantAPIClientParams interface | ||
|
||
> Warning: This API is now obsolete. | ||
> | ||
> | ||
<b>Signature:</b> | ||
|
||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -4,6 +4,9 @@ | |
|
||
## DeprecationAPIClientParams interface | ||
|
||
> Warning: This API is now obsolete. | ||
> | ||
> | ||
<b>Signature:</b> | ||
|
||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -4,6 +4,9 @@ | |
|
||
## DeprecationAPIResponse interface | ||
|
||
> Warning: This API is now obsolete. | ||
> | ||
> | ||
<b>Signature:</b> | ||
|
||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -4,6 +4,9 @@ | |
|
||
## DeprecationInfo interface | ||
|
||
> Warning: This API is now obsolete. | ||
> | ||
> | ||
<b>Signature:</b> | ||
|
||
|
18 changes: 18 additions & 0 deletions
18
.../development/core/server/kibana-plugin-core-server.elasticsearchclientconfig.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,18 @@ | ||
<!-- Do not edit this file. It is automatically generated by API Documenter. --> | ||
|
||
[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [ElasticsearchClientConfig](./kibana-plugin-core-server.elasticsearchclientconfig.md) | ||
|
||
## ElasticsearchClientConfig type | ||
|
||
Configuration options to be used to create a [cluster client](./kibana-plugin-core-server.iclusterclient.md) using the [createClient API](./kibana-plugin-core-server.elasticsearchservicestart.createclient.md) | ||
|
||
<b>Signature:</b> | ||
|
||
```typescript | ||
export declare type ElasticsearchClientConfig = Pick<ElasticsearchConfig, 'customHeaders' | 'logQueries' | 'sniffOnStart' | 'sniffOnConnectionFault' | 'requestHeadersWhitelist' | 'sniffInterval' | 'hosts' | 'username' | 'password'> & { | ||
pingTimeout?: ElasticsearchConfig['pingTimeout'] | ClientOptions['pingTimeout']; | ||
requestTimeout?: ElasticsearchConfig['requestTimeout'] | ClientOptions['requestTimeout']; | ||
ssl?: Partial<ElasticsearchConfig['ssl']>; | ||
keepAlive?: boolean; | ||
}; | ||
``` |
22 changes: 22 additions & 0 deletions
22
...pment/core/server/kibana-plugin-core-server.elasticsearchservicestart.client.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,22 @@ | ||
<!-- Do not edit this file. It is automatically generated by API Documenter. --> | ||
|
||
[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [ElasticsearchServiceStart](./kibana-plugin-core-server.elasticsearchservicestart.md) > [client](./kibana-plugin-core-server.elasticsearchservicestart.client.md) | ||
|
||
## ElasticsearchServiceStart.client property | ||
|
||
A pre-configured [Elasticsearch client](./kibana-plugin-core-server.iclusterclient.md) | ||
|
||
<b>Signature:</b> | ||
|
||
```typescript | ||
readonly client: IClusterClient; | ||
``` | ||
|
||
## Example | ||
|
||
|
||
```js | ||
const client = core.elasticsearch.client; | ||
|
||
``` | ||
|
23 changes: 23 additions & 0 deletions
23
...core/server/kibana-plugin-core-server.elasticsearchservicestart.createclient.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,23 @@ | ||
<!-- Do not edit this file. It is automatically generated by API Documenter. --> | ||
|
||
[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [ElasticsearchServiceStart](./kibana-plugin-core-server.elasticsearchservicestart.md) > [createClient](./kibana-plugin-core-server.elasticsearchservicestart.createclient.md) | ||
|
||
## ElasticsearchServiceStart.createClient property | ||
|
||
Create application specific Elasticsearch cluster API client with customized config. See [IClusterClient](./kibana-plugin-core-server.iclusterclient.md)<!-- -->. | ||
|
||
<b>Signature:</b> | ||
|
||
```typescript | ||
readonly createClient: (type: string, clientConfig?: Partial<ElasticsearchClientConfig>) => ICustomClusterClient; | ||
``` | ||
|
||
## Example | ||
|
||
|
||
```js | ||
const client = elasticsearch.createClient('my-app-name', config); | ||
const data = await client.asInternalUser.search(); | ||
|
||
``` | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
13 changes: 13 additions & 0 deletions
13
...elopment/core/server/kibana-plugin-core-server.iclusterclient.asinternaluser.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [IClusterClient](./kibana-plugin-core-server.iclusterclient.md) > [asInternalUser](./kibana-plugin-core-server.iclusterclient.asinternaluser.md) | ||
|
||
## IClusterClient.asInternalUser property | ||
|
||
A [client](./kibana-plugin-core-server.elasticsearchclient.md) to be used to query the ES cluster on behalf of the Kibana internal user | ||
|
||
<b>Signature:</b> | ||
|
||
```typescript | ||
readonly asInternalUser: ElasticsearchClient; | ||
``` |
13 changes: 13 additions & 0 deletions
13
docs/development/core/server/kibana-plugin-core-server.iclusterclient.asscoped.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [IClusterClient](./kibana-plugin-core-server.iclusterclient.md) > [asScoped](./kibana-plugin-core-server.iclusterclient.asscoped.md) | ||
|
||
## IClusterClient.asScoped property | ||
|
||
Creates a [scoped cluster client](./kibana-plugin-core-server.iscopedclusterclient.md) bound to given [request](./kibana-plugin-core-server.scopeablerequest.md) | ||
|
||
<b>Signature:</b> | ||
|
||
```typescript | ||
asScoped: (request: ScopeableRequest) => IScopedClusterClient; | ||
``` |
21 changes: 21 additions & 0 deletions
21
docs/development/core/server/kibana-plugin-core-server.iclusterclient.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,21 @@ | ||
<!-- Do not edit this file. It is automatically generated by API Documenter. --> | ||
|
||
[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [IClusterClient](./kibana-plugin-core-server.iclusterclient.md) | ||
|
||
## IClusterClient interface | ||
|
||
Represents an Elasticsearch cluster API client created by the platform. It allows to call API on behalf of the internal Kibana user and the actual user that is derived from the request headers (via `asScoped(...)`<!-- -->). | ||
|
||
<b>Signature:</b> | ||
|
||
```typescript | ||
export interface IClusterClient | ||
``` | ||
|
||
## Properties | ||
|
||
| Property | Type | Description | | ||
| --- | --- | --- | | ||
| [asInternalUser](./kibana-plugin-core-server.iclusterclient.asinternaluser.md) | <code>ElasticsearchClient</code> | A [client](./kibana-plugin-core-server.elasticsearchclient.md) to be used to query the ES cluster on behalf of the Kibana internal user | | ||
| [asScoped](./kibana-plugin-core-server.iclusterclient.asscoped.md) | <code>(request: ScopeableRequest) => IScopedClusterClient</code> | Creates a [scoped cluster client](./kibana-plugin-core-server.iscopedclusterclient.md) bound to given [request](./kibana-plugin-core-server.scopeablerequest.md) | | ||
|
13 changes: 13 additions & 0 deletions
13
...development/core/server/kibana-plugin-core-server.icustomclusterclient.close.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [ICustomClusterClient](./kibana-plugin-core-server.icustomclusterclient.md) > [close](./kibana-plugin-core-server.icustomclusterclient.close.md) | ||
|
||
## ICustomClusterClient.close property | ||
|
||
Closes the cluster client. After that client cannot be used and one should create a new client instance to be able to interact with Elasticsearch API. | ||
|
||
<b>Signature:</b> | ||
|
||
```typescript | ||
close: () => Promise<void>; | ||
``` |
20 changes: 20 additions & 0 deletions
20
docs/development/core/server/kibana-plugin-core-server.icustomclusterclient.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,20 @@ | ||
<!-- Do not edit this file. It is automatically generated by API Documenter. --> | ||
|
||
[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [ICustomClusterClient](./kibana-plugin-core-server.icustomclusterclient.md) | ||
|
||
## ICustomClusterClient interface | ||
|
||
See [IClusterClient](./kibana-plugin-core-server.iclusterclient.md) | ||
|
||
<b>Signature:</b> | ||
|
||
```typescript | ||
export interface ICustomClusterClient extends IClusterClient | ||
``` | ||
## Properties | ||
| Property | Type | Description | | ||
| --- | --- | --- | | ||
| [close](./kibana-plugin-core-server.icustomclusterclient.close.md) | <code>() => Promise<void></code> | Closes the cluster client. After that client cannot be used and one should create a new client instance to be able to interact with Elasticsearch API. | | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -4,6 +4,9 @@ | |
|
||
## IndexSettingsDeprecationInfo interface | ||
|
||
> Warning: This API is now obsolete. | ||
> | ||
> | ||
<b>Signature:</b> | ||
|
||
|
13 changes: 13 additions & 0 deletions
13
...ent/core/server/kibana-plugin-core-server.iscopedclusterclient.ascurrentuser.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [IScopedClusterClient](./kibana-plugin-core-server.iscopedclusterclient.md) > [asCurrentUser](./kibana-plugin-core-server.iscopedclusterclient.ascurrentuser.md) | ||
|
||
## IScopedClusterClient.asCurrentUser property | ||
|
||
A [client](./kibana-plugin-core-server.elasticsearchclient.md) to be used to query the elasticsearch cluster on behalf of the user that initiated the request to the Kibana server. | ||
|
||
<b>Signature:</b> | ||
|
||
```typescript | ||
readonly asCurrentUser: ElasticsearchClient; | ||
``` |
13 changes: 13 additions & 0 deletions
13
...nt/core/server/kibana-plugin-core-server.iscopedclusterclient.asinternaluser.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [IScopedClusterClient](./kibana-plugin-core-server.iscopedclusterclient.md) > [asInternalUser](./kibana-plugin-core-server.iscopedclusterclient.asinternaluser.md) | ||
|
||
## IScopedClusterClient.asInternalUser property | ||
|
||
A [client](./kibana-plugin-core-server.elasticsearchclient.md) to be used to query the elasticsearch cluster on behalf of the internal Kibana user. | ||
|
||
<b>Signature:</b> | ||
|
||
```typescript | ||
readonly asInternalUser: ElasticsearchClient; | ||
``` |
21 changes: 21 additions & 0 deletions
21
docs/development/core/server/kibana-plugin-core-server.iscopedclusterclient.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,21 @@ | ||
<!-- Do not edit this file. It is automatically generated by API Documenter. --> | ||
|
||
[Home](./index.md) > [kibana-plugin-core-server](./kibana-plugin-core-server.md) > [IScopedClusterClient](./kibana-plugin-core-server.iscopedclusterclient.md) | ||
|
||
## IScopedClusterClient interface | ||
|
||
Serves the same purpose as the normal [cluster client](./kibana-plugin-core-server.iclusterclient.md) but exposes an additional `asCurrentUser` method that doesn't use credentials of the Kibana internal user (as `asInternalUser` does) to request Elasticsearch API, but rather passes HTTP headers extracted from the current user request to the API instead. | ||
|
||
<b>Signature:</b> | ||
|
||
```typescript | ||
export interface IScopedClusterClient | ||
``` | ||
|
||
## Properties | ||
|
||
| Property | Type | Description | | ||
| --- | --- | --- | | ||
| [asCurrentUser](./kibana-plugin-core-server.iscopedclusterclient.ascurrentuser.md) | <code>ElasticsearchClient</code> | A [client](./kibana-plugin-core-server.elasticsearchclient.md) to be used to query the elasticsearch cluster on behalf of the user that initiated the request to the Kibana server. | | ||
| [asInternalUser](./kibana-plugin-core-server.iscopedclusterclient.asinternaluser.md) | <code>ElasticsearchClient</code> | A [client](./kibana-plugin-core-server.elasticsearchclient.md) to be used to query the elasticsearch cluster on behalf of the internal Kibana user. | | ||
|
Oops, something went wrong.