haufe.requestmonitoring 0.6.0

Zope 2 request monitoring

Table of contents

• Introduction

• Requirements

• Features

  • Fine resolution request logging

    • Fields

  • Success request logging

  • Monitoring long running requests

    • Dump trace on pdb

  • Installation

• Author

• License

• Changelog

  • 0.6.0 (2021-05-12)

  • 0.5.1 (2018-04-03)

  • 0.5.0 (2016-09-29)

  • 0.4.0 (2013-09-20)

  • 0.3.0 (2012-10-16)

  • 0.2.3 - (2009/08/11)

  • 0.2.2 - (2009/07/20)

  • 0.2.1 - (2009/05/28)

  • 0.2.0 - (2009/05/12)

Introduction

haufe.requestmonitoring implements a detailed request logging functionality on top of the publication events as introduced with Zope 2.12.

Requirements

• Zope 2.12.0b2 or higher

• Currently tested on Zope 2.13.21

You can use this with older Zope releases (2.10.x) but you must also include ZPublisherEventsBackport.

Features

Fine resolution request logging

Used as base for ztop and zanalyse, i.e. helps to determine the Zope load, detect long running requests and to analyse the causes of restarts.

The implementation in this module registers subscribers for IPubStart and IPubSuccess/IPubFailure. For each of these events, a log entry of the form:

timestamp status request_time type request_id request_info

is written.

Fields

• timestamp is the current time in the format %y%m%dT%H%M%S.

• status is 0 for IPubStart events, 390 for requests that will be retried and the result of IStatus applied to the response otherwise.

• request_time is 0 for IPubStart events. Otherwise, it will be the request time in seconds.

• type is + for IPubStart and - otherwise.

• request_id is the (process) unique request id.

• request_info is IInfo applied to the request.

In addition, a log entry with request_info == restarted is written when this logging is activated. Apart from request_info and timestamp all other fields are 0. It indicates (obviously) that the server has been restarted. Following requests get request ids starting with 1.

To activate this logging, both timelogging.zcml must be activated (on by default) and a product-config section with name timelogging must be defined containing the key filebase. It specifies the basename of the logfile; .<date> will be appended to this base. Then, ITicket, IInfo adapters must be defined (e.g. the one from info). An IStatus adapter may be defined for response.

Example:

<product-config timelogging>
filebase /path/to/request-logs/instance-foo
</product-config>

Success request logging

This logging writes two files <base>_good.<date> and <base>_bad.<date>. For each request, a character is written to either the good or the bad logfile, depending on whether the request was successful or unsuccessful. This means, that only the file size matters for these logfiles.

Usually, response codes >= 500 are considered as unsuccessful requests. You can register an ISuccessFull adapter, when you need a different classification.

To activate this logging, both successlogging.zcml must be activated (on by default) and a product-config section with name successlogging must be defined containing the key filebase. It specifies the basename of the logfiles (represented as <base> above).

Example:

<product-config successlogging>
filebase /path/to/request-logs/successful-foo
</product-config>

Monitoring long running requests

haufe.requestmonitoring allows you to monitor long-running request. The following configuration within your zope.conf configuration file will install the DumpTracer and check after the period time passed for requests running longer than time.

To activate this logging, both monitor.zcml must be activated (off by default) and the requestmonitor configuration section must be present:

zope-conf-additional =
    %import haufe.requestmonitoring
    <requestmonitor requestmonitor>
        # default is 1m
        period 10s
        # default is 1
        verbosity 2
        <monitorhandler dumper>
            factory haufe.requestmonitoring.DumpTraceback.factory
            # 0 --> no repetition
            repeat -1
            time 10s
        </monitorhandler>
    </requestmonitor>

A typical dump trace looks like this (it shows you the URL and the current stacktrace):

2009-08-11 14:29:09 INFO Zope Ready to handle requests
2009-08-11 14:29:09 INFO RequestMonitor started
2009-08-11 14:29:14 INFO RequestMonitor monitoring 1 requests
2009-08-11 14:29:19 INFO RequestMonitor monitoring 1 requests
2009-08-11 14:29:24 INFO RequestMonitor monitoring 1 requests
2009-08-11 14:29:24 WARNING RequestMonitor.DumpTrace Long running request
Request 1 "/foo" running in thread -497947728 since 14.9961140156s
Python call stack (innermost first)
Module /home/junga/sandboxes/review/parts/instance/Extensions/foo.py, line 4, in foo
Module Products.ExternalMethod.ExternalMethod, line 231, in __call__
- __traceback_info__: ((), {}, None)
Module ZPublisher.Publish, line 46, in call_object
Module ZPublisher.mapply, line 88, in mapply
Module ZPublisher.Publish, line 126, in publish
Module ZPublisher.Publish, line 225, in publish_module_standard
Module ZPublisher.Publish, line 424, in publish_module
Module Products.ZopeProfiler.ZopeProfiler, line 353, in _profilePublishModule
Module Products.ZopeProfiler.MonkeyPatcher, line 35, in __call__
Module ZServer.PubCore.ZServerPublisher, line 28, in __init__

The log line “RequestMonitor monitoring X requests” simply says that a request is under monitor and sometimes you get useless noise in the log file.

You can play with the verbosity option: put the value to 0 for disable the log line. Default value (1) will display the log line every time one or more requests are under monitor. A value of 2 is more verbose, displaying also info about requests URLs.

Dump trace on pdb

Traceback dump can became quickly a nightmare if you put a Python debug line on your source code and then you want to test it running Zope.

In that case you can disable traceback dump when you are executing the debugger. Simply add the DISABLE_HAUFE_MONITORING_ON_PDB environment variable:

environment-vars =
    ...
    DISABLE_HAUFE_MONITORING_ON_PDB True

Installation

Add haufe.requestmonitoring to both eggs and zcml option of your buildout.cfg file.

Author

• original author: Dieter Maurer

• current maintainer: Andreas Jung, [e-mail]

License

haufe.requestmonitoring is published under the Zope Public License V 2.1 (ZPL). See LICENSE.txt.

Changelog

0.6.0 (2021-05-12)

• Support Zope 4 / Python 3. [tschorr]

0.5.1 (2018-04-03)

• Fix logging format. Refs: #9 [mamico]

0.5.0 (2016-09-29)

• For all logging output, use unicode and string format instead of string substitution to avoid possible encoding errors. Refs: #5. [thet]

• Allow the monitorhandler define it’s zLOG loglevel. This makes possible to define the ERROR level instead of WARNING for long running requests and get notified by a tool like Sentry, when it’s configured to notice ERROR level logs. [thet]

• Remove Logger.py, which is a simpler version of the “Long Request Logger” in DumpTraceback.py and isn’t used nor documented. [thet]

• Move docs/HISTORY.txt to CHANGES.rst. [thet]

• PEP8 compatibility

0.4.0 (2013-09-20)

• Added retro-compatibility with old versions of Zope without bein forced to manually patch Zope. [giacomos]

• You can now add a DISABLE_HAUFE_MONITORING_ON_PDB envvar to stop dumping traceback when on Python pdb. [keul]

0.3.0 (2012-10-16)

• Do not use deprecated threadframe dependency anymore on recent Python versions. [keul]

• Fixed egg dependencies for Zope 2.13. [keul]

• Added the verbosity configuration option for the logger. [keul]

0.2.3 - (2009/08/11)

• Updated documentation.

0.2.2 - (2009/07/20)

• Minor cleanup.

• Minor documentation cleanup.

0.2.1 - (2009/05/28)

• Configure ‘successlogging’ by default.

• Slightly updated documentation.

0.2.0 - (2009/05/12)

• Initial release.