Item10362: Logger documentation is insufficient

Priority: Urgent
Current State: Closed
Released In: 1.1.3
Target Release: patch
Applies To: Engine
Component: Logging
Reported By: GeorgeClark
Waiting For:
Last Change By: KennethLavrsen
The documentation on the new Foswiki 1.1 logger is very insufficient.

When migrating a web site,
  • What are all the file name changes?
  • How does one migrate and assure contiguous logs?
  • How do you ensure statistics are correct across the migration.

Started some initial docs when trying to figure out how to migrate, but it's incomplete. This needs to be polished up a bit and added to the release notes.

Logging information

Foswiki 1.0.x logs to the data directory, 1.1.x logs to working/logs The format of the log files has not changed.

Foswiki 1.0.x Foswiki 1.1.x
Current & Prior Current Month Prior Months
foswiki-root/data/logYYYYMM foswiki-root/working/logs/events.log foswiki-root/working/logs/events.YYYYMM
foswiki-root/data/warnYYYYMM (Not sure if this file still exists - have not seen one yet)
foswiki-root/data/error.log foswiki-root/working/logs/error.log foswiki-root/working/logs/error.YYYYMM
foswiki-root/data/debug.txt foswiki-root/working/logs/debug.log foswiki-root/working/logs/debug.YYYYMM
foswiki-root/data/configurationlog.txt foswiki-root/working/logs/configure.log (Doesn't appear to auto roll?)

  1. Copy current log from data to working/logs directory renaming to remove the YYYYMM
  2. Copy older files over renaming to the new file pattern

-- GeorgeClark - 17 Feb 2011

I can't comment on the configuration log (I didn't do that one) but the others are bang on the money. A warn log will emerge if anyone ever generates a warning, but as Foswiki::Func logs warnings in the debug log, that's unlikely. But it could in theory happen - it's just another log level.

-- CrawfordCurrie - 17 Feb 2011

ItemTemplate edit

Summary Logger documentation is insufficient
ReportedBy GeorgeClark
Codebase 1.1.2, 1.1.1, 1.1.0, 1.1.0 beta1, trunk
SVN Range
AppliesTo Engine
Component Logging
Priority Urgent
CurrentState Closed
Checkins distro:21e87bb9e6e9 distro:d98eeacb0f98
TargetRelease patch
ReleasedIn 1.1.3
Topic revision: r6 - 16 Apr 2011, KennethLavrsen
The copyright of the content on this website is held by the contributing authors, except where stated elsewhere. See Copyright Statement. Creative Commons License    Legal Imprint    Privacy Policy