/usr/lib/python2.7/dist-packages/graypy-0.2.14.egg-info/PKG-INFO is in python-graypy 0.2.14-1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 | Metadata-Version: 1.0
Name: graypy
Version: 0.2.14
Summary: Python logging handler that sends messages in GELF (Graylog Extended Log Format).
Home-page: https://github.com/severb/graypy
Author: Sever Banesiu
Author-email: banesiu.sever@gmail.com
License: BSD License
Description: Installing
==========
Using easy_install::
easy_install graypy
Install with requirements for ``GELFRabbitHandler``::
easy_install graypy[amqp]
Usage
=====
Messages are sent to Graylog2 using a custom handler for the builtin logging library in GELF format::
import logging
import graypy
my_logger = logging.getLogger('test_logger')
my_logger.setLevel(logging.DEBUG)
handler = graypy.GELFHandler('localhost', 12201)
my_logger.addHandler(handler)
my_logger.debug('Hello Graylog2.')
Alternately, use ``GELFRabbitHandler`` to send messages to RabbitMQ and configure your Graylog2 server to consume messages via AMQP. This prevents log messages from being lost due to dropped UDP packets (``GELFHandler`` sends messages to Graylog2 using UDP). You will need to configure RabbitMQ with a 'gelf_log' queue and bind it to the 'logging.gelf' exchange so messages are properly routed to a queue that can be consumed by Graylog2 (the queue and exchange names may be customized to your liking)::
import logging
import graypy
my_logger = logging.getLogger('test_logger')
my_logger.setLevel(logging.DEBUG)
handler = graypy.GELFRabbitHandler('amqp://guest:guest@localhost/%2F', 'logging.gelf')
my_logger.addHandler(handler)
my_logger.debug('Hello Graylog2.')
Tracebacks are added as full messages::
import logging
import graypy
my_logger = logging.getLogger('test_logger')
my_logger.setLevel(logging.DEBUG)
handler = graypy.GELFHandler('localhost', 12201)
my_logger.addHandler(handler)
try:
puff_the_magic_dragon()
except NameError:
my_logger.debug('No dragons here.', exc_info=1)
Configuration parameters
========================
GELFHandler:
* **host** - the host of the graylog server.
* **port** - the port of the graylog server (default 12201).
* **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.
* **level_names** - allows the use of string error level names instead in addition to their numerical representation.
GELFRabbitHandler:
* **url** - 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.
Using with Django
=================
It's easy to integrate ``graypy`` with Django's logging settings. Just add a
new handler in your ``settings.py`` like this::
LOGGING = {
...
'handlers': {
'graypy': {
'level': 'WARNING',
'class': 'graypy.GELFHandler',
'host': 'localhost',
'port': 12201,
},
},
'loggers': {
'django.request': {
'handlers': ['graypy'],
'level': 'ERROR',
'propagate': True,
},
},
}
Custom fields
=============
A number of custom fields are automatically added if available:
* function
* pid
* process_name
* thread_name
You can disable these additional fields if you don't want them by adding an argument to the handler::
handler = graypy.GELFHandler('localhost', 12201, debugging_fields=False)
graypy also supports additional fields to be included in the messages sent to Graylog2. This can be done by using Python's LoggerAdapter_ and Filter_. In general, LoggerAdapter makes it easy to add static information to your log messages and Filters give you more flexibility, for example to add additional information based on the message that is being logged.
Example using LoggerAdapter_::
import logging
import graypy
my_logger = logging.getLogger('test_logger')
my_logger.setLevel(logging.DEBUG)
handler = graypy.GELFHandler('localhost', 12201)
my_logger.addHandler(handler)
my_adapter = logging.LoggerAdapter(logging.getLogger('test_logger'),
{ 'username': 'John' })
my_adapter.debug('Hello Graylog2 from John.')
Example using Filter_::
import logging
import graypy
class UsernameFilter(logging.Filter):
def __init__(self):
# In an actual use case would dynamically get this (e.g. from memcache)
self.username = "John"
def filter(self, record):
record.username = self.username
return True
my_logger = logging.getLogger('test_logger')
my_logger.setLevel(logging.DEBUG)
handler = graypy.GELFHandler('localhost', 12201)
my_logger.addHandler(handler)
my_logger.addFilter(UsernameFilter())
my_logger.debug('Hello Graylog2 from John.')
Contributors:
* Sever Banesiu
* Daniel Miller
.. _LoggerAdapter: http://docs.python.org/howto/logging-cookbook.html#using-loggeradapters-to-impart-contextual-information
.. _Filter: http://docs.python.org/howto/logging-cookbook.html#using-filters-to-impart-contextual-information
.. image:: https://d2weczhvl823v0.cloudfront.net/severb/graypy/trend.png
:alt: Bitdeli badge
:target: https://bitdeli.com/free
Keywords: logging gelf graylog2 graylog udp amqp
Platform: UNKNOWN
|