irc

Milestone: 1

Write events to IRC

Synopsis

This is what it might look like in your config file:

output {
  irc {
    channels => ... # array (required)
    codec => ... # codec (optional), default: "plain"
    format => ... # string (optional), default: "%{message}"
    host => ... # string (required)
    messages_per_second => ... # number (optional), default: 0.5
    nick => ... # string (optional), default: "logstash"
    password => ... # password (optional)
    port => ... # number (optional), default: 6667
    post_string => ... # string (optional)
    pre_string => ... # string (optional)
    real => ... # string (optional), default: "logstash"
    secure => ... # boolean (optional), default: false
    user => ... # string (optional), default: "logstash"
    workers => ... # number (optional), default: 1
  }
}

Details

channels (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.

exclude_tags DEPRECATED

• DEPRECATED WARNING: This config item is deprecated. It may be removed in a further version.
• Value type is array
• Default value is []

Only handle events without any of these tags. Note this check is additional to type and tags.

format

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

Message format to send, event tokens are usable here

host (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.

tags DEPRECATED

• DEPRECATED WARNING: This config item is deprecated. It may be removed in a further version.
• Value type is array
• Default value is []

Only handle events with all of these tags. Note that if you specify a type, the event must also match that type. Optional.

type DEPRECATED

• DEPRECATED WARNING: This config item is deprecated. It may be removed in a further version.
• Value type is string
• Default value is ""

The type to act on. If a type is given, then this output will only act on messages with the same type. See any input plugin’s “type” attribute for more. Optional.

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.

---

This is documentation from lib/logstash/outputs/irc.rb