matrix-org/synapse

Add additional debug logging to MultiWriterIdGenerator.__init__ and get_cache_dict

Open

#9,443 opened on 2021年2月18日

GitHub で見る
 (1 comment) (0 reactions) (0 assignees)Python (11,713 stars) (2,196 forks)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
Issue 種別
feature
難度新しい貢献者にとっての実装難度です。1 は非常に小さな変更、5 は専門的な作業です。
2
推定時間経験ある貢献者が調査、実装、テスト、pull request 準備にかけるおおよその時間範囲です。
under 1 hour
活動状況Issue が今どれだけ取り組みやすいかを示します。新しい、活発、古い、ブロック中、またはメンテナー入力待ちなどです。
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.