Mask
  • Dark
    Light

Mask

  • Dark
    Light

Overview

This filter type hides (or masks) specific data, based on the configured regex pattern.

This filter type can be useful to hide sensitive data, specifically phone numbers and credit card numbers. Based on the configured regex pattern, this filter type changes the log lines to hide the matched content.


Review Parameters

Review the following parameters that you can configure in the Edge Delta App:

YAMLDescription

name

Enter a descriptive name for this filter.

When you create a workflow, you will use this label to enter your filter into the workflow.

This parameter is required. 

Review the following example:

mask_email

type

Select (or enter) mask.

This parameter is required. 

Review the following example:

type: mask

predefined_pattern

Instead of a custom pattern, you can use a common, predefined pattern, specifically credit_card and us_phone_dash.

You must configure the pattern parameter or the predefined_pattern parameter.

This parameter is optional. 

Review the following example:

predefined_pattern: credit_card

pattern

Enter a regular expression pattern to define which strings to match for.

You must configure the pattern parameter or the predefined_pattern parameter.

This parameter is optional. 

Review the following example:

pattern: 'email:\s*(?P<email>\w+)

mask

Enter the string to be used as the replacement for the matched part of the log. The default mask is ******. If you specify an empty mask ( "" ), then the filter will remove the matched pattern from the log.

This parameter is optional. 

Review the following example:

mask: 'XXXXX'

mask_captured

This parameter supports capture groups for regex masks. In other words, you can replace any match of a capture group with a given map.

To replace all matches (not submatch), you can use the all keyword.

This parameter is optional. 

Review the following example:

mask_captured:
  email: '******'

Review Sample Configuration

The following example displays a filter that replaces password: SOME_PASSWORD with password: ****** :

  - name: mask_password
    type: mask
    pattern: "password:\s*\w+"
    mask: "password: ******"

  - name: mask_email
    type: mask
    pattern: "email:\s*(?P<email>\w+)"
    mask_captured:
      email: '******'

Instead of a custom pattern, you can also use a common, predefined pattern for credit_card and us_phone_dash.

The following example displays a filter that masks US phone numbers:

  - name: mask_phone
    type: mask
    predefined_pattern: us_phone_dash

Was this article helpful?

What's Next
Changing your password will log you out immediately. Use the new password to log back in.
First name must have atleast 2 characters. Numbers and special characters are not allowed.
Last name must have atleast 1 characters. Numbers and special characters are not allowed.
Enter a valid email
Enter a valid password
Your profile has been successfully updated.