Skip to content

Commit

Permalink
Follow up changes in documentation after #28927 (#29501)
Browse files Browse the repository at this point in the history
* Follow up changes in the docs for logging
* add reference configuration

(cherry picked from commit 391a948)
  • Loading branch information
kvch authored and mergify-bot committed Dec 22, 2021
1 parent 1a8bb5d commit 729e166
Show file tree
Hide file tree
Showing 14 changed files with 28 additions and 15 deletions.
3 changes: 2 additions & 1 deletion auditbeat/auditbeat.reference.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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.
Expand Down
3 changes: 2 additions & 1 deletion filebeat/filebeat.reference.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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.
Expand Down
3 changes: 2 additions & 1 deletion heartbeat/heartbeat.reference.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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.
Expand Down
4 changes: 2 additions & 2 deletions libbeat/_meta/config/output-file.reference.yml.tmpl
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -33,4 +33,4 @@
#permissions: 0600

# Configure automatic file rotation on every startup. The default is true.
#rotate_on_startup: true
#rotate_on_startup: true
3 changes: 2 additions & 1 deletion libbeat/outputs/fileout/docs/fileout.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -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`

Expand Down
3 changes: 2 additions & 1 deletion metricbeat/metricbeat.reference.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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.
Expand Down
3 changes: 2 additions & 1 deletion packetbeat/packetbeat.reference.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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.
Expand Down
3 changes: 2 additions & 1 deletion winlogbeat/winlogbeat.reference.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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.
Expand Down
3 changes: 2 additions & 1 deletion x-pack/auditbeat/auditbeat.reference.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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.
Expand Down
3 changes: 2 additions & 1 deletion x-pack/filebeat/filebeat.reference.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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.
Expand Down
3 changes: 2 additions & 1 deletion x-pack/heartbeat/heartbeat.reference.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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.
Expand Down
3 changes: 2 additions & 1 deletion x-pack/metricbeat/metricbeat.reference.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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.
Expand Down
3 changes: 2 additions & 1 deletion x-pack/packetbeat/packetbeat.reference.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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.
Expand Down
3 changes: 2 additions & 1 deletion x-pack/winlogbeat/winlogbeat.reference.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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.
Expand Down

0 comments on commit 729e166

Please sign in to comment.