IETF-syslog messages
This section describes the format of a syslog message, according to the IETF-syslog protocol. A syslog message consists of the following parts:
HEADER(includes thePRIas well)STRUCTURED-DATAMSG
The following is a sample syslog message (source: https://tools.ietf.org/html/rfc5424):
<34>1 2003-10-11T22:14:15.003Z mymachine.example.com su - ID47 - BOM'su root' failed for lonvick on /dev/pts/8
The message corresponds to the following format:
<priority>VERSION ISOTIMESTAMP HOSTNAME APPLICATION PID MESSAGEID STRUCTURED-DATA MSG
| Part | Example |
|---|---|
PRI |
<34> |
VERSION |
1 |
TIMESTAMP |
2003-10-11T22:14:15.003Z |
HOSTNAME |
mymachine.example.com |
APP-NAME |
su |
PROCID |
- |
MSGID |
ID47 |
STRUCTURED-DATA |
- |
MSG |
'su root' failed for lonvick on /dev/pts/8 |
The HEADER part of the message must be in plain ASCII format, the parameter values of the STRUCTURED-DATA part must be in UTF-8, while the MSG part should be in UTF-8. The different parts of the message are explained in the following sections.
PRI and VERSION are mandatory. The remaining HEADER fields (TIMESTAMP, HOSTNAME, APP-NAME, PROCID, MSGID) and the STRUCTURED-DATA must be present, but can be the NILVALUE - when the sender has no value for them. The MSG part is optional.
The PRI message part
The PRI is calculated and interpreted exactly as in BSD-syslog messages (facility * 8 + severity). For the formula and the facility and severity code tables, see The PRI message part.
The HEADER message part
The HEADER part contains the following elements:
- VERSION: Version number of the syslog protocol standard. Currently this can only be
1. - ISOTIMESTAMP: The time when the message was generated in the ISO 8601 compatible standard timestamp format (yyyy-mm-ddThh:mm:ss+-ZONE), for example:
2006-06-13T15:58:00.123+01:00. - HOSTNAME: The machine that originally sent the message.
- APPLICATION: The device or application that generated the message
- PID: The process name or process ID of the syslog application that sent the message. It is not necessarily the process ID of the application that generated the message.
- MESSAGEID: The ID number of the message.
ts-format() option in Global options reference.
The AxoSyslog application will truncate the following fields:
- If APP-NAME is longer than 48 characters it will be truncated to 48 characters.
- If PROC-ID is longer than 128 characters it will be truncated to 128 characters.
- If MSGID is longer than 32 characters it will be truncated to 32 characters.
- If HOSTNAME is longer than 255 characters it will be truncated to 255 characters.
The STRUCTURED-DATA message part
The STRUCTURED-DATA message part may contain meta-information about the syslog message, or application-specific information such as traffic counters or IP addresses. STRUCTURED-DATA consists of data blocks enclosed in brackets ([]). Every block includes the ID of the block, and one or more name=value pairs. The AxoSyslog application automatically parses the STRUCTURED-DATA part of syslog messages, which can be referenced in macros (for details, see Macros of AxoSyslog). An example STRUCTURED-DATA block looks like:
[exampleSDID@0 iut="3" eventSource="Application" eventID="1011"][examplePriority@0 class="high"]
The MSG message part
The MSG part contains the text of the message itself. The encoding of the text must be UTF-8 if the BOM
The byte order mark (BOM) is a Unicode character used to signal the byte-order of the message text.
character is present in the message. If the message does not contain the BOM character, the encoding is treated as unknown. Usually messages arriving from legacy sources do not include the BOM character. CRLF characters will not be removed from the message.