From 35cf52f7c6ab09335e31a02d377fd18989caa842 Mon Sep 17 00:00:00 2001
From: "mergify[bot]" <37929162+mergify[bot]@users.noreply.github.com>
Date: Thu, 23 Dec 2021 15:18:55 +0100
Subject: [PATCH] Follow up changes in documentation after #28927 (#29501)
 (#29576)
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

* Follow up changes in the docs for logging
* add reference configuration

(cherry picked from commit 391a948ec15e55735367429bec81c22c539a444a)

Co-authored-by: Noémi Ványi <kvch@users.noreply.github.com>
---
 auditbeat/auditbeat.reference.yml                   | 3 ++-
 filebeat/filebeat.reference.yml                     | 3 ++-
 heartbeat/heartbeat.reference.yml                   | 3 ++-
 libbeat/_meta/config/output-file.reference.yml.tmpl | 4 ++--
 libbeat/outputs/fileout/docs/fileout.asciidoc       | 3 ++-
 metricbeat/metricbeat.reference.yml                 | 3 ++-
 packetbeat/packetbeat.reference.yml                 | 3 ++-
 winlogbeat/winlogbeat.reference.yml                 | 3 ++-
 x-pack/auditbeat/auditbeat.reference.yml            | 3 ++-
 x-pack/filebeat/filebeat.reference.yml              | 3 ++-
 x-pack/heartbeat/heartbeat.reference.yml            | 3 ++-
 x-pack/metricbeat/metricbeat.reference.yml          | 3 ++-
 x-pack/packetbeat/packetbeat.reference.yml          | 3 ++-
 x-pack/winlogbeat/winlogbeat.reference.yml          | 3 ++-
 14 files changed, 28 insertions(+), 15 deletions(-)

diff --git a/auditbeat/auditbeat.reference.yml b/auditbeat/auditbeat.reference.yml
index 544cd80ade25..27be08dd194b 100644
--- a/auditbeat/auditbeat.reference.yml
+++ b/auditbeat/auditbeat.reference.yml
@@ -1057,7 +1057,7 @@ output.elasticsearch:
   #path: "/tmp/auditbeat"
 
   # Name of the generated files. The default is `auditbeat` and it generates
-  # files: `auditbeat`, `auditbeat.1`, `auditbeat.2`, etc.
+  # files: `auditbeat-{datetime}.ndjson`, `auditbeat-{datetime}-1.ndjson`, etc.
   #filename: auditbeat
 
   # Maximum size in kilobytes of each file. When this size is reached, and on
@@ -1075,6 +1075,7 @@ output.elasticsearch:
   
   # Configure automatic file rotation on every startup. The default is true.
   #rotate_on_startup: true
+
 # ------------------------------- Console Output -------------------------------
 #output.console:
   # Boolean flag to enable or disable the output module.
diff --git a/filebeat/filebeat.reference.yml b/filebeat/filebeat.reference.yml
index b63760c63dd4..912a8f9bcb62 100644
--- a/filebeat/filebeat.reference.yml
+++ b/filebeat/filebeat.reference.yml
@@ -1990,7 +1990,7 @@ output.elasticsearch:
   #path: "/tmp/filebeat"
 
   # Name of the generated files. The default is `filebeat` and it generates
-  # files: `filebeat`, `filebeat.1`, `filebeat.2`, etc.
+  # files: `filebeat-{datetime}.ndjson`, `filebeat-{datetime}-1.ndjson`, etc.
   #filename: filebeat
 
   # Maximum size in kilobytes of each file. When this size is reached, and on
@@ -2008,6 +2008,7 @@ output.elasticsearch:
   
   # Configure automatic file rotation on every startup. The default is true.
   #rotate_on_startup: true
+
 # ------------------------------- Console Output -------------------------------
 #output.console:
   # Boolean flag to enable or disable the output module.
diff --git a/heartbeat/heartbeat.reference.yml b/heartbeat/heartbeat.reference.yml
index 76dcc7758b9e..aca74cd9e636 100644
--- a/heartbeat/heartbeat.reference.yml
+++ b/heartbeat/heartbeat.reference.yml
@@ -1203,7 +1203,7 @@ output.elasticsearch:
   #path: "/tmp/heartbeat"
 
   # Name of the generated files. The default is `heartbeat` and it generates
-  # files: `heartbeat`, `heartbeat.1`, `heartbeat.2`, etc.
+  # files: `heartbeat-{datetime}.ndjson`, `heartbeat-{datetime}-1.ndjson`, etc.
   #filename: heartbeat
 
   # Maximum size in kilobytes of each file. When this size is reached, and on
@@ -1221,6 +1221,7 @@ output.elasticsearch:
   
   # Configure automatic file rotation on every startup. The default is true.
   #rotate_on_startup: true
+
 # ------------------------------- Console Output -------------------------------
 #output.console:
   # Boolean flag to enable or disable the output module.
diff --git a/libbeat/_meta/config/output-file.reference.yml.tmpl b/libbeat/_meta/config/output-file.reference.yml.tmpl
index 7f7ff9998b33..665b8f3a7c13 100644
--- a/libbeat/_meta/config/output-file.reference.yml.tmpl
+++ b/libbeat/_meta/config/output-file.reference.yml.tmpl
@@ -16,7 +16,7 @@
   #path: "/tmp/{{.BeatName}}"
 
   # Name of the generated files. The default is `{{.BeatName}}` and it generates
-  # files: `{{.BeatName}}`, `{{.BeatName}}.1`, `{{.BeatName}}.2`, etc.
+  # files: `{{.BeatName}}-{datetime}.ndjson`, `{{.BeatName}}-{datetime}-1.ndjson`, etc.
   #filename: {{.BeatName}}
 
   # Maximum size in kilobytes of each file. When this size is reached, and on
@@ -33,4 +33,4 @@
   #permissions: 0600
   
   # Configure automatic file rotation on every startup. The default is true.
-  #rotate_on_startup: true
\ No newline at end of file
+  #rotate_on_startup: true
diff --git a/libbeat/outputs/fileout/docs/fileout.asciidoc b/libbeat/outputs/fileout/docs/fileout.asciidoc
index a0979f92ef56..f4dc7c5f95db 100644
--- a/libbeat/outputs/fileout/docs/fileout.asciidoc
+++ b/libbeat/outputs/fileout/docs/fileout.asciidoc
@@ -45,7 +45,8 @@ mandatory.
 ===== `filename`
 
 The name of the generated files. The default is set to the Beat name. For example, the files
-generated by default for {beatname_uc} would be "{beatname_lc}", "{beatname_lc}.1", "{beatname_lc}.2", and so on.
+generated by default for {beatname_uc} would be "{beatname_lc}-{{datetime}}.ndjson", "{beatname_lc}-{{datetime}}-1.ndjson",
+"{beatname_lc}-{{datetime}}-2.ndjson", and so on.
 
 ===== `rotate_every_kb`
 
diff --git a/metricbeat/metricbeat.reference.yml b/metricbeat/metricbeat.reference.yml
index 81a0535ba362..1e4f204b2e89 100644
--- a/metricbeat/metricbeat.reference.yml
+++ b/metricbeat/metricbeat.reference.yml
@@ -1892,7 +1892,7 @@ output.elasticsearch:
   #path: "/tmp/metricbeat"
 
   # Name of the generated files. The default is `metricbeat` and it generates
-  # files: `metricbeat`, `metricbeat.1`, `metricbeat.2`, etc.
+  # files: `metricbeat-{datetime}.ndjson`, `metricbeat-{datetime}-1.ndjson`, etc.
   #filename: metricbeat
 
   # Maximum size in kilobytes of each file. When this size is reached, and on
@@ -1910,6 +1910,7 @@ output.elasticsearch:
   
   # Configure automatic file rotation on every startup. The default is true.
   #rotate_on_startup: true
+
 # ------------------------------- Console Output -------------------------------
 #output.console:
   # Boolean flag to enable or disable the output module.
diff --git a/packetbeat/packetbeat.reference.yml b/packetbeat/packetbeat.reference.yml
index 3d9d0f604bf7..739fe5c53324 100644
--- a/packetbeat/packetbeat.reference.yml
+++ b/packetbeat/packetbeat.reference.yml
@@ -1552,7 +1552,7 @@ output.elasticsearch:
   #path: "/tmp/packetbeat"
 
   # Name of the generated files. The default is `packetbeat` and it generates
-  # files: `packetbeat`, `packetbeat.1`, `packetbeat.2`, etc.
+  # files: `packetbeat-{datetime}.ndjson`, `packetbeat-{datetime}-1.ndjson`, etc.
   #filename: packetbeat
 
   # Maximum size in kilobytes of each file. When this size is reached, and on
@@ -1570,6 +1570,7 @@ output.elasticsearch:
   
   # Configure automatic file rotation on every startup. The default is true.
   #rotate_on_startup: true
+
 # ------------------------------- Console Output -------------------------------
 #output.console:
   # Boolean flag to enable or disable the output module.
diff --git a/winlogbeat/winlogbeat.reference.yml b/winlogbeat/winlogbeat.reference.yml
index 11a5ac82351c..51ca51897f8f 100644
--- a/winlogbeat/winlogbeat.reference.yml
+++ b/winlogbeat/winlogbeat.reference.yml
@@ -988,7 +988,7 @@ output.elasticsearch:
   #path: "/tmp/winlogbeat"
 
   # Name of the generated files. The default is `winlogbeat` and it generates
-  # files: `winlogbeat`, `winlogbeat.1`, `winlogbeat.2`, etc.
+  # files: `winlogbeat-{datetime}.ndjson`, `winlogbeat-{datetime}-1.ndjson`, etc.
   #filename: winlogbeat
 
   # Maximum size in kilobytes of each file. When this size is reached, and on
@@ -1006,6 +1006,7 @@ output.elasticsearch:
   
   # Configure automatic file rotation on every startup. The default is true.
   #rotate_on_startup: true
+
 # ------------------------------- Console Output -------------------------------
 #output.console:
   # Boolean flag to enable or disable the output module.
diff --git a/x-pack/auditbeat/auditbeat.reference.yml b/x-pack/auditbeat/auditbeat.reference.yml
index 5219627ac63c..b058641150cf 100644
--- a/x-pack/auditbeat/auditbeat.reference.yml
+++ b/x-pack/auditbeat/auditbeat.reference.yml
@@ -1113,7 +1113,7 @@ output.elasticsearch:
   #path: "/tmp/auditbeat"
 
   # Name of the generated files. The default is `auditbeat` and it generates
-  # files: `auditbeat`, `auditbeat.1`, `auditbeat.2`, etc.
+  # files: `auditbeat-{datetime}.ndjson`, `auditbeat-{datetime}-1.ndjson`, etc.
   #filename: auditbeat
 
   # Maximum size in kilobytes of each file. When this size is reached, and on
@@ -1131,6 +1131,7 @@ output.elasticsearch:
   
   # Configure automatic file rotation on every startup. The default is true.
   #rotate_on_startup: true
+
 # ------------------------------- Console Output -------------------------------
 #output.console:
   # Boolean flag to enable or disable the output module.
diff --git a/x-pack/filebeat/filebeat.reference.yml b/x-pack/filebeat/filebeat.reference.yml
index 796d69340463..e65e6990c620 100644
--- a/x-pack/filebeat/filebeat.reference.yml
+++ b/x-pack/filebeat/filebeat.reference.yml
@@ -4220,7 +4220,7 @@ output.elasticsearch:
   #path: "/tmp/filebeat"
 
   # Name of the generated files. The default is `filebeat` and it generates
-  # files: `filebeat`, `filebeat.1`, `filebeat.2`, etc.
+  # files: `filebeat-{datetime}.ndjson`, `filebeat-{datetime}-1.ndjson`, etc.
   #filename: filebeat
 
   # Maximum size in kilobytes of each file. When this size is reached, and on
@@ -4238,6 +4238,7 @@ output.elasticsearch:
   
   # Configure automatic file rotation on every startup. The default is true.
   #rotate_on_startup: true
+
 # ------------------------------- Console Output -------------------------------
 #output.console:
   # Boolean flag to enable or disable the output module.
diff --git a/x-pack/heartbeat/heartbeat.reference.yml b/x-pack/heartbeat/heartbeat.reference.yml
index 76dcc7758b9e..aca74cd9e636 100644
--- a/x-pack/heartbeat/heartbeat.reference.yml
+++ b/x-pack/heartbeat/heartbeat.reference.yml
@@ -1203,7 +1203,7 @@ output.elasticsearch:
   #path: "/tmp/heartbeat"
 
   # Name of the generated files. The default is `heartbeat` and it generates
-  # files: `heartbeat`, `heartbeat.1`, `heartbeat.2`, etc.
+  # files: `heartbeat-{datetime}.ndjson`, `heartbeat-{datetime}-1.ndjson`, etc.
   #filename: heartbeat
 
   # Maximum size in kilobytes of each file. When this size is reached, and on
@@ -1221,6 +1221,7 @@ output.elasticsearch:
   
   # Configure automatic file rotation on every startup. The default is true.
   #rotate_on_startup: true
+
 # ------------------------------- Console Output -------------------------------
 #output.console:
   # Boolean flag to enable or disable the output module.
diff --git a/x-pack/metricbeat/metricbeat.reference.yml b/x-pack/metricbeat/metricbeat.reference.yml
index 8bc82f2379a7..f848b8d40925 100644
--- a/x-pack/metricbeat/metricbeat.reference.yml
+++ b/x-pack/metricbeat/metricbeat.reference.yml
@@ -2413,7 +2413,7 @@ output.elasticsearch:
   #path: "/tmp/metricbeat"
 
   # Name of the generated files. The default is `metricbeat` and it generates
-  # files: `metricbeat`, `metricbeat.1`, `metricbeat.2`, etc.
+  # files: `metricbeat-{datetime}.ndjson`, `metricbeat-{datetime}-1.ndjson`, etc.
   #filename: metricbeat
 
   # Maximum size in kilobytes of each file. When this size is reached, and on
@@ -2431,6 +2431,7 @@ output.elasticsearch:
   
   # Configure automatic file rotation on every startup. The default is true.
   #rotate_on_startup: true
+
 # ------------------------------- Console Output -------------------------------
 #output.console:
   # Boolean flag to enable or disable the output module.
diff --git a/x-pack/packetbeat/packetbeat.reference.yml b/x-pack/packetbeat/packetbeat.reference.yml
index 3d9d0f604bf7..739fe5c53324 100644
--- a/x-pack/packetbeat/packetbeat.reference.yml
+++ b/x-pack/packetbeat/packetbeat.reference.yml
@@ -1552,7 +1552,7 @@ output.elasticsearch:
   #path: "/tmp/packetbeat"
 
   # Name of the generated files. The default is `packetbeat` and it generates
-  # files: `packetbeat`, `packetbeat.1`, `packetbeat.2`, etc.
+  # files: `packetbeat-{datetime}.ndjson`, `packetbeat-{datetime}-1.ndjson`, etc.
   #filename: packetbeat
 
   # Maximum size in kilobytes of each file. When this size is reached, and on
@@ -1570,6 +1570,7 @@ output.elasticsearch:
   
   # Configure automatic file rotation on every startup. The default is true.
   #rotate_on_startup: true
+
 # ------------------------------- Console Output -------------------------------
 #output.console:
   # Boolean flag to enable or disable the output module.
diff --git a/x-pack/winlogbeat/winlogbeat.reference.yml b/x-pack/winlogbeat/winlogbeat.reference.yml
index 940cd6125a02..d74e971638a3 100644
--- a/x-pack/winlogbeat/winlogbeat.reference.yml
+++ b/x-pack/winlogbeat/winlogbeat.reference.yml
@@ -1031,7 +1031,7 @@ output.elasticsearch:
   #path: "/tmp/winlogbeat"
 
   # Name of the generated files. The default is `winlogbeat` and it generates
-  # files: `winlogbeat`, `winlogbeat.1`, `winlogbeat.2`, etc.
+  # files: `winlogbeat-{datetime}.ndjson`, `winlogbeat-{datetime}-1.ndjson`, etc.
   #filename: winlogbeat
 
   # Maximum size in kilobytes of each file. When this size is reached, and on
@@ -1049,6 +1049,7 @@ output.elasticsearch:
   
   # Configure automatic file rotation on every startup. The default is true.
   #rotate_on_startup: true
+
 # ------------------------------- Console Output -------------------------------
 #output.console:
   # Boolean flag to enable or disable the output module.