From 6d4ab8fb90ae2eaa3393dcbd37c83c486202b347 Mon Sep 17 00:00:00 2001 From: DMRobertson Date: Tue, 27 Sep 2022 12:50:14 +0000 Subject: deploy: 3853011d01ad3f5034f53a9dfb7a06e36cf70ae9 --- latest/usage/administration/request_log.html | 4 ++-- latest/usage/configuration/config_documentation.html | 18 ++++++++++++++---- 2 files changed, 16 insertions(+), 6 deletions(-) (limited to 'latest/usage') diff --git a/latest/usage/administration/request_log.html b/latest/usage/administration/request_log.html index 2b8b1ebef1..3bcb164ae6 100644 --- a/latest/usage/administration/request_log.html +++ b/latest/usage/administration/request_log.html @@ -153,14 +153,14 @@ -AAAAAAAAAAAAAAAAAAAAA- -BBBBBBBBBBBBBBBBBBBBBB- -C- -DD- -EEEEEE- -FFFFFFFFF- -GG- -HHHHHHHHHHHHHHHHHHHHHHH- -IIIIII- -JJJJJJJ- -KKKKKK-, -LLLLLL- -MMMMMMM- -NNNNNN- O -P- -QQ- -RRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRR- -SSSSSSSSSSSS- -TTTTTT- - + - + diff --git a/latest/usage/configuration/config_documentation.html b/latest/usage/configuration/config_documentation.html index b2efcc4050..8db17f9cec 100644 --- a/latest/usage/configuration/config_documentation.html +++ b/latest/usage/configuration/config_documentation.html @@ -488,7 +488,16 @@ configuration.

  • x_forwarded: Only valid for an 'http' listener. Set to true to use the X-Forwarded-For header as the client IP. Useful when Synapse is -behind a reverse-proxy.

    +behind a reverse-proxy.

    +
    • +
  • +

    request_id_header: The header extracted from each incoming request that is +used as the basis for the request ID. The request ID is used in +logs and tracing to +correlate and match up requests. When unset, Synapse will automatically +generate sequential request IDs. This option is useful when Synapse is behind +a reverse-proxy.

    +

    Added in Synapse 1.68.0.

  • resources: Only valid for an 'http' listener. A list of resources to host @@ -1008,8 +1017,9 @@ on this homeserver.

    Options related to caching.

    event_cache_size

    -

    The number of events to cache in memory. Not affected by -caches.global_factor and is not part of the caches section. Defaults to 10K.

    +

    The number of events to cache in memory. Defaults to 10K. Like other caches, +this is affected by caches.global_factor (see below).

    +

    Note that this option is not part of the caches section.

    Example configuration:

    event_cache_size: 15K
    @@ -1314,7 +1324,7 @@ client is attempting to log into. Defaults to per_second: 0.17, burst_count: 3.

  • -

    failted_attempts ratelimits login requests based on the account the +

    failed_attempts ratelimits login requests based on the account the client is attempting to log into, based on the amount of failed login attempts for this account. Defaults to per_second: 0.17, burst_count: 3.

    • -- cgit 1.5.1
    PartExplanation
    AAAATimestamp request was logged (not recieved)
    AAAATimestamp request was logged (not received)
    BBBBLogger name (synapse.access.(http\|https).<tag>, where 'tag' is defined in the listeners config section, normally the port)
    CCCCLine number in code
    DDDDLog Level
    EEEERequest Identifier (This identifier is shared by related log lines)
    FFFFSource IP (Or X-Forwarded-For if enabled)
    GGGGServer Port
    HHHHFederated Server or Local User making request (blank if unauthenticated or not supplied)
    HHHHFederated Server or Local User making request (blank if unauthenticated or not supplied).
    If this is of the form `@aaa:example.com
    IIIITotal Time to process the request
    JJJJTime to send response over network once generated (this may be negative if the socket is closed before the response is generated)
    KKKKUserland CPU time