syslog-ng Open Source Edition 3.30 - Administration Guide

Prerequisites

• Version 3.29 of syslog-ng OSE or later.

  NOTE: Most Linux distributions feature syslog-ng OSE versions earlier than version 3.29. For up-to-date binaries, visit the syslog-ng third-party binaries page.

• PAN-OS log messages from Palo Alto Networks devices.

Limitations

The panos-parser() only works on syslog-ng OSE version 3.29 or later.

Configuration

You can include the panos-parser() in your syslog-ng OSE configuration like this:

parser p_parser{
    panos-parser();
};

To use this parser, the scl.conf file must be included in your syslog-ng OSE configuration:

@include "scl.conf"

The panos-parser() is a reusable configuration snippet configured to parse Palo Alto Networks PAN-OS log messages. For details on using or writing such configuration snippets, see Reusing configuration blocks. You can find the source of this configuration snippet on GitHub.

Message format and log format

Using the panos-parser(), the parsed messages in syslog-ng OSE have the following general format:

<PRI><TIMESTAMP> <HOST> <PALO-ALTO-fields-in-CSV-format>

There are several "types" of log formats in Palo Alto Networks PAN-OS. For example, the most commonly used SYSTEM type has the following message format on the syslog-ng OSE side after parsing:

<12>Apr 14 16:48:54 paloalto.test.net 1,2020/04/14 16:48:54,unknown,SYSTEM,auth,0,2020/04/14 16:48:54,,auth-fail,,0,0,general,medium,failed authentication for user 'admin'. Reason: Invalid username/password. From: 10.0.10.55.,1718,0x0,0,0,0,0,,paloalto

prefix()

Description: Insert a prefix before the name part of the parsed name-value pairs to help further processing. For example:

• To insert the my-parsed-data. prefix, use the prefix(my-parsed-data.) option.

• To refer to a particular data that has a prefix, use the prefix in the name of the macro, for example, ${my-parsed-data.name}.

• If you forward the parsed messages using the IETF-syslog protocol, you can insert all the parsed data into the SDATA part of the message using the prefix(.SDATA.my-parsed-data.) option.

Names starting with a dot (for example, .example) are reserved for use by syslog-ng OSE. If you use such a macro name as the name of a parsed value, it will attempt to replace the original value of the macro (note that only soft macros can be overwritten, see Hard versus soft macros for details). To avoid such problems, use a prefix when naming the parsed values, for example, prefix(my-parsed-data.)

Declaration:

@version: 3.30
@include "scl.conf"
log {
    source { system(); };
    parser { sudo-parser(); };
    destination { ... };
};

prefix()

Description: Insert a prefix before the name part of the parsed name-value pairs to help further processing. For example:

• To insert the my-parsed-data. prefix, use the prefix(my-parsed-data.) option.

• To refer to a particular data that has a prefix, use the prefix in the name of the macro, for example, ${my-parsed-data.name}.

• If you forward the parsed messages using the IETF-syslog protocol, you can insert all the parsed data into the SDATA part of the message using the prefix(.SDATA.my-parsed-data.) option.

Names starting with a dot (for example, .example) are reserved for use by syslog-ng OSE. If you use such a macro name as the name of a parsed value, it will attempt to replace the original value of the macro (note that only soft macros can be overwritten, see Hard versus soft macros for details). To avoid such problems, use a prefix when naming the parsed values, for example, prefix(my-parsed-data.)

By default, sudo-parser() uses the sudo. prefix. To modify it, use the following format:

parser { sudo-parser(prefix("myprefix.")); };