You can set the PRI value of a BSD or IETF syslog message with the set-pri() rewrite function by specifying a template string. This is useful, for example, if incoming messages do not have a PRI value specified by default, but a PRI value is required for filtering purposes.
When configured, the set-pri() function will only rewrite the PRI value of the message field.
NOTE: If the specified parameter value is not a valid value, the function ignores it and sends a debug message. However, the syslog-ng Open Source Edition (syslog-ng OSE) application will still send the message.
Declaration
rewrite <rule-name> { set-pri("template-string"); };
Parameters
The set-pri() rewrite function expects a template string as its only parameter, for example:
-
set-pri("42");
-
set-pri("$.json.priority");
Accepted values
The template string specified for the set-pri() rewrite function must expand to a natural number in the interval of 0–1023, inclusive. This means that if you, for example, extract the value from a syslog <PRI> header (such as <42>), then you need to remove the opening and closing brackets (< >) in the specified template string.
Example: Temporarily raising the priority of an application
In the following example, the set-pri() rewrite function is used to temporarily raise the priority of the application myprogram:
log { source { system(); }; if (program("myprogram")){ rewrite { set-pri("92"); }; }; destination { file("/var/log/mail.log"); }; flags(flow-control); }
Example: Changing the priority of an application log message in JSON format
In the following example, an application sends log messages in the following JSON format:
{ "time": "2003-10-11T22:14:15.003Z", "host": "mymachine", "priority": "165", "message": "An application event log entry." }
You can parse these logs with the syslog-ng JSON parser function:
{ parser p_json { json-parser (prefix(".json.")); }
As the application message contains a valid priority field, you can use the set-pri() rewrite function to modify the priority of the message:
set-pri("$.json.priority");