The bobbin from infinite-technology

Introduction

Bobbin is a high-performance Slf4j-compatible logger designed for multi-threaded applications (especially those with persistent threads like batch, stream and messaging applications).

Bobbin leverages the concept of Logback/Log4j2 sifting appenders while providing much more easier configuration using native Groovy/Java scripting expressions.

Bobbin is available in JCenter repository.

Maven

❗ Note that there is no <type>pom</type>

Example Maven project with Bobbin

...
<repositories>
    <repository>
        <id>jcenter</id>
        <name>jcenter</name>
        <url>https://jcenter.bintray.com</url>
    </repository>
</repositories>
...
<dependency>
    <groupId>io.i-t</groupId>
    <artifactId>bobbin</artifactId>
    <version>4.1.0</version>
</dependency>
...

Gradle

repositories {
    jcenter()
}
dependencies {
    compile "org.codehaus.groovy:groovy-all:2.5.4"
    compile "io.i-t:bobbin:4.1.0"
}

Sample configurations

Examples of Bobbin.yml for different use cases.

General usage

destinations:
  - name: io.infinite.bobbin.config.ConsoleDestinationConfig
    levels: [warn, error, info]
  - name: io.infinite.bobbin.config.FileDestinationConfig
    packages: [io.infinite]
    fileName: ("./LOGS/INFINITE/${className}/${level}/${className}_${level}_${date}.log")
  - name: io.infinite.bobbin.config.FileDestinationConfig
    fileName: ("./LOGS/PACKAGES/${className}/${level}/${className}_${level}_${date}.log")
    format: dateTime + delimiter + level + delimiter + threadName + delimiter + className + delimiter + message

Spring Boot

Logging Spring Boot HTTP with Bobbin

destinations:
  - name: io.infinite.bobbin.config.ConsoleDestinationConfig
    formatThrowable: "%format% + delimiter + throwable"
    levels: [warn, error, info]
  - name: io.infinite.bobbin.config.FileDestinationConfig
    levels: [warn]
    fileName: ("./LOGS/WARNINGS_${date}.log")
  - name: io.infinite.bobbin.config.FileDestinationConfig
    levels: [error]
    fileName: ("./LOGS/ERRORS_${date}.log")
  - name: io.infinite.bobbin.config.FileDestinationConfig
    packages: [org.springframework.web]
    fileName: ("./LOGS/SPRING_WEB/SPRING_WEB_${date}.log")

Logstash

Pass named parameters to Logstash without using MDC (using positioned logging arguments indexes instead).

levels: [info, warn, error, debug]
destinations:
  - name: io.infinite.bobbin.config.ConsoleDestinationConfig
    packages: [com.acme.logstash]
    dateTimeFormat: "yyyy-MM-dd'T'HH:mm:ss:SSSZ"
    lineBreak: ",\r\n"
    formatArgs: |-
      """{
        "@timestamp": "$dateTime",
        "@version": "1",
        "message": "$message",
        "logger_name": "$className",
        "thread_name": "$threadName",
        "level": "$level",
        "username": "${args[0]}",
        "URI": "${args[1]}",
        "sessionId": "${args[2]}",
        "transactionId": "${args[3]}",
        "instanceId": "${MDC.get('instanceUUID')}"
      }"""

MDC and log formatting

Use MDC and change formatting of individual logging signatures - like formatThrowable in this case.

%format% placeholder helps to reuse the base formatting (which itself can be also redefined using format parameter).

format: dateTime + delimiter + MDC.get("instanceUUID") + delimiter + level + delimiter + threadName + delimiter + className + delimiter + message
destinations:
  - name: io.infinite.bobbin.config.ConsoleDestinationConfig
    formatThrowable: "%format% + delimiter + throwable"
    levels: [warn, error, info]
  - name: io.infinite.bobbin.config.FileDestinationConfig
    levels: [warn]
    fileName: ("./LOGS/WARNINGS_${date}.log")
  - name: io.infinite.bobbin.config.FileDestinationConfig
    levels: [error]
    fileName: ("./LOGS/ERRORS_${date}.log")
  - name: io.infinite.bobbin.config.FileDestinationConfig
    packages: [org.springframework.web]
    fileName: ("./LOGS/SPRING_WEB/SPRING_WEB_${date}.log")
  - name: io.infinite.bobbin.config.FileDestinationConfig
    packages: [io.infinite]
    fileName: ("./LOGS/THREADS/${threadGroupName}/${threadName}/${threadName}_${date}.log")
  - name: io.infinite.bobbin.config.FileDestinationConfig
    packages: [conf.plugins.output]
    fileName: ("./LOGS/PLUGINS/OUTPUT/${className}/${className}_${date}.log")
  - name: io.infinite.bobbin.config.FileDestinationConfig
    packages: [conf.plugins.input]
    fileName: ("./LOGS/PLUGINS/INPUT/${className}/${className}_${date}.log")

Bug: SLF4J 1.8+ (recent) versions support

The problem:

If we add some dependency with a transitive dependency to "org.slf4j:slf4j-api:1.8.0" and more recent, the Bobbin does not work

Expected behavior:

Logs


Bobbin          : main: Application working dir: /Users/%username%/Desktop/%project%
Bobbin          : main: Searching for Bobbin.yml in: ./Bobbin.yml (full path: /Users/%username%/Desktop/%project%/Bobbin.yml)
Bobbin          : main: Found: /Users/%username%/Desktop/%project%/Bobbin.yml

Actual behavior:

Logs


SLF4J: No SLF4J providers were found.
SLF4J: Defaulting to no-operation (NOP) logger implementation
SLF4J: See http://www.slf4j.org/codes.html#noProviders for further details.
SLF4J: Class path contains SLF4J bindings targeting slf4j-api versions prior to 1.8.
SLF4J: Ignoring binding found at [jar:file:/Users/%username%/Desktop/%project%/%project%/build/distributions/%project%-1.0.1/lib/bobbin-4.1.0.jar!/org/slf4j/impl/StaticLoggerBinder.class]
SLF4J: See http://www.slf4j.org/codes.html#ignoredBindings for an explanation.

Example Gradle configuration:

build.gradle


def kotlin_version = '1.3.71'
def groovy_version = '2.5.4'
def bobbin_version = '4.1.0'
def textio_version = '3.4.1'
dependencies {
    implementation     "org.jetbrains.kotlin:kotlin-stdlib-jdk8:$kotlin_version"
    implementation     "org.jetbrains.kotlin:kotlin-reflect:$kotlin_version"  
    implementation     "org.codehaus.groovy:groovy-all:$groovy_version" 
    implementation     "io.i-t:bobbin:$bobbin_version"  
    // the library below depends on a more recent slf4j artifact  
    implementation     "org.beryx:text-io:$textio_version"  
}

Please, if you have any questions regarding configuration details, leave a comment and I will reply with more information on the problem.

infinite-technology / bobbin Goto Github PK

bobbin's Introduction

Introduction

Maven

Gradle

Sample configurations

General usage

Spring Boot

Logstash

MDC and log formatting

bobbin's People

Contributors

Stargazers

Watchers

Forkers

bobbin's Issues

Recommend Projects

Recommend Topics

Recommend Org