irc
editirc
edit- Version: 3.0.2
- Released on: July 14, 2016
- Changelog
Getting Help
editFor questions about the plugin, open a topic in the Discuss forums. For bugs or feature requests, open an issue in Github. For the list of Elastic supported plugins, please consult the Elastic Support Matrix.
Synopsis
editThis plugin supports the following configuration options:
Required configuration options:
irc { channels => ... host => ... }
Available configuration options:
Setting | Input type | Required |
---|---|---|
Yes |
||
No |
||
No |
||
No |
||
Yes |
||
No |
||
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.
enable_metric
edit- 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.
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
id
edit- 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_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