Skip to content

Commit

Permalink
Add debug logging for when room keys are uploaded, including whether …
Browse files Browse the repository at this point in the history
…they are replacing other room keys. (element-hq#17266)

Fixes: element-hq#17013

Add logging for whether room keys are replaced
This is motivated by the Crypto team who need to diagnose crypto issues.

The existing opentracing logging is not enough because it is not enabled
for all users.
  • Loading branch information
reivilibre authored and Mic92 committed Jun 14, 2024
1 parent df0cf9e commit 48af592
Show file tree
Hide file tree
Showing 2 changed files with 19 additions and 0 deletions.
1 change: 1 addition & 0 deletions changelog.d/17266.misc
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
Add debug logging for when room keys are uploaded, including whether they are replacing other room keys.
18 changes: 18 additions & 0 deletions synapse/handlers/e2e_room_keys.py
Original file line number Diff line number Diff line change
Expand Up @@ -247,6 +247,12 @@ async def upload_room_keys(
if current_room_key:
if self._should_replace_room_key(current_room_key, room_key):
log_kv({"message": "Replacing room key."})
logger.debug(
"Replacing room key. room=%s session=%s user=%s",
room_id,
session_id,
user_id,
)
# updates are done one at a time in the DB, so send
# updates right away rather than batching them up,
# like we do with the inserts
Expand All @@ -256,6 +262,12 @@ async def upload_room_keys(
changed = True
else:
log_kv({"message": "Not replacing room_key."})
logger.debug(
"Not replacing room key. room=%s session=%s user=%s",
room_id,
session_id,
user_id,
)
else:
log_kv(
{
Expand All @@ -265,6 +277,12 @@ async def upload_room_keys(
}
)
log_kv({"message": "Replacing room key."})
logger.debug(
"Inserting new room key. room=%s session=%s user=%s",
room_id,
session_id,
user_id,
)
to_insert.append((room_id, session_id, room_key))
changed = True

Expand Down

0 comments on commit 48af592

Please sign in to comment.