Skip to content

Commit abb054e

Browse files
Update README.md
1 parent 24a2521 commit abb054e

File tree

1 file changed

+14
-0
lines changed

1 file changed

+14
-0
lines changed

README.md

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -25,6 +25,20 @@ command:
2525
The JMH benchmark is executed by several parameters that are all defined in the
2626
`com.openelements.logger.api.BenchmarkConstants` class in the `logger-api` module.
2727

28+
## What is tested
29+
30+
Since not all loggers provide the same set of functionalities the `com.openelements.logger.api.Logger` interface contains all features that should be tested. That feature set reflects the features that a modern logging api should provide:
31+
32+
- log messages
33+
- add stack trace (by throwable to message)
34+
- support `{}` placeholders in message
35+
- support markers
36+
- support a context (like MDC or thread context)
37+
- add a timestamp, the current thread and the name of the caller class to the message
38+
- log to file system and/or console
39+
40+
Since some loggers does not provide some of the features a simple implementation is part of the `com.openelements.logger.api.Logger` implementation for that logger lib.
41+
2842
## How to add a new logging library?
2943

3044
To add a new logging library, you need to create a new module that contains the implementation of the logging library.

0 commit comments

Comments
 (0)