Skip to content

Commit ed1a6c2

Browse files
committed
Adjust readme, benchmark results
1 parent 93e6054 commit ed1a6c2

File tree

4 files changed

+18973
-11
lines changed

4 files changed

+18973
-11
lines changed

README.md

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -20,13 +20,13 @@ High-performance filtering of to-be-logged JSON. Reads, filters and writes JSON
2020

2121
Features:
2222

23-
* Mask single values or whole subtrees
24-
* Remove single values or whole subtrees
25-
* Limit String value size
23+
* Anonymize single values or whole subtrees
24+
* Remove whole subtrees
25+
* Limit text value size
2626
* Limit document size (skip end of document when max size is reached)
2727
* Remove whitespace
2828

29-
The library contains multiple filter implementations as to accommodate combinations of the above features with as little overhead as possible.
29+
The library contains multiple filter implementations as to accommodate combinations of the above features with as little overhead as possible. No external dependencies are necessary, except for the opt-in [Jackson] module (see below).
3030

3131
The equivalent filters are also implemented using [Jackson]:
3232

@@ -41,7 +41,7 @@ Bugs, feature suggestions and help requests can be filed with the [issue-tracker
4141
[Apache 2.0]
4242

4343
## Obtain
44-
The project is built with [Maven] and is available on the central Maven repository. No external dependencies are necessary, except for the opt-in Jackson module.
44+
The project is built with [Maven] and is available on the central Maven repository.
4545

4646
<details>
4747
<summary>Maven coordinates</summary>
@@ -111,7 +111,7 @@ Use a `DefaultJsonLogFilterBuilder` or `JacksonJsonLogFilterBuilder` to configur
111111
```java
112112
JsonFilter filter = DefaultJsonLogFilterBuilder.createInstance()
113113
.withMaxStringLength(127) // cuts long texts
114-
.withAnonymize("$.customer.email") // inserts ***** for values
114+
.withAnonymize("$.customer.email") // inserts "*" for values
115115
.withPrune("$.customer.account") // removes whole subtree
116116
.withMaxPathMatches(16) // halt anon/prune after a number of hits
117117
.withMaxSize(128*1024)
@@ -131,7 +131,7 @@ Configure max string length for output like
131131
}
132132
```
133133

134-
### Mask (anonymize)
134+
### anonymize (mask)
135135
Configure anonymize for output like
136136

137137
```json
@@ -216,7 +216,7 @@ For a typical, light-weight web service, the overall system performance improvem
216216

217217
Memory use will be at most 8 times the raw JSON byte size; depending on the invoked `JsonFilter` method (some accept `String`, other raw bytes or chars).
218218

219-
See the benchmark results ([JDK 17](https://jmh.morethan.io/?source=https://raw.githubusercontent.com/skjolber/json-log-filter/master/benchmark/jmh/results/jmh-results-4.1.2.jdk17.json&topBar=off)) and the [JMH] module for running detailed benchmarks.
219+
See the benchmark results ([JDK 25](https://jmh.morethan.io/?source=https://raw.githubusercontent.com/skjolber/json-log-filter/master/benchmark/jmh/results/jmh-results-5.0.0.jdk25.json&topBar=off)) and the [JMH] module for running detailed benchmarks.
220220

221221
There is also a [path](impl/path) artifact which helps facilitate per-path filters for request/response-logging applications, which should further improve performance.
222222

@@ -229,7 +229,7 @@ Using SIMD for parsing JSON:
229229

230230
Alternative JSON filters:
231231

232-
* [json-masker](https://github.com/Breus/json-masker) (included in benchmark).
232+
* [json-masker](https://github.com/Breus/json-masker) (included in some of the benchmarks).
233233

234234
[Apache 2.0]: https://www.apache.org/licenses/LICENSE-2.0.html
235235
[issue-tracker]: https://github.com/skjolber/json-log-filter/issues

0 commit comments

Comments
 (0)