Smalltalk/X Webserver

Documentation of class 'MiniLogger':

Class: MiniLogger

Inheritance
Description
Class protocol
Private classes
Examples

Inheritance:

   Object
   |
   +--MiniLogger
      |
      +--UnixSyslogInterface

Package:: stx:libbasic

Category:: System-Debugging-Support

Version:: rev: 1.155 date: 2024/04/29 13:25:46; user: cg; file: MiniLogger.st directory: libbasic; module: stx stc-classLibrary: libbasic

Description:

A very simple logger for Smalltalk/X. This one is always present.
It mimics the protocol of the loggers found in stx:goodies/loggia,
which can be activated by setting the global 'Logger' to an instance of
one of them.

All
    'Transcript show: 'Processor [info]: xxx'
should be rewritten over time to use the Logger.

'Object infoPrint' and 'Object debugPrint' have been changed to
forward their messages to the global 'Logger' if not nil.

Usage:
    Logger info: 'Hello world'.
    Logger debug: 'Hello world'.
    Logger warning: 'Hello world'.
    Logger error: 'Hello world'.

to disable logging:
    MiniLogger logOnTranscript:false.
    MiniLogger logOnStderr:false.

for selective logging:
    Logger loggingThreshold: Logger severityALL.
    Logger loggingThreshold: Logger severityINFO.
    Logger loggingThreshold: Logger severityNONE.

ALL > FATAL > ERROR > WARN > INFO > DEBUG > TRACE0 > TRACE3 > NONE

The following keywords are expanded in the message:
    'LINE'      linenumber in the sending method
    'RECEIVER'  printstring of receiver in sending context
    'CLASS'     class of receiver in sending context
    'MCLASS'    class of sendig method
    'SELECTOR'  selector of sending method
    'WHO'       who-string of sending method
    'WHERE'     who-string plus linenumber of sending method

i.e.
    Logger info:'%(WHERE) - some message here'

For more examples, see #examples.


[instance variables:]

[class variables:]

copyrightCOPYRIGHT (c) 2012-2014 by Jan Vrany & eXept Software AG
             All Rights Reserved

This software is furnished under a license and may be used
only in accordance with the terms of that license and with the
inclusion of the above copyright notice.   This software may not
be provided or otherwise made available to, or used by, any
other person.  No title to or ownership of the software is
hereby transferred.

Class protocol:

accessing-log format

logColor

is coloring of logs enabled/disabled

Usage example(s):

     Logger logColor:true
     Logger warn:'wwww'.
     Logger error:'wwww'.
     Logger info:'wwww'.
     Logger logColor:false
     Logger warn:'wwww'.
     Logger error:'wwww'.
     Logger info:'wwww'.

logColor: aBoolean

enable/disable coloring of logs

Usage example(s):

     Logger logColor:true
     Logger warn:'wwww'.
     Logger error:'wwww'.
     Logger info:'wwww'.
     Logger logColor:false
     Logger warn:'wwww'.
     Logger error:'wwww'.
     Logger info:'wwww'.

logFile

if this is non-nil, the log goes into that file (possibly in addition to other destinations)

logFile: aFilename

if non-nil, the log goes into that file (possibly in addition to other destinations)

logFormat

will be used for the log message as:
%1 [%2] (%3): %4
with
%1: facility (area such as 'STX' or 'appname')
%2: severity (error, info, etc.)
%3: timestamp (in timestamp format)
%4: caller/originator (receiver's class name)
%5: message
%6: location where log was generated ('[class>>sel@lineNr]'
%7: process id
%8: process name

Usage example(s):

     MiniLogger logFormat:'%1 [%2]: %5 %6'.
     'hello' errorPrintCR.

     MiniLogger logFormat:'%1 [%2]: %5'.
     'hello' errorPrintCR.

     MiniLogger logFormat:'%3 %1 [%2]: %5'.
     'hello' errorPrintCR.

     MiniLogger logFormat:nil.
     'hello' errorPrintCR.

logFormat: aFormatString

will be used for the log message as:
%1 [%2] (%3):%5 {%6}'
with
%1: facility (area such as 'STX' or 'appname')
%2: severity (error, info, etc.)
%3: timestamp (in timestamp format)
%4: caller/originator (receiver's class name)
%5: message
%6: location where log was generated ('[class>>sel@lineNr]
%7: process id
%8: process name
Pass a nil argument to return to the default format.

Usage example(s):

     MiniLogger logFormat:'%1 [%2]: %5 %6'.
     'hello' errorPrintCR.

     MiniLogger logFormat:'%1 [%2]: %5'.
     'hello' errorPrintCR.

     MiniLogger logFormat:'%3 %1 [%2]: %5'.
     'hello' errorPrintCR.

     MiniLogger logFormat:nil.
     'hello' errorPrintCR.

logFormatTranscript

will be used for transcript messages as:
with
%1: facility (area such as 'STX' or 'appname')
%2: severity (error, info, etc.)
%3: timestamp (in timestamp format)
%4: caller/originator (receiver's class name)
%5: message
%6: location where log was generated ('[class>>sel@lineNr]'
%7: process id
%8: process name

logFormatTranscript: aFormatString

will be used for the log message as:
%1: facility (area such as 'STX' or 'appname')
%2: severity (error, info, etc.)
%3: timestamp (in timestamp format)
%4: caller/originator (receiver's class name)
%5: message
%6: location where log was generated ('[class>>sel@lineNr]
%7: process id
%8: process name
Pass a nil argument to return to the default format.

Usage example(s):

     MiniLogger logFormatTranscript:'[%2]: %5 %6'.
     'hello' errorPrintCR.

     MiniLogger logFormatTranscript:nil.
     'hello' errorPrintCR.

     MiniLogger logFormat:'%3 %1 [%2]: %5'.
     'hello' errorPrintCR.

     MiniLogger logFormat:nil.
     'hello' errorPrintCR.

logOnStderr

true if the log is sent to stderr (possibly in addition to other destinations)

logOnStderr: aBoolean

enable/disable logging on stderr (possibly in addition to other destinations)

Usage example(s):

     MiniLogger logOnStderr:false
     MiniLogger logOnTranscript:false

     MiniLogger logOnStderr:true
     MiniLogger logOnTranscript:true

logOnTranscript

true if logging on the Transcript is enabled (possibly in addition to other destinations)

logOnTranscript: aBoolean

enable/disable logging on the Transcript (possibly in addition to other destinations)

Usage example(s):

     MiniLogger logOnStderr:false
     MiniLogger logOnTranscript:false

     MiniLogger logOnStderr:true
     MiniLogger logOnTranscript:true

timestampFormat

will be used for the log message

Usage example(s):

     Timestamp now printStringFormat:(self timestampFormat)
     self timestampFormat:'%h:%m:%s.%i'

timestampFormat: aTimestampFormatString

will be used for the log messages

Usage example(s):

     Timestamp now printStringFormat:(self timestampFormat)
     self timestampFormat:'%h:%m:%s.%i'
     self timestampFormat:'%s.%i'

accessing-severities

severities