Browse Source

Add `tag` to `listeners` documentation (#14803)

* Add `tag` to `listeners` documentation

* newsfile
tags/v1.76.0rc1
Dirk Klimpel 1 year ago
committed by GitHub
parent
commit
bc7ca704dd
No known key found for this signature in database GPG Key ID: 4AEE18F83AFDEB23
3 changed files with 7 additions and 2 deletions
  1. +1
    -0
      changelog.d/14803.doc
  2. +2
    -2
      docs/usage/administration/request_log.md
  3. +4
    -0
      docs/usage/configuration/config_documentation.md

+ 1
- 0
changelog.d/14803.doc View File

@@ -0,0 +1 @@
Add missing documentation for `tag` to `listeners` section.

+ 2
- 2
docs/usage/administration/request_log.md View File

@@ -10,10 +10,10 @@ 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 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`](../configuration/config_documentation.md#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)|


+ 4
- 0
docs/usage/configuration/config_documentation.md View File

@@ -422,6 +422,10 @@ Sub-options for each listener include:

* `port`: the TCP port to bind to.

* `tag`: An alias for the port in the logger name. If set the tag is logged instead
of the port. Default to `None`, is optional and only valid for listener with `type: http`.
See the docs [request log format](../administration/request_log.md).

* `bind_addresses`: a list of local addresses to listen on. The default is
'all local interfaces'.



Loading…
Cancel
Save