{,x-pack}/packetbeat: fix documentation for flows period (#35009)

elastic · Jun 1, 2023 · 99928a3 · 99928a3
1 parent 8fd3d45
commit 99928a3
Show file tree

Hide file tree

Showing 8 changed files with 8 additions and 8 deletions.
diff --git a/CHANGELOG.next.asciidoc b/CHANGELOG.next.asciidoc
@@ -174,7 +174,7 @@ automatic splitting at root level, if root level element is an array. {pull}3415
 
 *Packetbeat*
 
-
+- Fix documentation for `flows.period` related to flow reporting. {pull}35009[35009]
 
 *Winlogbeat*
 

diff --git a/packetbeat/_meta/config/beat.reference.yml.tmpl b/packetbeat/_meta/config/beat.reference.yml.tmpl
@@ -71,7 +71,7 @@ packetbeat.flows:
   # timed out.
   timeout: 30s
 
-  # Configure reporting period. If set to -1, only killed flows will be reported
+  # Configure reporting period. If set to -1s, only killed flows will be reported
   period: 10s
 
   # Set to true to publish fields with null values in events.

diff --git a/packetbeat/_meta/config/beat.yml.tmpl b/packetbeat/_meta/config/beat.yml.tmpl
@@ -52,7 +52,7 @@ packetbeat.flows:
   # timed out.
   timeout: 30s
 
-  # Configure reporting period. If set to -1, only killed flows will be reported
+  # Configure reporting period. If set to -1s, only killed flows will be reported
   period: 10s
 
 {{header "Transaction protocols"}}

diff --git a/packetbeat/packetbeat.reference.yml b/packetbeat/packetbeat.reference.yml
@@ -69,7 +69,7 @@ packetbeat.flows:
   # timed out.
   timeout: 30s
 
-  # Configure reporting period. If set to -1, only killed flows will be reported
+  # Configure reporting period. If set to -1s, only killed flows will be reported
   period: 10s
 
   # Set to true to publish fields with null values in events.

diff --git a/packetbeat/packetbeat.yml b/packetbeat/packetbeat.yml
@@ -50,7 +50,7 @@ packetbeat.flows:
   # timed out.
   timeout: 30s
 
-  # Configure reporting period. If set to -1, only killed flows will be reported
+  # Configure reporting period. If set to -1s, only killed flows will be reported
   period: 10s
 
 # =========================== Transaction protocols ============================

diff --git a/packetbeat/tests/system/config/packetbeat.yml.j2 b/packetbeat/tests/system/config/packetbeat.yml.j2
@@ -24,7 +24,7 @@ packetbeat.interfaces.bpf_filter: {{ bpf_filter }}
 # timed out.
 packetbeat.flows.timeout: 2s
 
-# Configure reporting period. If set to -1, only killed flows will be reported
+# Configure reporting period. If set to -1s, only killed flows will be reported
 packetbeat.flows.period: -1s
 {% endif %}
 

diff --git a/x-pack/packetbeat/packetbeat.reference.yml b/x-pack/packetbeat/packetbeat.reference.yml
@@ -69,7 +69,7 @@ packetbeat.flows:
   # timed out.
   timeout: 30s
 
-  # Configure reporting period. If set to -1, only killed flows will be reported
+  # Configure reporting period. If set to -1s, only killed flows will be reported
   period: 10s
 
   # Set to true to publish fields with null values in events.

diff --git a/x-pack/packetbeat/packetbeat.yml b/x-pack/packetbeat/packetbeat.yml
@@ -50,7 +50,7 @@ packetbeat.flows:
   # timed out.
   timeout: 30s
 
-  # Configure reporting period. If set to -1, only killed flows will be reported
+  # Configure reporting period. If set to -1s, only killed flows will be reported
   period: 10s
 
 # =========================== Transaction protocols ============================