matrix-org/synapse

Add additional debug logging to MultiWriterIdGenerator.__init__ and get_cache_dict

Open

#9,443 创建于 2021年2月18日

在 GitHub 查看
 (1 评论) (0 反应) (0 负责人)Python (11,713 star) (2,196 fork)batch import
O-OccasionalS-TolerableT-Taskgood first issue

描述

We should add debug logging to MultiWriterIdGenerator similar to that in StreamIdGenerator, per https://github.com/matrix-org/synapse/issues/9268#issuecomment-770190320:

If MultiWriterIdGenerator.__init__ and get_cache_dict included some logger.debug, this would be a lot less confusing to diagonose.

(I mention MultiWriterIdGenerator specifically, because StreamIdGenerator.__init__ does write debug, via _load_current_id, and it is quite helpful, and the inconsistency is extra confusing.)

贡献者指南

技术栈
python
领域
backendobservability
议题类型
feature
难度面向新贡献者的预计实现难度，1 表示很小改动，5 表示专家级工作。
2
预计时间有经验贡献者完成调查、实现、测试并准备 pull request 的粗略时间范围。
under 1 hour
活动状态议题当前的可参与程度：新鲜、活跃、陈旧、阻塞或等待维护者输入。
fresh
清晰度议题是否清楚说明期望改动、验收标准和下一步。
clear
前置要求
Python
新手友好度1-100 的估计分数，表示该议题对首次贡献者的友好程度。
80
研究方向
Refer to `StreamIdGenerator. init ` which uses ` load current id` for debug logging. Find `MultiWriterIdGenerator. init ` and `get cache dict` in the Synapse codebase (likely in `synapse/storage/databases/main/stream.py`). Add `logger.debug` statements similar to the existing pattern. Ensure the logging includes relevant state information to aid in diagnosis.