Page History

...

JS7 - Log Management is offered with JOC Cockpit acting as a central point of view for monitoring of log output created by JS7 products.

• Service
  • The JS7 - Log Management Notification Service is used to collect log output of JS7 productsfrom Controllers and Agents. The service is compliant to RFC5424, aka Syslog Protocol.
  • The Log Management Service offers restart capabilities.
• Clients
  • The JS7 products, JOC Cockpit, Controller and Agents can act as clients to the Log Management Service. The products can be configured to report log output errors and warnings to the Log Management Service.
  • Users have a choice to enable forwarding of log output per instance of a JS7 product during installation or later on by adjusting the Log4j configuration.
  User Interface
  • JOC Cockpit offers the user interface to access and to query log output.

...

By default the Log4j configuration of JS7 products Controller and Agents will not make use of the Log Management Service. Instead, users choose for which instances of JS7 products Controllers and Agents they want to send log output errors and warnings to the Log Management Service.

...

<Appenders>
    <Syslog name="RFC5424" format="RFC5424" host="localhost" port="4514"
            protocol="UDP" charset="UTF-8" facility="LOCAL0" newLine="false">
        <PatternLayout pattern="<134>1 %d{ISO8601}{ETC/UTC}Z ${hostName} JS7 Controller {
"host":"${hostName}",
"controllerId":"${ControllerId}",
"agentId":"...",
"level":"%p",
"logger":"%c{1}",
"message":"%enc{%m}{JSON}",
"thrown":"%enc{%throwable{10}}{JSON}"
}"
        />
    </Syslog>
</Appenders>

Explanations:

• Similar to Controller Log4j configuration, see above.

JOC Cockpit Log4j Configuration

The following Log4j configuration is available from the log4j2.xml-example file in the JOC Cockpit's <jetty-base>/resources/joc directory.

• Users can copy the log4j2.xml-example file to a file with the name log4j2.xml. Should this file exist, then the <Syslog> element from the example file can be copied.
• Users have to adjust settings from the <Syslog> configuration element.

<Appenders>
    <Syslog name="RFC5424" format="RFC5424" host="localhost" port="4514"
            protocol="UDP" charset="UTF-8" facility="LOCAL0" newLine="false">
        <PatternLayout pattern="<134>1 %d{ISO8601}{ETC/UTC}Z ${hostName} JS7 Controller {
"host":"${hostName}",
"controllerId":"${ControllerId}",
"agentId":"...",
"level":"%p",
"logger":"%c{1}",
"message":"%enc{%m}{JSON}",
"thrown":"%enc{%throwable{10}}{JSON}"
}"
        />
    </Syslog>
</Appenders>

...