Tweak logging for when a worker waits for its view of a replication s…

…tream 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]>
matrix-org · Feb 21, 2023 · addd12f · addd12f
1 parent 8cede52
commit addd12f
Show file tree

Hide file tree

Showing 2 changed files with 11 additions and 2 deletions.
diff --git a/changelog.d/15120.misc b/changelog.d/15120.misc
@@ -0,0 +1 @@
+Tweak logging for when a worker waits for its view of a replication stream to catch up.
diff --git a/synapse/replication/tcp/client.py b/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(
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1 @@
		Tweak logging for when a worker waits for its view of a replication stream to catch up.