PII Configuration

The following document explores the syntax and semantics of PII configs for Relay. To get started with PII configs, it’s recommended to use Piinguin and refer back to this document when needed.

A basic example

Say you have an exception message which, unfortunately, contains IP addresses which are not supposed to be there. You’d write:

{
  "applications": {
    "text": ["@ip:replace"]
  }
}

It reads as “apply rule @ip:replace to all text fields.

Rules

The following rules exist by default:

  • @ip:replace and @ip:hash for pattern-matching IP addresses
  • @imei:replace and @imei:hash for pattern-matching IMEIs
  • @mac:replace, @mac:mask and @mac:hash for pattern-matching MAC addresses
  • @email:mask, @email:replace and @email:hash for pattern-matching email addresses
  • @creditcard:mask, @creditcard:replace and @creditcard:hash for pattern-matching creditcard numbers
  • @userpath:replace and @userpath:hash for pattern-matching local paths (e.g. C:/Users/foo/)
  • @password:remove for pattern matching passwords. In this case we’re pattern matching against the field’s key, whether it contains password, credentials or similar strings.

Writing your own rules

Rules generally consist of two parts:

Each page comes with examples. Try those examples out by pasting them into the “PII config” column of Piinguin and clicking on fields to get suggestions.