Skip to content
This repository was archived by the owner on Apr 26, 2024. It is now read-only.

Commit bc7ca70

Browse files
authored
Add tag to listeners documentation (#14803)
* Add `tag` to `listeners` documentation * newsfile
1 parent 06ab64f commit bc7ca70

File tree

3 files changed

+7
-2
lines changed

3 files changed

+7
-2
lines changed

changelog.d/14803.doc

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
Add missing documentation for `tag` to `listeners` section.

docs/usage/administration/request_log.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,10 +10,10 @@ See the following for how to decode the dense data available from the default lo
1010
```
1111

1212

13-
| Part | Explanation |
13+
| Part | Explanation |
1414
| ----- | ------------ |
1515
| AAAA | Timestamp request was logged (not received) |
16-
| BBBB | Logger name (`synapse.access.(http\|https).<tag>`, where 'tag' is defined in the `listeners` config section, normally the port) |
16+
| 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) |
1717
| CCCC | Line number in code |
1818
| DDDD | Log Level |
1919
| EEEE | Request Identifier (This identifier is shared by related log lines)|

docs/usage/configuration/config_documentation.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -422,6 +422,10 @@ Sub-options for each listener include:
422422

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

425+
* `tag`: An alias for the port in the logger name. If set the tag is logged instead
426+
of the port. Default to `None`, is optional and only valid for listener with `type: http`.
427+
See the docs [request log format](../administration/request_log.md).
428+
425429
* `bind_addresses`: a list of local addresses to listen on. The default is
426430
'all local interfaces'.
427431

0 commit comments

Comments
 (0)