https://github.com/backtrace-labs/backtrace-log4j
https://github.com/backtrace-labs/backtrace-log4j
Last synced: 7 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/backtrace-labs/backtrace-log4j
- Owner: backtrace-labs
- License: mit
- Created: 2020-02-12T23:12:16.000Z (almost 6 years ago)
- Default Branch: master
- Last Pushed: 2023-07-06T21:34:51.000Z (over 2 years ago)
- Last Synced: 2025-04-22T23:14:53.771Z (9 months ago)
- Language: Java
- Size: 109 KB
- Stars: 3
- Watchers: 11
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# This library is currently in early access
# Backtrace Log4j support
[Backtrace](http://backtrace.io/) provides support for log4j by providing a special appender that can be connected to any application to send logged information also to the Backtrace dashboard. BacktraceAppender sends also MDC properties and using offline database for error report storage and re-submission in case of network outage.
# Installation via Gradle or Maven
* Gradle
```
dependencies {
implementation 'com.github.backtrace-labs.backtrace-log4j:backtrace-log4j:0.9.7'
}
```
* Maven
```
com.github.backtrace-labs.backtrace-log4j
backtrace-log4j
0.9.7
```
# Configuration
In order to configure the BacktraceAppender, it is mandatory to set the `submissionUrl` parameter or two parameters such as `endpointUrl` and `submissionToken`. Other parameters are optional.
### Example basic configuration using the log4j.properties
```
log4j.rootLogger=CONSOLE, backtrace
log4j.appender.CONSOLE=org.apache.log4j.ConsoleAppender
log4j.appender.CONSOLE.layout=org.apache.log4j.PatternLayout
log4j.appender.CONSOLE.layout.ConversionPattern=%-4r [%t] %-5p %c %x - %m%n
log4j.appender.backtrace=BacktraceAppender
log4j.appender.backtrace.threshold=ERROR
log4j.appender.backtrace.endpointUrl=https://.sp.backtrace.io:6098/
log4j.appender.backtrace.submissionToken=
```
### Optional parameters:
- `threshold` - minimum threshold of what kind of messages are to be sent, eg. `DEBUG`, `WARN`, `ERROR`
- `appVersion` - string value which represents your's application version
- `appName` - string value which represents your's application name
- `allThreads` - boolean value, default `true` (also if this parameter is not specified) the library will gather information about all threads. If `false` library will gather only information from thread in which caused exception
- `enableUncaughtExceptionHandler` - boolean value, if `true` library will catch all uncaught exceptions and send to server
- `useDatabase` - boolean value, default `true` (also if this parameter is not specified) the library will store unsent messages in files, if `false` library will not be using any files to store reports
- `maxDatabaseSize` - maximum database size in bytes, by default size is unlimited
- `maxDatabaseRecordCount` - number of times library will try to send the error report again if sending will finished with fail
- `maxDatabaseRetryLimit` - maximum number of messages in database. If a limit is set, the oldest error reports will be deleted if there will be try to exceed the limit
# Waiting
By default Backtrace is sending all messages asynchronously and doesn't block main thread. You can wait until all currently messages will be sent with executing method `await`. Optionally as a parameter to `await` method you can pass the maximum time you want to wait for that.
```java
BacktraceAppender backtrace = (BacktraceAppender) Logger.getRootLogger().getAppender("backtrace");
backtrace.await();
```
# Closing
To make sure that all resources allocated by the library are released, call the `close` method. This method will send the currently processed message and then free all resources. Below you can find example how to do it.
```java
BacktraceAppender backtrace = (BacktraceAppender) Logger.getRootLogger().getAppender("backtrace");
backtrace.close();
```
# Debugging library
If you want to disable all logs which comes from this library add to `log4j.properties` file following line.
```java
log4j.logger.backtrace.io=OFF
```
You can also set the level with which you want to receive logs from this library, eg. ERROR, INFORM or DEBUG.
```java
log4j.logger.backtrace.io=ERROR
```