==============
EEA Graylogger
==============
.. image:: https://ci.eionet.europa.eu/buildStatus/icon?job=eea/eea.graylogger/develop
:target: https://ci.eionet.europa.eu/job/eea/job/eea.graylogger/job/develop/display/redirect
:alt: develop
.. image:: https://ci.eionet.europa.eu/buildStatus/icon?job=eea/eea.graylogger/master
:target: https://ci.eionet.europa.eu/job/eea/job/eea.graylogger/job/master/display/redirect
:alt: master
GELF (Graylog Extended Log Format) for Zope event logs
Contents
========
.. contents::
Main features
=============
1. Sends Zope event logs to Graylog_ instead of a file.
Install
=======
Plone 5.2+ (WSGI)
-----------------
- Add `eea.graylogger`_ to your eggs section in your buildout and re-run buildout
::
[instance]
eggs +=
eea.graylogger
event-log-handler = eea.graylogger.GELFHandler
event-log-args = ('logs.example.com', 12201)
event-log-kwargs = {'level_names': True, 'facility': 'example.com'}
access-log-handler = eea.graylogger.GELFHandler
access-log-args = ('logs.example.com', 12201)
access-log-kwargs = {'facility': 'example.com'}
See `graypy`_ documentation for more details.
Alternatively, you can skip `-log-args` and `-log-kwargs` and use environment variables to
define Graylog `host:port` and `facility`:
::
[instance]
eggs +=
eea.graylogger
event-log-handler = eea.graylogger.GELFHandler
access-log-handler = eea.graylogger.GELFHandler
* `GRAYLOG` - Graylog `host`, or `host:port` (e.g.: `GRAYLOG=logs.example.com:12201`)
* `GRAYLOG_FACILITY` - Graylog facility (e.g.: `GRAYLOG_FACILITY=example.com`)
Plone < 5.2 (non-WSGI)
----------------------
- 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.
* **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_ >= 2.1.0
3. `plone.recipe.zope2instance`_ >= 6.5.0
Source code
===========
- Latest source code (Plone 5 / Python 3 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 Graylogger (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)
.. _`EEA`: https://www.eea.europa.eu/
.. _`Graylog`: https://www.graylog.org
.. _`graypy`: https://pypi.org/project/graypy/
.. _`Graylog2 Docker image`: https://github.com/eea/eea.docker.graylog2
.. _`eea.graylogger`: https://github.com/eea/eea.graylogger
.. _`plone.recipe.zope2instance`: https://pypi.org/project/plone.recipe.zope2instance
Changelog
=========
2.4 - (2023-06-12)
---------------------------
* Bug fix: Fix tests
[iulianpetchesi refs #249331]
2.3 - (2023-03-31)
---------------------------
* Change: Remove graypy pin
[iulianpetchesi refs #249331]
2.2 - (2023-03-31)
---------------------------
* Change: Change setup.py version pinnings
[iulianpetchesi refs #249331]
2.1 - (2023-03-31)
---------------------------
* Change: Bypass Plone 6 error when using eea.graylogger
[iulianpetchesi refs #249331]
2.0 - (2019-11-25)
--------------------------
* Feature: Python3 / Plone 5.2 / WSGI support
[avoinea refs #110157]
* Change: Upgrade to graypy 2.1.0
[avoinea refs #110157]
* Change: Remove chunk_size option
[avoinea refs #110157]
1.9 - (2019-04-02)
------------------
* Bug fix: Fix Readme unicode/decode error
[avoinea]
1.8 - (2019-04-02)
------------------
* Bug fix: Pin graypy version
[valipod]
1.7 - (2019-01-28)
-----------------------
* Jenkins: Add sonarqube step
[avoinea refs #101552]
* Change: updated URLs pointing to eea.europa.eu with https://
[alecghica refs #95849]
1.6 - (2017-12-12)
------------------
* Change: Replace eeacms/zptlint with eeacms/plone-test:4 zptlint
[avoinea refs #90415]
1.5 - (2017-06-15)
------------------
* Bug fix: Fix to work with graypy 0.2.14+ (facility override)
[avoinea refs #85963]
1.4 - (2017-05-15)
------------------
* Change: fixed PyLint warnings and errors
[eduard-fironda refs #84949]
1.3 - (2017-04-24)
------------------
* Change: updated package information
[eduard-fironda]
1.2 - (2015-10-05)
------------------
* Bug fix: Instance name param added to graylog's log entry
[lucas, refs #28304]
1.1 - (2015-07-06)
------------------
* Bug fix: Added hard dependency to amqplib in order to fix GELFRabbitHandler
[voineali refs #21610]
1.0 - (2015-05-05)
------------------
* Initial release
[voineali]
Raw data
{
"_id": null,
"home_page": "https://github.com/collective/eea.graylogger",
"name": "eea.graylogger",
"maintainer": "",
"docs_url": null,
"requires_python": "",
"maintainer_email": "",
"keywords": "EEA Add-ons Plone Zope",
"author": "European Environment Agency: IDM2 A-Team",
"author_email": "eea-edw-a-team-alerts@googlegroups.com",
"download_url": "https://files.pythonhosted.org/packages/ba/3e/4bf6e6af064cee33b4a4b3ac8c4dfb357e468636a7168afb8bb739a6da48/eea.graylogger-2.4.zip",
"platform": null,
"description": "==============\nEEA Graylogger\n==============\n.. image:: https://ci.eionet.europa.eu/buildStatus/icon?job=eea/eea.graylogger/develop\n :target: https://ci.eionet.europa.eu/job/eea/job/eea.graylogger/job/develop/display/redirect\n :alt: develop\n.. image:: https://ci.eionet.europa.eu/buildStatus/icon?job=eea/eea.graylogger/master\n :target: https://ci.eionet.europa.eu/job/eea/job/eea.graylogger/job/master/display/redirect\n :alt: master\n\nGELF (Graylog Extended Log Format) for Zope event logs\n\n\nContents\n========\n\n.. contents::\n\n\nMain features\n=============\n\n1. Sends Zope event logs to Graylog_ instead of a file.\n\n\nInstall\n=======\n\nPlone 5.2+ (WSGI)\n-----------------\n\n- Add `eea.graylogger`_ to your eggs section in your buildout and re-run buildout\n\n ::\n\n [instance]\n eggs +=\n eea.graylogger\n\n event-log-handler = eea.graylogger.GELFHandler\n event-log-args = ('logs.example.com', 12201)\n event-log-kwargs = {'level_names': True, 'facility': 'example.com'}\n\n access-log-handler = eea.graylogger.GELFHandler\n access-log-args = ('logs.example.com', 12201)\n access-log-kwargs = {'facility': 'example.com'}\n\nSee `graypy`_ documentation for more details.\n\nAlternatively, you can skip `-log-args` and `-log-kwargs` and use environment variables to\ndefine Graylog `host:port` and `facility`:\n\n ::\n\n [instance]\n eggs +=\n eea.graylogger\n\n event-log-handler = eea.graylogger.GELFHandler\n access-log-handler = eea.graylogger.GELFHandler\n\n* `GRAYLOG` - Graylog `host`, or `host:port` (e.g.: `GRAYLOG=logs.example.com:12201`)\n* `GRAYLOG_FACILITY` - Graylog facility (e.g.: `GRAYLOG_FACILITY=example.com`)\n\nPlone < 5.2 (non-WSGI)\n----------------------\n\n- Add `eea.graylogger`_ to your eggs section in your buildout and re-run buildout.\n You can download a sample buildout from\n https://github.com/eea/eea.graylogger/tree/master/buildouts/plone4\n\n ::\n\n [instance]\n eggs =\n ...\n eea.graylogger\n\n zope-conf-imports =\n eea.graylogger\n\n event-log-custom =\n <graylog>\n server 172.17.0.18:12201\n </graylog>\n\nGetting started\n===============\n\n1. Install Graylog_ server or use `Graylog2 Docker image`_\n2. Restart Zope\n3. Go to http://localhost:9000 to see your Zope logs\n\nConfiguration parameters\n========================\n\n* **rabbit** - True if you want to use GELFRabbitHandler instead of GELFHandler.\n See `graypy`_ documentation for more details.\n\nGELFHandler\n-----------\n\n* **server** - the host[:port] of the graylog server.\n* **debugging_fields** - send debug fields if true (the default).\n* **extra_fields** - send extra fields on the log record to graylog if true (the default).\n* **fqdn** - use fully qualified domain name of localhost as source host (socket.getfqdn()).\n* **localname** - use specified hostname as source host.\n* **facility** - replace facility with specified value. if specified, record.name\n will be passed as logger parameter.\n\nGELFRabbitHandler\n-----------------\n\n* **server** - RabbitMQ URL (ex: amqp://guest:guest@localhost:5672/%2F).\n* **exchange** - RabbitMQ exchange. Default `logging.gelf`. A queue binding must\n be defined on the server to prevent log messages from being dropped.\n* **debugging_fields** - send debug fields if true (the default).\n* **extra_fields** - send extra fields on the log record to graylog if true (the default).\n* **fqdn** - use fully qualified domain name of localhost as source host - socket.getfqdn().\n* **exchange_type** - RabbitMQ exchange type (default fanout).\n* **localname** - use specified hostname as source host.\n* **facility** - replace facility with specified value. if specified, record.name\n will be passed as logger parameter.\n\n\nDependencies\n============\n\n1. Graylog_ server\n2. graypy_ >= 2.1.0\n3. `plone.recipe.zope2instance`_ >= 6.5.0\n\nSource code\n===========\n\n- Latest source code (Plone 5 / Python 3 compatible):\n https://github.com/eea/eea.graylogger\n\n\nCopyright and license\n=====================\nThe Initial Owner of the Original Code is European Environment Agency (EEA).\nAll Rights Reserved.\n\nThe EEA Graylogger (the Original Code) is free software;\nyou can redistribute it and/or modify it under the terms of the GNU\nGeneral Public License as published by the Free Software Foundation;\neither version 2 of the License, or (at your option) any later\nversion.\n\nMore details under docs/License.txt\n\n\nFunding\n=======\n\nEEA_ - European Environment Agency (EU)\n\n.. _`EEA`: https://www.eea.europa.eu/\n.. _`Graylog`: https://www.graylog.org\n.. _`graypy`: https://pypi.org/project/graypy/\n.. _`Graylog2 Docker image`: https://github.com/eea/eea.docker.graylog2\n.. _`eea.graylogger`: https://github.com/eea/eea.graylogger\n.. _`plone.recipe.zope2instance`: https://pypi.org/project/plone.recipe.zope2instance\n\nChangelog\n=========\n\n2.4 - (2023-06-12)\n---------------------------\n* Bug fix: Fix tests\n [iulianpetchesi refs #249331]\n\n2.3 - (2023-03-31)\n---------------------------\n* Change: Remove graypy pin\n [iulianpetchesi refs #249331]\n\n2.2 - (2023-03-31)\n---------------------------\n* Change: Change setup.py version pinnings\n [iulianpetchesi refs #249331]\n\n2.1 - (2023-03-31)\n---------------------------\n* Change: Bypass Plone 6 error when using eea.graylogger\n [iulianpetchesi refs #249331]\n\n2.0 - (2019-11-25)\n--------------------------\n* Feature: Python3 / Plone 5.2 / WSGI support\n [avoinea refs #110157]\n* Change: Upgrade to graypy 2.1.0\n [avoinea refs #110157]\n* Change: Remove chunk_size option\n [avoinea refs #110157]\n\n1.9 - (2019-04-02)\n------------------\n* Bug fix: Fix Readme unicode/decode error\n [avoinea]\n\n1.8 - (2019-04-02)\n------------------\n* Bug fix: Pin graypy version\n [valipod]\n\n1.7 - (2019-01-28)\n-----------------------\n* Jenkins: Add sonarqube step\n [avoinea refs #101552]\n* Change: updated URLs pointing to eea.europa.eu with https://\n [alecghica refs #95849]\n\n1.6 - (2017-12-12)\n------------------\n* Change: Replace eeacms/zptlint with eeacms/plone-test:4 zptlint\n [avoinea refs #90415]\n\n1.5 - (2017-06-15)\n------------------\n* Bug fix: Fix to work with graypy 0.2.14+ (facility override)\n [avoinea refs #85963]\n\n1.4 - (2017-05-15)\n------------------\n* Change: fixed PyLint warnings and errors\n [eduard-fironda refs #84949]\n\n1.3 - (2017-04-24)\n------------------\n* Change: updated package information\n [eduard-fironda]\n\n1.2 - (2015-10-05)\n------------------\n* Bug fix: Instance name param added to graylog's log entry\n [lucas, refs #28304]\n\n1.1 - (2015-07-06)\n------------------\n* Bug fix: Added hard dependency to amqplib in order to fix GELFRabbitHandler\n [voineali refs #21610]\n\n1.0 - (2015-05-05)\n------------------\n* Initial release\n [voineali]\n\n\n",
"bugtrack_url": null,
"license": "GPL version 2",
"summary": "GELF (Graylog Extended Log Format) for Zope",
"version": "2.4",
"project_urls": {
"Homepage": "https://github.com/collective/eea.graylogger"
},
"split_keywords": [
"eea",
"add-ons",
"plone",
"zope"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "ba3e4bf6e6af064cee33b4a4b3ac8c4dfb357e468636a7168afb8bb739a6da48",
"md5": "6a45d6bc7333f85fde94776a9476f1c6",
"sha256": "b309c42506242344229428f30e676639e0f929976fe24381e87da812925f825f"
},
"downloads": -1,
"filename": "eea.graylogger-2.4.zip",
"has_sig": false,
"md5_digest": "6a45d6bc7333f85fde94776a9476f1c6",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 26413,
"upload_time": "2023-06-12T10:32:08",
"upload_time_iso_8601": "2023-06-12T10:32:08.609392Z",
"url": "https://files.pythonhosted.org/packages/ba/3e/4bf6e6af064cee33b4a4b3ac8c4dfb357e468636a7168afb8bb739a6da48/eea.graylogger-2.4.zip",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-06-12 10:32:08",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "collective",
"github_project": "eea.graylogger",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "eea.graylogger"
}
JSON
