graypy 2.1.0

使用pip

安装基本的graypy Python日志处理器

pip install graypy

使用GELFRabbitHandler的要求进行安装

pip install graypy[amqp]

使用easy_install

安装基本的graypy Python日志处理器

easy_install graypy

使用GELFRabbitHandler的要求进行安装

easy_install graypy[amqp]

UDP日志

使用 GELFUDPHandler 可以轻松地将UDP日志转发到本地托管的Graylog服务器

import logging
import graypy

my_logger = logging.getLogger('test_logger')
my_logger.setLevel(logging.DEBUG)

handler = graypy.GELFUDPHandler('localhost', 12201)
my_logger.addHandler(handler)

my_logger.debug('Hello Graylog.')

RabbitMQ 日志

或者，使用 GELFRabbitHandler 将消息发送到 RabbitMQ，并配置您的 Graylog 服务器通过 AMQP 消费消息。这可以防止由于丢弃的 UDP 数据包而丢失日志消息（GELFUDPHandler 使用 UDP 将消息发送到 Graylog）。您需要配置 RabbitMQ 使用 gelf_log 队列，并将其绑定到 logging.gelf 交换，以便消息被正确路由到可以被 Graylog 消费的消息队列（队列和交换机名称可以按您的喜好自定义）。

import logging
import graypy

my_logger = logging.getLogger('test_logger')
my_logger.setLevel(logging.DEBUG)

handler = graypy.GELFRabbitHandler('amqp://guest:guest@localhost/', exchange='logging.gelf')
my_logger.addHandler(handler)

my_logger.debug('Hello Graylog.')

Django 日志

通过在您的 settings.py 中添加新的处理器，可以轻松地将 graypy 集成到 Django 的日志设置中。

LOGGING = {
    'version': 1,
    # other dictConfig keys here...
    'handlers': {
        'graypy': {
            'level': 'WARNING',
            'class': 'graypy.GELFUDPHandler',
            'host': 'localhost',
            'port': 12201,
        },
    },
    'loggers': {
        'django.request': {
            'handlers': ['graypy'],
            'level': 'ERROR',
            'propagate': True,
        },
    },
}

跟踪日志

默认情况下，捕获的异常跟踪信息会作为 full_message 字段添加到 GELF 日志中

import logging
import graypy

my_logger = logging.getLogger('test_logger')
my_logger.setLevel(logging.DEBUG)

handler = graypy.GELFUDPHandler('localhost', 12201)
my_logger.addHandler(handler)

try:
    puff_the_magic_dragon()
except NameError:
    my_logger.debug('No dragons here.', exc_info=1)

默认日志字段

如果可用，默认情况下会自动将一些调试日志字段添加到 GELF 日志中

• function

• pid

• process_name

• thread_name

您可以通过在处理器的构造函数中指定 debugging_fields=False 来禁用自动添加这些调试日志字段

handler = graypy.GELFUDPHandler('localhost', 12201, debugging_fields=False)

添加自定义日志字段

graypy 还支持在发送到 Graylog 的 GELF 日志中包含自定义字段。这可以通过使用 Python 的 LoggerAdapter 和 Filter 类来实现。

import logging
import graypy

my_logger = logging.getLogger('test_logger')
my_logger.setLevel(logging.DEBUG)

handler = graypy.GELFUDPHandler('localhost', 12201)
my_logger.addHandler(handler)

my_adapter = logging.LoggerAdapter(logging.getLogger('test_logger'),
                                   {'username': 'John'})

my_adapter.debug('Hello Graylog from John.')

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.GELFUDPHandler('localhost', 12201)
my_logger.addHandler(handler)

my_logger.addFilter(UsernameFilter())

my_logger.debug('Hello Graylog from John.')