collective.logbook 0.6

Motivation

For anonymous users Plone generates an Error Page which contains an error number. But what to do with this error number?

You have to log into your plone site, go to the ZMI, check the error_log object and probably construct the url by hand to get the proper error with this error number, like:

http://your-plone-site/error_log/showEntry?id=1237283091.10.529903983894

If you are lucky, you will find the error. If not, and the number of occured errors exceeded the number of exceptions to keep, or maybe a cronjob restarted your zope instance, then….

Hmm, not really smooth this behaviour.

Wouldn’t it be better to have a nice frontend where you can paste the error number to a field and search for it? Keep all log persistent, also when zope restarts? Keep only unique errors and not thousand times the same Error? Get an email when a new, unique error occured, so you know already what’s going on before your customer mails this error number to you?

If you think that this would be cool, collective.logbook is what you want:)

Under the Hood

No, you won’t get DOOOOMED when you install collective.logbook :)

from Products.SiteErrorLog.SiteErrorLog import SiteErrorLog

_raising = SiteErrorLog.raising

def raising(self, info):
    enty_url = _raising(self, info)
    notify(ErrorRaisedEvent(self, enty_url))
    return enty_url

http://your-plone-site/error_log/showEntry?id=1237283091.10.529903983894

<!-- default storage adapter -->
<adapter
    for="*"
    factory=".storage.LogBookStorage"
  />

<subscriber
    for=".interfaces.INotifyTraceback"
    handler=".events.mailHandler"
  />

def initialize(context):
    """ Initializer called when used as a Zope 2 product. """

    app = context._ProductContext__app
    enabled = app.getProperty("logbook_enabled", False)

    if enabled:
        monkey.install_monkey()

./bin/instance test collective.logbook

Running:
..............
Ran 14 tests with 0 failures and 0 errors in 0.145 seconds.

Usage

After install, go to http://your-plone-site/@@logbook

Installation

These instructions assume that you already have a Plone 3 buildout that’s built and ready to run.

Edit your buildout.cfg file and look for the eggs key in the instance section. Add collective.logbook to that list. Your list will look something like this:

eggs =
    ${buildout:eggs}
    ${plone:eggs}
    collective.logbook

In the same section, look for the zcml key. Add collective.logbook here, too (not needed for plone versions > 3.3 which ship with z3c.autoinclude):

zcml = collective.logbook

0.6 (2011-11-28)

• Log exceptions within exception handler [jfroche]

• Move delete all button, add show all button, show error message if error was not found. [jfroche]

• Add option that disable browsing stored errors. This option become useful if you have a site with many errors. [jfroche]

0.5 (2011-08-16)

• Move storage to OOBTree to avoid that logging error transactions get bigger and bigger. Add upgradehandler accordingly. [gotcha]

• Fix saving configuration. [gotcha]

• Logging initialization at startup time was broken with Zope 2.13 at least. [gotcha]

• Added support for i18n [macagua]

• Added support for Spanisn translation [macagua]

• Move the mail notifier into a view to use a template for better HTML email handling. [rossp]

• Include the REQUEST HTML for more useful debugging and troubleshooting. [rossp]

0.4 (2010-08-02)

• Add “z3c.autoinclude.plugin” entry point, so in Plone 3.3+ you can avoid loading the ZCML file. [WouterVH]

• expose send mail exception to the log message this fixes http://plone.org/products/collective.logbook/issues/3 [naro]

• fixed email notification for plone4 since MailHost.send signature changed (see Upgrade Information) [fRiSi]

• store and show user and date for referenced errors too this fixes http://plone.org/products/collective.logbook/issues/2 [fRiSi]

0.3.1 (2009-03-18)

• the error handler now starts a new transaction before saving it into the logbook [ramonski]

0.3 (2009-03-17)

• 0.2 release was broken, sorry for this re-release [ramonski]

• fixed issues which caused some ugly Database Conflict errors [ramonski]

• removed all Zope2.app() stuff [ramonski]

• mail handler stops when no emails specified [ramonski]

• fixed uninstall method of properties [ramonski]

0.2 (2009-03-17)

• added a configlet for plone control panel [ramonski]

• added a default notify traceback email handler [ramonski]

• added propert install/uninstall methods for the SiteErrorLog patch [ramonski]

• added 2 properties in the application root [ramonski]

0.1 - Unreleased

• Initial release [ramonski]