ircedit

  • Version: 3.0.2
  • Released on: 2016-07-14
  • Changelog

Write events to IRC

 

Synopsisedit

This plugin supports the following configuration options:

Required configuration options:

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

Available configuration options:

Setting Input typeRequiredDefault 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

Detailsedit

 

channelsedit

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

codecedit

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

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

formatedit

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

Message format to send, event tokens are usable here

hostedit

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

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

messages_per_secondedit

  • Value type is number
  • Default value is 0.5

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

nickedit

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

IRC Nickname

passwordedit

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

IRC server password

portedit

  • Value type is number
  • Default value is 6667

Port on host to connect to.

post_stringedit

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

Static string after event

pre_stringedit

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

Static string before event

realedit

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

IRC Real name

secureedit

  • Value type is boolean
  • Default value is false

Set this to true to enable SSL.

useredit

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

IRC Username

workersedit

  • 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