From 38611635075215caf869d72ac8cef7c0902c8b49 Mon Sep 17 00:00:00 2001
From: Ivan Matmati <imatmati@haproxy.com>
Date: Mon, 4 Sep 2023 17:47:47 +0200
Subject: [PATCH] DOC: documentation for log-format-tcp

---
 documentation/annotations.md | 21 +++++++++++++++++++++
 documentation/doc.yaml       | 19 +++++++++++++++++++
 2 files changed, 40 insertions(+)

diff --git a/documentation/annotations.md b/documentation/annotations.md
index 2b7fbfd4..7a8395f8 100644
--- a/documentation/annotations.md
+++ b/documentation/annotations.md
@@ -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:|
@@ -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>
 
 ***
diff --git a/documentation/doc.yaml b/documentation/doc.yaml
index 83084ca2..8fbd8278 100644
--- a/documentation/doc.yaml
+++ b/documentation/doc.yaml
@@ -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