How scanning works
Scanning happens in the ingest path, before storage:- Your agent sends logs. Log events arrive at the Atatus ingest endpoint as usual.
- Scanning groups decide what gets scanned. Each group can narrow the traffic with a filter query. Groups are evaluated in the order you arrange them.
- Rules look for matches. Every rule in the group runs its regular expression against the event, optionally checking for nearby keywords to cut down on false positives.
- The match action is applied. A matched value is hashed, redacted, partially redacted, or left alone, depending on the rule.
- Tags are attached. The event is tagged with the rule’s
sensitive_dataandsensitive_data_categorytags, so you can search for it later without ever seeing the original value. - The event is stored. Only the masked version is written.
Key concepts
What you can scan
The Sensitive Data Classifier currently scans Logs, covering log messages and their attributes.Support for scanning APM spans and API analytics is planned. This page will be updated when those products are available.
- 100% scans every event in the group.
- Sample scans a percentage of events, between 10% and 90%. Useful while you are tuning a new rule and want to limit the impact.
- None leaves Logs out of the group, so the group scans nothing.
Match actions
Every rule ends in one of four actions:Where to find it
The Sensitive Data Classifier lives under Security in the Atatus dashboard.Next steps
- Set Up the Sensitive Data Classifier walks through your first scanning group end to end.
- Scanning Groups covers filters, sampling, and group order.
- Scanning Rules covers patterns, keywords, and match actions.
- Library Rules lists every built-in rule.
- Custom Rules shows how to write your own patterns.
- Investigate Sensitive Data shows how to search and alert on what was found.