ircedit

This is a community-maintained plugin!

Read events from an IRC Server.

 

Synopsisedit

This plugin supports the following configuration options:

Required configuration options:

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

Available configuration options:

SettingInput typeRequiredDefault value

add_field

hash

No

{}

catch_all

boolean

No

false

channels

array

Yes

 

codec

codec

No

"plain"

get_stats

boolean

No

false

host

string

Yes

 

nick

string

No

"logstash"

password

password

No

 

port

number

No

6667

real

string

No

"logstash"

secure

boolean

No

false

stats_interval

number

No

5

tags

array

No

 

type

string

No

 

user

string

No

"logstash"

Detailsedit

 

add_fieldedit

  • Value type is hash
  • Default value is {}

Add a field to an event

catch_alledit

  • Value type is boolean
  • Default value is false

Catch all IRC channel/user events not just channel messages

channelsedit

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

Channels to join and read messages from.

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

For passworded channels, add a space and the channel password, such as "#logstash password".

codecedit

  • Value type is codec
  • Default value is "plain"

The codec used for input data. Input codecs are a convenient method for decoding your data before it enters the input, without needing a separate filter in your Logstash pipeline.

get_statsedit

  • Value type is boolean
  • Default value is false

Gather and send user counts for channels - this requires catch_all and will force it

hostedit

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

Host of the IRC Server to connect to.

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 for the IRC Server

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.

stats_intervaledit

  • Value type is number
  • Default value is 5

How often in minutes to get the user count stats

tagsedit

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

Add any number of arbitrary tags to your event.

This can help with processing later.

typeedit

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

Add a type field to all events handled by this input.

Types are used mainly for filter activation.

The type is stored as part of the event itself, so you can also use the type to search for it in Kibana.

If you try to set a type on an event that already has one (for example when you send an event from a shipper to an indexer) then a new input will not override the existing type. A type set at the shipper stays with that event for its life even when sent to another Logstash server.

useredit

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

IRC Username