graypy 技术文档

1. 安装指南

graypy 可以通过以下方式安装：

使用 pip：

pip install graypy

或者安装带有 GELFRabbitHandler 依赖的版本：

pip install graypy[amqp]

使用 easy_install：

easy_install graypy

或者安装带有 GELFRabbitHandler 依赖的版本：

easy_install graypy[amqp]

2. 项目的使用说明

graypy 提供了多个日志处理器，用于将日志消息以 Graylog Extended Log Format (GELF) 的形式发送到 Graylog 服务器。以下是可用的 GELF 日志处理器列表：

• GELFUDPHandler - 通过 UDP 发送日志
• GELFTCPHandler - 通过 TCP 发送日志
• GELFTLSHandler - 通过支持 TLS 的 TCP 发送日志
• GELFHTTPHandler - 通过 HTTP 发送日志
• GELFRabbitHandler - 通过 RabbitMQ 发送日志

UDP 日志

要使用 GELFUDPHandler 将日志发送到本地 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 数据包丢失导致的日志消息丢失。

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.')

3. 项目API使用文档

graypy 的 API 使用 Python 的 logging.Handler 类的子类。具体使用方法请参考以下示例：

• GELFUDPHandler 的使用方法见 UDP 日志部分。
• GELFRabbitHandler 的使用方法见 RabbitMQ 日志部分。

更多详细信息和示例，请参考官方文档。

4. 项目安装方式

项目的安装方式已在“安装指南”部分详细说明，以下是简要步骤：

• 使用 pip 或 easy_install 安装基本版本的 graypy。
• 如需使用 GELFRabbitHandler，安装时需添加 [amqp] 依赖。