Agent:...orities(3pm)

✨ NAME ✨

Log::Agent::Priorities — the lil glow-up translator between syslog priorities and logging levels 💖

(it's a Perl thing, from the User Contributed Perl Documentation corner of the universe, and yes bestie, the man page name is Agent:...orities(3pm) 🎀)

---

🌸 SYNOPSIS 🌸

Not intended to be used directly

like... she's not for you to drive, she's for the module to drive 🫶

---

💅 DESCRIPTION 💅

okay so this package is basically the group chat translator between syslog priorities and logging levels. that's it, that's the job. level_from_prio("crit") hands you back 2, and prio_from_level(4) gives you "warning" — and plot twist, prio_from_level(5) gives you "warning" too 😭 same answer, different number, she contains multitudes.

Here's the whole roster of known priorities, bestie. each one can be abbreviated down to the first 2 letters, and it does not care about your capitalisation (case-insensitive, we don't judge 💖), and here's the logging level each one maps to:

• none — level -1 — export constant NONE — (special, see the text below 👀)
• emergency — level 0 — traditional tokens: emerg, panic — export constant EMERG
• alert — level 1 — export constant ALERT
• critical — level 2 — traditional token: crit — export constant CRIT
• error — level 3 — traditional token: err — export constant ERROR
• warning — level 4 — export constant WARN
• notice — level 6 — export constant NOTICE
• info — level 8 — export constant INFO
• debug — level 10 — export constant DEBUG

the stuff in parenthesis up there is the traditional syslog priority tokens, for the historians. and yes, the levels 5, 7 and 9 are just... not there. they're being saved for a possible extension, like a spare room 🛋️. for now those numbers map to the level immediately below them.

the Export column is where the symbolic constants live — those are defined by this package. you can import them one by one, or grab the whole squad at once with the :LEVELS tag, like so:

use Log::Agent::Priorities qw(:LEVELS);

now, the special token none? she's for special occasions only and you have to spell her all the way out (no abbreviation privileges, she's too iconic for that 💅). she maps to -1, and she's the move when you're specifying a logging level and you want literally nothing to be logged — like, none guarantees no logging happens, even for emergency situations. dead silent. not a peep. periodt.

here's the vibe anywhere a priority is expected: you can throw in a number and it gets taken as a logging level, or you can throw in a string and it gets taken as a priority. and if the default mapping above isn't giving for you, you can redefine it — for example by specifying notice:9. that gets taken as being level 9, but with a notice priority regardless, not info, which is what it would've been implicitly determined as otherwise. she's canonically notice, ok?? 🙈

and the routine priority_level() is the one who unpacks all of this. she decompiles notice:9 into ("notice", 9), and apart from that she uses prio_from_level() or level_from_prio() to compute whatever information is missing. for example, give her critical and priority_level() returns the tuple ("critical", 2). chef's kiss, no notes 🔥

---

👑 AUTHOR 👑

Raphael Manfredi <Raphael_Manfredi@pobox.com> — the main character who wrote her ✨

---

🦋 SEE ALSO 🦋

• Log::Agent(3)
• Log::Agent::Logger(3)

---

and that's a wrap bestie!! 🎀 this whole lil page is from perl v5.36.0, dated 2022-10-15 — so like, she's been slaying since forever, we love a legacy icon 🌈💜