Mirrors
/
synapse
mirror of https://github.com/element-hq/synapse.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Add debug logging for when room keys are uploaded, including whether they are replacing other room keys. (#17266) 

Fixes: #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.
This commit is contained in:
reivilibre 2024-06-07 12:01:21 +01:00 committed by GitHub
parent 4a7c58642c
commit 17d6c28285
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
2 changed files with 19 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
changelog.d/17266.misc Normal file
View File

@ -0,0 +1 @@
Add debug logging for when room keys are uploaded, including whether they are replacing other room keys.

18
synapse/handlers/e2e_room_keys.py
View File

@ -247,6 +247,12 @@ class E2eRoomKeysHandler:
if current_room_key: if current_room_key:
if self._should_replace_room_key(current_room_key, room_key): if self._should_replace_room_key(current_room_key, room_key):
log_kv({"message": "Replacing 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 are done one at a time in the DB, so send
# updates right away rather than batching them up, # updates right away rather than batching them up,
# like we do with the inserts # like we do with the inserts
@ -256,6 +262,12 @@ class E2eRoomKeysHandler:
changed = True changed = True
else: else:
log_kv({"message": "Not replacing room_key."}) 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: else:
log_kv( log_kv(
{ {
@ -265,6 +277,12 @@ class E2eRoomKeysHandler:
} }
) )
log_kv({"message": "Replacing room key."}) 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)) to_insert.append((room_id, session_id, room_key))
changed = True changed = True