Skip to content

Commit 51f5fcb

Browse files
committed
Update readme
1 parent c5a39a9 commit 51f5fcb

File tree

1 file changed

+12
-12
lines changed

1 file changed

+12
-12
lines changed

README.md

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
11
# avaje-simple-logger
22

3-
A SLF4J Logger built primarily for use with GraalVM Native image that writes JSON structured logs to `System.out`.
4-
It is designed to be used by applications that will be run in **K8s** or **Lambda**.
3+
A SLF4J Logger built primarily for use with GraalVM Native image that writes JSON structured logs to `System.out`.
4+
It is designed to be used by applications that will be run in **K8s** or **Lambda**.
55

66

77
## Background
88

9-
This logger has been created from the Logback JSON Encoder from [avaje-logback-encoder](https://github.com/avaje/avaje-logback-encoder),
9+
This logger has been created from the Logback JSON Encoder from [avaje-logback-encoder](https://github.com/avaje/avaje-logback-encoder),
1010
and turned into a SLF4J Logger, thus removing the dependency on Logback and its associated XML configuration.
1111

1212

@@ -18,7 +18,7 @@ and turned into a SLF4J Logger, thus removing the dependency on Logback and its
1818
<dependency>
1919
<groupId>io.avaje</groupId>
2020
<artifactId>avaje-simple-logger</artifactId>
21-
<version>0.1</version>
21+
<version>0.2</version>
2222
</dependency>
2323
```
2424

@@ -36,14 +36,14 @@ log.level.io.avaje=INFO
3636

3737
#### Step 3: `src/test/resources/avaje-logger-test.properties`
3838

39-
For testing, we might desire to log in a plain format rather than JSON format.
39+
For testing, we might desire to log in a plain format rather than JSON format.
4040
We also might want to define some test specific log levels.
4141

4242
Add test specific configuration via `src/test/resources/avaje-logger-test.properties`
4343

4444
```properties
4545
## for testing we desire plain format than json format
46-
logger.writer=plain
46+
logger.format=plain
4747

4848
## default log level to use when running tests
4949
logger.defaultLogLevel=INFO
@@ -57,7 +57,7 @@ log.level.io.ebean.DDL=TRACE
5757

5858
## Configure
5959

60-
Configure the logger via main resource `avaje-logger.properties`
60+
Configure the logger via main resource `avaje-logger.properties`
6161
and test resource `avaje-logger-test.properties`
6262

6363

@@ -66,8 +66,8 @@ and test resource `avaje-logger-test.properties`
6666
logger.defaultLogLevel=warn
6767

6868
## specify to log as `json` or `plain` format (defaults to json)
69-
logger.writer=json
70-
logger.writer=plain
69+
#logger.format=json
70+
logger.format=plain
7171

7272
## specify if the logger name is abbreviated. Values:
7373
## - full - use the full logger name
@@ -95,7 +95,7 @@ logger.timestampPattern=ISO_OFFSET_DATE_TIME
9595
avaje-simple-logger automatically registers with avaje-config such that any configuration changes that
9696
start with `log.level.` are logging level configuration changes, and these are applied.
9797

98-
avaje-config supports plugins like [AWS AppConfig](https://avaje.io/config/#aws-appconfig), where
98+
avaje-config supports plugins like [AWS AppConfig](https://avaje.io/config/#aws-appconfig), where
9999
configuration changes can be dynamically made to the application. For example, `log.level.` changes
100100
can be dynamically made this way.
101101

@@ -109,7 +109,7 @@ This excludes the avaje-config dependency.
109109
<dependency>
110110
<groupId>io.avaje</groupId>
111111
<artifactId>avaje-simple-json-logger</artifactId>
112-
<version>0.1</version>
112+
<version>0.2</version>
113113
</dependency>
114114
```
115115

@@ -122,4 +122,4 @@ nameLevels.put("com.foo.bar", "info");
122122
...
123123
LoggerContext.get().putAll(nameLevels);
124124
```
125-
125+

0 commit comments

Comments
 (0)