irc
editirc
editThis is a community-maintained plugin!
Write events to IRC
Synopsis
editThis plugin supports the following configuration options:
Required configuration options:
irc { channels => ... host => ... }
Available configuration options:
Setting | Input type | Required | Default value |
---|---|---|---|
Yes |
|||
No |
|
||
No |
|
||
Yes |
|||
No |
|
||
No |
|
||
No |
|||
No |
|
||
No |
|||
No |
|||
No |
|
||
No |
|
||
No |
|
||
No |
|
Details
edit
channels
edit- 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
edit- 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)
edit- DEPRECATED WARNING: This configuration item is deprecated and may not be available in future versions.
- Value type is array
-
Default value is
[]
Only handle events without any of these tags. Optional.
format
edit- Value type is string
-
Default value is
"%{message}"
Message format to send, event tokens are usable here
host
edit- 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
edit- Value type is number
-
Default value is
0.5
Limit the rate of messages sent to IRC in messages per second.
post_string
edit- Value type is string
- There is no default value for this setting.
Static string after event
pre_string
edit- Value type is string
- There is no default value for this setting.
Static string before event
tags
(DEPRECATED)
edit- DEPRECATED WARNING: This configuration item is deprecated and may not be available in future versions.
- Value type is array
-
Default value is
[]
Only handle events with all of these tags. Optional.
type
(DEPRECATED)
edit- DEPRECATED WARNING: This configuration item is deprecated and may not be available in future versions.
- 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.