Sanitization

Sanitization protects sensitive data (passwords, secret keys, etc.) from leakage.

You should always sanitize the log so no personal tokens and/or keys are leaked.

If you don't use sanitization, the request and response logs will not be available in the console.

With correct sanitization

Example of a log from the console with a sanitized access token

...
"log": {
        "sanitize": ["request.headers.accesstoken"]
    }
...

Accesstoken is correctly mapped, so it's not exposed.

Without sanitization

Output from the Scenario Debugger

Without sanitization, there isn't a log in the list of executions in Live Stream.

Additionally there will be no shown log in the Scenario Debugger, as shown in the screenshot above.

Neither the developer nor user can see the original request and respond to debug possible issues.

With incorrect sanitization

Example of a log from the console with an exposed access token

...
"log": {
        "sanitize": ["request.headers.token"]
    }
...

Notice, the accesstoken was mistaken for token. Therefore the accesstoken was exposed in the log.