irc
editirc
editThis is a community-maintained plugin!
Read events from an IRC Server.
Synopsis
editThis plugin supports the following configuration options:
Required configuration options:
irc { channels => ... host => ... }
Available configuration options:
Setting | Input type | Required | Default value |
---|---|---|---|
No |
|
||
No |
|
||
Yes |
|||
No |
|
||
No |
|
||
Yes |
|||
No |
|
||
No |
|||
No |
|
||
No |
|
||
No |
|
||
No |
|
||
No |
|||
No |
|||
No |
|
Details
edit
catch_all
edit- Value type is boolean
-
Default value is
false
Catch all IRC channel/user events not just channel messages
channels
edit- 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".
codec
edit- 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_stats
edit- Value type is boolean
-
Default value is
false
Gather and send user counts for channels - this requires catch_all and will force it
host
edit- 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.
stats_interval
edit- Value type is number
-
Default value is
5
How often in minutes to get the user count stats
tags
edit- 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.
type
edit- 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.