table of contents
Agent::Tag::Priority(3pm) | User Contributed Perl Documentation | Agent::Tag::Priority(3pm) |
NAME¶
Log::Agent::Tag::Priority - a log priority tag string
SYNOPSIS¶
Not intended to be used directly Inherits from Log::Agent::Tag.
DESCRIPTION¶
This class represents a log priority tag string.
CREATION ROUTINE PARAMETERS¶
The following parameters are defined, in alphabetical order:
- "-display" => string
- Specifies the priority/level string to display, with minimal variable
substitution. For instance:
-display => '[$priority/$level]'
The defined variables are documented in the DISPLAY VARIABLES section underneath.
- "-level" => level
- This parameter is internally added by "Log::Agent" when computing the priority tag, since only it knows the level of the current message.
- "-postfix" => flag
- Whether tag should be placed after or before the log message. By default, it is prepended to the log message, i.e. this parameter is false.
- "-priority" => prio
- This parameter is internally added by "Log::Agent" when computing the priority tag, since only it knows the priority of the current message.
- "-separator" => string
- The separation string between the tag and the log message. A single space by default.
DISPLAY VARIABLES¶
The "-display" switch understands a few variables that can be substituted in the supplied string. Both $var and "${var}" forms are supported. Unknown variables are left untouched.
- $priority
- The full priority name of the logged message, e.g. "warning" or "error".
- $level
- The associated priority level of the logged message, a number. For instance, the level associated to "warning" is 4. See Log::Agent::Priorities for the default name -> level mapping.
AUTHOR¶
Raphael Manfredi <Raphael_Manfredi@pobox.com>
SEE ALSO¶
Log::Agent::Tag(3), Log::Agent::Message(3), Log::Agent::Priorities(3).
2022-10-15 | perl v5.34.0 |