Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Provide more detail on log levels #4405

Merged
merged 1 commit into from
May 30, 2017
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion filebeat/docs/command-line.asciidoc
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
[[filebeat-command-line]]
[[command-line-options]]
=== Command Line Options

The following command line option is specific to Filebeat.
Expand Down
4 changes: 2 additions & 2 deletions filebeat/docs/getting-started.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ After installing the Elastic Stack, read the following topics to learn how to in
* <<filebeat-starting>>
* <<filebeat-index-pattern>>
* <<filebeat-modules-quickstart>>
* <<filebeat-command-line>>
* <<command-line-options>>
* <<directory-layout>>

[[filebeat-installation]]
Expand Down Expand Up @@ -223,7 +223,7 @@ include::../../libbeat/docs/shared-template-load.asciidoc[]
Start Filebeat by issuing the appropriate command for your platform.

NOTE: If you use an init.d script to start Filebeat on deb or rpm, you can't
specify command line flags (see <<filebeat-command-line>>). To specify flags,
specify command line flags (see <<command-line-options>>). To specify flags,
start Filebeat in the foreground.

*deb:*
Expand Down
2 changes: 1 addition & 1 deletion filebeat/docs/migration.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -298,7 +298,7 @@ options with Logstash Forwarder, make sure that you add your options to the
configuration file. For naming changes, see <<renamed-options>>.

Filebeat does provide command line options that are common to all Beats. For more details about
these options, see <<filebeat-command-line>>.
these options, see <<command-line-options>>.

[[renamed-options]]
[float]
Expand Down
2 changes: 1 addition & 1 deletion heartbeat/docs/command-line.asciidoc
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
[[heartbeat-command-line]]
[[command-line-options]]
=== Command Line Options

Heartbeat does not have any Heartbeat-specific command line options.
Expand Down
4 changes: 2 additions & 2 deletions heartbeat/docs/getting-started.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ install, configure, and run Heartbeat:
* <<heartbeat-configuration>>
* <<heartbeat-template>>
* <<heartbeat-starting>>
* <<heartbeat-command-line>>
* <<command-line-options>>
* <<directory-layout>>


Expand Down Expand Up @@ -234,7 +234,7 @@ include::../../libbeat/docs/shared-template-load.asciidoc[]
Start Heartbeat by issuing the appropriate command for your platform.

NOTE: If you use an init.d script to start Heartbeat on deb or rpm, you can't
specify command line flags (see <<heartbeat-command-line>>). To specify flags,
specify command line flags (see <<command-line-options>>). To specify flags,
start Heartbeat in the foreground.

*deb:*
Expand Down
43 changes: 32 additions & 11 deletions libbeat/docs/loggingconfig.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -15,8 +15,8 @@

The `logging` section of the +{beatname_lc}.yml+ config file contains options
for configuring the Beats logging output. The logging system can write logs to
syslog or rotate log files. If logging is not explicitly configured, file output
is used on Windows systems, and syslog output is used on Linux and OS X.
the syslog or rotate log files. If logging is not explicitly configured, file
output is used on Windows systems, and syslog output is used on Linux and OS X.

[source,yaml]
------------------------------------------------------------------------------
Expand All @@ -29,29 +29,50 @@ logging.files:
keepfiles: 7
------------------------------------------------------------------------------

In addition to the logging system, the logging output configuration can be
modified from the command line.
TIP: In addition to setting logging options in the config file, you can modify
the logging output configuration from the command line. See
<<command-line-options>>.

==== Logging Options

You can specify the following options in the `logging` section of the +{beatname_lc}.yml+ config file:

===== to_syslog

If enabled, sends all logging output to syslog. The default
value is false.
When true, writes all logging output to the syslog.

===== to_files

Writes all logging output to files subject to file rotation. The
default value is true.
When true, writes all logging output to files. The log files are automatically
rotated when the log file size limit is reached.

NOTE: {beatname_uc} only creates a log file if there is logging output. For
example, if you set the log <<level,`level`>> to `error` and there are no errors,
there will be no log file in the directory specified for logs.

[[level]]
===== level

Minimum log level. One of debug, info, warning, error or critical. If debug is
used, but no selectors are configured, the `*` selector will be used.
The default log level is "info".
Minimum log level. One of `debug`, `info`, `warning`, `error`, or `critical`.
The default log level is `info`.

`debug`:: Logs debug messages, including a detailed printout of all events
flushed by the Beat. Also logs informational messages, warnings, errors, and
critical errors. When the log level is `debug`, you can specify a list of
<<selectors,`selectors`>> to display debug messages for specific components.
If no selectors are specified, the `*` selector is used to display debug
messages for all components.

`info`:: Logs informational messages, including the number of events
that are published. Also logs any warnings, errors, or critical errors.

`warning`:: Logs warnings, errors, and critical errors.

`error`:: Logs errors and critical errors.

`critical`:: Logs critical errors only.

[[selectors]]
===== selectors

The list of debugging-only selector tags used by different Beats components. Use `*`
Expand Down
2 changes: 1 addition & 1 deletion packetbeat/docs/command-line.asciidoc
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
[[packetbeat-command]]
[[command-line-options]]
=== Command Line Options

The following command line options are available for Packetbeat. To use these options,
Expand Down
4 changes: 2 additions & 2 deletions packetbeat/docs/gettingstarted.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ After installing the Elastic Stack, read the following topics to learn how to in
* <<packetbeat-template>>
* <<packetbeat-starting>>
* <<packetbeat-sample-dashboards>>
* <<packetbeat-command>>
* <<command-line-options>>
* <<directory-layout>>

[[packetbeat-installation]]
Expand Down Expand Up @@ -259,7 +259,7 @@ include::../../libbeat/docs/shared-template-load.asciidoc[]
Run Packetbeat by issuing the command that is appropriate for your platform.

NOTE: If you use an init.d script to start Packetbeat on deb or rpm, you can't
specify command line flags (see <<packetbeat-command>>). To specify flags,
specify command line flags (see <<command-line-options>>). To specify flags,
start Packetbeat in the foreground.

*deb:*
Expand Down
2 changes: 1 addition & 1 deletion winlogbeat/docs/command-line.asciidoc
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
[[winlogbeat-command-line-options]]
[[command-line-options]]
=== Command Line Options

Winlogbeat does not have any Winlogbeat-specific command line options. Instead,
Expand Down
2 changes: 1 addition & 1 deletion winlogbeat/docs/getting-started.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ After installing the Elastic Stack, read the following topics to learn how to in
* <<winlogbeat-template>>
* <<winlogbeat-starting>>
* <<winlogbeat-sample-dashboards>>
* <<winlogbeat-command-line-options>>
* <<command-line-options>>
* <<directory-layout>>

[[winlogbeat-installation]]
Expand Down