Skip to main content

Structured logging for Plone

Project description

ftw.structlog

This package implements structured request logging in Plone.

It does so by writing logfiles (one per instance) that contain one JSON entry per line for every request. That JSON entry contains all the information the Z2 log provides, and more, in structured key/value pairs.

Installation

  • Install ftw.structlog by adding it to the list of eggs in your buildout. Then run buildout and restart your instance:
[instance]
eggs +=
    ftw.structlog
  • Alternatively, add it as a dependency to your package’s setup.py.

Logged Information

Example entry:

{
  "bytes": 6875,
  "duration": 0.30268411636353,
  "host": "127.0.0.1",
  "method": "GET",
  "referer": "http:\/\/localhost:8080\/plone",
  "site": "plone",
  "status": 200,
  "timestamp": "2017-07-29T12:30:58.000750+02:00",
  "url": "http:\/\/localhost:8080\/plone\/my-page",
  "user": "john.doe",
  "user_agent": "Mozilla\/5.0 (Macintosh; Intel Mac OS X 10_11_6) AppleWebKit\/537.36 (KHTML, like Gecko) Chrome\/60.0.3112.113 Safari\/537.36"
}

The logged JSON entry contains the following data:

key value
bytes Size of response body in bytes (Content-Length)
duration Time spent in ZPublisher to handle request (time between IPubStart and IPubSuccess / IPubFailure )
host Host where the request originated from (respecting X-Forwarded-For)
method HTTP request method
referer Referer
site Plone site ID
status HTTP response status
timestamp Time when request was received (non-naive local time in ISO 8601, in the server’s local timezone as determined by tzlocal)
url URL of the request (including query string if present)
user Username of the authenticated user, "Anonymous" otherwise
user_agent User-Agent

Logfile Location

One logfile per Zope2 instance will be created, and its location and name will be derived from the instance’s eventlog path. If the instance’s eventlog path is var/log/instance2.log, the JSON logfile’s path will be var/log/instance2-json.log.

Note: Because ftw.structlog derives its logfile name from the eventlog path, an eventlog must be configured in zope.conf, otherwise ftw.structlog will not log any requests and complain noisily through the root logger.

Changelog

1.0.1 (2017-09-03)

  • Fail gracefully if eventlog config can’t be found in order to derive log location from it. Instead of preventing instance startup, log a noticeable error message using the root logger. [lgraf]

1.0.0 (2017-09-03)

  • Initial implementation [lgraf]

Project details


Release history Release notifications

This version
History Node

1.0.1

History Node

1.0.0

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Filename, size & hash SHA256 hash help File type Python version Upload date
ftw.structlog-1.0.1.tar.gz (17.0 kB) Copy SHA256 hash SHA256 Source None Sep 3, 2017

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging CloudAMQP CloudAMQP RabbitMQ AWS AWS Cloud computing Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page