irc

This is a community-maintained plugin!

Write events to IRC

 

Synopsis

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"

format

string

No

"%{message}"

host

string

Yes

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

number

No

1

Details

 

channels

  • 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

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

format

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

Message format to send, event tokens are usable here

host

  • 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

  • Value type is number
  • Default value is 0.5

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

nick

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

IRC Nickname

password

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

IRC server password

port

  • Value type is number
  • Default value is 6667

Port on host to connect to.

post_string

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

Static string after event

pre_string

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

Static string before event

real

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

IRC Real name

secure

  • Value type is boolean
  • Default value is false

Set this to true to enable SSL.

user

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

IRC Username

workers

  • Value type is number
  • Default value is 1

The number of workers to use for this output. Note that this setting may not be useful for all outputs.