Add Logs to doc website repo. (#1944)
* Add Logs to doc website repo. Signed-off-by: carolxob <carolxob@amazon.com> * Minor copy edits, added one heading. Signed-off-by: carolxob <carolxob@amazon.com> * Update _data-prepper/logs.md Co-authored-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> * Minor heading changes. Signed-off-by: carolxob <carolxob@amazon.com> * Incorporated doc review edits. Signed-off-by: carolxob <carolxob@amazon.com> * Incorporated technical feedback. Signed-off-by: carolxob <carolxob@amazon.com> * Minor technical feedback incorporated. Signed-off-by: carolxob <carolxob@amazon.com> * Minor phrasing change. Signed-off-by: carolxob <carolxob@amazon.com> * Added comments for editorial. Signed-off-by: carolxob <carolxob@amazon.com> * Incorporated editorial feedkback changes. Signed-off-by: carolxob <carolxob@amazon.com> Signed-off-by: carolxob <carolxob@amazon.com> Co-authored-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com>
This commit is contained in:
parent
96cfdf0952
commit
22bac5fd45
|
@ -0,0 +1,28 @@
|
|||
---
|
||||
layout: default
|
||||
title: Log4j configuration
|
||||
nav_order: 12
|
||||
---
|
||||
|
||||
# Log4j configuration
|
||||
|
||||
This section provides information about configuring Log4j.
|
||||
|
||||
## Logging
|
||||
|
||||
The following describes how Data Prepper performs logging. Data Prepper uses [SLF4J](http://www.slf4j.org/) with a [Log4j 2 binding](http://logging.apache.org/log4j/2.x/log4j-slf4j-impl/).
|
||||
|
||||
For Data Prepper versions 2.0 and later, the Log4j 2 configuration file can be found and edited in `config/log4j2.properties` in the application's home directory. The default properties for Log4j 2 can be found in `log4j2-rolling.properties` in the *shared-config* directory.
|
||||
|
||||
For Data Prepper versions before 2.0, the Log4j 2 configuration file can be overridden by setting the `log4j.configurationFile` system property when running Data Prepper. The default properties for Log4j 2 can be found in `log4j2.properties` in the *shared-config* directory.
|
||||
|
||||
### Example
|
||||
|
||||
When running Data Prepper, the following command can be overridden by setting the system property `-Dlog4j.configurationFile={property_value}`, where `{property_value}` is a path to the Log4j 2 configuration file:
|
||||
|
||||
```
|
||||
java "-Dlog4j.configurationFile=config/custom-log4j2.properties" -jar data-prepper-core-$VERSION.jar pipelines.yaml data-prepper-config.yaml
|
||||
```
|
||||
|
||||
See the [Log4j 2 configuration documentation](https://logging.apache.org/log4j/2.x/manual/configuration.html) for more information about Log4j 2 configuration.
|
||||
|
Loading…
Reference in New Issue