github-mirrors/logstash
1
0
Fork 0
mirror of https://github.com/elastic/logstash.git synced 2025-04-24 14:47:19 -04:00
Code Issues Projects Releases Packages Wiki Activity

Add pipelines.yml and log4j2.properties to list of config files Add anchor to log4j2 topic heading for linking

Browse source 
Fixes #9321
This commit is contained in:
Karen Metts 2018-04-06 11:39:50 -04:00 • committed by karen.metts
parent 8ede70de8c
commit 06f697daec
2 changed files with 18 additions and 12 deletions
Download patch file Download diff file Expand all files Collapse all files

21
docs/static/logging.asciidoc vendored
View file

@ -5,20 +5,21 @@ Logstash emits internal logs during its operation, which are placed in `LS_HOME/
DEB/RPM). The default logging level is `INFO`. Logstash's logging framework is based on DEB/RPM). The default logging level is `INFO`. Logstash's logging framework is based on
http://logging.apache.org/log4j/2.x/[Log4j 2 framework], and much of its functionality is exposed directly to users. http://logging.apache.org/log4j/2.x/[Log4j 2 framework], and much of its functionality is exposed directly to users.
When debugging problems, particularly problems with plugins, it can be helpful to increase the logging level to `DEBUG` When debugging problems, particularly problems with plugins, it can be helpful to increase the logging level to `DEBUG`
to emit more verbose messages. Previously, you could only set a log level that applied to the entire Logstash product. to get more verbose messages. Previously, you could only set a log level that applied to the entire Logstash product.
Starting with 5.0, you can configure logging for a particular subsystem in Logstash. For example, if you are Starting with 5.0, you can configure logging for a particular subsystem in Logstash. For example, if you are
debugging issues with Elasticsearch Output, you can increase log levels just for that component. This way debugging issues with Elasticsearch Output, you can increase log levels just for that component. This way
you can reduce noise due to excessive logging and focus on the problem area effectively. you can reduce noise due to excessive logging and focus on the problem area effectively.
==== Log file location ==== Log file location
You can specify the log file location using `--path.logs` setting. You can specify the log file location using `--path.logs` setting.
[[log4j2]]
==== Log4j 2 Configuration ==== Log4j 2 Configuration
Logstash ships with a `log4j2.properties` file with out-of-the-box settings. You can modify this file directly to change the Logstash ships with a `log4j2.properties` file with out-of-the-box settings. You can modify this file to change the
rotation policy, type, and other https://logging.apache.org/log4j/2.x/manual/configuration.html#Loggers[log4j2 configuration]. rotation policy, type, and other https://logging.apache.org/log4j/2.x/manual/configuration.html#Loggers[log4j2 configuration].
You must restart Logstash to apply any changes that you make to this file. You must restart Logstash to apply any changes that you make to this file.
==== Slowlog ==== Slowlog
@ -55,15 +56,15 @@ The logs will include the full event and filter configuration that are responsib
==== Logging APIs ==== Logging APIs
You could modify the `log4j2.properties` file and restart your Logstash, but that is both tedious and leads to unnecessary You could modify the `log4j2.properties` file and restart your Logstash, but that is both tedious and leads to unnecessary
downtime. Instead, you can dynamically update logging levels through the logging API. These settings are effective downtime. Instead, you can dynamically update logging levels through the logging API. These settings are effective
immediately and do not need a restart. immediately and do not need a restart.
NOTE: By default, the logging API attempts to bind to `tcp:9600`. If this port is already in use by another Logstash NOTE: By default, the logging API attempts to bind to `tcp:9600`. If this port is already in use by another Logstash
instance, you need to launch Logstash with the `--http.port` flag specified to bind to a different port. See instance, you need to launch Logstash with the `--http.port` flag specified to bind to a different port. See
<<command-line-flags>> for more information. <<command-line-flags>> for more information.
To update logging levels, take the subsystem/module you are interested in and prepend To update logging levels, take the subsystem/module you are interested in and prepend
`logger.` to it. For example: `logger.` to it. For example:
[source,js] [source,js]
@ -75,7 +76,7 @@ curl -XPUT 'localhost:9600/_node/logging?pretty' -H 'Content-Type: application/j
' '
-------------------------------------------------- --------------------------------------------------
While this setting is in effect, Logstash will begin to emit DEBUG-level logs for __all__ the Elasticsearch outputs While this setting is in effect, Logstash emits DEBUG-level logs for __all__ the Elasticsearch outputs
specified in your configuration. Please note this new setting is transient and will not survive a restart. specified in your configuration. Please note this new setting is transient and will not survive a restart.
Persistent changes should be added to `log4j2.properties`. For example: Persistent changes should be added to `log4j2.properties`. For example:

9
docs/static/setting-up-logstash.asciidoc vendored
View file

@ -182,9 +182,14 @@ The settings files are already defined in the Logstash installation. Logstash in
*`logstash.yml`*:: *`logstash.yml`*::
Contains Logstash configuration flags. You can set flags in this file instead of passing the flags at the command Contains Logstash configuration flags. You can set flags in this file instead of passing the flags at the command
line. Any flags that you set at the command line override the corresponding settings in the `logstash.yml` file. See <<logstash-settings-file>> for more info. line. Any flags that you set at the command line override the corresponding settings in the `logstash.yml` file. See <<logstash-settings-file>> for more info.
*`pipelines.yml`*::
Contains the framework and instructions for running multiple pipelines in a single Logstash instance. See <<multiple-pipelines>> for more info.
*`jvm.options`*:: *`jvm.options`*::
Contains JVM configuration flags. Specify each flag on a separate line. You can also use this file to set the locale Contains JVM configuration flags. Use this file to set initial and maximum values for
for Logstash. total heap space. You can also use this file to set the locale for Logstash.
Specify each flag on a separate line. All other settings in this file are
considered expert settings.
*`log4j2.properties`*:: Contains default settings for `log4j 2` library. See <<log4j2>> for more info.
*`startup.options` (Linux)*:: *`startup.options` (Linux)*::
Contains options used by the `system-install` script in `/usr/share/logstash/bin` to build the appropriate startup Contains options used by the `system-install` script in `/usr/share/logstash/bin` to build the appropriate startup
script for your system. When you install the Logstash package, the `system-install` script executes at the end of the script for your system. When you install the Logstash package, the `system-install` script executes at the end of the