Sentry Python日志集成疑问：Handler选择与自定义格式化

问题背景 #

现有Logger配置了两个Handler，代码如下：

ch = logging.StreamHandler(sys.stdout)
ch.setLevel(logging.DEBUG)
ch.setFormatter(logging.Formatter('%(message)s'))  # Logs are pre-formatted as JSON strings

# File handler for custom human-readable output
fh = logging.FileHandler(os.environ["LOG_FILE_LOCATION"])
fh.setLevel(logging.DEBUG)
fh.setFormatter(CustomFileFormatter())

logger.addHandler(ch)
logger.addHandler(fh)

同时有一条Sentry中的示例日志：

{"event": "Error event", "logger": "A.a1", "level": "error", "environment": "staging",  "image_name": "X", "target_module": "Y", "filename": "/usr/local/lib/python3.10/site-packages/structlog/stdlib.py", "lineno": 247, "function": "_proxy_to_logger", "timestamp": "2024-07-22T06:58:00.499028Z"}

问题1：Sentry会使用哪个Handler来展示错误消息？ #

Sentry不会复用你当前配置的StreamHandler或FileHandler。它的SDK会自动创建专属的日志Handler（比如sentry_sdk.integrations.logging.EventHandler）并添加到你的logger实例中。你现有的两个Handler只负责将日志输出到控制台和文件，和Sentry的消息展示逻辑完全独立——Sentry用自己的Handler捕获日志事件后，按自身规则处理并展示。

问题2：如何自定义发送至Sentry的输出格式？ #

核心是通过Sentry SDK的钩子或自定义处理器修改事件内容，常用两种方式：

• 使用before_send钩子：在初始化Sentry时传入该函数，可在事件发送前修改其结构，灵活性最高。示例代码：

  import sentry_sdk
  from sentry_sdk.integrations.logging import LoggingIntegration
  
  def before_send(event, hint):
      # 在这里按需修改事件，比如调整message、增减字段
      if 'logentry' in event:
          event['logentry']['message'] = "自定义消息内容"
      return event
  
  sentry_logging = LoggingIntegration(
      level=logging.DEBUG,        # 捕获DEBUG及以上级别日志
      event_level=logging.ERROR   # ERROR及以上级别作为Sentry事件上报
  )
  
  sentry_sdk.init(
      dsn="你的Sentry DSN",
      integrations=[sentry_logging],
      before_send=before_send
  )
  

• 给Sentry Handler单独设置Formatter：如果需要对日志原始格式做调整，可以给Sentry的专属Handler设置自定义Formatter，但这种方式不如before_send直接操作Sentry事件结构灵活。

问题3：如何让Sentry记录的message等于event字段，其余键值对作为标签？ #

结合你提供的JSON格式日志（StreamHandler输出的是预格式化JSON字符串），可以通过before_send钩子解析JSON并重构Sentry事件：

import json
import sentry_sdk
from sentry_sdk.integrations.logging import LoggingIntegration

def before_send(event, hint):
    if 'logentry' in event and 'message' in event['logentry']:
        try:
            # 解析日志中的JSON字符串
            log_data = json.loads(event['logentry']['message'])
            # 将event字段设为Sentry的message
            event['logentry']['message'] = log_data.get('event', '')
            # 把剩余键值对转为Sentry标签（标签值需为字符串）
            for key, value in log_data.items():
                if key != 'event':
                    event['tags'][key] = str(value)
        except json.JSONDecodeError:
            # 解析失败时保留原事件，避免报错
            pass
    return event

sentry_logging = LoggingIntegration(
    level=logging.DEBUG,
    event_level=logging.ERROR
)

sentry_sdk.init(
    dsn="你的Sentry DSN",
    integrations=[sentry_logging],
    before_send=before_send
)

注意：Sentry标签有长度限制，过长的值会被截断；同时不要添加过多标签，避免影响性能和可读性。

内容的提问来源于stack exchange，提问作者Ram