You are viewing documentation for an older version of Confluent Platform. For the latest, click here.

Kafka Connect Syslog Source Connector

You can use the syslog connector to consume data from network devices. Supported formats are rfc 3164, rfc 5424, and Common Event Format (CEF).


This connector listens on a network port. Running more than one task or running in distributed mode can cause some undesired effects if another task already has the port open. It is recommended that you run this connector in Standalone Workers.

Install Syslog Source Connector

You can install this connector by using the Confluent Hub client (recommended) or you can manually download the ZIP file.

Install the connector using Confluent Hub

Confluent Hub Client must be installed. This is installed by default with Confluent Enterprise.

Navigate to your Confluent Platform installation directory and run this command to install the latest (latest) connector version. The connector must be installed on every machine where Connect will be run.

confluent-hub install confluentinc/kafka-connect-syslog:latest

You can install a specific version by replacing latest with a version number. For example:

confluent-hub install confluentinc/kafka-connect-syslog:5.1.0

Install Connector Manually

Download and extract the ZIP file for your connector and then follow the manual connector installation instructions.


You can use this connector for a 30-day trial period without a license key.

After 30 days, this connector is available under a Confluent enterprise license. Confluent issues enterprise license keys to subscribers, along with providing enterprise-level support for Confluent Platform and your connectors. If you are a subscriber, please contact Confluent Support at for more information.

See Confluent Platform license for license properties and License topic configuration for information about the license topic.

Quick Start

  1. Install the connector:

    confluent-hub install confluentinc/kafka-connect-syslog:latest
  2. Start Confluent Platform:

    |confluent_start| connect
  3. Create a config file with the following contents:

  4. Load the Syslog Connector.

    confluent load syslog-tcp​ -d path/to/


    Don’t use the Confluent CLI in production environments. Always run the Syslog connector in standalone mode, for example, with bin/connect-standalone.

  5. Test with sample syslog-formatted message sent via netcat:

    echo "<34>1 2003-10-11T22:14:15.003Z su - ID47 - Your refrigerator is running" | nc -v -w 0 localhost 5454
  6. Confirm that the message is logged to Kafka:

    kafka-avro-console-consumer \
        --bootstrap-server localhost:9092 \
        --property schema.registry.url=http://localhost:8081 \
        --topic syslog --from-beginning | jq '.'

Output Schema

The Syslog Connector accepts Syslog messages as strings, and produces structured messages as output to the configured Kafka topic.

Record Key Schema


Host of the Syslog message, as specified in the message body. If no host is specified, the remote address of the message will be used.

  • Type: string

Record Value Schema

Some fields are relevant for only some message types, and will be null for others.


String representing a human-readable and understandable description of the event. The event name should not contain information that is specifically mentioned in other fields. Used in CEF.

  • Type: string

Type of message received (either “RFC5424”, “RFC3164”, “CEF”, or “UNKNOWN”).

  • Type: string

The freeform message extracted from full message. “MSG” field of the Syslog spec.

  • Type: string

Extracted host from the syslog message.

  • Type: string

“VERSION” field of the Syslog spec.

  • Type: int

Level as determined by “PRIORITY” field of Syslog spec.

  • Type: int

“TAG” field of Syslog spec

  • Type: string

“FACILITY” as determined by the “PRIORITY” of the Syslog spec.

  • Type: int

Severity of CEF messages.

  • Type: string

“APP-NAME” field of the Syslog spec.

  • Type: string

Remote address of the request received by the connector.

  • Type: string

The full, unmodified, unparsed message as received by the connector.

  • Type: string

“PROCID” field of the Syslog spec.

  • Type: string

“MSGID” field of the Syslog spec.

  • Type: string

Vendor identifier that is used to group products.

  • Type: string

Product identifier that is used for message logging.

  • Type: string

The version of the logging device product.

  • Type: string

The device event class ID. This is a unique per event-type identifier. The device event class ID identifies the type of event reported. In the intrusion detection system (IDS) world, each signature or rule that detects certain activity has a unique device event class ID assigned. This is a requirement for other types of devices as well, and helps correlation engines process the events. Also known as Signature ID.

  • Type: string

“Extension” mapping for the CEF message format.

  • Type: map<string, string>

“STRUCTURED-DATA” field of the Syslog spec.

  • Type: Array of StructuredDatum structs:

    id: String StructuredDataElements: map<string, string>