irc

edit
  • Version: 3.0.2
  • Released on: 2016-07-14
  • Changelog
  • Compatible: 5.1.1.1, 5.0.0, 2.4.1, 2.4.0, 2.3.4

Write events to IRC

 

Synopsis

edit

This plugin supports the following configuration options:

Required configuration options:

irc {
    channels => ...
    host => ...
}

Available configuration options:

Setting Input type Required Default value

channels

array

Yes

codec

codec

No

"plain"

enable_metric

boolean

No

true

format

string

No

"%{message}"

host

string

Yes

id

string

No

messages_per_second

number

No

0.5

nick

string

No

"logstash"

password

password

No

port

number

No

6667

post_string

string

No

pre_string

string

No

real

string

No

"logstash"

secure

boolean

No

false

user

string

No

"logstash"

workers

<<,>>

No

1

Details

edit

 

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".

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.

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

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

Add a unique ID to the plugin instance, this ID is used for tracking information for a specific configuration of the plugin.

output {
 stdout {
   id => "ABC"
 }
}

If you don’t explicitely set this variable Logstash will generate a unique name.

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

workers

edit
  • Value type is string
  • Default value is 1

TODO remove this in Logstash 6.0 when we no longer support the :legacy type This is hacky, but it can only be herne