PerlDoc

See PublishedAPI for packages intended to be used by Plugin and Contrib authors, or browse all packages.
See also Developing plugins, Developer's Bible, Technical Overview

Perl Module:

---

Parent package: Foswiki::Logger
Child packages:

More ...Less ...

• Foswiki::Logger::PlainFile::EventIterator
• Foswiki::Logger::PlainFile::Obfuscating - Plain file implementation of the Foswiki Logger interface, with obfuscation of IP addresses. See Foswiki::Logger::PlainFile for further details. This implementation only implements log() call.

internal package Foswiki::Logger::PlainFile is a Foswiki::Logger

Plain file implementation of the Foswiki Logger interface. Mostly compatible with TWiki (and Foswiki 1.0.0) log files, except that dates are recorded using ISO format, and include the time, and it dies when a log can't be written (rather than printing a warning).

This logger implementation maps groups of levels to a single logfile, viz.

• debug messages are output to $Foswiki::cfg{Log}{Dir}/debug.log
• info messages are output to $Foswiki::cfg{Log}{Dir}/events.log
• warning, error, critical, alert, emergency messages are output to $Foswiki::cfg{Log}{Dir}/error.log.
• error, critical, alert, and emergency messages are also written to standard error (the webserver log file, usually)

ObjectMethod log($level, @fields)

See Foswiki::Logger for the interface.

ObjectMethod eachEventSince($time, \@levels, $version) → $iterator

• $time - a time in the past
• \@levels - log levels to return events for. Individual level or array reference.
• $version - Version 1 of API returns a hash instead of an array.
• $lock - boolean switch to enable locking, off by default

See Foswiki::Logger for the interface.