Skip to content

Commit 744c239

Browse files
kohendNivLipetz
andauthored
Apply suggestions from code review
Co-Authored-By: Niv Lipetz <niv.lipetz@gmail.com>
1 parent 618e28b commit 744c239

File tree

1 file changed

+5
-5
lines changed

1 file changed

+5
-5
lines changed

README.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -19,15 +19,15 @@ Install with gem:
1919
## Setup
2020
In order to setup this plugin, the parameter `fieldsToMaskFilePath` needs to be a valid path to a file containing a list of all the fields to mask. The file should have a unique field on each line. These fields **are** case-sensitive (`Name` != `name`).
2121

22-
In addition, there's a new optional parameter called `fieldsToExcludeJSONPaths` it contains a comma separated list for JSON fields which include optional excluded fields (with dot notation for nesting).
22+
In addition, there's an optional parameter called `fieldsToExcludeJSONPaths` which receives as input a comma separated string of JSON fields that should be excluded in the masking procedure. Nested JSON fields are supported by `dot notation` (i.e: `path.to.excluded.field.in.record.nestedExcludedField`)
2323
The JSON fields are comma separated as well.
24-
This can be used for things like registration services or audit log entries which do not need to be masked.
24+
This can be used for logs of registration services or audit log entries which do not need to be masked.
2525
This is configured as shown below:
2626
```
2727
<filter "**">
2828
@type masking
2929
fieldsToMaskFilePath "/path/to/fields-to-mask-file"
30-
fieldsToExcludeJSONPaths "excludeMaskFields,exclude.excludeMaskFields"
30+
fieldsToExcludeJSONPaths "excludedField,exclude.path.nestedExcludedField"
3131
</filter>
3232
```
3333

@@ -56,7 +56,7 @@ phone
5656
<filter "**">
5757
@type masking
5858
fieldsToMaskFilePath "/path/to/fields-to-mask-file"
59-
fieldsToExcludeJSONPaths "excludeMaskFields,exclude.excludeMaskFields"
59+
fieldsToExcludeJSONPaths "excludedField,exclude.path.nestedExcludedField"
6060
</filter>
6161
6262
<match "**">
@@ -96,4 +96,4 @@ echo '{ :body => "{\"first_name\":\"mickey\", \"type\":\"puggle\", \"last_name\"
9696
9797
```
9898
2019-12-01 14:25:53.385681000 +0300 maskme: {"message":"{ :body => \"{\\\"first_name\\\":\\\"mickey\\\", \\\"type\\\":\\\"puggle\\\", \\\"last_name\\\":\\\"*******\\\", \\\"password\\\":\\\"*******\\\"}\"}"}
99-
```
99+
```

0 commit comments

Comments
 (0)