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
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
Prev Previous commit
Next Next commit
Fixed due to comments and merged two preconfig pages
YulNaumenko committed May 5, 2020

Verified

This commit was created on GitHub.com and signed with GitHub’s verified signature.
commit 59b038768b97b916dd48143ba0fec00e2d845bf4
7 changes: 2 additions & 5 deletions docs/user/alerting/action-types.asciidoc
Original file line number Diff line number Diff line change
@@ -44,10 +44,8 @@ see https://www.elastic.co/subscriptions[the subscription page].
=== Preconfigured connectors and action types

You can create connectors for actions in <<managing-alerts-and-actions, Alerts and Actions>> or via the action API.
For out-of-the-box and standardized connectors, you can <<pre-configured-connectors, preconfigure connectors>>
before {kib} starts.

Action type with only preconfigured connectors could be specified as a <<pre-configured-action-types, preconfigured action type>>.
For out-of-the-box and standardized connectors, you can <<preconfigured-connector-example, preconfigure connectors>>
YulNaumenko marked this conversation as resolved.
Show resolved Hide resolved
or define action type with only preconfigured connectors could be specified as a <<preconfigured-action-type-example, preconfigured action type>> before {kib} starts .

include::action-types/email.asciidoc[]
include::action-types/index.asciidoc[]
@@ -56,4 +54,3 @@ include::action-types/server-log.asciidoc[]
include::action-types/slack.asciidoc[]
include::action-types/webhook.asciidoc[]
include::pre-configured-connectors.asciidoc[]
include::pre-configured-action-types.asciidoc[]
4 changes: 2 additions & 2 deletions docs/user/alerting/action-types/email.asciidoc
Original file line number Diff line number Diff line change
@@ -28,7 +28,7 @@ Password:: password for 'login' type authentication.
name: preconfigured-email-action-type
actionTypeId: .email
config:
sender: [email protected]
from: [email protected]
host: validhostname
port: 8080
secure: false
@@ -37,7 +37,7 @@ Password:: password for 'login' type authentication.
password: passwordkeystorevalue
--

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

[cols="3*<"]
|=====
2 changes: 1 addition & 1 deletion docs/user/alerting/action-types/index.asciidoc
Original file line number Diff line number Diff line change
@@ -30,7 +30,7 @@ Execution time field:: This field will be automatically set to the time the ale
executionTimeField: somedate
--

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

[cols="3*<"]
|=====
2 changes: 1 addition & 1 deletion docs/user/alerting/action-types/pagerduty.asciidoc
Original file line number Diff line number Diff line change
@@ -150,7 +150,7 @@ Integration Key:: A 32 character PagerDuty Integration Key for an integration
routingKey: testroutingkey
--

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

[cols="3*<"]
|=====
2 changes: 1 addition & 1 deletion docs/user/alerting/action-types/slack.asciidoc
Original file line number Diff line number Diff line change
@@ -26,7 +26,7 @@ Webhook URL:: The URL of the incoming webhook. See https://api.slack.com/messa
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:
`config:` define action type specific to the configuration. The config object contains the following properties:
YulNaumenko marked this conversation as resolved.
Show resolved Hide resolved

[cols="3*<"]
|=====
2 changes: 1 addition & 1 deletion docs/user/alerting/action-types/webhook.asciidoc
Original file line number Diff line number Diff line change
@@ -36,7 +36,7 @@ Password:: An optional password. If set, HTTP basic authentication is used. Cur
password: passwordkeystorevalue
--

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

[cols="3*<"]
|=====
61 changes: 0 additions & 61 deletions docs/user/alerting/pre-configured-action-types.asciidoc

This file was deleted.

60 changes: 51 additions & 9 deletions docs/user/alerting/pre-configured-connectors.asciidoc
Original file line number Diff line number Diff line change
@@ -1,25 +1,28 @@
[role="xpack"]
[[pre-configured-connectors]]
[[pre-configured-action-types-and-connectors]]

== Preconfigured connectors
== Preconfigured action types and connectors

You can preconfigure an action connector to have all the information it needs prior to startup
You can preconfigure an action type or just a connector to have all the information it needs prior to startup
YulNaumenko marked this conversation as resolved.
Show resolved Hide resolved
by adding it to the `kibana.yml` file.
Sensitive configuration information, such as credentials, can use the <<creating-keystore, {kib} keystore>>.

Preconfigured connectors offer the following capabilities:

- Require no setup. Configuration and credentials needed to execute an
action are predefined, including the connector name and ID.
- Requires no setup. Configuration and credentials needed to execute an
action are predefined, including the connectors name and ID.
YulNaumenko marked this conversation as resolved.
Show resolved Hide resolved
- Appear in all spaces because they are not saved objects.
- Cannot be edited or deleted.

Sensitive configuration information, such as credentials, can use the <<creating-keystore, {kib} keystore>>.

A preconfigured action types has only preconfigured connectors. But preconfigured connectors could belong to the preconfigured action type or to the regular action type as well.
YulNaumenko marked this conversation as resolved.
Show resolved Hide resolved

[float]
[[preconfigured-connector-example]]
=== Example of a preconfigured connector
=== Creating a preconfigured 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>>
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:
@@ -53,9 +56,32 @@ You can find all details about available action types configuration <<action-typ
Sensitive properties, such as passwords, can also be stored in the <<creating-keystore, {kib} keystore>>.
==============================================

[float]
[[preconfigured-action-type-example]]
=== Creating a preconfigured action type
YulNaumenko marked this conversation as resolved.
Show resolved Hide resolved

In the `kibana.yml` file:
YulNaumenko marked this conversation as resolved.
Show resolved Hide resolved

. Exclude the action type from `xpack.actions.enabledActionTypes`.
. Add all its preconfigured connectors.

The following example shows a valid configuration of preconfigured action type with one out-of-the box connector.

```js
xpack.actions.enabledActionTypes: ['.slack', '.email', '.index'] <1>
xpack.actions.preconfigured: <2>
- id: 'my-server-log'
actionTypeId: .server-log
name: 'Server log #xyz'
```

<1> `enabledActionTypes` should exclude preconfigured action type to prevent creating and deleting connectors.
<2> `preconfigured` is the setting for defining the list of available connectors for the preconfigured action type.


[float]
[[pre-configured-connector-alert-form]]
=== Creating an alert with a preconfigured connector
=== Alert with a preconfigured connector

When attaching an action to an alert,
select from a list of available action types, and
@@ -86,3 +112,19 @@ A message indicates that this is a preconfigured connector.

[role="screenshot"]
image::images/pre-configured-connectors-view-screen.png[Pre-configured connector view details]

If preconfigured connector belong to the preconfigured action type, it is disabled for the details preview.
YulNaumenko marked this conversation as resolved.
Show resolved Hide resolved

[role="screenshot"]
image::images/pre-configured-action-type-managing.png[Connectors managing tab with pre-cofigured]


[float]
[[managing-pre-configured-action-types]]
=== Managing preconfigured action types

Clicking *Create connector* shows the list of available action types.
Preconfigured action types are not included because you can't create a connector with a preconfigured action type.
YulNaumenko marked this conversation as resolved.
Show resolved Hide resolved

[role="screenshot"]
image::images/pre-configured-action-type-select-type.png[Pre-configured connector create menu]
YulNaumenko marked this conversation as resolved.
Show resolved Hide resolved