Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/dekobon/log4j2-bunyan-layout

Bunyan Layout for Log4j2
https://github.com/dekobon/log4j2-bunyan-layout

bunyan layout log4j2 log4j2-layout logging

Last synced: 1 day ago
JSON representation

Bunyan Layout for Log4j2

Host: GitHub
URL: https://github.com/dekobon/log4j2-bunyan-layout
Owner: dekobon
License: apache-2.0
Created: 2021-11-24T15:46:23.000Z (almost 3 years ago)
Default Branch: master
Last Pushed: 2023-04-03T15:45:29.000Z (over 1 year ago)
Last Synced: 2024-04-16T07:51:04.098Z (7 months ago)
Topics: bunyan, layout, log4j2, log4j2-layout, logging
Language: Java
Homepage:
Size: 199 KB
Stars: 0
Watchers: 2
Forks: 0
Open Issues: 0
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

README

# Log4j2 Bunyan Layout
[![Continuous Integration](https://github.com/dekobon/log4j2-bunyan-layout/actions/workflows/ci.yaml/badge.svg)](https://github.com/dekobon/log4j2-bunyan-layout/actions/workflows/ci.yaml)

![Screenshot](docs/screenshot.png)

## Overview

This project provides a custom [Log4j Layout](https://logging.apache.org/log4j/2.x/manual/layouts.html)
that outputs structured logs in the [Bunyan JSON](https://github.com/trentm/node-bunyan)
format. Similar to Log4j `log4j2-bunyan-layout` aims to
[minimize object creation and thereby garbage collection](https://logging.apache.org/log4j/2.x/manual/garbagefree.html). Additionally, `log4j2-bunyan-layout` uses the
[DSL-JSON library](https://github.com/ngs-doo/dsl-json) for fast JSON
serialization.

## Configuration

Add a dependency definition to your Maven pom.xml:
```xml

...

org.apache.logging.log4j
log4j-core
2.16.0

com.github.dekobon
log4j2-bunyan-layout
1.0.3

```

Edit your log4j2 configuration such that you have added it as a layout to your
appender. For example, a minimal configuration would look like:
```xml

```

A more robust configuration may look like:

```xml
...

...
```

The layout has the following properties.

### `BunyanJsonLayout`
* `appName` (required) - string to use as application name in bunyan log messages.
* `endOfLine` - string to append to the end of each JSON object (default: (Unix new line) `\n`).
This property accepts Java style escaped values such as: `\n`, `\r`, `\t`, `\0`.
If there are octals, unicode, or any sort of non-trivial escapes in
this value, Java 15+ must be used or the Apache Commons Text library must be
loaded.
* `maxMessageLength` - size in characters to truncate log messages to (default: `32768`).
* `properties` - flag when set to true enables the output of *all* [context properties](https://logging.apache.org/log4j/2.x/manual/thread-context.html) (default: `false`).

### `ThrowableFormat` (Optional element - only a single element is valid)
* `format` - pattern in which to format exception (throwable) stack traces that
are associated with a log event. If `format` is specified `depth` may not be
specified. Format can be set to any of the following values:
* `none` - no stacktrace is output.
* `full` - the full stacktrace is output (default).
* `extended` - outputs the full stacktrace including the location of where
the class was loaded from and the version of the jar if available.
* `short` - outputs the first line of the Throwable.
* `short.className` - outputs the name of the class where the exception occurred.
* `short.methodName` - outputs the method name where the exception occurred.
* `short.lineNumber` - outputs the line number where the exception occurred.
* `short.fileName` - outputs the name of the file where the exception occurred.
* `short.message` - outputs only the message.
* `short.localizedMessage` - outputs the localized message.
* `depth` - number of lines of the stack trace to output. If `depth` is
specified `format` may not be specified.
* `ignorePackages` - a comma delimited list of Java packages to suppress
matching stack frames from stack traces.

### `KeyValuePair` (Optional element - many elements may be defined)
* `key` - String indicating the name of the value to be output as an additional
log attribute.
* `value` - A string constant to output as an additional log attribute, or
alternatively a dynamic value defined using
[Log4j2's lookup syntax](https://logging.apache.org/log4j/2.x/manual/lookups.html).

## License

This project is licensed under the [Apache License v2 license](./LICENSE).