1Agent::Tag::Priority(3)User Contributed Perl DocumentatioAngent::Tag::Priority(3)
2
3
4

NAME

6       Log::Agent::Tag::Priority - a log priority tag string
7

SYNOPSIS

9        Not intended to be used directly
10        Inherits from Log::Agent::Tag.
11

DESCRIPTION

13       This class represents a log priority tag string.
14

CREATION ROUTINE PARAMETERS

16       The following parameters are defined, in alphabetical order:
17
18       "-display" => string
19           Specifies the priority/level string to display, with minimal
20           variable substitution.  For instance:
21
22            -display => '[$priority/$level]'
23
24           The defined variables are documented in the DISPLAY VARIABLES
25           section underneath.
26
27       "-level" => level
28           This parameter is internally added by "Log::Agent" when computing
29           the priority tag, since only it knows the level of the current
30           message.
31
32       "-postfix" => flag
33           Whether tag should be placed after or before the log message.  By
34           default, it is prepended to the log message, i.e. this parameter is
35           false.
36
37       "-priority" => prio
38           This parameter is internally added by "Log::Agent" when computing
39           the priority tag, since only it knows the priority of the current
40           message.
41
42       "-separator" => string
43           The separation string between the tag and the log message.  A
44           single space by default.
45

DISPLAY VARIABLES

47       The "-display" switch understands a few variables that can be
48       substituted in the supplied string.  Both $var and "${var}" forms are
49       supported.  Unknown variables are left untouched.
50
51       $priority
52           The full priority name of the logged message, e.g. "warning" or
53           "error".
54
55       $level
56           The associated priority level of the logged message, a number.  For
57           instance, the level associated to "warning" is 4.  See
58           Log::Agent::Priorities for the default name -> level mapping.
59

AUTHOR

61       Raphael Manfredi <Raphael_Manfredi@pobox.com>
62

SEE ALSO

64       Log::Agent::Tag(3), Log::Agent::Message(3), Log::Agent::Priorities(3).
65
66
67
68perl v5.38.0                      2023-07-20           Agent::Tag::Priority(3)