Skip to content

Commit

Permalink
DOC: documentation for log-format-tcp
Browse files Browse the repository at this point in the history
  • Loading branch information
ivanmatmati authored and oktalz committed Sep 6, 2023
1 parent 10faae7 commit 3861163
Show file tree
Hide file tree
Showing 2 changed files with 40 additions and 0 deletions.
21 changes: 21 additions & 0 deletions documentation/annotations.md
Original file line number Diff line number Diff line change
Expand Up @@ -45,6 +45,7 @@ This is autogenerated from [doc.yaml](doc.yaml). Description can be found in [ge
| [ingress.class](#ingress-class) | string | | |:white_circle:|:large_blue_circle:|:white_circle:|
| [load-balance](#balance-algorithm) | string | "roundrobin" | |:large_blue_circle:|:large_blue_circle:|:large_blue_circle:|
| [log-format](#log-format) | string | | |:large_blue_circle:|:white_circle:|:white_circle:|
| [log-format-tcp](#log-format) | string | | |:large_blue_circle:|:white_circle:|:white_circle:|
| [logasap](#logging) | [bool](#bool) | "false" | |:large_blue_circle:|:white_circle:|:white_circle:|
| [maxconn](#maximum-concurrent-connections) | number | | |:large_blue_circle:|:white_circle:|:white_circle:|
| [nbthread](#number-of-threads) | number | | |:large_blue_circle:|:white_circle:|:white_circle:|
Expand Down Expand Up @@ -935,6 +936,26 @@ Example:
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\""
```

##### `log-format-tcp`

Sets the log format string to use for TCP traffic.

Available on: `configmap`

:information_source: Default is option tcplog

:information_source: Applies only to TCP configmap defined by command line option --configmap-tcp-services

Possible values:

- Log format string. More information in [HAProxy documentation](https://docs.haproxy.org/2.8/configuration.html#8.2.3)

Example:

```yaml
log-format-tcp: "%{+Q}o %t %s"
```

<p align='right'><a href='#available-annotations'>:arrow_up_small: back to top</a></p>

***
Expand Down
19 changes: 19 additions & 0 deletions documentation/doc.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -1014,6 +1014,25 @@ annotations:
[
'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\""',
]
- title: log-format-tcp
type: string
group: log-format
dependencies: ""
default: ""
description:
- Sets the log format string to use for TCP traffic.
tip:
- 'Default is option tcplog'
- 'Applies only to TCP configmap defined by command line option --configmap-tcp-services'
values:
- Log format string. More information in [HAProxy documentation](https://docs.haproxy.org/2.8/configuration.html#8.2.3)
applies_to:
- configmap
version_min: "1.7"
example:
[
'log-format-tcp: "%{+Q}o %t %s"'
]
- title: logasap
type: bool
group: logging
Expand Down

0 comments on commit 3861163

Please sign in to comment.