Be mindful of other logging context filters in 3rd-party code #19068
+37
−4
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
MadLittleMods
changed the title
MadLittleMods
force-pushed
the
madlittlemods/no-mangle-log-records-outside-synapse
branch
from
01d945b to
0256915
Compare
MadLittleMods
commented
Oct 17, 2025
Comment on lines
+638
to
+645
| def safe_set(attr: str, value: Any) -> None: | ||
| """ | ||
| Only write the attribute if it hasn't already been set or we actually have | ||
| a Synapse logcontext (indicating that this log record is relevant to | ||
| Synapse). | ||
| """ | ||
| if context is not SENTINEL_CONTEXT or not hasattr(record, attr): | ||
| setattr(record, attr, value) |
There was a problem hiding this comment.
Is the abstraction worth it? Should I just inline the usage?
Originally, I thought I would have to use it more for all of the request attributes below but turns out we can do a little optimization to avoid it.
There was a problem hiding this comment.
Why not move setting the server_name under the request attribute? Then you'd only have one usage of safe_set, and then it'd be even more clear that it's not necessary.
There was a problem hiding this comment.
I'm not following 🙇
anoadragon453
approved these changes
Oct 30, 2025
Comment on lines
+638
to
+645
| def safe_set(attr: str, value: Any) -> None: | ||
| """ | ||
| Only write the attribute if it hasn't already been set or we actually have | ||
| a Synapse logcontext (indicating that this log record is relevant to | ||
| Synapse). | ||
| """ | ||
| if context is not SENTINEL_CONTEXT or not hasattr(record, attr): | ||
| setattr(record, attr, value) |
There was a problem hiding this comment.
Why not move setting the server_name under the request attribute? Then you'd only have one usage of safe_set, and then it'd be even more clear that it's not necessary.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Be mindful that Synapse can be run alongside other code in the same Python process. We shouldn't overwrite fields on given log record unless we know it's relevant to Synapse.
(no clobber)
Background
As part of Element's plan to support a light form of vhosting (virtual host) (multiple instances of Synapse in the same Python process), we're currently diving into the details and implications of running multiple instances of Synapse in the same Python process.
"Per-tenant logging" tracked internally by https://github.com/element-hq/synapse-small-hosts/issues/48
Pull Request Checklist
EventStoretoEventWorkerStore.".code blocks.