This project provides multiple appenders for logging frameworks. Currently, only Logback and Log4J are supported but more are planned.
| Appender name | Description |
|---|---|
| DiscordWebhook | Sends log entries via Webhook to a Discord channel |
| DiscordBot | Sends log entries via Bot account to a Discord channel |
| GithubIssue | Creates an issue for exceptions on a Github Repository |
| GithubCommentingIssue | Creates an issue for exceptions on a Github Repository, but tries to prevent duplicated issues |
| GitlabIssue | Creates an issue for exceptions on a Gitlab Repository |
| GitlabCommentingIssue | Creates an issue for exceptions on a Gitlab Repository, but tries to prevent duplicated issues |
| Passthrough | Passes the log event to another appender |
The releases of the Appenders Project are published in the Central repository.
If you prefer pinning your version to a branch or commit instead of version numbers, these are deployed in GitLab.
Branch, Commit & Snapshot Versions
If you want to use branch and commit versions, you need to add new repository to your build configuration.
This only provides information about the repository and the version information. For the actual dependency, please look below at the framework details.
<repository>
<id>appenders-gitlab</id>
<url>https://gitlab.com/api/v4/groups/12234336/-/packages/maven</url>
</repository>repositories {
maven {
url "https://gitlab.com/api/v4/groups/12234336/-/packages/maven"
}
}Snapshot versions get deployed on each push to development.
Click here to see a list of available versions.
Branch versions are deployed every hour if the deployed version is out of date.
They have set the version to <BRANCH_SLUG>-SNAPSHOT.
Click here to see a list of available versions.
Commit versions have set the version to the full commit sha.
Click here to see a list of available versions.
Log4J
<dependency>
<groupId>com.github.taucher2003.appenders</groupId>
<artifactId>log4j</artifactId>
<version>VERSION</version>
<scope>compile</scope>
</dependency>dependencies {
implementation 'com.github.taucher2003.appenders:log4j:VERSION'
}Logback
<dependency>
<groupId>com.github.taucher2003.appenders</groupId>
<artifactId>logback</artifactId>
<version>VERSION</version>
<scope>compile</scope>
</dependency>dependencies {
implementation 'com.github.taucher2003.appenders:logback:VERSION'
}All Implementations
<dependency>
<groupId>com.github.taucher2003.appenders</groupId>
<artifactId>all</artifactId>
<version>VERSION</version>
<scope>compile</scope>
</dependency>dependencies {
implementation 'com.github.taucher2003.appenders:all:VERSION'
}Log4J Discord
You need to create a new appender in your log4j2.xml configuration.
As plugin, you can choose between DiscordBot and DiscordWebhook.
The DiscordBot plugin requires the two settings token and channelId.
The DiscordWebhook plugin however, just requires the url and allows optional threadId, username and avatarUrl settings.
<?xml version="1.0" encoding="UTF-8"?>
<Configuration status="[...]" shutdownHook="[...]" packages="[...]">
<Appenders>
[...] existing appenders
<DiscordWebhook name="DiscordWebhook"
url="[your webhook url]">
<filters>
<MarkerFilter marker="discord-webhook" onMatch="ACCEPT" onMismatch="DENY"/>
</filters>
</DiscordWebhook>
<DiscordBot name="DiscordBot"
token="[your bot token]"
channelId="[your channel id]">
<MarkerFilter marker="discord-bot" onMatch="ACCEPT" onMismatch="DENY"/>
</DiscordBot>
</Appenders>
<Loggers>
<Root level="[...]">
[...] existing loggers
<AppenderRef ref="DiscordWebhook"/>
<AppenderRef ref="DiscordBot"/>
</Root>
</Loggers>
</Configuration>Log4J Github
You need to create a new appender in your log4j2.xml configuration.
As plugin, you can choose between GithubIssue and GithubCommentingIssue.
Both of them require the settings baseUrl, repositoryOwner, repositoryName and accessToken.
baseUrl is the base url of the Github API. For github.com users, this would be https://api.github.com.
repositoryOwner defines the name of the account, which owns the repository. That is either your username or
organization name.
repositoryName sets the name of the repository itself, which will be used to create the issues. The accessToken will
be used for authorization. The issues will be created with the account, where the access token belongs to.
This appender will only log events which have a throwable attached. All log events without a throwable will be dropped by this appender. The log level does not matter.
<?xml version="1.0" encoding="UTF-8"?>
<Configuration status="[...]" shutdownHook="[...]" packages="[...]">
<Appenders>
[...] existing appenders
<GithubIssue name="GithubIssue"
baseUrl="https://api.github.com"
repositoryOwner="Taucher2003"
repositoryName="Appenders"
accessToken="[your access token]"/>
<GithubCommentingIssue name="GithubCommentingIssue"
baseUrl="https://api.github.com"
repositoryOwner="Taucher2003"
repositoryName="Appenders"
accessToken="[your access token]"/>
</Appenders>
<Loggers>
<Root level="[...]">
[...] existing loggers
<AppenderRef ref="GithubIssue"/>
<AppenderRef ref="GithubCommentingIssue"/>
</Root>
</Loggers>
</Configuration>Log4J Gitlab
You need to create a new appender in your log4j2.xml configuration.
As plugin, you can choose between GitlabIssue and GitlabCommentingIssue.
Both of them require the settings baseUrl, repositoryId, accessToken and confidential.
baseUrl is the base url of the GitLab instance. For gitlab.com users, this would be https://gitlab.com.
repositoryId defines the id of the repository, which will be used to create the issues. The accessToken will be used
for authorization. The issues will be created with the account, where the access token belongs to. If confidential is
set to true, the issues will be created as confidential issue, so they are hidden from guest users.
This appender will only log events which have a throwable attached. All log events without a throwable will be dropped by this appender. The log level does not matter.
<?xml version="1.0" encoding="UTF-8"?>
<Configuration status="[...]" shutdownHook="[...]" packages="[...]">
<Appenders>
[...] existing appenders
<GitlabIssue name="GitlabIssue"
baseUrl="https://gitlab.com"
repositoryId="1"
accessToken="[your access token]"
confidential="true"/>
<GitlabCommentingIssue name="GitlabCommentingIssue"
baseUrl="https://gitlab.com"
repositoryId="1"
accessToken="[your access token]"/>
</Appenders>
<Loggers>
<Root level="[...]">
[...] existing loggers
<AppenderRef ref="GitlabIssue"/>
<AppenderRef ref="GitlabCommentingIssue"/>
</Root>
</Loggers>
</Configuration>Logback Discord
You need to create a new appender in your logback.xml configuration.
As class, you can choose between com.github.taucher2003.appenders.logback.discord.LogbackBotAppender
and com.github.taucher2003.appenders.logback.discord.LogbackWebhookAppender.
The BotAppender requires the two settings token and channelId.
The WebhookAppender however, just requires the url and allows optional threadId, username and avatarUrl settings.
Both of them allow shared settings. These are not required and have reasonable default settings.
| Setting name | What it does |
|---|---|
| errorColor | Set the embed color of the error level |
| warnColor | Set the embed color of the warn level |
| infoColor | Set the embed color of the info level |
| debugColor | Set the embed color of the debug level |
| traceColor | Set the embed color of the trace level |
| fallbackColor | Set the embed color for unknown levels |
| flushInterval | Set the interval which is used to regularly flush the buffer |
| flushUnit | Set the TimeUnit name for the sendingInterval. This is required to be a valid enum constant of java.util.concurrent.TimeUnit |
| marker | Add a marker to the list of allowed markers for this logger |
| ignoredMarker | Add a marker, which is ignored |
| level | Add a level which should be logged |
If no values have been set for marker, all log events will be handled by the logger. If at least one marker has been
set, only log events with a marker named like one in the list will be handled and log events without or with other
markers will be dropped by this logger.
Same applies to level and ignoredMarker.
level is used to filter for logging levels and ignoredMarker will set markers, which will be dropped.
<?xml version="1.0" encoding="UTF-8"?>
<configuration debug="false">
[...] existing configuration
<appender name="discord-bot" class="com.github.taucher2003.appenders.logback.discord.LogbackBotAppender">
<token>[your bot token]</token>
<channelId>[your channel id]</channelId>
<level>ERROR</level> <!-- Restrict the logger to ERROR level -->
<ignoredMarker>discord-ignored</ignoredMarker> <!-- Ignore all log events with the "discord-ignored" marker -->
</appender>
<root level="INFO">
[...] other existing appenders
<appender-ref ref="discord-bot"/>
</root>
</configuration>Logback Github
You need to create a new appender in your logback.xml configuration.
As class, you can choose between com.github.taucher2003.appenders.logback.github.LogbackIssueAppender
and com.github.taucher2003.appenders.logback.github.LogbackCommentingIssueAppender.
Both of them require the settings baseUrl, repositoryOwner, repositoryName and accessToken.
baseUrl is the base url of the Github API. For github.com users, this would be https://api.github.com.
repositoryOwner defines the name of the account, which owns the repository. That is either your username or
organization name.
repositoryName sets the name of the repository itself, which will be used to create the issues. The accessToken will
be used for authorization. The issues will be created with the account, where the access token belongs to.
This appender will only log events which have a throwable attached. All log events without a throwable will be dropped by this appender.
If no values have been set for marker, all log events will be handled by the logger. If at least one marker has been
set, only log events with a marker named like one in the list will be handled and log events without or with other
markers will be dropped by this logger.
Same applies to level and ignoredMarker.
level is used to filter for logging levels and ignoredMarker will set markers, which will be dropped.
<?xml version="1.0" encoding="UTF-8"?>
<configuration debug="false">
[...] existing configuration
<appender name="github-issues" class="com.github.taucher2003.appenders.logback.github.LogbackIssueAppender">
<baseUrl>https://api.github.com</baseUrl>
<repositoryOwner>Taucher2003</repositoryOwner>
<repositoryName>Appenders</repositoryName>
<accessToken>[your access token]</accessToken>
</appender>
<root level="INFO">
[...] other existing appenders
<appender-ref ref="github-issues"/>
</root>
</configuration>Logback Gitlab
You need to create a new appender in your logback.xml configuration.
As class, you can choose between com.github.taucher2003.appenders.logback.gitlab.LogbackIssueAppender
and com.github.taucher2003.appenders.logback.gitlab.LogbackCommentingIssueAppender.
Both of them require the settings baseUrl, repositoryId, accessToken and confidential.
baseUrl is the base url of the GitLab instance. For gitlab.com users, this would be https://gitlab.com.
repositoryId defines the id of the repository, which will be used to create the issues. The accessToken will be used
for authorization. The issues will be created with the account, where the access token belongs to. If confidential is
set to true, the issues will be created as confidential issue, so they are hidden from guest users.
This appender will only log events which have a throwable attached. All log events without a throwable will be dropped by this appender.
If no values have been set for marker, all log events will be handled by the logger. If at least one marker has been
set, only log events with a marker named like one in the list will be handled and log events without or with other
markers will be dropped by this logger.
Same applies to level and ignoredMarker.
level is used to filter for logging levels and ignoredMarker will set markers, which will be dropped.
<?xml version="1.0" encoding="UTF-8"?>
<configuration debug="false">
[...] existing configuration
<appender name="gitlab-issues" class="com.github.taucher2003.appenders.logback.gitlab.LogbackIssueAppender">
<baseUrl>https://gitlab.com</baseUrl>
<repositoryId>1</repositoryId>
<accessToken>[your access token]</accessToken>
<confidential>true</confidential>
</appender>
<root level="INFO">
[...] other existing appenders
<appender-ref ref="gitlab-issues"/>
</root>
</configuration>Logback Passthrough
You need to create a new appender in your logback.xml configuration.
As class, you need to use com.github.taucher2003.appenders.logback.log.LogbackPassthroughAppender.
The appender requires the setting targetAppenderName which specifies the name of an appender the events should get passed to.
The target appender needs to be attached to at least one logger to work.
If no values have been set for marker, all log events will be handled by the logger. If at least one marker has been
set, only log events with a marker named like one in the list will be handled and log events without or with other
markers will be dropped by this logger.
Same applies to level and ignoredMarker.
level is used to filter for logging levels and ignoredMarker will set markers, which will be dropped.
<?xml version="1.0" encoding="UTF-8"?>
<configuration debug="false">
[...] existing configuration
<appender name="console" class="ch.qos.logback.core.ConsoleAppender">
[...] existing configuration
</appender>
<appender name="console-passthrough" class="com.github.taucher2003.appenders.logback.log.LogbackPassthroughAppender">
<targetAppenderName>console</targetAppenderName>
<!-- This example will only pass log events with level WARN and ERROR to the console -->
<level>WARN</level>
<level>ERROR</level>
</appender>
<root level="INFO">
[...] other existing appenders
<appender-ref ref="console-passthrough"/>
</root>
<logger name="noop-registration-logger" level="ERROR">
<!-- The appender needs to be registered in at least one logger -->
<!-- otherwise Logback will forget it after configuration time -->
<appender-ref ref="console"/>
</logger>
</configuration>Currently none, feel free to open issues if you found some
Contributions are very welcome. Feel free to open issues, fork the project and create pull requests. Contribution guidelines maybe follow later. Every contribution is valuable, so just don't be a dick.