NetSDS::Logger(3pm)

💖 NetSDS::Logger 💖

okay bestie, so this is a page from the User Contributed Perl Documentation — a whole little syslog wrapper for your apps and your classes, and we're gonna get into it. pull up a chair. 🫶

---

✨ NAME ✨

NetSDS::Logger — a syslog wrapper for applications and classes. it's giving "logging, but make it a whole module." 💅

---

🌸 SYNOPSIS 🌸

use NetSDS::Logger;

my $logger = NetSDS::Logger->new(
        name => 'NetSDS-SuperDaemon',
);
$logger->log("info", "Syslog message here");

look at her go. she's logging. she's thriving. 🔥

---

🦋 DESCRIPTION 🦋

so this module is literally the whole logging functionality implementation for NetSDS components. that's her job. that's what she does.

by default, messages get logged with the local0 facility and the pid,ndelay,nowait options. no cap, those are the defaults, don't come for me.

NOTE: the NetSDS::Logger module is for internal use, mostly from application frameworks like NetSDS::App, NetSDS::App::FCGI, etc. so like, she's not really out here for the general public — she's the backstage queen, not the main stage girlie. 👑

---

👑 CLASS API 👑

new(%parameters) — the constructor 🎀

new() creates a brand new logger object and opens a socket with the default NetSDS logging parameters. it's giving "hello world, but make it syslog."

the arguments allowed (as a hash, bestie, it's a hash):

• name — the application name, for identification purposes.

use only ASCII characters in name to avoid possible errors. fr fr, keep it ASCII or chaos ensues. 😭

the default value is NetSDS.

• facility — the logging facility.

the available facility values are:

• local0..local7
• user
• daemon

if it's not set, local0 gets used as the default value. iconic default behavior. ⭐

log($level, $message) — write a record to the log ✨

this is a wrapper to the syslog() method of the Unix::Syslog module. shoutout Unix::Syslog. 🫶

the level gets passed as a string and it may be one of the following:

• alert — LOG_ALERT
• crit — LOG_CRIT
• debug — LOG_DEBUG
• emerg — LOG_EMERG
• error — LOG_ERR
• info — LOG_INFO
• notice — LOG_NOTICE
• warning — LOG_WARNING

pick your vibe, bestie. one of those. that's the whole menu. 💜

DESTROY — the class destructor 💀

the destructor (the DESTROY method, iykyk) calls the closelog() function.

that's it. that's all she does. no notes. clean exit. slay. 💅

---

🌈 EXAMPLES 🌈

see NetSDS::App for an example. yes really, that's the whole section. go look. 🧚

---

🌟 SEE ALSO 🌟

• Sys::Syslog

---

🍓 TODO 🍓

1. implement logging via UDP socket.

(she's not done yet, she's got plans. we love a girl with goals. 🎀)

---

💜 AUTHOR 💜

Michael Bochkaryov <misha@rattler.kiev.ua>

---

📜 LICENSE 📜

Copyright (C) 2008-2009 Net Style Ltd.

this program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version.

this program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. see the GNU General Public License for more details.

you should have received a copy of the GNU General Public License along with this program; if not, write to the Free Software Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA.

---

aaaand that's the whole page, bestie!! this one shipped as perl v5.32.1, dated 2021-12-26, under the NetSDS::Logger(3pm) name — go log something iconic, mwah 💖✨