summary refs log tree commit diff
path: root/tests/test_utils
diff options
context:
space:
mode:
authorEric Eastwood <erice@element.io>2023-05-22 13:49:01 -0500
committerGitHub <noreply@github.com>2023-05-22 13:49:01 -0500
commit1903c7e5edccc86f6d28aed33dc2995b43d941b7 (patch)
treede9792335b55e989ed93f4f4e0a572033a9f2b53 /tests/test_utils
parentRemove outdated comment in log config (#15648) (diff)
downloadsynapse-1903c7e5edccc86f6d28aed33dc2995b43d941b7.tar.xz
Remove duplicate timestamp from test logs (`_trial_temp/test.log`) (#15636)
Fix https://github.com/matrix-org/synapse/issues/15618

### Before

```
2023-05-17 22:51:36-0500 [-] 2023-05-17 22:51:36,889 - synapse.server - 338 - INFO - sentinel - Finished setting up.
```

### After

```
2023-05-19 18:16:20-0500 [-] synapse.server - 338 - INFO - sentinel - Finished setting up.
```


### Dev notes

The `Twisted.Logger` controls the `2023-05-19 18:16:20-0500 [-]` prefix, see : [`twisted/twisted` -> `src/twisted/logger/_format.py#L362-L374`](https://github.com/twisted/twisted/blob/34b161e66bc7c9f9efbb95e82c770a863933e498/src/twisted/logger/_format.py#L362-L374)

And we delegate our logs to the Twisted Logger for the tests which puts it in `_trial_temp/test.log`

Diffstat (limited to 'tests/test_utils')
-rw-r--r--tests/test_utils/logging_setup.py7
1 files changed, 3 insertions, 4 deletions
diff --git a/tests/test_utils/logging_setup.py b/tests/test_utils/logging_setup.py
index b522163a34..c37f205ed0 100644
--- a/tests/test_utils/logging_setup.py
+++ b/tests/test_utils/logging_setup.py
@@ -40,10 +40,9 @@ def setup_logging() -> None:
     """
     root_logger = logging.getLogger()
 
-    log_format = (
-        "%(asctime)s - %(name)s - %(lineno)d - "
-        "%(levelname)s - %(request)s - %(message)s"
-    )
+    # We exclude `%(asctime)s` from this format because the Twisted logger adds its own
+    # timestamp
+    log_format = "%(name)s - %(lineno)d - " "%(levelname)s - %(request)s - %(message)s"
 
     handler = ToTwistedHandler()
     formatter = logging.Formatter(log_format)