Configuring a JMS appender - Cloud

Talend Remote Engine User Guide for Linux

Version
Cloud
Language
English (United States)
EnrichDitaval
linux
Product
Talend Cloud
Module
Talend Remote Engine
Content
Design and Development
Installation and Upgrade

You may want to send logs to an ActiveMQ backend system.

Talend Cloud supports the ActiveMQ TCP protocol.

Procedure

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

    Example

    log4j2.appender.jms.type = Jms
    log4j2.appender.jms.name = JmsAppender
    log4j2.appender.jms.destinationBindingName= dynamicQueues/myQueueName1
    log4j2.appender.jms.factoryName=org.apache.activemq.jndi.ActiveMQInitialContextFactory
    log4j2.appender.jms.factoryBindingName=ConnectionFactory
    log4j2.appender.jms.providerURL=tcp://localhost:616162
    log4j2.appender.jms.userName=admin 
    log4j2.appender.jms.password=admin3
    log4j2.appender.jms.layout.type = JsonTemplateLayout
    log4j2.appender.jms.layout.eventTemplateUri=${karaf.base.uri}/etc/jsonLogMinTemplate.json
    log4j2.appender.jms.layout.stackTraceElementTemplateUri=${karaf.base.uri}/etc/StackTraceElementLayout.json
    
    log4j2.rootLogger.appenderRef.JmsAppender.ref = JmsAppender
  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 Cloud 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:

      Example

      {
       "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"},
       "bundle.name": \{"$resolver": "source", "field": "bundle.name"},
       "bundle.version": \{"$resolver": "source", "field": "bundle.version"}
      }
  4. Configure your JMS system to use this new jsonLogMinTemplateCustom.json template instead of the default template file jsonLogMinTemplate.json.
1 This is an example. The destinationBindingName could be dynamicQueues/myQueueName or dynamicTopics/myTopicName.
2 This is an example. You need to define your JMS host and its port.
3 This admin is only an example for userName and password.