Syslog output pluginedit

  • Plugin version: v3.0.3
  • Released on: 2017-08-16
  • Changelog

Installationedit

For 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 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.

Descriptionedit

Send 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 Optionsedit

This plugin supports the following configuration options plus the Common Options described later.

Setting Input typeRequired

appname

string

No

facility

string

No

host

string

Yes

message

string

No

msgid

string

No

port

number

Yes

priority

string

No

procid

string

No

protocol

string, one of ["tcp", "udp", "ssl-tcp"]

No

reconnect_interval

number

No

rfc

string, one of ["rfc3164", "rfc5424"]

No

severity

string

No

sourcehost

string

No

ssl_cacert

a valid filesystem path

No

ssl_cert

a valid filesystem path

No

ssl_key

a valid filesystem path

No

ssl_key_passphrase

password

No

ssl_verify

boolean

No

use_labels

boolean

No

Also see Common Options for a list of options supported by all output plugins.

 

appnameedit

  • 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.

facilityedit

  • 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.

hostedit

  • This is a required setting.
  • Value type is string
  • There is no default value for this setting.

syslog server address to connect to

messageedit

  • 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.

msgidedit

  • 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.

portedit

  • This is a required setting.
  • Value type is number
  • There is no default value for this setting.

syslog server port to connect to

priorityedit

  • 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.

procidedit

  • 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.

protocoledit

  • 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_intervaledit

  • Value type is number
  • Default value is 1

when connection fails, retry interval in sec.

rfcedit

  • Value can be any of: rfc3164, rfc5424
  • Default value is "rfc3164"

syslog message format: you can choose between rfc3164 or rfc5424

severityedit

  • 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.

sourcehostedit

  • 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_cacertedit

  • 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.

ssl_certedit

  • Value type is path
  • There is no default value for this setting.

SSL certificate path

ssl_keyedit

  • Value type is path
  • There is no default value for this setting.

SSL key path

ssl_key_passphraseedit

  • Value type is password
  • Default value is nil

SSL key passphrase

ssl_verifyedit

  • Value type is boolean
  • Default value is false

Verify the identity of the other end of the SSL connection against the CA.

use_labelsedit

  • Value type is boolean
  • Default value is true

use label parsing for severity and facility levels use priority field if set to false

Common Optionsedit

The following configuration options are supported by all output plugins:

Setting Input typeRequired

codec

codec

No

enable_metric

boolean

No

id

string

No

workers

number

No

codecedit

  • 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_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.

  • 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"
 }
}

workersedit

  • Value type is string
  • Default value is 1