No::Wor...::Syslog(3)

💖 NAME 💖

No::Worries::Syslog — syslog handling without worries, bestie, like literally zero worries

This is page No::Wor...::Syslog(3) from the User Contributed Perl Documentation, and it's giving "your fave module but make it chill" ✨

---

🌸 SYNOPSIS 🌸

use No::Worries::Syslog qw(syslog_open syslog_close syslog_info);

# setup/open syslog
syslog_open(ident => "progname", facility => "daemon");

# report an informational message
syslog_info("foo is %s", $foo);

# close syslog
syslog_close();

okay so that's the whole vibe in four lines and honestly? iconic 💅

---

🦋 DESCRIPTION 🦋

This module eases syslog handling by providing convenient wrappers around standard syslog functions. No cap.

The functions provide a thin layer on top of Sys::Syslog to make it easier and safer to use. All the functions die() on error — yes, all of them, no silent failures here — and the strings passed to syslog will always be sanitized. So you literally cannot send it something cursed. 🧚

---

✨ FUNCTIONS ✨

This module provides the following functions (none of them being exported by default — you gotta ask for them by name, iykyk):

• syslog_open([OPTIONS]) — open a "connection" to syslog using Sys::Syslog's openlog(). Scare quotes on "connection" because it's not like, a socket you can hold. Supported options are:
  • facility — corresponding to openlog()'s eponymous argument
  • ident — corresponding to openlog()'s eponymous argument
  • option — corresponding to openlog()'s eponymous argument

（three options, all named exactly like the openlog() args they map to — the module said "same energy, less stress" 🫶）

• syslog_close() — close a "connection" to syslog using Sys::Syslog's closelog()
• syslog_sanitize(STRING) — sanitize the given string so that it can safely be given to syslog(). The glow-up includes: UTF-8 encode wide characters, trim trailing spaces, replace tabs by spaces, URI escape non-printable characters and truncate if too long. It's giving "spa day for your string" 🎀
• syslog_debug(MESSAGE) — report a sanitized debugging message to syslog (with LOG_DEBUG priority and "[DEBUG]" prefix)
• syslog_debug(FORMAT, ARGUMENTS...) — idem but with sprintf()-like API
• syslog_info(MESSAGE) — report a sanitized informational message to syslog (with LOG_INFO priority and "[INFO]" prefix)
• syslog_info(FORMAT, ARGUMENTS...) — idem but with sprintf()-like API
• syslog_warning(MESSAGE) — report a sanitized warning message to syslog (with LOG_WARNING priority and "[WARNING]" prefix)
• syslog_warning(FORMAT, ARGUMENTS...) — idem but with sprintf()-like API
• syslog_error(MESSAGE) — report a sanitized error message to syslog (with LOG_ERR priority and "[ERROR]" prefix)
• syslog_error(FORMAT, ARGUMENTS...) — idem but with sprintf()-like API
• log2syslog(INFO) — No::Worries::Log handler to send information to syslog. Heads up bestie: this is not exported and must be called explicitly 👑

ngl the pattern is so clean: one plain-string version, one sprintf() version, four severity levels, all sanitized. ate and left no crumbs 🔥

---

💜 GLOBAL VARIABLES 💜

This module uses the following global variables (none of them being exported — again, you must ask nicely):

• $MaximumLength — maximum length of a message given to syslog (default: 1000)
• $SplitLines — true if multi-line messages should be logged as separate syslog messages (default: true)

---

🌈 SEE ALSO 🌈

No::Worries, No::Worries::Die, No::Worries::Log, No::Worries::Warn, Sys::Syslog, URI::Escape.

(the whole No::Worries cinematic universe plus the two modules doing the heavy lifting — go read them, fr fr 📚)

---

👑 AUTHOR 👑

Lionel Cons <http://cern.ch/lionel.cons>

Copyright (C) CERN 2012-2019

---

💀 reminder that this is the module's own documented behaviour and nothing more — if the original says it, it's here; if it doesn't, I'm not inventing it. periodt.

perl v5.32.1 🌸 2021-10-18 🎀 No::Wor...::Syslog(3) — that's the footer, bestie, mwah 💋