Introduction
The JS7 offers a Logging Service compliant to RFC5424, aka syslog protocol.
- The Logging Service is available from JOC Cockpit within the scope of JS7 - Services.
- The Logging Service offers high availability: in case of fail-over or switch-over of JOC Cockpit the Logging Service will become available from the active JOC Cockpit instance.
- x
- All JS7 products, JOC Cockpit, Controller and Agents, can be configured to report log output to the JS7 Logging Service.
- x
The JS7 Logging Service becomes available from
Jira |
---|
server | SOS JIRA |
---|
columnIds | issuekey,summary,issuetype,created,updated,duedate,assignee,reporter,priority,status,resolution |
---|
columns | key,summary,type,created,updated,due,assignee,reporter,priority,status,resolution |
---|
serverId | 6dc67751-9d67-34cd-985b-194a8cdc9602 |
---|
key | JOC-1828 |
---|
|
Display feature availability |
---|
|
Log4j2 Configuration
By default the Log4j configuration of JS7 products will not make use of the Logging Service. Instead, users choose for which instances of JS7 products they want send log output to the Logging Service.
Controller Log4j2 Configuration
The following Log4j2 configuration is available from the log4j2.xml-example
file available available with a Controller's data directory:
Code Block |
---|
language | xml |
---|
title | Example for Controller log4j.xml Configuration |
---|
linenumbers | true |
---|
collapse | true |
---|
|
<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:
Agent Log4j2 Configuration
The following Log4j2 configuration is available from the log4j2.xml-example
file available available with a Controller's data directory:
Code Block |
---|
language | xml |
---|
title | Example for Agent log4j.xml Configuration |
---|
linenumbers | true |
---|
collapse | true |
---|
|
<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:
JOC Cockpit Log4j2 Configuration
The following Log4j2 configuration is available from the log4j2.xml-example
file available available with a Controller's data directory:
Code Block |
---|
language | xml |
---|
title | Example for Agent log4j.xml Configuration |
---|
linenumbers | true |
---|
collapse | true |
---|
|
<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:
Delimitation
Security
Resilience
High Availability