matrix-org/synapse

Add additional debug logging to MultiWriterIdGenerator.__init__ and get_cache_dict

Open

#9,443 opened on Feb 18, 2021

View on GitHub
 (1 comment) (0 reactions) (0 assignees)Python (11,713 stars) (2,196 forks)batch import
O-OccasionalS-TolerableT-Taskgood first issue

Description

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

Contributor guide

Tech stack
python
Domain
backendobservability
Issue type
feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
under 1 hour
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
fresh
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
Python
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
80
Research direction
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.