Syslog output plugin
editSyslog output plugin
edit- Plugin version: v3.0.5
- Released on: 2018-04-06
- Changelog
For other versions, see the Versioned plugin docs.
Installation
editFor plugins not bundled by default, it is easy to install by running bin/logstash-plugin install logstash-output-syslog
. See Working with plugins for more details.
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.
Description
editSend events to a syslog server.
You can send messages compliant with RFC3164 or RFC5424 using either UDP or TCP as the transport protocol.
By default the contents of the message
field will be shipped as
the free-form message text part of the emitted syslog message. If
your messages don’t have a message
field or if you for some other
reason want to change the emitted message, modify the message
configuration option.
Syslog Output Configuration Options
editThis plugin supports the following configuration options plus the Common Options described later.
Setting | Input type | Required |
---|---|---|
No |
||
No |
||
Yes |
||
No |
||
No |
||
Yes |
||
No |
||
No |
||
string, one of |
No |
|
No |
||
string, one of |
No |
|
No |
||
No |
||
a valid filesystem path |
No |
|
a valid filesystem path |
No |
|
a valid filesystem path |
No |
|
No |
||
No |
||
No |
Also see Common Options for a list of options supported by all output plugins.
appname
edit- Value type is string
-
Default value is
"LOGSTASH"
application name for syslog message. The new value can include %{foo}
strings
to help you build a new value from other parts of the event.
facility
edit- Value type is string
-
Default value is
"user-level"
facility label for syslog message
default fallback to user-level as in rfc3164
The new value can include %{foo}
strings
to help you build a new value from other parts of the event.
host
edit- This is a required setting.
- Value type is string
- There is no default value for this setting.
syslog server address to connect to
message
edit- Value type is string
-
Default value is
"%{message}"
message text to log. The new value can include %{foo}
strings
to help you build a new value from other parts of the event.
msgid
edit- Value type is string
-
Default value is
"-"
message id for syslog message. The new value can include %{foo}
strings
to help you build a new value from other parts of the event.
port
edit- This is a required setting.
- Value type is number
- There is no default value for this setting.
syslog server port to connect to
priority
edit- Value type is string
-
Default value is
"%{syslog_pri}"
syslog priority
The new value can include %{foo}
strings
to help you build a new value from other parts of the event.
procid
edit- Value type is string
-
Default value is
"-"
process id for syslog message. The new value can include %{foo}
strings
to help you build a new value from other parts of the event.
protocol
edit-
Value can be any of:
tcp
,udp
,ssl-tcp
-
Default value is
"udp"
syslog server protocol. you can choose between udp, tcp and ssl/tls over tcp
reconnect_interval
edit- Value type is number
-
Default value is
1
when connection fails, retry interval in sec.
rfc
edit-
Value can be any of:
rfc3164
,rfc5424
-
Default value is
"rfc3164"
syslog message format: you can choose between rfc3164 or rfc5424
severity
edit- Value type is string
-
Default value is
"notice"
severity label for syslog message
default fallback to notice as in rfc3164
The new value can include %{foo}
strings
to help you build a new value from other parts of the event.
sourcehost
edit- Value type is string
-
Default value is
"%{host}"
source host for syslog message. The new value can include %{foo}
strings
to help you build a new value from other parts of the event.
ssl_cacert
edit- Value type is path
- There is no default value for this setting.
The SSL CA certificate, chainfile or CA path. The system CA path is automatically included.
Common Options
editThe following configuration options are supported by all output plugins:
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.
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 syslog outputs.
Adding a named ID in this case will help in monitoring Logstash when using the monitoring APIs.
output { syslog { id => "my_plugin_id" } }
Variable substitution in the id
field only supports environment variables
and does not support the use of values from the secret store.