You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardexpand all lines: docs/user/alerting/action-types/email.asciidoc
+5-5
Original file line number
Diff line number
Diff line change
@@ -1,6 +1,6 @@
1
1
[role="xpack"]
2
2
[[email-action-type]]
3
-
== Email action type
3
+
===Email action
4
4
5
5
The email action type uses the SMTP protocol to send mail message, using an integration of https://nodemailer.com/[Nodemailer]. Email message text is sent as both plain text and html text.
6
6
@@ -10,11 +10,11 @@ The email action type uses the SMTP protocol to send mail message, using an inte
10
10
11
11
Email connectors have the following configuration properties:
12
12
13
-
Name:: The name of the connector. The name is used to identify a connector in the management UI connector listing, or in the connector list when configuring an action.
13
+
Name:: The name of the connector. The name is used to identify a connector in the management UI connector listing, or in the connector list when configuring an action.
14
14
Sender:: The from address for all emails sent with this connector, specified in `user@host-name` format.
15
-
Host:: Host name of the service provider. If you are using the <<action-settings, `xpack.actions.whitelistedHosts`>> setting, make sure this hostname is whitelisted.
15
+
Host:: Host name of the service provider. If you are using the <<action-settings, `xpack.actions.whitelistedHosts`>> setting, make sure this hostname is whitelisted.
16
16
Port:: The port to connect to on the service provider.
17
-
Secure:: If true the connection will use TLS when connecting to the service provider. See https://nodemailer.com/smtp/#tls-options[nodemailer TLS documentation] for more information.
17
+
Secure:: If true the connection will use TLS when connecting to the service provider. See https://nodemailer.com/smtp/#tls-options[nodemailer TLS documentation] for more information.
18
18
Username:: username for 'login' type authentication.
19
19
Password:: password for 'login' type authentication.
20
20
@@ -26,4 +26,4 @@ Email actions have the following configuration properties:
26
26
27
27
To, CC, BCC:: Each is a list of addresses. Addresses can be specified in `user@host-name` format, or in `name <user@host-name>` format. One of To, CC, or BCC must contain an entry.
28
28
Subject:: The subject line of the email.
29
-
Message:: The message text of the email. Markdown format is supported.
29
+
Message:: The message text of the email. Markdown format is supported.
Copy file name to clipboardexpand all lines: docs/user/alerting/action-types/pagerduty.asciidoc
+11-13
Original file line number
Diff line number
Diff line change
@@ -1,6 +1,6 @@
1
1
[role="xpack"]
2
2
[[pagerduty-action-type]]
3
-
== PagerDuty action type
3
+
===PagerDuty action
4
4
5
5
The PagerDuty action type uses the https://v2.developer.pagerduty.com/docs/events-api-v2[v2 Events API] to trigger, acknowledge, and resolve PagerDuty alerts.
6
6
@@ -10,7 +10,7 @@ The PagerDuty action type uses the https://v2.developer.pagerduty.com/docs/event
10
10
11
11
[float]
12
12
[[pagerduty-benefits]]
13
-
=== PagerDuty + Elastic integration benefits
13
+
==== PagerDuty + Elastic integration benefits
14
14
15
15
By integrating PagerDuty with alerts, you can:
16
16
@@ -20,15 +20,15 @@ By integrating PagerDuty with alerts, you can:
20
20
21
21
[float]
22
22
[[pagerduty-how-it-works]]
23
-
==== How it works
23
+
===== How it works
24
24
25
25
{kib} allows you to create alerts to notify you of a significant move
26
26
in your dataset.
27
27
You can create alerts for all your Observability, Security, and Elastic Stack use cases.
28
28
Alerts will trigger a new incident on the corresponding PagerDuty service.
29
29
30
30
[float]
31
-
==== Requirements
31
+
===== Requirements
32
32
33
33
In the `kibana.yml` configuration file, you must add the <<general-alert-action-settings, saved objects encryption setting>>.
34
34
This is required to encrypt parameters that must be secured, for example PagerDuty’s integration key.
@@ -47,18 +47,17 @@ review the <<action-settings, Actions settings>> that are available to you.
47
47
48
48
[float]
49
49
[[pagerduty-support]]
50
-
==== Support
50
+
===== Support
51
51
If you need help with this integration, get in touch with the {kib} team by visiting
52
52
https://support.elastic.co[support.elastic.co] or by using the *Ask Elastic* option in the {kib} Help menu.
53
53
You can also select the {kib} category at https://discuss.elastic.co/[discuss.elastic.co].
54
54
55
55
[float]
56
56
[[pagerduty-integration-walkthrough]]
57
-
==== Integration with PagerDuty walkthrough
57
+
===== Integration with PagerDuty walkthrough
58
58
59
-
[float]
60
59
[[pagerduty-in-pagerduty]]
61
-
===== In PagerDuty
60
+
*In PagerDuty*
62
61
63
62
. From the *Configuration* menu, select *Services*.
The Slack action type uses https://api.slack.com/incoming-webhooks[Slack Incoming Webhooks].
5
+
The Slack action type uses https://api.slack.com/incoming-webhooks[Slack Incoming Webhooks].
6
6
7
7
[float]
8
8
[[slack-connector-configuration]]
@@ -11,12 +11,12 @@ The Slack action type uses https://api.slack.com/incoming-webhooks[Slack Incomin
11
11
Slack connectors have the following configuration properties:
12
12
13
13
Name:: The name of the connector. The name is used to identify a connector in the management UI connector listing, or in the connector list when configuring an action.
14
-
Webhook URL:: The URL of the incoming webhook. See https://api.slack.com/messaging/webhooks#getting_started[Slack Incoming Webhooks] for instructions on generating this URL. If you are using the <<action-settings, `xpack.actions.whitelistedHosts`>> setting, make sure the hostname is whitelisted.
14
+
Webhook URL:: The URL of the incoming webhook. See https://api.slack.com/messaging/webhooks#getting_started[Slack Incoming Webhooks] for instructions on generating this URL. If you are using the <<action-settings, `xpack.actions.whitelistedHosts`>> setting, make sure the hostname is whitelisted.
15
15
16
16
[float]
17
17
[[slack-action-configuration]]
18
18
==== Action configuration
19
19
20
20
Slack actions have the following properties:
21
21
22
-
Message:: The message text, converted to the `text` field in the Webhook JSON payload. Currently only the text field is supported. Markdown, images, and other advanced formatting are not yet supported.
22
+
Message:: The message text, converted to the `text` field in the Webhook JSON payload. Currently only the text field is supported. Markdown, images, and other advanced formatting are not yet supported.
Copy file name to clipboardexpand all lines: docs/user/alerting/action-types/webhook.asciidoc
+3-3
Original file line number
Diff line number
Diff line change
@@ -1,6 +1,6 @@
1
1
[role="xpack"]
2
2
[[webhook-action-type]]
3
-
== Webhook action type
3
+
===Webhook action
4
4
5
5
The Webhook action type uses https://github.com/axios/axios[axios] to send a POST or PUT request to a web service.
6
6
@@ -11,7 +11,7 @@ The Webhook action type uses https://github.com/axios/axios[axios] to send a POS
11
11
Webhook connectors have the following configuration properties:
12
12
13
13
Name:: The name of the connector. The name is used to identify a connector in the management UI connector listing, or in the connector list when configuring an action.
14
-
URL:: The request URL. If you are using the <<action-settings, `xpack.actions.whitelistedHosts`>> setting, make sure the hostname is whitelisted.
14
+
URL:: The request URL. If you are using the <<action-settings, `xpack.actions.whitelistedHosts`>> setting, make sure the hostname is whitelisted.
15
15
Method:: HTTP request method, either `post`(default) or `put`.
16
16
Headers:: A set of key-value pairs sent as headers with the request
17
17
User:: An optional username. If set, HTTP basic authentication is used. Currently only basic authentication is supported.
@@ -23,4 +23,4 @@ Password:: An optional password. If set, HTTP basic authentication is used. Cur
0 commit comments