ftw.structlog 1.1.0

Structured logging for Plone

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,
  "cient_ip": "127.0.0.1",
  "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)
client_ip	Host where the request originated from (respecting X-Forwarded-For)
duration	Time spent in ZPublisher to handle request (time between IPubStart and IPubSuccess / IPubFailure )
host	Deprecated. You should use client_ip instead.
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.

When running tests in other projects, these errors can be muted by setting the environment variable FTW_STRUCTLOG_MUTE_SETUP_ERRORS=true.

Links

• Github: https://github.com/4teamwork/ftw.structlog

• Issues: https://github.com/4teamwork/ftw.structlog/issues

• Pypi: http://pypi.python.org/pypi/ftw.structlog

• Continuous integration: https://jenkins.4teamwork.ch/search?q=ftw.structlog

Copyright

This package is copyright by 4teamwork.

ftw.structlog is licensed under GNU General Public License, version 2.

Changelog

1.1.0 (2019-01-11)

• DEPRECATED: The host field is deprecated. Instead, the newly introduced client_ip field should be used to get the client’s IP address. [lgraf]

• Always log missing referer as empty string instead of null. [lgraf]

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]