7.1 KiB
| navigation_title | mapped_pages | |
|---|---|---|
| irc |
|
Irc output plugin [plugins-outputs-irc]
- Plugin version: v3.0.6
- Released on: 2018-04-06
- Changelog
For other versions, see the Versioned plugin docs.
Installation [_installation_34]
For plugins not bundled by default, it is easy to install by running bin/logstash-plugin install logstash-output-irc. See Working with plugins for more details.
Getting help [_getting_help_87]
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.
Description [_description_87]
Write events to IRC
Irc Output Configuration Options [plugins-outputs-irc-options]
This plugin supports the following configuration options plus the Common options described later.
| Setting | Input type | Required |
|---|---|---|
channels |
array | Yes |
format |
string | No |
host |
string | Yes |
messages_per_second |
number | No |
nick |
string | No |
password |
password | No |
port |
number | No |
post_string |
string | No |
pre_string |
string | No |
real |
string | No |
secure |
boolean | No |
user |
string | No |
Also see Common options for a list of options supported by all output plugins.
channels [plugins-outputs-irc-channels]
- 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".
format [plugins-outputs-irc-format]
- Value type is string
- Default value is
"%{{message}}"
Message format to send, event tokens are usable here
host [plugins-outputs-irc-host]
- 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 [plugins-outputs-irc-messages_per_second]
- Value type is number
- Default value is
0.5
Limit the rate of messages sent to IRC in messages per second.
nick [plugins-outputs-irc-nick]
- Value type is string
- Default value is
"logstash"
IRC Nickname
password [plugins-outputs-irc-password]
- Value type is password
- There is no default value for this setting.
IRC server password
port [plugins-outputs-irc-port]
- Value type is number
- Default value is
6667
Port on host to connect to.
post_string [plugins-outputs-irc-post_string]
- Value type is string
- There is no default value for this setting.
Static string after event
pre_string [plugins-outputs-irc-pre_string]
- Value type is string
- There is no default value for this setting.
Static string before event
real [plugins-outputs-irc-real]
- Value type is string
- Default value is
"logstash"
IRC Real name
secure [plugins-outputs-irc-secure]
- Value type is boolean
- Default value is
false
Set this to true to enable SSL.
user [plugins-outputs-irc-user]
- Value type is string
- Default value is
"logstash"
IRC Username
Common options [plugins-outputs-irc-common-options]
These configuration options are supported by all output plugins:
| Setting | Input type | Required |
|---|---|---|
codec |
codec | No |
enable_metric |
boolean | No |
id |
string | No |
codec [plugins-outputs-irc-codec]
- 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 [plugins-outputs-irc-enable_metric]
- 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.
id [plugins-outputs-irc-id]
- 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 irc outputs. Adding a named ID in this case will help in monitoring Logstash when using the monitoring APIs.
output {
irc {
id => "my_plugin_id"
}
}
::::{note}
Variable substitution in the id field only supports environment variables and does not support the use of values from the secret store.
::::