OpenCloud
/
MatrixSynapse
mirror of https://github.com/matrix-org/synapse
1
0
Fork 0
Code Issues Releases Wiki Activity

Update request log format documentation to mention the format used when the authenticated user is controlling another user. (#13794)

dmr/try-black-cache
reivilibre 2022-09-16 11:48:41 +00:00 committed by GitHub
parent b73cbb8215
commit f7a77ad717
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 3 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
changelog.d/13794.doc Normal file
View File

@ -0,0 +1 @@
Update request log format documentation to mention the format used when the authenticated user is controlling another user.

4
docs/usage/administration/request_log.md
View File

@ -12,14 +12,14 @@ See the following for how to decode the dense data available from the default lo
| Part | Explanation | | 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) | | 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 | | CCCC | Line number in code |
| DDDD | Log Level | | DDDD | Log Level |
| EEEE | Request Identifier (This identifier is shared by related log lines)| | EEEE | Request Identifier (This identifier is shared by related log lines)|
| FFFF | Source IP (Or X-Forwarded-For if enabled) | | FFFF | Source IP (Or X-Forwarded-For if enabled) |
| GGGG | Server Port | | 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 | | 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)| | 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 | | KKKK | Userland CPU time |