Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Extended alerting documentation with information about using Kibana keystore and action types for preconfigured connectors #65201

Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
52 changes: 52 additions & 0 deletions docs/user/alerting/action-types/email.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,58 @@ Username:: username for 'login' type authentication.
Password:: password for 'login' type authentication.

[float]
[[Preconfigured-email-configuration]]
==== Preconfigured action type properties:
YulNaumenko marked this conversation as resolved.
Show resolved Hide resolved

[source,text]
--
id: 'my-email'
name: preconfigured-email-action-type
actionTypeId: .email
config:
sender: [email protected]
YulNaumenko marked this conversation as resolved.
Show resolved Hide resolved
host: validhostname
port: 8080
secure: false
secrets:
user: testuser
password: passwordkeystorevalue
--

`config:` define action type specific to the configuration. Index `config:` consists from the next sub properties:
YulNaumenko marked this conversation as resolved.
Show resolved Hide resolved

[cols="3*<"]
|=====

|`sender:`
YulNaumenko marked this conversation as resolved.
Show resolved Hide resolved
| Email address string
YulNaumenko marked this conversation as resolved.
Show resolved Hide resolved
| correspond to *Sender*.
|`host:`
| String
| correspond to *Host*.
|`port:`
| Number
| correspond to *Port*.
|`secure:`
| Boolean
| correspond to *Secure*.

|=====

`secrets:` define action type sensitive configuration:

[cols="3*<"]
|=====

|`user:`
| String
| correspond to *User*.
|`password:`
| String
| correspond to *Password*. Should be stored in the <<creating-keystore, {kib} keystore>>.

|=====

[[email-action-configuration]]
==== Action configuration

Expand Down
33 changes: 33 additions & 0 deletions docs/user/alerting/action-types/index.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,39 @@ Index:: The {es} index to be written to.
Refresh:: Setting for the {ref}/docs-refresh.html[refresh] policy for the write request.
Execution time field:: This field will be automatically set to the time the alert condition was detected.

[float]
[[Preconfigured-index-configuration]]
==== Preconfigured action type properties:
YulNaumenko marked this conversation as resolved.
Show resolved Hide resolved

[source,text]
--
id: 'my-index'
name: action-type-index
actionTypeId: .index
config:
index: .kibana
refresh: true
executionTimeField: somedate
--

`config:` define action type specific to the configuration. Index `config:` consists from the next sub properties:

[cols="3*<"]
|=====

|`index:`
| String
| correspond to *Index*.
|`refresh:`
| Boolean
| correspond to *Refresh*.
|`executionTimeField:`
| String
| correspond to *Execution time field*.

|=====


[float]
[[index-action-configuration]]
==== Action configuration
Expand Down
37 changes: 37 additions & 0 deletions docs/user/alerting/action-types/pagerduty.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -135,6 +135,43 @@ Name:: The name of the connector. The name is used to identify a connector
API URL:: An optional PagerDuty event URL. Defaults to `https://events.pagerduty.com/v2/enqueue`. If you are using the <<action-settings, `xpack.actions.whitelistedHosts`>> setting, make sure the hostname is whitelisted.
Integration Key:: A 32 character PagerDuty Integration Key for an integration on a service, also referred to as the routing key.

[float]
[[Preconfigured-pagerduty-configuration]]
==== Preconfigured action type properties:
YulNaumenko marked this conversation as resolved.
Show resolved Hide resolved

[source,text]
--
id: 'my-pagerduty'
name: preconfigured-pagerduty-action-type
actionTypeId: .pagerduty
config:
apiUrl: https://test.host
secrets:
routingKey: testroutingkey
--

`config:` define action type specific to the configuration. Index `config:` consists from the next sub properties:

[cols="3*<"]
|=====

|`apiUrl:`
| URL string
| correspond to *API URL*.

|=====

`secrets:` define action type sensitive configuration:
YulNaumenko marked this conversation as resolved.
Show resolved Hide resolved

[cols="3*<"]
|=====

|`routingKey:`
| String
| correspond to *Integration Key*.

|=====

[float]
[[pagerduty-action-configuration]]
==== Action configuration
Expand Down
11 changes: 11 additions & 0 deletions docs/user/alerting/action-types/server-log.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,17 @@ Server log connectors have the following configuration properties:

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.

[float]
[[Preconfigured-server-log-configuration]]
==== Preconfigured action type properties:
YulNaumenko marked this conversation as resolved.
Show resolved Hide resolved

[source,text]
--
id: 'my-server-log'
name: test
actionTypeId: .server-log
--
YulNaumenko marked this conversation as resolved.
Show resolved Hide resolved

[float]
[[server-log-action-configuration]]
==== Action configuration
Expand Down
25 changes: 25 additions & 0 deletions docs/user/alerting/action-types/slack.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,31 @@ Slack connectors have the following configuration properties:
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.
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.

[float]
[[Preconfigured-slack-configuration]]
==== Preconfigured action type properties:
YulNaumenko marked this conversation as resolved.
Show resolved Hide resolved

[source,text]
--
id: 'my-slack'
name: preconfigured-slack-action-type
actionTypeId: .slack
config:
webhookUrl: 'https://hooks.slack.com/services/abcd/efgh/ijklmnopqrstuvwxyz'
--

`config:` define action type specific to the configuration. Index `config:` consists from the next sub properties:

[cols="3*<"]
|=====

|`webhookUrl:`
| URL string
| correspond to *Webhook URL*.

|=====


[float]
[[slack-action-configuration]]
==== Action configuration
Expand Down
50 changes: 50 additions & 0 deletions docs/user/alerting/action-types/webhook.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,56 @@ Headers:: A set of key-value pairs sent as headers with the request
User:: An optional username. If set, HTTP basic authentication is used. Currently only basic authentication is supported.
Password:: An optional password. If set, HTTP basic authentication is used. Currently only basic authentication is supported.

[float]
[[Preconfigured-webhook-configuration]]
==== Preconfigured action type properties:
YulNaumenko marked this conversation as resolved.
Show resolved Hide resolved

[source,text]
--
id: 'my-webhook'
name: preconfigured-webhook-action-type
actionTypeId: .webhook
config:
url: https://test.host
method: POST
headers:
testheader: testvalue
secrets:
user: testuser
password: passwordkeystorevalue
--

`config:` define action type specific to the configuration. Index `config:` consists from the next sub properties:

[cols="3*<"]
|=====

|`url:`
| URL string
| correspond to *URL*.
|`method:`
| String
| correspond to *Method*.
|`headers:`
| Record<String, String>
| correspond to *Headers*.

|=====

`secrets:` define action type sensitive configuration:

[cols="3*<"]
|=====

|`user:`
| String
| correspond to *User*.
|`password:`
| String
| correspond to *Password*. Should be stored in the <<creating-keystore, {kib} keystore>>.

|=====

[float]
[[webhook-action-configuration]]
==== Action configuration
Expand Down
7 changes: 4 additions & 3 deletions docs/user/alerting/pre-configured-connectors.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@

You can preconfigure an action connector to have all the information it needs prior to startup
by adding it to the `kibana.yml` file.
Sensitive configuration information, such as credentials, can use the {kib} keystore.
Sensitive configuration information, such as credentials, can use the <<creating-keystore, {kib} keystore>>.

Preconfigured connectors offer the following capabilities:

Expand All @@ -18,7 +18,8 @@ action are predefined, including the connector name and ID.
[[preconfigured-connector-example]]
=== Example of a preconfigured connector

The following example shows a valid configuration 2 out-of-the box connector.
The following example shows a valid configuration 2 out-of-the box connectors: <<slack-action-type, Slack>> and <<webhook-action-type, Webhook>>.
YulNaumenko marked this conversation as resolved.
Show resolved Hide resolved
You can find all details about available action types configuration <<action-types, here>>
YulNaumenko marked this conversation as resolved.
Show resolved Hide resolved

```js
xpack.actions.preconfigured:
Expand Down Expand Up @@ -49,7 +50,7 @@ The following example shows a valid configuration 2 out-of-the box connector.

[NOTE]
==============================================
Sensitive properties, such as passwords, can also be stored in the {kib} keystore.
Sensitive properties, such as passwords, can also be stored in the <<creating-keystore, {kib} keystore>>.
==============================================

[float]
Expand Down