Irc output plugin v3.0.3

edit
  • Plugin version: v3.0.3
  • Released on: 2017-06-23
  • Changelog

For other versions, see the overview list.

To learn more about Logstash, see the Logstash Reference.

Getting help

edit

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

edit

Write events to IRC

Irc Output Configuration Options

edit

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

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

 

channels

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

Channels to broadcast to.

These should be full channel names including the # symbol, such as "#logstash".

format

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

Message format to send, event tokens are usable here

host

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

Address of the host to connect to

messages_per_second

edit
  • Value type is number
  • Default value is 0.5

Limit the rate of messages sent to IRC in messages per second.

nick

edit
  • Value type is string
  • Default value is "logstash"

IRC Nickname

password

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

IRC server password

port

edit
  • Value type is number
  • Default value is 6667

Port on host to connect to.

post_string

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

Static string after event

pre_string

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

Static string before event

real

edit
  • Value type is string
  • Default value is "logstash"

IRC Real name

secure

edit
  • Value type is boolean
  • Default value is false

Set this to true to enable SSL.

user

edit
  • Value type is string
  • Default value is "logstash"

IRC Username

Common options

edit

These configuration options are supported by all output plugins:

Setting Input type Required

codec

codec

No

enable_metric

boolean

No

id

string

No

codec

edit
  • 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.

enable_metric

edit
  • 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 irc outputs. Adding a named ID in this case will help in monitoring Logstash when using the monitoring APIs.

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