About this document

The section exists in new Wiki and PDF but the content differs (list of bullet points depicting what these guidelines address).

Introduction

The section exists in Wiki and PDF with differences in content:

• The description of the four logs (Audit, Metric, Error, and Debug) has been moved to separate sections (Types of EELF Logs) in the new Wiki.

• “General guidelines and conventions” topic doesn’t exist in the new Wiki guidelines.

Audit Log

The format of the Audit Log and detailed description of the fields do not exist in the new guidelines. Some of the fields in the Audit log section match the fields in the MDCs section available on the new Wiki guidelines. The following are the fields (present in the Audit log section) that do not exist in the MDCs section:

• Category log level

• class name

• Unused

• detailMessage

Number of fields in Audit Log section in PDF: 26

Number of fields in MDC sections on Wiki: 30 (including RequestID and InvocationID)

Metrics Log Format

The format of the Metrics Log and detailed description of the fields do not exist in the new guidelines. Some of the fields in the Metrics log section match the fields in the MDCs section available on the new Wiki guidelines.

The following are the fields (present in the Metrics log section) that do not exist in the MDCs section:

• Category log level

• ClientIP

• class name

• Unused

• detailMessage

Number of fields in Metrics Log section in PDF: 29

Number of fields in MDC sections on Wiki: 30 (including RequestID and InvocationID)

Error Log

The format of the Error Log and detailed description of the fields do not exist in the new guidelines. Some of the fields in the Error log section match the fields in the MDCs section available on the new Wiki guidelines. The following are the fields (present in the Error log section) that do not exist in the MDCs section:

• Timestamp

• ErrorCategory

• ErrorCode

• ErrorDescription

• detailMessage

Number of fields in Error Log section in PDF: 11

Number of fields in MDC sections on Wiki: 30 (including RequestID and InvocationID)

Debug Log

The format of the Debug Log and detailed description of the fields does not exist in the new guidelines. Some of the fields in the Debug log section match the fields in the MDCs section available on the new Wiki guidelines. The following are the fields (present in the Debug log section) that do not exist in the MDCs section:

• Timestamp

• DebugInfo

• End of Record

Number of fields in Debug Log section in PDF: 4

Number of fields in MDC sections on Wiki: 30 (including RequestID and InvocationID)

How to Log

Sub-sections:

• EELF

• SLF4J

• Providers

• Logback

• Log4j 2.X

• Log4j 1.X

What to Log

Sub-sections:

• General

• Standard Attributes

• MDCs

• Examples

• Markers

• Errorcodes

• Output Format

• Output Location

• Configuration

• Retention

Types of EELF Logs

Some part of this section (descriptions of four log types) exist in the PDF.

New ONAP Component Checklist