logstash-docs-md
Loading

Slack output plugin v2.2.0

  • Plugin version: v2.2.0
  • Released on: 2020-08-10
  • Changelog

For other versions, see the overview list.

To learn more about Logstash, see the Logstash Reference.

Getting help

For questions about the plugin, open a topic in the Discuss forums. For bugs or feature requests, open an issue in Github. For the list of Elastic supported plugins, please consult the Elastic Support Matrix.

Description

Write events to Slack.

This plugin supports the following configuration options plus the Common options described later.

Setting Input type Required
attachments array No
channel string No
format string No
icon_emoji string No
icon_url string No
url string Yes
username string No

Also see Common options for a list of options supported by all output plugins.

  • Value type is array
  • There is no default value for this setting.

Attachments array as described https://api.slack.com/docs/attachments

  • Value type is string
  • There is no default value for this setting.

The channel to post to

  • Value type is string
  • Default value is "%{{message}}"

The text to post in slack

  • Value type is string
  • There is no default value for this setting.

Emoji icon to use

  • Value type is string
  • There is no default value for this setting.

Icon URL to use

  • This is a required setting.
  • Value type is string
  • There is no default value for this setting.

The incoming webhook URI needed to post a message

  • Value type is string
  • There is no default value for this setting.

The username to use for posting

These configuration options are supported by all output plugins:

Setting Input type Required
codec codec No
enable_metric boolean No
id string No
  • Value type is codec
  • Default value is "plain"

The codec used for output data. Output codecs are a convenient method for encoding your data before it leaves the output without needing a separate filter in your Logstash pipeline.

  • Value type is boolean
  • Default value is true

Disable or enable metric logging for this specific plugin instance. By default we record all the metrics we can, but you can disable metrics collection for a specific plugin.

  • Value type is string
  • There is no default value for this setting.

Add a unique ID to the plugin configuration. If no ID is specified, Logstash will generate one. It is strongly recommended to set this ID in your configuration. This is particularly useful when you have two or more plugins of the same type. For example, if you have 2 slack outputs. Adding a named ID in this case will help in monitoring Logstash when using the monitoring APIs.

output {
  slack {
    id => "my_plugin_id"
  }
}