Skip to content

Commit 3861163

Browse files
ivanmatmatioktalz
authored andcommitted
DOC: documentation for log-format-tcp
1 parent 10faae7 commit 3861163

File tree

2 files changed

+40
-0
lines changed

2 files changed

+40
-0
lines changed

documentation/annotations.md

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -45,6 +45,7 @@ This is autogenerated from [doc.yaml](doc.yaml). Description can be found in [ge
4545
| [ingress.class](#ingress-class) | string | | |:white_circle:|:large_blue_circle:|:white_circle:|
4646
| [load-balance](#balance-algorithm) | string | "roundrobin" | |:large_blue_circle:|:large_blue_circle:|:large_blue_circle:|
4747
| [log-format](#log-format) | string | | |:large_blue_circle:|:white_circle:|:white_circle:|
48+
| [log-format-tcp](#log-format) | string | | |:large_blue_circle:|:white_circle:|:white_circle:|
4849
| [logasap](#logging) | [bool](#bool) | "false" | |:large_blue_circle:|:white_circle:|:white_circle:|
4950
| [maxconn](#maximum-concurrent-connections) | number | | |:large_blue_circle:|:white_circle:|:white_circle:|
5051
| [nbthread](#number-of-threads) | number | | |:large_blue_circle:|:white_circle:|:white_circle:|
@@ -935,6 +936,26 @@ Example:
935936
log-format: "%ci:%cp [%tr] %ft %b/%s %TR/%Tw/%Tc/%Tr/%Ta %ST %B %CC %CS %tsc %ac/%fc/%bc/%sc/%rc %sq/%bq %hr %hs \"%HM %[var(txn.base)] %HV\""
936937
```
937938

939+
##### `log-format-tcp`
940+
941+
Sets the log format string to use for TCP traffic.
942+
943+
Available on: `configmap`
944+
945+
:information_source: Default is option tcplog
946+
947+
:information_source: Applies only to TCP configmap defined by command line option --configmap-tcp-services
948+
949+
Possible values:
950+
951+
- Log format string. More information in [HAProxy documentation](https://docs.haproxy.org/2.8/configuration.html#8.2.3)
952+
953+
Example:
954+
955+
```yaml
956+
log-format-tcp: "%{+Q}o %t %s"
957+
```
958+
938959
<p align='right'><a href='#available-annotations'>:arrow_up_small: back to top</a></p>
939960

940961
***

documentation/doc.yaml

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1014,6 +1014,25 @@ annotations:
10141014
[
10151015
'log-format: "%ci:%cp [%tr] %ft %b/%s %TR/%Tw/%Tc/%Tr/%Ta %ST %B %CC %CS %tsc %ac/%fc/%bc/%sc/%rc %sq/%bq %hr %hs \"%HM %[var(txn.base)] %HV\""',
10161016
]
1017+
- title: log-format-tcp
1018+
type: string
1019+
group: log-format
1020+
dependencies: ""
1021+
default: ""
1022+
description:
1023+
- Sets the log format string to use for TCP traffic.
1024+
tip:
1025+
- 'Default is option tcplog'
1026+
- 'Applies only to TCP configmap defined by command line option --configmap-tcp-services'
1027+
values:
1028+
- Log format string. More information in [HAProxy documentation](https://docs.haproxy.org/2.8/configuration.html#8.2.3)
1029+
applies_to:
1030+
- configmap
1031+
version_min: "1.7"
1032+
example:
1033+
[
1034+
'log-format-tcp: "%{+Q}o %t %s"'
1035+
]
10171036
- title: logasap
10181037
type: bool
10191038
group: logging

0 commit comments

Comments
 (0)