Skip to content

Commit d218a1c

Browse files
authored
Revise README for clarity and add path module section
Updated wording for clarity and added a section on request/response path module.
1 parent e058b83 commit d218a1c

File tree

1 file changed

+4
-3
lines changed

1 file changed

+4
-3
lines changed

README.md

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ Features:
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. No external dependencies are necessary.
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 required.
3030

3131
Bugs, feature suggestions and help requests can be filed with the [issue-tracker].
3232

@@ -201,6 +201,9 @@ The resulting metrics could be logged as metadata alongside the JSON payload or
201201
* Measuring the impact of the filtering, i.e. reduction in data size
202202
* Make sure filters are actually operating as intended
203203

204+
### Request/response path module
205+
See the [path](impl/path) module for help facilitating per-path filters for request/response-logging applications. This to further improve performance.
206+
204207
### Opt-in [Jackson] module
205208
The filters have also been implemented using [Jackson], in an opt-in module.
206209

@@ -216,8 +219,6 @@ This project trades parser/serializer features for performance, and runs multipl
216219

217220
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.
218221

219-
There is also a [path](impl/path) artifact which helps facilitate per-path filters for request/response-logging applications, which should further improve performance.
220-
221222
# See also
222223
See the [xml-log-filter] for corresponding high-performance filtering of XML, and [JsonPath](https://github.com/json-path/JsonPath) for more advanced filtering.
223224

0 commit comments

Comments
 (0)