mirror of
https://mau.dev/maunium/synapse.git
synced 2024-10-31 19:59:01 +01:00
Add tag
to listeners
documentation (#14803)
* Add `tag` to `listeners` documentation * newsfile
This commit is contained in:
parent
06ab64f201
commit
bc7ca704dd
3 changed files with 7 additions and 2 deletions
1
changelog.d/14803.doc
Normal file
1
changelog.d/14803.doc
Normal file
|
@ -0,0 +1 @@
|
||||||
|
Add missing documentation for `tag` to `listeners` section.
|
|
@ -13,7 +13,7 @@ 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) |
|
| 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 |
|
| 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)|
|
||||||
|
|
|
@ -422,6 +422,10 @@ Sub-options for each listener include:
|
||||||
|
|
||||||
* `port`: the TCP port to bind to.
|
* `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
|
* `bind_addresses`: a list of local addresses to listen on. The default is
|
||||||
'all local interfaces'.
|
'all local interfaces'.
|
||||||
|
|
||||||
|
|
Loading…
Reference in a new issue