From f0d6b2a0f48d18f3a728125e533c2651703c79ab Mon Sep 17 00:00:00 2001
From: Martin Chodur <m.chodur@seznam.cz>
Date: Tue, 31 Aug 2021 16:15:39 +0200
Subject: [PATCH] fix: docs of the eventIdMetadataKey config field

Signed-off-by: Martin Chodur <m.chodur@seznam.cz>
---
 docs/modules/envoy_access_log_server.md | 2 +-
 docs/modules/kafka_ingester.md          | 2 +-
 docs/modules/tailer.md                  | 2 +-
 3 files changed, 3 insertions(+), 3 deletions(-)

diff --git a/docs/modules/envoy_access_log_server.md b/docs/modules/envoy_access_log_server.md
index 98168d0..29880d8 100644
--- a/docs/modules/envoy_access_log_server.md
+++ b/docs/modules/envoy_access_log_server.md
@@ -131,6 +131,6 @@ Please note that some of the keys may not be present	|
 address: ":18090"
 # gracefulShutdownTimeout for the GRPC server. Please note also the existence of 'maximumGracefulShutdownDuration' global config option which is effectively an upper boundary of here-specified timeout value.
 gracefulShutdownTimeout: "5s"
-# eventIdMetadataKey it's value will be used as a unique id for the generated event if present.
+# eventIdMetadataKey its value will be used as a unique id for the generated event if present (hint: use a trace ID if possible).
 eventIdMetadataKey: <string>
 ```
diff --git a/docs/modules/kafka_ingester.md b/docs/modules/kafka_ingester.md
index f876198..a1d784c 100644
--- a/docs/modules/kafka_ingester.md
+++ b/docs/modules/kafka_ingester.md
@@ -28,7 +28,7 @@ retentionTime: <duration>
 # fallbackStartOffset determines from whence the consumer group should begin consuming when it finds a partition without a committed offset.
 # Default: FirstOffset
 fallbackStartOffset: <LastOffset|FirstOffset>
-# eventIdMetadataKey it's value will be used as a unique id for the generated event if present.
+# eventIdMetadataKey its value will be used as a unique id for the generated event if present (hint: use a trace ID if possible).
 eventIdMetadataKey: <string>
 ```
 
diff --git a/docs/modules/tailer.md b/docs/modules/tailer.md
index b3b498e..f13beb1 100644
--- a/docs/modules/tailer.md
+++ b/docs/modules/tailer.md
@@ -35,7 +35,7 @@ positionPersistenceInterval: "2s"
 loglineParseRegexp: '^(?P<ip>[A-Fa-f0-9.:]{4,50}) \S+ \S+ \[(?P<time>.*?)\] "(?P<request>.*?)" (?P<statusCode>\d+) \d+ "(?P<referer>.*?)" uag="(?P<userAgent>[^"]+)" "[^"]+" ua="[^"]+" rt="(?P<requestDuration>\d+(\.\d+)??)".+ignore-slo="(?P<ignoreSloHeader>[^"]*)" slo-domain="(?P<sloDomain>[^"]*)" slo-app="(?P<sloApp>[^"]*)" slo-class="(?P<sloClass>[^"]*)" slo-endpoint="(?P<sloEndpoint>[^"]*)" slo-result="(?P<sloResult>[^"]*)"'    # emptyGroupRE defines RE used to decide whether some of the RE match groups specified in loglineParseRegexp is empty and this its assigned variable should be kept unitialized
 # Value, that will be treated as empty value.
 emptyGroupRE: '^-$'
-# eventIdMetadataKey it's value will be used as a unique id for the generated event if present.
+# eventIdMetadataKey its value will be used as a unique id for the generated event if present (hint: use a trace ID if possible).
 eventIdMetadataKey: <string>
 ```