Skip to content

Commit 1b3dcfc

Browse files
kibanamachinekibanamachine
authored
Merge branch 'master' into fix-repo-root-finding-for-ci
2 parents 5e214ec + de58b8c commit 1b3dcfc

637 files changed

Lines changed: 6084 additions & 1583 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

‎.github/CODEOWNERS‎

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -315,7 +315,6 @@
315315
/src/plugins/es_ui_shared/ @elastic/kibana-stack-management
316316
/x-pack/plugins/cross_cluster_replication/ @elastic/kibana-stack-management
317317
/x-pack/plugins/index_lifecycle_management/ @elastic/kibana-stack-management
318-
/x-pack/plugins/console_extensions/ @elastic/kibana-stack-management
319318
/x-pack/plugins/grokdebugger/ @elastic/kibana-stack-management
320319
/x-pack/plugins/index_management/ @elastic/kibana-stack-management
321320
/x-pack/plugins/license_api_guard/ @elastic/kibana-stack-management
@@ -330,7 +329,6 @@
330329
/x-pack/plugins/ingest_pipelines/ @elastic/kibana-stack-management
331330
/packages/kbn-ace/ @elastic/kibana-stack-management
332331
/packages/kbn-monaco/ @elastic/kibana-stack-management
333-
#CC# /x-pack/plugins/console_extensions/ @elastic/kibana-stack-management
334332
#CC# /x-pack/plugins/cross_cluster_replication/ @elastic/kibana-stack-management
335333

336334
# Security Solution

‎docs/apm/agent-configuration.asciidoc‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -43,6 +43,7 @@ Supported configurations are also tagged with the image:./images/dynamic-config.
4343

4444
[horizontal]
4545
Go Agent:: {apm-go-ref}/configuration.html[Configuration reference]
46+
iOS agent:: _Not yet supported_
4647
Java Agent:: {apm-java-ref}/configuration.html[Configuration reference]
4748
.NET Agent:: {apm-dotnet-ref}/configuration.html[Configuration reference]
4849
Node.js Agent:: {apm-node-ref}/configuration.html[Configuration reference]

‎docs/apm/apm-alerts.asciidoc‎

Lines changed: 50 additions & 65 deletions
Original file line numberDiff line numberDiff line change
@@ -1,69 +1,57 @@
11
[role="xpack"]
22
[[apm-alerts]]
3-
=== Alerts
3+
=== Alerts and rules
44

55
++++
66
<titleabbrev>Create an alert</titleabbrev>
77
++++
88

9+
The APM app allows you to define **rules** to detect complex conditions within your APM data
10+
and trigger built-in **actions** when those conditions are met.
911

10-
The APM app integrates with Kibana's {kibana-ref}/alerting-getting-started.html[alerting and actions] feature.
11-
It provides a set of built-in **actions** and APM specific threshold **alerts** for you to use
12-
and enables central management of all alerts from <<management,Kibana Management>>.
12+
The following **rules** are supported:
13+
14+
* Latency anomaly rule:
15+
Alert when latency of a service is abnormal
16+
* Transaction error rate threshold rule:
17+
Alert when the service's transaction error rate is above the defined threshold
18+
* Error count threshold rule:
19+
Alert when the number of errors in a service exceeds a defined threshold
1320

1421
[role="screenshot"]
1522
image::apm/images/apm-alert.png[Create an alert in the APM app]
1623

17-
For a walkthrough of the alert flyout panel, including detailed information on each configurable property,
18-
see Kibana's <<create-edit-rules,defining alerts>>.
19-
20-
The APM app supports four different types of alerts:
21-
22-
* Transaction duration anomaly:
23-
alerts when the service's transaction duration reaches a certain anomaly score
24-
* Transaction duration threshold:
25-
alerts when the service's transaction duration exceeds a given time limit over a given time frame
26-
* Transaction error rate threshold:
27-
alerts when the service's transaction error rate is above the selected rate over a given time frame
28-
* Error count threshold:
29-
alerts when service exceeds a selected number of errors over a given time frame
24+
For a complete walkthrough of the **Create rule** flyout panel, including detailed information on each configurable property,
25+
see Kibana's <<create-edit-rules,create and edit rules>>.
3026

31-
Below, we'll walk through the creation of two of these alerts.
27+
Below, we'll walk through the creation of two APM rules.
3228

3329
[float]
3430
[[apm-create-transaction-alert]]
35-
=== Example: create a transaction duration alert
31+
=== Example: create a latency anomaly rule
3632

37-
Transaction duration alerts trigger when the duration of a specific transaction type in a service exceeds a defined threshold.
38-
This guide will create an alert for the `opbeans-java` service based on the following criteria:
33+
Latency anomaly rules trigger when the latency of a service is abnormal.
34+
This guide will create an alert for all services based on the following criteria:
3935

40-
* Environment: Production
41-
* Transaction type: `transaction.type:request`
42-
* Average request is above `1500ms` for the last 5 minutes
43-
* Check every 10 minutes, and repeat the alert every 30 minutes
44-
* Send the alert via Slack
36+
* Environment: production
37+
* Severity level: critical
38+
* Run every five minutes
39+
* Send an alert to a Slack channel only when the rule status changes
4540

46-
From the APM app, navigate to the `opbeans-java` service and select
47-
**Alerts** > **Create threshold alert** > **Transaction duration**.
41+
From any page in the APM app, select **Alerts and rules** > **Latency** > **Create anomaly rule**.
42+
Change the name of the alert, but do not edit the tags.
4843

49-
`Transaction duration | opbeans-java` is automatically set as the name of the alert,
50-
and `apm` and `service.name:opbeans-java` are added as tags.
51-
It's fine to change the name of the alert, but do not edit the tags.
44+
Based on the criteria above, define the following rule details:
5245

53-
Based on the alert criteria, define the following alert details:
46+
* **Check every** - `5 minutes`
47+
* **Notify** - "Only on status change"
48+
* **Environment** - `all`
49+
* **Has anomaly with severity** - `critical`
5450

55-
* **Check every** - `10 minutes`
56-
* **Notify every** - `30 minutes`
57-
* **TYPE** - `request`
58-
* **WHEN** - `avg`
59-
* **IS ABOVE** - `1500ms`
60-
* **FOR THE LAST** - `5 minutes`
61-
62-
Select an action type.
63-
Multiple action types can be selected, but in this example, we want to post to a Slack channel.
51+
Next, add a connector. Multiple connectors can be selected, but in this example we're interested in Slack.
6452
Select **Slack** > **Create a connector**.
6553
Enter a name for the connector,
66-
and paste the webhook URL.
54+
and paste your Slack webhook URL.
6755
See Slack's webhook documentation if you need to create one.
6856

6957
A default message is provided as a starting point for your alert.
@@ -72,35 +60,32 @@ to pass additional alert values at the time a condition is detected to an action
7260
A list of available variables can be accessed by selecting the
7361
**add variable** button image:apm/images/add-variable.png[add variable button].
7462

75-
Select **Save**. The alert has been created and is now active!
63+
Click **Save**. The rule has been created and is now active!
7664

7765
[float]
7866
[[apm-create-error-alert]]
79-
=== Example: create an error rate alert
67+
=== Example: create an error count threshold alert
8068

81-
Error rate alerts trigger when the number of errors in a service exceeds a defined threshold.
82-
This guide creates an alert for the `opbeans-python` service based on the following criteria:
69+
The error count threshold alert triggers when the number of errors in a service exceeds a defined threshold.
70+
This guide will create an alert for all services based on the following criteria:
8371

84-
* Environment: Production
72+
* All environments
8573
* Error rate is above 25 for the last minute
86-
* Check every 1 minute, and repeat the alert every 10 minutes
87-
* Send the alert via email to the `opbeans-python` team
88-
89-
From the APM app, navigate to the `opbeans-python` service and select
90-
**Alerts** > **Create threshold alert** > **Error rate**.
74+
* Check every 1 minute, and alert every time the rule is active
75+
* Send the alert via email to the site reliability team
9176

92-
`Error rate | opbeans-python` is automatically set as the name of the alert,
93-
and `apm` and `service.name:opbeans-python` are added as tags.
94-
It's fine to change the name of the alert, but do not edit the tags.
77+
From any page in the APM app, select **Alerts and rules** > **Error count** > **Create threshold rule**.
78+
Change the name of the alert, but do not edit the tags.
9579

96-
Based on the alert criteria, define the following alert details:
80+
Based on the criteria above, define the following rule details:
9781

9882
* **Check every** - `1 minute`
99-
* **Notify every** - `10 minutes`
100-
* **IS ABOVE** - `25 errors`
101-
* **FOR THE LAST** - `1 minute`
83+
* **Notify** - "Every time alert is active"
84+
* **Environment** - `all`
85+
* **Is above** - `25 errors`
86+
* **For the last** - `1 minute`
10287

103-
Select the **Email** action type and click **Create a connector**.
88+
Select the **Email** connector and click **Create a connector**.
10489
Fill out the required details: sender, host, port, etc., and click **save**.
10590

10691
A default message is provided as a starting point for your alert.
@@ -109,14 +94,14 @@ to pass additional alert values at the time a condition is detected to an action
10994
A list of available variables can be accessed by selecting the
11095
**add variable** button image:apm/images/add-variable.png[add variable button].
11196

112-
Select **Save**. The alert has been created and is now active!
97+
Click **Save**. The alert has been created and is now active!
11398

11499
[float]
115100
[[apm-alert-manage]]
116-
=== Manage alerts and actions
101+
=== Manage alerts and rules
117102

118-
From the APM app, select **Alerts** > **View active alerts** to be taken to the Kibana alerts and actions management page.
119-
From this page, you can create, edit, disable, mute, and delete alerts, and create, edit, and disable connectors.
103+
From the APM app, select **Alerts and rules** > **Manage rules** to be taken to the Kibana **Rules and Connectors** page.
104+
From this page, you can disable, mute, and delete APM alerts.
120105

121106
[float]
122107
[[apm-alert-more-info]]
@@ -126,4 +111,4 @@ See {kibana-ref}/alerting-getting-started.html[alerting and actions] for more in
126111

127112
NOTE: If you are using an **on-premise** Elastic Stack deployment with security,
128113
communication between Elasticsearch and Kibana must have TLS configured.
129-
More information is in the alerting {kibana-ref}/alerting-setup.html#alerting-prerequisites[prerequisites].
114+
More information is in the alerting {kibana-ref}/alerting-setup.html#alerting-prerequisites[prerequisites].

‎docs/apm/filters.asciidoc‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -36,6 +36,7 @@ It's vital to be consistent when naming environments in your agents.
3636
To learn how to configure service environments, see the specific agent documentation:
3737

3838
* *Go:* {apm-go-ref}/configuration.html#config-environment[`ELASTIC_APM_ENVIRONMENT`]
39+
* *iOS agent:* _Not yet supported_
3940
* *Java:* {apm-java-ref}/config-core.html#config-environment[`environment`]
4041
* *.NET:* {apm-dotnet-ref}/config-core.html#config-environment[`Environment`]
4142
* *Node.js:* {apm-node-ref}/configuration.html#environment[`environment`]

‎docs/apm/images/apm-agent-configuration.png‎

-11.2 KB
Loading

‎docs/apm/images/apm-alert.png‎

-163 KB
Loading

‎docs/apm/images/apm-error-group.png‎

25.4 KB
Loading

‎docs/apm/images/apm-logs-tab.png‎

116 KB
Loading

‎docs/apm/images/apm-services-overview.png‎

-120 KB
Loading

‎docs/apm/images/apm-settings.png‎

20 KB
Loading

0 commit comments

Comments
 (0)