Skip to content

About

No description, website, or topics provided.

Resources

Security policy

Stars

0 stars

Watchers

0 watching

Forks

Repository files navigation

Log10x Decoder for Java

License Maven Central

Java library and CLI tool for decoding Log10x-encoded log events back to their original form. Log10x losslessly compacts log events by extracting recurring structure into templates and storing only the variable values — this library reverses that process.

Modules

Module Description
log10x-decoder-core Core decoding library — use this as a dependency in your Java applications
log10x-decoder-cli Command-line tool for decoding encoded log files

Installation

Maven

<dependency>
    <groupId>com.log10x</groupId>
    <artifactId>log10x-decoder-core</artifactId>
    <version>1.0.1</version>
</dependency>

Gradle

implementation 'com.log10x:log10x-decoder-core:1.0.1'

Usage

Library

import com.log10x.decode.SingleEventDecoder;
import com.log10x.decode.lexer.TokenizeContext;

String decoded = SingleEventDecoder.decode(
    TokenizeContext.DEFAULT,
    templateHash,
    encodedEvent,
    templatePattern
);

CLI

# Decode a file
log10x-decode -t templates.json -f encoded.log -o decoded.log

# Decode from stdin
cat encoded.log | log10x-decode -t templates.json

Building from Source

Prerequisites

  • Java 8+ (JDK)
  • Gradle 7+

Build

./gradlew build

Build fat JAR (CLI)

./gradlew :log10x-decoder-cli:shadowJar

Build native image (requires GraalVM)

./gradlew :log10x-decoder-cli:nativeImage

Publishing to Maven Central

Releases are published via GitHub Actions, triggered by pushing git tags.

Each module has its own tag suffix and workflow:

Module Tag format Workflow
log10x-decoder-core v{version}-core publish-core.yml
log10x-decoder-cli v{version}-cli publish-cli.yml

The version is extracted from the tag automatically (e.g., tag v1.0.0-core publishes version 1.0.0).

Core must be published before CLI, since the CLI pulls core from Maven Central as a dependency. Wait for core to appear on Maven Central before tagging CLI.

Release steps

# 1. Tag and push core
git tag v1.0.0-core
git push origin v1.0.0-core

# 2. Wait for core to appear on Maven Central (~10-30 min)

# 3. Tag and push CLI
git tag v1.0.0-cli
git push origin v1.0.0-cli

Also Available

Documentation

License

This repository is licensed under the MIT License.

Important: Log10x Product License Required

This repository contains a decoder library for Log10x-encoded events. While the decoder itself is open source, using the 10x Engine to encode events requires a commercial license.

Component License
This repository (decoder library & CLI) MIT (open source)
The 10x Engine Commercial license required

What this means:

  • You can freely use, modify, and distribute this decoder
  • The 10x Engine that generates encoded events requires a paid subscription
  • A valid Log10x license is required to run the 10x Engine

Get Started:

Contributing

Contributions are welcome! Please read our contributing guidelines and submit pull requests to the repository.

Support

For issues and feature requests:

About

No description, website, or topics provided.

Resources

Security policy

Stars

0 stars

Watchers

0 watching

Forks

Releases

Packages

Used by

Contributors

Languages