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

…5086) (cherry picked from commit d043a69) Co-authored-by: Dan Kortschak <90160302+efd6@users.noreply.github.com>
elastic · Apr 14, 2023 · fe0da65 · fe0da65
1 parent 109f79a
commit fe0da65
Show file tree

Hide file tree

Showing 8 changed files with 8 additions and 7 deletions.
diff --git a/CHANGELOG.next.asciidoc b/CHANGELOG.next.asciidoc
@@ -53,6 +53,7 @@ https://github.com/elastic/beats/compare/v7.0.0-alpha2...master[Check the HEAD d
 *Packetbeat*
 
 - Handle truncated DNS records more gracefully. {issue}21495[21495] {pull}28297[28297]
+- 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
@@ -67,7 +67,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
@@ -31,7 +31,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
@@ -67,7 +67,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
@@ -31,7 +31,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
@@ -22,7 +22,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
@@ -67,7 +67,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
@@ -31,7 +31,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 ============================