ircedit
- Version: 3.0.2
- Released on: July 14, 2016
- Changelog
Getting Helpedit
For 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.
Synopsisedit
This plugin supports the following configuration options:
Required configuration options:
irc {
channels => ...
host => ...
}
Available configuration options:
| Setting | Input type | Required |
|---|---|---|
No |
||
No |
||
Yes |
||
No |
||
No |
||
No |
||
Yes |
||
No |
||
No |
||
No |
||
No |
||
No |
||
No |
||
No |
||
No |
||
No |
||
No |
Detailsedit
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.
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.
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.
idedit
- 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"
}
}
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.
This is the base class for Logstash inputs.
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.