redactionprocessor.json•2.88 kB
{
"fields": [
{
"name": "AllowAllKeys",
"type": "bool",
"description": "AllowAllKeys is a flag to allow all span attribute keys. Setting this to true disables the AllowedKeys list. The list of BlockedValues is applied regardless. If you just want to block values, set this to true.",
"required": true,
"mapstructureTag": "allow_all_keys"
},
{
"name": "AllowedKeys",
"type": "[]string",
"description": "AllowedKeys is a list of allowed span attribute keys. Span attributes not on the list are removed. The list fails closed if it's empty. To allow all keys, you should explicitly set AllowAllKeys",
"required": true,
"mapstructureTag": "allowed_keys"
},
{
"name": "BlockedKeyPatterns",
"type": "[]string",
"description": "BlockedKeyPatterns is a list of blocked span attribute key patterns. Span attributes matching the regexes on the list are masked.",
"required": true,
"mapstructureTag": "blocked_key_patterns"
},
{
"name": "HashFunction",
"type": "HashFunction",
"description": "HashFunction defines the function for hashing the values instead of masking them with a fixed string. By default, no hash function is used and masking with a fixed string is performed.",
"required": true,
"mapstructureTag": "hash_function"
},
{
"name": "IgnoredKeys",
"type": "[]string",
"description": "IgnoredKeys is a list of span attribute keys that are not redacted. Span attributes in this list are allowed to pass through the filter without being changed or removed.",
"required": true,
"mapstructureTag": "ignored_keys"
},
{
"name": "BlockedValues",
"type": "[]string",
"description": "BlockedValues is a list of regular expressions for blocking values of allowed span attributes. Values that match are masked.",
"required": true,
"mapstructureTag": "blocked_values"
},
{
"name": "AllowedValues",
"type": "[]string",
"description": "AllowedValues is a list of regular expressions for allowing values of blocked span attributes. Values that match are not masked.",
"required": true,
"mapstructureTag": "allowed_values"
},
{
"name": "Summary",
"type": "string",
"description": "Summary controls the verbosity level of the diagnostic attributes that the processor adds to the spans when it redacts or masks other attributes. In some contexts a list of redacted attributes leaks information, while it is valuable when integrating and testing a new configuration. Possible values are `debug`, `info`, and `silent`.",
"required": true,
"mapstructureTag": "summary"
}
],
"imports": [
"encoding",
"errors",
"fmt",
"strings"
],
"packageName": "redactionprocessor"
}