mirror of
https://github.com/elastic/kibana.git
synced 2025-04-24 01:38:56 -04:00
[DOCS] Move preconfigured Slack connector details (#166212)
This commit is contained in:
parent
bfa334c500
commit
5e5e4cfc0a
6 changed files with 51 additions and 31 deletions
|
@ -3,6 +3,10 @@
|
|||
++++
|
||||
<titleabbrev>Slack</titleabbrev>
|
||||
++++
|
||||
:frontmatter-description: Add a connector that can send Slack messages.
|
||||
:frontmatter-tags-products: [kibana]
|
||||
:frontmatter-tags-content-type: [how-to]
|
||||
:frontmatter-tags-user-goals: [configure]
|
||||
|
||||
The Slack connector uses incoming webhooks or an API method to send Slack messages.
|
||||
|
||||
|
@ -28,37 +32,6 @@ Thus a connector can be used in multiple rules and actions to communicate with d
|
|||
|
||||
For Slack setup details, go to <<configuring-slack>>.
|
||||
|
||||
[float]
|
||||
[[preconfigured-slack-configuration]]
|
||||
=== Create preconfigured connectors
|
||||
|
||||
If you are running {kib} on-prem, you can define connectors by
|
||||
adding `xpack.actions.preconfigured` settings to your `kibana.yml` file.
|
||||
|
||||
.Example Slack connector with webhook
|
||||
[source,text]
|
||||
--
|
||||
xpack.actions.preconfigured:
|
||||
my-slack:
|
||||
name: preconfigured-slack-webhook-connector-type
|
||||
actionTypeId: .slack
|
||||
secrets:
|
||||
webhookUrl: 'https://hooks.slack.com/services/xxxx/xxxx/xxxx' <1>
|
||||
--
|
||||
<1> To obtain this value, go to <<configuring-slack-webhook>>.
|
||||
|
||||
.Example Slack connector with web API
|
||||
[source,text]
|
||||
--
|
||||
xpack.actions.preconfigured:
|
||||
my-slack:
|
||||
name: preconfigured-slack-api-connector-type
|
||||
actionTypeId: .slack_api
|
||||
secrets:
|
||||
token: 'xoxb-xxxx-xxxx-xxxx' <1>
|
||||
--
|
||||
<1> To obtain this value, go to <<configuring-slack-web-api>>.
|
||||
|
||||
[float]
|
||||
[[slack-action-configuration]]
|
||||
=== Test connectors
|
||||
|
|
|
@ -111,6 +111,7 @@ Index names must start with `kibana-alert-history-` to take advantage of the pre
|
|||
* <<preconfigured-opsgenie-configuration>>
|
||||
* <<preconfigured-pagerduty-configuration>>
|
||||
* <<preconfigured-server-log-configuration>>
|
||||
* <<preconfigured-slack-configuration>>
|
||||
* <<preconfigured-webhook-configuration>>
|
||||
* <<preconfigured-cases-webhook-configuration>>
|
||||
* <<preconfigured-xmatters-configuration>>
|
||||
|
@ -229,6 +230,37 @@ xpack.actions.preconfigured:
|
|||
actionTypeId: .server-log
|
||||
--
|
||||
|
||||
|
||||
[float]
|
||||
[[preconfigured-slack-configuration]]
|
||||
==== Slack connectors
|
||||
|
||||
The following example creates a <<slack-action-type,Slack connector>> with webhook:
|
||||
|
||||
[source,text]
|
||||
--
|
||||
xpack.actions.preconfigured:
|
||||
my-slack:
|
||||
name: preconfigured-slack-webhook-connector-type
|
||||
actionTypeId: .slack
|
||||
secrets:
|
||||
webhookUrl: 'https://hooks.slack.com/services/xxxx/xxxx/xxxx' <1>
|
||||
--
|
||||
<1> The Slack webhook URL.
|
||||
|
||||
The following example creates a Slack connector with web API:
|
||||
|
||||
[source,text]
|
||||
--
|
||||
xpack.actions.preconfigured:
|
||||
my-slack:
|
||||
name: preconfigured-slack-api-connector-type
|
||||
actionTypeId: .slack_api
|
||||
secrets:
|
||||
token: 'xoxb-xxxx-xxxx-xxxx' <1>
|
||||
--
|
||||
<1> The Slack bot user OAuth token.
|
||||
|
||||
[float]
|
||||
[[preconfigured-webhook-configuration]]
|
||||
==== Webhook connectors
|
||||
|
|
|
@ -383,6 +383,13 @@ It is used only when `xpack.actions.preconfigured.<connector-id>.config.usesBasi
|
|||
+
|
||||
NOTE: If you are using the `xpack.actions.allowedHosts` setting, make sure this hostname is added to the allowed hosts.
|
||||
|
||||
`xpack.actions.preconfigured.<connector-id>.secrets.token`::
|
||||
A token secret that varies by connector:
|
||||
+
|
||||
--
|
||||
For a <<slack-action-type,Slack connector>>, specifies the Slack bot user OAuth token.
|
||||
--
|
||||
|
||||
`xpack.actions.preconfigured.<connector-id>.secrets.user`::
|
||||
A user name secret that varies by connector:
|
||||
+
|
||||
|
@ -396,6 +403,11 @@ For a <<teams-action-type,Microsoft Teams>>, specifies the URL of the incoming w
|
|||
NOTE: If you are using the `xpack.actions.allowedHosts` setting, make sure the hostname is added to the allowed hosts.
|
||||
|
||||
|
||||
`xpack.actions.preconfigured.<connector-id>.secrets.webhookUrl`::
|
||||
For a <<slack-action-type,Slack connector>>, specifies the Slack webhook URL.
|
||||
+
|
||||
NOTE: If you are using the `xpack.actions.allowedHosts` setting, make sure the hostname is added to the allowed hosts.
|
||||
|
||||
[float]
|
||||
[[alert-settings]]
|
||||
=== Alerting settings
|
||||
|
|
|
@ -3986,6 +3986,7 @@
|
|||
".servicenow-sir",
|
||||
".server-log",
|
||||
".slack",
|
||||
".slack_api",
|
||||
".swimlane",
|
||||
".teams",
|
||||
".tines",
|
||||
|
|
|
@ -2754,6 +2754,7 @@ components:
|
|||
- .servicenow-sir
|
||||
- .server-log
|
||||
- .slack
|
||||
- .slack_api
|
||||
- .swimlane
|
||||
- .teams
|
||||
- .tines
|
||||
|
|
|
@ -15,6 +15,7 @@ enum:
|
|||
- .servicenow-sir
|
||||
- .server-log
|
||||
- .slack
|
||||
- .slack_api
|
||||
- .swimlane
|
||||
- .teams
|
||||
- .tines
|
||||
|
|
Loading…
Add table
Add a link
Reference in a new issue