Skip to content

Commit 7f359d9

Browse files
committed
docs: Explain sanitization in Audit log
1 parent 8e0947e commit 7f359d9

File tree

1 file changed

+10
-2
lines changed

1 file changed

+10
-2
lines changed

docs/pages/product/workspace/audit-log.mdx

Lines changed: 10 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -45,11 +45,19 @@ Audit Log displays events in a table with the following information for each eve
4545

4646
You can click on any event to view extended information:
4747
- IP address from which an event was initiated.
48-
- Event-specific attributes with sensitive information (e.g., passwords and tokens)
49-
sanitized.
48+
- Event-specific attributes.
5049

5150
<Screenshot src="https://ucarecdn.com/43f0d225-0cde-40dd-867b-8705f3ee0ff2/" />
5251

52+
#### Sanitization
53+
54+
Audit Log uses heuristics to detect sensitive values (e.g., passwords and tokens)
55+
and sanitize them, i.e., replace them with `[HIDDEN]` in event-specific
56+
attributes. You can see that a password was sanitized on the screenshot above.
57+
58+
If you'd like your custom environment variable to be sanitized, include one of
59+
the following substrings in its name: `PASS`, `SECRET`, `TOKEN`, `KEY`.
60+
5361
### Filters
5462

5563
You can also customize the table view with filters on the top and in the right sidebar:

0 commit comments

Comments
 (0)