summary refs log tree commit diff
diff options
context:
space:
mode:
authorreivilibre <oliverw@matrix.org>2022-09-16 11:48:41 +0000
committerGitHub <noreply@github.com>2022-09-16 11:48:41 +0000
commitf7a77ad7170bfc689a02f9e3212341b8a1402663 (patch)
tree1a0469ca38fbca20713f3bd403945f8cf766bdda
parentAvoid putting rejected events in room state (#13723) (diff)
downloadsynapse-f7a77ad7170bfc689a02f9e3212341b8a1402663.tar.xz
Update request log format documentation to mention the format used when the authenticated user is controlling another user. (#13794)
-rw-r--r--changelog.d/13794.doc1
-rw-r--r--docs/usage/administration/request_log.md4
2 files changed, 3 insertions, 2 deletions
diff --git a/changelog.d/13794.doc b/changelog.d/13794.doc
new file mode 100644
index 0000000000..3272454d2c
--- /dev/null
+++ b/changelog.d/13794.doc
@@ -0,0 +1 @@
+Update request log format documentation to mention the format used when the authenticated user is controlling another user.
\ No newline at end of file
diff --git a/docs/usage/administration/request_log.md b/docs/usage/administration/request_log.md
index adb5f4f5f3..82f5ac7b96 100644
--- a/docs/usage/administration/request_log.md
+++ b/docs/usage/administration/request_log.md
@@ -12,14 +12,14 @@ See the following for how to decode the dense data available from the default lo
 
 | Part  | Explanation | 
 | ----- | ------------ |
-| AAAA  | Timestamp request was logged (not recieved) |
+| AAAA  | Timestamp request was logged (not received) |
 | BBBB  | Logger name (`synapse.access.(http\|https).<tag>`, where 'tag' is defined in the `listeners` config section, normally the port) |
 | CCCC  | Line number in code |
 | DDDD  | Log Level |
 | EEEE  | Request Identifier (This identifier is shared by related log lines)|
 | FFFF  | Source IP (Or X-Forwarded-For if enabled) |
 | GGGG  | Server Port |
-| HHHH  | Federated Server or Local User making request (blank if unauthenticated or not supplied) |
+| HHHH  | Federated Server or Local User making request (blank if unauthenticated or not supplied).<br/>If this is of the form `@aaa:example.com|@bbb:example.com`, then that means that `@aaa:example.com` is authenticated but they are controlling `@bbb:example.com`, e.g. if `aaa` is controlling `bbb` [via the admin API](https://matrix-org.github.io/synapse/latest/admin_api/user_admin_api.html#login-as-a-user). |
 | IIII  | Total Time to process the request |
 | JJJJ  | Time to send response over network once generated (this may be negative if the socket is closed before the response is generated)|
 | KKKK  | Userland CPU time |