eea.graylogger 1.0

GELF (Graylog Extended Log Format) for Zope

GELF (Graylog Extended Log Format) for Zope event logs

Contents

Contents

• Contents

• Main features

• Install

• Getting started

• Configuration parameters

  • GELFHandler

  • GELFRabbitHandler

• Dependencies

• Source code

• Copyright and license

• Funding

• Changelog

Main features

1. Sends Zope event logs to Graylog instead of a file.

Install

• Add eea.graylogger to your eggs section in your buildout and re-run buildout. You can download a sample buildout from https://github.com/eea/eea.graylogger/tree/master/buildouts/plone4

  [instance]
  eggs =
      ...
      eea.graylogger
  
  zope-conf-imports =
    eea.graylogger
  
  event-log-custom =
    <graylog>
      server 172.17.0.18:12201
    </graylog>

Getting started

1. Install Graylog server or use Graylog2 Docker image

2. Restart Zope

3. Go to http://localhost:9000 to see your Zope logs

Configuration parameters

• rabbit - True if you want to use GELFRabbitHandler instead of GELFHandler. See graypy documentation for more details.

GELFHandler

• server - the host[:port] of the graylog server.

• chunk_size - message chunk size. messages larger than this size will be sent to graylog in multiple chunks (default 1420).

• debugging_fields - send debug fields if true (the default).

• extra_fields - send extra fields on the log record to graylog if true (the default).

• fqdn - use fully qualified domain name of localhost as source host (socket.getfqdn()).

• localname - use specified hostname as source host.

• facility - replace facility with specified value. if specified, record.name will be passed as logger parameter.

GELFRabbitHandler

• server - RabbitMQ URL (ex: amqp://guest:guest@localhost:5672/%2F).

• exchange - RabbitMQ exchange. Default ‘logging.gelf’. A queue binding must be defined on the server to prevent log messages from being dropped.

• debugging_fields - send debug fields if true (the default).

• extra_fields - send extra fields on the log record to graylog if true (the default).

• fqdn - use fully qualified domain name of localhost as source host - socket.getfqdn().

• exchange_type - RabbitMQ exchange type (default fanout).

• localname - use specified hostname as source host.

• facility - replace facility with specified value. if specified, record.name will be passed as logger parameter.

Dependencies

1. Graylog server

2. graypy

Source code

• Latest source code (Plone 4 compatible): https://github.com/eea/eea.graylogger

Copyright and license

The Initial Owner of the Original Code is European Environment Agency (EEA). All Rights Reserved.

The EEA Progress Bar (the Original Code) is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version.

More details under docs/License.txt

Funding

EEA - European Environment Agency (EU)

Changelog

1.0 - (2015-05-05)

• Initial release