﻿---
title: Syslog output plugin v3.0.5
description: Plugin version: v3.0.5, Released on: 2018-04-06, Changelog. For other versions, see the overview list. To learn more about Logstash, see the Logstash...
url: https://docs-v3-preview.elastic.dev/elastic/logstash-docs-md/tree/main/vpr/v3-0-5-plugins-outputs-syslog
---

# Syslog output plugin v3.0.5
- Plugin version: v3.0.5
- Released on: 2018-04-06
- [Changelog](https://github.com/logstash-plugins/logstash-output-syslog/blob/v3.0.5/CHANGELOG.md)

For other versions, see the [overview list](https://docs-v3-preview.elastic.dev/elastic/logstash-docs-md/tree/main/vpr/output-syslog-index).
To learn more about Logstash, see the [Logstash Reference](https://www.elastic.co/guide/en/logstash/current/index.html).

## Getting help

For questions about the plugin, open a topic in the [Discuss](http://discuss.elastic.co) forums. For bugs or feature requests, open an issue in [Github](https://github.com/logstash-plugins/logstash-output-syslog). For the list of Elastic supported plugins, please consult the [Elastic Support Matrix](https://www.elastic.co/support/matrix#matrix_logstash_plugins).

## Description

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 Options

This plugin supports the following configuration options plus the [Common options](#v3.0.5-plugins-outputs-syslog-common-options) described later.

| Setting                                                                                       | Input type                                                                                                     | Required |
|-----------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------|----------|
| [`appname`](#v3.0.5-plugins-outputs-syslog-appname)`appname`                                  | [string](/elastic/logstash-docs-md/tree/main/lsr/value-types#string)string                                     | No       |
| [`facility`](#v3.0.5-plugins-outputs-syslog-facility)`facility`                               | [string](/elastic/logstash-docs-md/tree/main/lsr/value-types#string)string                                     | No       |
| [`host`](#v3.0.5-plugins-outputs-syslog-host)`host`                                           | [string](/elastic/logstash-docs-md/tree/main/lsr/value-types#string)string                                     | Yes      |
| [`message`](#v3.0.5-plugins-outputs-syslog-message)`message`                                  | [string](/elastic/logstash-docs-md/tree/main/lsr/value-types#string)string                                     | No       |
| [`msgid`](#v3.0.5-plugins-outputs-syslog-msgid)`msgid`                                        | [string](/elastic/logstash-docs-md/tree/main/lsr/value-types#string)string                                     | No       |
| [`port`](#v3.0.5-plugins-outputs-syslog-port)`port`                                           | [number](/elastic/logstash-docs-md/tree/main/lsr/value-types#number)number                                     | Yes      |
| [`priority`](#v3.0.5-plugins-outputs-syslog-priority)`priority`                               | [string](/elastic/logstash-docs-md/tree/main/lsr/value-types#string)string                                     | No       |
| [`procid`](#v3.0.5-plugins-outputs-syslog-procid)`procid`                                     | [string](/elastic/logstash-docs-md/tree/main/lsr/value-types#string)string                                     | No       |
| [`protocol`](#v3.0.5-plugins-outputs-syslog-protocol)`protocol`                               | [string](/elastic/logstash-docs-md/tree/main/lsr/value-types#string)string, one of `["tcp", "udp", "ssl-tcp"]` | No       |
| [`reconnect_interval`](#v3.0.5-plugins-outputs-syslog-reconnect_interval)`reconnect_interval` | [number](/elastic/logstash-docs-md/tree/main/lsr/value-types#number)number                                     | No       |
| [`rfc`](#v3.0.5-plugins-outputs-syslog-rfc)`rfc`                                              | [string](/elastic/logstash-docs-md/tree/main/lsr/value-types#string)string, one of `["rfc3164", "rfc5424"]`    | No       |
| [`severity`](#v3.0.5-plugins-outputs-syslog-severity)`severity`                               | [string](/elastic/logstash-docs-md/tree/main/lsr/value-types#string)string                                     | No       |
| [`sourcehost`](#v3.0.5-plugins-outputs-syslog-sourcehost)`sourcehost`                         | [string](/elastic/logstash-docs-md/tree/main/lsr/value-types#string)string                                     | No       |
| [`ssl_cacert`](#v3.0.5-plugins-outputs-syslog-ssl_cacert)`ssl_cacert`                         | a valid filesystem path                                                                                        | No       |
| [`ssl_cert`](#v3.0.5-plugins-outputs-syslog-ssl_cert)`ssl_cert`                               | a valid filesystem path                                                                                        | No       |
| [`ssl_key`](#v3.0.5-plugins-outputs-syslog-ssl_key)`ssl_key`                                  | a valid filesystem path                                                                                        | No       |
| [`ssl_key_passphrase`](#v3.0.5-plugins-outputs-syslog-ssl_key_passphrase)`ssl_key_passphrase` | [password](/elastic/logstash-docs-md/tree/main/lsr/value-types#password)password                               | No       |
| [`ssl_verify`](#v3.0.5-plugins-outputs-syslog-ssl_verify)`ssl_verify`                         | [boolean](/elastic/logstash-docs-md/tree/main/lsr/value-types#boolean)boolean                                  | No       |
| [`use_labels`](#v3.0.5-plugins-outputs-syslog-use_labels)`use_labels`                         | [boolean](/elastic/logstash-docs-md/tree/main/lsr/value-types#boolean)boolean                                  | No       |

Also see [Common options](#v3.0.5-plugins-outputs-syslog-common-options) for a list of options supported by all output plugins.

### `appname`

- Value type is [string](/elastic/logstash-docs-md/tree/main/lsr/value-types#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`

- Value type is [string](/elastic/logstash-docs-md/tree/main/lsr/value-types#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`

- This is a required setting.
- Value type is [string](/elastic/logstash-docs-md/tree/main/lsr/value-types#string)
- There is no default value for this setting.

syslog server address to connect to

### `message`

- Value type is [string](/elastic/logstash-docs-md/tree/main/lsr/value-types#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`

- Value type is [string](/elastic/logstash-docs-md/tree/main/lsr/value-types#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`

- This is a required setting.
- Value type is [number](/elastic/logstash-docs-md/tree/main/lsr/value-types#number)
- There is no default value for this setting.

syslog server port to connect to

### `priority`

- Value type is [string](/elastic/logstash-docs-md/tree/main/lsr/value-types#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`

- Value type is [string](/elastic/logstash-docs-md/tree/main/lsr/value-types#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`

- 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`

- Value type is [number](/elastic/logstash-docs-md/tree/main/lsr/value-types#number)
- Default value is `1`

when connection fails, retry interval in sec.

### `rfc`

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

syslog message format: you can choose between rfc3164 or rfc5424

### `severity`

- Value type is [string](/elastic/logstash-docs-md/tree/main/lsr/value-types#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`

- Value type is [string](/elastic/logstash-docs-md/tree/main/lsr/value-types#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`

- Value type is [path](/elastic/logstash-docs-md/tree/main/lsr/value-types#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_cert`

- Value type is [path](/elastic/logstash-docs-md/tree/main/lsr/value-types#path)
- There is no default value for this setting.

SSL certificate path

### `ssl_key`

- Value type is [path](/elastic/logstash-docs-md/tree/main/lsr/value-types#path)
- There is no default value for this setting.

SSL key path

### `ssl_key_passphrase`

- Value type is [password](/elastic/logstash-docs-md/tree/main/lsr/value-types#password)
- Default value is `nil`

SSL key passphrase

### `ssl_verify`

- Value type is [boolean](/elastic/logstash-docs-md/tree/main/lsr/value-types#boolean)
- Default value is `false`

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

### `use_labels`

- Value type is [boolean](/elastic/logstash-docs-md/tree/main/lsr/value-types#boolean)
- Default value is `true`

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

## Common options

These configuration options are supported by all output plugins:

| Setting                                                                        | Input type                                                                    | Required |
|--------------------------------------------------------------------------------|-------------------------------------------------------------------------------|----------|
| [`codec`](#v3.0.5-plugins-outputs-syslog-codec)`codec`                         | [codec](/elastic/logstash-docs-md/tree/main/lsr/value-types#codec)codec       | No       |
| [`enable_metric`](#v3.0.5-plugins-outputs-syslog-enable_metric)`enable_metric` | [boolean](/elastic/logstash-docs-md/tree/main/lsr/value-types#boolean)boolean | No       |
| [`id`](#v3.0.5-plugins-outputs-syslog-id)`id`                                  | [string](/elastic/logstash-docs-md/tree/main/lsr/value-types#string)string    | No       |


### `codec`

- Value type is [codec](/elastic/logstash-docs-md/tree/main/lsr/value-types#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`

- Value type is [boolean](/elastic/logstash-docs-md/tree/main/lsr/value-types#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`

- Value type is [string](/elastic/logstash-docs-md/tree/main/lsr/value-types#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"
  }
}
```