Overview

Common logging project for Appulse project. It contains all required dependencies as well as colorizing configurations for logging output.

Usage

Just add dependency to your project.

Maven:

<dependencies>
    ...
    <dependency>
        <groupId>io.appulse</groupId>
        <artifactId>logging-java</artifactId>
        <version>1.1.3</version>
    </dependency>
    ...
</dependencies>

Gradle:

compile 'io.appulse:logging-java:1.1.3'

And use it as usual:

import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

public class SomeClass {

  Logger log = LoggerFactory.getLogger(SomeClass.class);

  public void doSomeLog () {
    log.info("info message");
    log.warn("warn message");
    log.error("error message");
  }
}

or, if you use a Lombok Project:

import lombok.extern.slf4j.Slf4j;

@Slf4j
public class SomeClass {

  public void doSomeLog () {
    log.info("info message");
    log.warn("warn message");
    log.error("error message");
  }
}

With default configuration (no logback.xml in classpath at all) it looks like:

You also could to override default logback's configuration, like an example below.

resources/logback.xml:

<?xml version="1.0" encoding="UTF-8"?>

<configuration>
  <property
    name="CONSOLE_LOG_PATTERN"
    value="${CONSOLE_LOG_PATTERN:-%clr(${LOG_LEVEL_PATTERN:-%5p}) %clr([%25.25thread]){faint} %clr(%-40.40logger{39}){cyan} %clr(:){faint} %m%n${LOG_EXCEPTION_CONVERSION_WORD:-%wEx}}"
  />

  <include resource="io/appulse/logging/logback/base.xml"/>
</configuration>

And output will be like:

Development

These instructions will get you a copy of the project up and running on your local machine for development and testing purposes.

Prerequisites

For building the project you need only a Java compiler.

IMPORTANT: the project requires Java version starting from 8

And, of course, you need to clone the project from GitHub:

$> git clone https://github.com/appulse-projects/logging-java
$> cd logging-java

Building

For building routine automation, I am using maven.

To build the project, do the following:

$> mvn clean package
...
[INFO] ------------------------------------------------------------------------
[INFO] BUILD SUCCESS
[INFO] ------------------------------------------------------------------------
[INFO] Total time: 18.447 s
[INFO] Finished at: 2018-01-23T18:36:20+03:00
[INFO] Final Memory: 52M/175M
[INFO] ------------------------------------------------------------------------

Running the tests

To run the project's test, do the following:

$> mvn clean test
...
[INFO] -------------------------------------------------------
[INFO]  T E S T S
[INFO] -------------------------------------------------------
...
[INFO]
[INFO] Results:
[INFO]
[INFO] Tests run: 20, Failures: 0, Errors: 0, Skipped: 0
[INFO]
...

Also, if you do package or install goals, the tests launch automatically.

Deploy

To deploy the project in Maven Central, use the following command:

$> ./mvnw \
    -DskipTests \
    -Dmaven.test.skip=true \
    -Dfindbugs.skip=true \
    -Dpmd.skip=true \
    -Dcheckstyle.skip \
    -Dmaven.javadoc.skip=false \
    --settings .settings.xml \
    deploy -B

It maybe usefull to import gpg's secret keys and ownertrust from somewhere:

$> echo "${GPG_SECRET_KEYS}" | base64 --decode | "${GPG_EXECUTABLE}" --batch --passphrase "${GPG_PASSPHRASE}" --import
...
$> echo "${GPG_OWNERTRUST}" | base64 --decode | "${GPG_EXECUTABLE}" --batch --passphrase "${GPG_PASSPHRASE}" --import-ownertrust
...

Built With

Java - is a systems and applications programming language
Lombok - is a java library that spicing up your java
Junit - is a simple framework to write repeatable tests
AssertJ - AssertJ provides a rich set of assertions, truly helpful error messages, improves test code readability
Maven - is a software project management and comprehension tool

Changelog

To see what has changed in recent versions of the project, see the changelog file.

Contributing

Please read contributing file for details on my code of conduct, and the process for submitting pull requests to me.

Versioning

We use SemVer for versioning. For the versions available, see the tags on this repository.

Authors

Artem Labazin - creator and the main developer

License

This project is licensed under the Apache License 2.0 License - see the license file for details