Page History

...

JS7 - Log Management is offered with JOC Cockpit for central receipt of warnings and errors created from monitoring of log output of Controllers and Agentsand dispatch of notifications created by Controller, Agent & JOC Cockpit instances.

• Service
  • The JS7 - Log Notification Service is used to collect warnings and errors from log output of Controllers and Agents and Controller & Agent instances and to create JS7 - Notifications. JOC Cockpit notifications are created directly and without use of the service.
  • The service is compliant to RFC5424, aka Syslog Protocol and offers restart capabilities.
• Clients
  • Controller and Agents & Agent instances can act as clients to the Log Notification Service. The products can be configured to report warnings and errors to the Log Notification Service.
  • Users have a choice to enable forwarding of warnings and errors during installation or later on by adjusting the Log4j configuration.
• User Interface
  • The JOC Cockpit offers notifications from the JS7 - Monitor view.

...

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

As a prerequisite the host and port used for the Log Notification Service have to be accessible for JS7 products.

The following examples explain the Log4j configuration.

...

The following Log4j configuration example extract is available from the log4j2.xml-example file in the Controller's <controller-data>/config 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 and related <Properties> elements from the example file can be copied.
• Users have to adjust settings from the <Properties> configuration elements. No changes must be applied to the <Syslog> configuration element.

<Properties>
        ...
        <Property name="SysLogLevel">Off</Property>
        <Property name="SysLogHost">localhost</Property>
        <Property name="SysLogPort">4245</Property>
        ...
</Properties>

<Appenders>
        ...
        <Syslog name="LogNotificationAppenderlogNotificationAppender" format="RFC5424" host="joc-2-0-primary${SysLogHost}" port="4245${SysLogPort}" protocol="UDP">
            <ThresholdFilter level="WARN"/>
            <PatternLayout charset="UTF-8" pattern="<134>1 %d{yyyy-MM-dd'T'HH:mm:ss.SSS}{Etc/UTC}Z ${hostName} Controller {
"controllerId":"&quot;controllerId&quot;:&quot;%X{js7.serverId}"&quot;,
"instanceId":"&quot;instanceId&quot;:&quot;%X{js7.clusterNodeId}"&quot;, 
"level":"%p",
"logger":"&quot;level&quot;:&quot;%p&quot;,
&quot;logger&quot;:&quot;%c{1}"&quot;,
"message":"&quot;message&quot;:&quot;%enc{%m}{JSON}"&quot;,
"thrown":"&quot;thrown&quot;:&quot;%enc{%throwable{10}}{JSON}"&quot;}"/>
        </Syslog>
        ...
</Appenders>

<Loggers>
        ...
        <Root level="${RootLogLevel}">
            ...
            <AppenderRef ref="logNotificationAppender" level="${SysLogLevel}"/>
        </Root>
</Loggers>

Explanations:

• <Syslog>: The XML element holds the required configuration. The following attributes are available:
  name: users a free to choose a name for SysLogLevel: By default the Off value is used that deactivates the Syslog Appender. A value WARN will forward warnings and errors to the Log Notification Service.
• SysLogHost
• format: The value RFC5424 is required.
host: The hostname or IP address of the JOC Cockpit operating instance operatiang the Log Notification Service.
• portSysLogPort: The port to which the  Log Notificatio Service listens.
• protocol: The value UDP is required.
<PatternLayout>: The XML element specifies the pattern used to send messages. The pattern must not be changedof the Log Notification Service in JOC Cockpit is required. The default value is 4245.

Agent Log4j Configuration

...

• 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 and related <Properties> elements from the example file can be copied.
• Users have to adjust settings from the <Properties> configuration elements. No changes must be applied to the <Syslog> configuration element.

...

<Properties>
        ...
        <Property name="SysLogLevel">Off</Property>
        <Property name="SysLogHost">localhost</Property>
        <Property name="SysLogPort">4245</Property>
        ...
</Properties>

<Appenders>
        ...
        <Syslog name="LogNotificationAppender" format="RFC5424" host="joc-2-0-primary${SysLogHost}" port="4245${SysLogPort}" protocol="UDP">
            <ThresholdFilter level="WARN"/>
            <PatternLayout charset="UTF-8" pattern="<134>1 %d{yyyy-MM-dd'T'HH:mm:ss.SSS}{Etc/UTC}Z ${hostName} Agent {
"instanceId":"&quot;instanceId&quot;:&quot;%X{js7.serverId}"&quot;,
"role":"&quot;role&quot;:&quot;%X{js7.clusterNodeId}"&quot;,
"level":"%p",
"logger":"&quot;level&quot;:&quot;%p&quot;,
&quot;logger&quot;:&quot;%c{1}"&quot;,
"message":"&quot;message&quot;:&quot;%enc{%m}{JSON}"&quot;,
"thrown":"&quot;thrown&quot;:&quot;%enc{%throwable{10}}{JSON}"&quot;}"/>
        </Syslog>
        ...
</Appenders>

<Loggers>
        ...
        <Root level="${RootLogLevel}">
            ...
            <AppenderRef ref="logNotificationAppender" level="${SysLogLevel}"/>
        </Root>
</Loggers>

Explanations:

• Similar to Controller Log4j configuration, see above.

...