Skip to main content Skip to complementary content

Configuring a Syslog appender

You may want to send logs directly to a syslog, a syslog-ng or a rsyslog system.


  1. Open the <RemoteEngineInstallationDirectory>/etc/org.ops4j.pax.logging.cfg file and add the following lines:


    log4j2.appender.syslog.type = Syslog = SyslogAppender
    log4j2.appender.syslog.format = RFC5424 = localhost
    log4j2.appender.syslog.port = 514
    log4j2.appender.syslog.protocol = TCP
    log4j2.appender.syslog.appName = RE
    log4j2.appender.syslog.includeMDC = true
    log4j2.appender.syslog.facility = LOCAL0
    log4j2.appender.syslog.layout.type = JsonTemplateLayout
    log4j2.rootLogger.appenderRef.SyslogAppender.ref = SyslogAppender
  2. Save the file.
  3. Add the Mapped Diagnostic Context (MDC) information to the JSON template file so that the output logs, where applicable, contain the MDC information. This MDC information includes the run ID of a Talend Management Console task.
    1. In <RemoteEngineInstallationDirectory>/etc, create a file and name it as jsonLogMinTemplateCustom.json.
    2. Add the following lines to this new file to create a MDC resolver:


       "logMessage": \{"$resolver": "message", "stringified": true},
       "mdc": {
       "$resolver": "mdc"
       "logTimestamp": \{"$resolver": "timestamp", "epoch": {"unit": "millis", "rounded": true}},
       "severity": \{"$resolver": "level", "field": "name"},
       "ticLogLevel": \{"$resolver": "source", "field": "ticLogLevel"},
       "": \{"$resolver": "source", "field": ""},
       "bundle.version": \{"$resolver": "source", "field": "bundle.version"}
  4. Configure your Syslog system to use this new jsonLogMinTemplateCustom.json template instead of the default template file jsonLogMinTemplate.json.

Did this page help you?

If you find any issues with this page or its content – a typo, a missing step, or a technical error – let us know how we can improve!