These docs are for v1.0. Click to read the latest docs for v3.0.

optional: scrub data from captured browser URLs

urlSanitizer
optional - function

Use urlSanitizer to scrub sensitive data from browser URLs.

You can redact from the URL and the query string, or remove the URL completely. The modified URL will then be used for all dashboard searches and metrics. Make sure that you return the modified url from the function:

LogRocket.init(YOUR_APP_ID, {
  browser: {
    urlSanitizer: url => {
      let sanitizedUrl = url;

      // redact the path following /ssn/ from the URL
      sanitizedUrl = sanitizedUrl.replace(/\/ssn\/([^\/]*)/i, '/ssn/**redacted**');

      // redact the value of the query parameter secret_key
      sanitizedUrl = sanitizedUrl.replace(/secret_key=([^&]*)/, 'secret_key=**redacted**');

      // make sure you return the sanitized URL string
      return sanitizedUrl;
    },
  },
})