LogLite(3pm)

📦
version 0.82 · 4 versions
, in debian bookworm, debian trixie, ubuntu noble, ubuntu resolute, ubuntu stonking

💖 NAME 💖

okay so bestie, listen: Log::LogLite is the class that helps us create simple logs for our application. that's the whole assignment and it ate. ✨

(this is the LogLite(3pm) page, living its best life over in the User Contributed Perl Documentation section, fyi 🫶)

✨ SYNOPSIS ✨

use Log::LogLite;
my $LOG_DIRECTORY = "/where/ever/our/log/file/should/be";
my $ERROR_LOG_LEVEL = 6;

# create new Log::LogLite object
my $log = new Log::LogLite($LOG_DIRECTORY."/error.log", $ERROR_LOG_LEVEL);

...

# we had an error
$log->write("Could not open the file ".$file_name.": $!", 4);

🌸 DESCRIPTION 🌸

so the vibe is: to have a log, you first gotta make a Log::LogLite object. that object gets created with a logging level, and the default logging level is 5, no cap.

once your Log::LogLite object exists, every call to the write method may drop a new line into the log file. the rule? if the level of the message is lower or equal to the logging level, the message gets written to the log file. otherwise it's giving silent treatment, respectfully.

the format of the logging messages can be controlled by changing the template, and by defining a default message. and plot twist — the class uses the IO::LockedFile class. 💅

🎀 CONSTRUCTOR 🎀

new ( FILEPATH [,LEVEL [,DEFAULT_MESSAGE ]] )

the constructor, the main character. ✨

  • FILEPATH is the path of the log file.
  • LEVEL is the defined logging level — aka the LEVEL data member.
  • DEFAULT_MESSAGE will define the DEFAULT_MESSAGE data member — a message that gets added to the message of each entry in the log (according to the TEMPLATE data member, see below).

the levels can be literally any levels that the user chooses to use. there are, though, recommended levels:

0  the application is unusable
1  the application is going to be unusable
2  critical conditions
3  error conditions
4  warning conditions
5  normal but significant condition
6  informational
7+ debug-level messages

the default value of LEVEL is 5. the default value of DEFAULT_MESSAGE is "" (empty string, iconically quiet). returns the new object. 🫶

👑 METHODS 👑

write( MESSAGE [, LEVEL ] )

if LEVEL is less or equal to the LEVEL data member, or if LEVEL is undefined, the string in MESSAGE will be written to the log file. does not return anything. it just does the thing and leaves. main character energy honestly. 💀

level( [ LEVEL ] )

access method to the LEVEL data member. if LEVEL is defined, the LEVEL data member will get its value. returns the value of the LEVEL data member. 🌈

default_message( [ MESSAGE ] )

access method to the DEFAULT_MESSAGE data member. if MESSAGE is defined, the DEFAULT_MESSAGE data member will get its value. returns the value of the DEFAULT_MESSAGE data member. 🍓

log_line_numbers( [ BOOLEAN ] )

if this flag is set to true, the <called_by> string will hold the file that calls the subroutine and the line where the call is issued. the default value is zero. (so by default, no receipts. 🙈)

template( [ TEMPLATE ] )

access method to the TEMPLATE data member. the TEMPLATE data member is a string that defines how the log entries will look like. the default TEMPLATE is:

'[<date>] <<level>> <called_by><default_message><message>'

where:

  • <date> will be replaced by a string that represent the date. for example: 09/01/2000 17:00:13
  • <level> will be replaced by the level of the entry.
  • <called_by> will be replaced by a call trace string. for example: CGIDaemon::listen > MyCGIDaemon::accepted
  • <default_message> will be replaced by the value of the DEFAULT_MESSAGE data member.
  • <message> will be replaced by the message string that is sent to the C<write> method.

returns the value of the TEMPLATE data member. ✨

💜 AUTHOR 💜

Rani Pinchuk, rani@cpan.org — the icon, the legend, the whole blueprint. 👑

Copyright (c) 2001-2002 Ockham Technology N.V. & Rani Pinchuk. All rights reserved. This package is free software; you can redistribute it and/or modify it under the same terms as Perl itself. (legal besties, we love to see it 🫶)

🌟 SEE ALSO 🌟

IO::LockedFile(3)

and that's the whole page, bestie — brought to you by perl v5.36.0, dated 2022-12-04. slay, bye 💅✨

📦 where this page comes from