...

Introduction

JS7 - Log Management is offered  from a service compliant to RFC5424, aka Syslog Protocol.

...

offered with JOC Cockpit acting as a central point of view for monitoring of log output created by JS7 products 

The Log Management Service is available from JOC Cockpit within the scope of JS7 - Services.

• Service
  • The service is compliant to RFC5424, aka Syslog Protocol.
  • The Log Management Service offers restart capabilities: in case of fail-over or switch-over of JOC Cockpit the Log Management Service will become available from the active JOC Cockpit instance.
• 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 to the JS7 Log Management Service.
  • In addition, log output of JS7 products is always written to local log files.
  • Users have a choice to enable forwarding of log output per instance of a JS7 product during installation or later on by adjusting the Log4j2 configuration. 

The JS7 Log Management Service becomes available from

Log4j2 Configuration

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

Controller Log4j2 Configuration

The following Log4j2 configuration is available from the log4j2.xml-example file in the Controller's <controller-data>/config directory:

<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}",
"thread":"%t",
"level":"%p",
"logger":"%c{1}",
"message":"%enc{%m}{JSON}",
"thrown":"%enc{%throwable{10}}{JSON}"
}"
        />
    </Syslog>
</Appenders>

Explanations:

• tbd

...

The following Log4j2 configuration is available from the log4j2.xml-example file in the Agent's <agent-data>/config directory:

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

• tbd

JOC Cockpit Log4j2 Configuration

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

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

• tbd

Delimitation

...

Due to limitations of the underlying Syslog Protocol the JS7 Log Management Service does not meet elaborated requirements for security, resiĺience and high availability.

...