Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/jahnelgroup/flogger
Flogger is an AspectJ library that provides the ability to easily add information to your logging framwork's MDC.
https://github.com/jahnelgroup/flogger
annotations aspectj-library java mdc spring-boot
Last synced: about 1 month ago
JSON representation
Flogger is an AspectJ library that provides the ability to easily add information to your logging framwork's MDC.
- Host: GitHub
- URL: https://github.com/jahnelgroup/flogger
- Owner: JahnelGroup
- License: mit
- Created: 2018-05-01T17:45:16.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2023-12-05T22:18:05.000Z (12 months ago)
- Last Synced: 2024-10-11T07:22:46.939Z (about 1 month ago)
- Topics: annotations, aspectj-library, java, mdc, spring-boot
- Language: Java
- Homepage:
- Size: 146 KB
- Stars: 3
- Watchers: 4
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Flogger
[](https://travis-ci.org/JahnelGroup/flogger)
> Whip your logs into shape!
Flogger is an AspectJ library that provides the ability to easily add information to the MDC.
## Table of Contents
- [Install](#install)
- [Usage](#usage)
- [License](#license)
## Install
### Spring Boot
Adding Flogger to a Spring Boot project is as simple as adding a dependency to `flogger-spring-boot`.
```
com.jahnelgroup.flogger
flogger-spring-boot
2.0.0
```
### Java 8
Flogger can also be used in plain Java projects using the `aspectj-maven-plugin`.
`flogger-sample` is an example project showing how to set it up.
## Usage
To add method parameters to the MDC, annotate them with `@BindParam`.
To add the return value of a method to the MDC, annotate the method with `@BindReturn`.
The key in the MDC can be customized by the `value` field on both annotations.
### Expansion
You can expand an object before it gets added to the MDC by setting `expand=true` in the annotations.
This will add the object's field values and method return values (only methods that take 0 parameters)
to the MDC instead of calling `.toString()` on the object.
By default, every field and method on the object will be added to the MDC. This can be customized similar
to Lombok's `@EqualsAndHashCode`.
To exclude a field/method, annotate it with `@BindExpand.Exclude`.
You can specify exactly which fields/methods are to be added to the MDC by annotating the object's class with
`@BindExpand(onlyExplicityIncluded=true)` and then each method/field you wish to add with `@BindExpand.Include`.
The key in the MDC for expanded fields/methods can be customized by the `value` field on `@BindExpand.Include`.
#### Example
```
public class Expanded {
private String field = "field"
private String method() {
return "method";
}
public String toString() {
return "expanded.toString()";
}
}
...
public void method(@BindParam(expand=?) Expanded expanded) {...}
```
When `expand=false` the MDC contains :
```
{expanded=expanded.toString()}
```
When `expand=true` the MDC contains:
```
{field=field, method=method, toString=expanded.toString()}
```
## License
[MIT © Jahnel Group](LICENSE)