metalog

Metalog

A low-impact, highly performant structured meta-logging library for Java.

Overview

Metalog is a modern logging framework designed for high-performance Java applications. It eliminates unnecessary overhead by generating log messages only when they are consumed, and supports both synchronous and asynchronous processing patterns with fine-grained control over message routing and ordering.

Key Features

Performance-First Design

  1. Lazy Message Generation - Log messages are only generated if consumed by subscribers
  2. Single Generation, Multiple Consumers - Messages generated once, shared across all subscribers
  3. CharSequence-Based - No forced string conversions; work with StringBuilder, String, or custom CharSequence implementations
  4. Asynchronous by Default - Messages consumed on configurable worker threads to minimize impact on application threads

Flexible Routing & Ordering

  1. Channel-Based Routing - Categorize messages using channels like ‘info’, ‘debug’, ‘warn’, ‘error’
  2. Optional Message Sequencing - Use sequencing keys to guarantee ordering with dedicated consumption threads
  3. Synchronous Processing Option - Opt-out of worker threads for immediate processing when needed

Version

Current release: 1.2.3

Project Structure

Quick Start

Simple Usage

// Minimal logging - message generated only if consumed
publish(() -> "Hello World");

Advanced Usage with Meta Information

// Include exception, thread info, and timestamp
publish(() -> {
    StringBuilder builder = new StringBuilder();
    builder.append(e.getMessage());
    builder.append(System.lineSeparator());
    builder.append(someCostlyOperation());
    return builder;
}, 
b -> b  // Meta builder callback
    .thrown(e)    // retain exception
    .thread()     // retain current thread information
    .time());     // retain current time

Method Reference Pattern

// Clean method reference for complex message generation
publish(this::someMethodToProduceTheMessage);

Installation

Add Metalog to your project via Maven Central:

<dependency>
    <groupId>io.github.jonloucks.metalog</groupId>
    <artifactId>metalog</artifactId>
    <version>1.2.3</version>
</dependency>

Or Gradle:

implementation 'io.github.jonloucks.metalog:metalog:1.2.3'

Core Concepts

Publisher

The Publisher interface is responsible for publishing log messages. Use GlobalMetalog for convenient global access or create dedicated Metalog instances.

Subscriber

Implement Subscriber to consume log messages. Subscribers receive both the log message and associated metadata.

Meta

Metadata attached to each log message includes:

Channels

Channels categorize log messages for routing. Common channels include:

Configuration

Metalog supports extensive configuration through Metalog.Config:

Metalog metalog = GlobalMetalog.createMetalog(builder -> builder
    .unkeyedThreadCount(20)           // Worker threads for unkeyed messages
    .keyedQueueLimit(1000)            // Queue limit for keyed messages
    .unkeyedFairness(false)           // FIFO processing for unkeyed messages
    .shutdownTimeout(Duration.ofSeconds(60))  // Graceful shutdown timeout
);

Architecture

Metalog follows a clean separation between API and implementation:

  1. metalog-api - Defines all public interfaces and contracts
  2. metalog-impl - Provides the default implementation using ServiceLoader
  3. Module System - Full Java Platform Module System (JPMS) support

The library uses dependency injection through the Contracts API for flexible component replacement and testing.

Documentation and Reports

Badges

OpenSSF Best Practices Coverage Badge Javadoc Badge

Building from Source

Metalog uses Gradle for building:

# Build and run all tests
./gradlew build

# Run tests with coverage
./gradlew test jacocoTestReport

# Publish to local Maven repository
./gradlew publishToMavenLocal

# Generate Javadoc
./gradlew javadoc

Contributing

Contributions are welcome! Please see:

Security

For security concerns, please see SECURITY.md.

License

See LICENSE file for details.

Release Notes

Release notes are available in the notes/ directory:

Requirements

This site is open source. Improve this page.