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.

Sign up for GitHub

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

Adding documentation for global action configuration options #83557

Merged
merged 3 commits into from
Nov 19, 2020
Merged

Adding documentation for global action configuration options #83557

Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
6999aea
Adding documentation for global action configuration options
bmcconaghy Nov 17, 2020
6af54af
Update docs/user/alerting/defining-alerts.asciidoc
bmcconaghy Nov 18, 2020
a3e6e37
incorporating PR feedback
bmcconaghy Nov 18, 2020
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
15 changes: 15 additions & 0 deletions docs/user/alerting/defining-alerts.asciidoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -74,6 +74,21 @@ image::images/alert-flyout-add-action.png[You can add multiple actions on an ale
Actions are not required on alerts. In some cases you may want to run an alert without actions first to understand its behavior, and configure actions later.
==============================================

[float]
=== Global actions configuration
Some actions configuration options apply to all actions.
If you are using an *on-premises* Elastic Stack deployment, you can set these in the kibana.yml file.
bmcconaghy marked this conversation as resolved.
Show resolved Hide resolved
If you are using a cloud deployment, you can set these via the console.

Here's a list of the available global configuration options and an explanation of what each one does:

* `xpack.actions.allowedHosts`: Set to an array of host names which actions such as email, slack, pagerduty, and webhook can connect to. An element of * indicates any host can be connected to. An empty array indicates no hosts can be connected to. Default: [ {asterisk} ]
bmcconaghy marked this conversation as resolved.
Show resolved Hide resolved
* `xpack.actions.enabledActionTypes`: Set to an array of action types that are enabled. An element of * indicates all action types registered are enabled. The action types provided by Kibana are: .server-log, .slack, .email, .index, .pagerduty, .webhook. Default: [ {asterisk} ]
bmcconaghy marked this conversation as resolved.
Show resolved Hide resolved
bmcconaghy marked this conversation as resolved.
Show resolved Hide resolved
* `xpack.actions.proxyUrl`: Specifies the proxy URL to use, if using a proxy for actions.
bmcconaghy marked this conversation as resolved.
Show resolved Hide resolved
* `xpack.actions.proxyHeader`: Specifies HTTP headers for proxy, if using a proxy for actions.
* `xpack.actions.proxyRejectUnauthorizedCertificates`: Set to `false` to bypass certificate validation for proxy, if using a proxy for actions.
* `xpack.actions.rejectUnauthorized`: Set to `false` to bypass certificate validation for actions.

[float]
=== Managing alerts

Expand Down