Tweak logging for when a worker waits for its view of a replication stream to catch up. (#15120)Co-authored-by: Sean Quah <[email protected]>

* Improve logging messages for the 'wait for repl stream' read-after-write consistency feature

* Newsfile

Signed-off-by: Olivier Wilkinson (reivilibre) <[email protected]>

* Update synapse/replication/tcp/client.py

Co-authored-by: Sean Quah <[email protected]>

---------

Signed-off-by: Olivier Wilkinson (reivilibre) <[email protected]>
Co-authored-by: Sean Quah <[email protected]>

Author: reivilibre

changelog.d/15120.misc

@@ -0,0 +1 @@
+Tweak logging for when a worker waits for its view of a replication stream to catch up.

synapse/replication/tcp/client.py

@@ -370,15 +370,23 @@ async def wait_for_stream_position(
         # We measure here to get in flight counts and average waiting time.
         with Measure(self._clock, "repl.wait_for_stream_position"):
             logger.info(
-                "Waiting for repl stream %r to reach %s (%s)",
+                "Waiting for repl stream %r to reach %s (%s); currently at: %s",
                 stream_name,
                 position,
                 instance_name,
+                current_position,
             )
             try:
                 await make_deferred_yieldable(deferred)
             except defer.TimeoutError:
-                logger.error("Timed out waiting for stream %s", stream_name)
+                logger.error(
+                    "Timed out waiting for repl stream %r to reach %s (%s)"
+                    "; currently at: %s",
+                    stream_name,
+                    position,
+                    instance_name,
+                    self._streams[stream_name].current_token(instance_name),
+                )
                 return
 
             logger.info(