You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+9-9Lines changed: 9 additions & 9 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -20,13 +20,13 @@ High-performance filtering of to-be-logged JSON. Reads, filters and writes JSON
20
20
21
21
Features:
22
22
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
26
26
* Limit document size (skip end of document when max size is reached)
27
27
* Remove whitespace
28
28
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).
30
30
31
31
The equivalent filters are also implemented using [Jackson]:
32
32
@@ -41,7 +41,7 @@ Bugs, feature suggestions and help requests can be filed with the [issue-tracker
41
41
[Apache 2.0]
42
42
43
43
## 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.
45
45
46
46
<details>
47
47
<summary>Maven coordinates</summary>
@@ -111,7 +111,7 @@ Use a `DefaultJsonLogFilterBuilder` or `JacksonJsonLogFilterBuilder` to configur
.withMaxPathMatches(16) // halt anon/prune after a number of hits
117
117
.withMaxSize(128*1024)
@@ -131,7 +131,7 @@ Configure max string length for output like
131
131
}
132
132
```
133
133
134
-
### Mask (anonymize)
134
+
### anonymize (mask)
135
135
Configure anonymize for output like
136
136
137
137
```json
@@ -216,7 +216,7 @@ For a typical, light-weight web service, the overall system performance improvem
216
216
217
217
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).
218
218
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.
220
220
221
221
There is also a [path](impl/path) artifact which helps facilitate per-path filters for request/response-logging applications, which should further improve performance.
222
222
@@ -229,7 +229,7 @@ Using SIMD for parsing JSON:
229
229
230
230
Alternative JSON filters:
231
231
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).
0 commit comments