Redact message payload, header, variable, query parameters, and telemetry
Table 1. Options for Redact
| Parameter |
Required |
Data type |
Details |
| variable |
Yes |
object |
Used to perform redact or remove on a variable |
| distributedVariable |
Yes |
object |
Used to perform redact or remove on a distributed variable |
| messageBody |
Yes |
object |
Used to perform redact or remove on a message body |
| messageHeader |
Yes |
object |
Contains metadata or control information for the message being processed or
redirected |
| messageQueryParam |
Yes |
object |
Represents query parameters included in the message request for filtering or
customization |
| telemetry |
Yes |
object |
Redact or Remove one or more attributes on the OpenTelemetry Span |
Table 2. Nested properties inside variable,
distributedVariable
| Parameter |
Required |
Data type |
Details |
| captures |
No |
object |
Capture expression(s) to use for redact or remove. Default is root |
| name |
Yes |
string |
Name of the variable |
Table 3. Options for captures
| Parameter |
Required |
Data type |
Details |
| jsonata |
Yes |
array of string |
JSONata capture expression(s) for redact or remove |
| information needed |
|
null |
|
Table 4. Nested properties inside
messageBody
| Parameter |
Required |
Data type |
Details |
| captures |
No |
object |
Capture expression(s) to use for redact or remove. Default is root |
| messageName |
No |
string or null |
Name of the message. Default is response |
Table 6. Nested properties inside
messageQueryParam
| Parameter |
Required |
Data type |
Details |
| messageName |
No |
string or null |
Name of the message. Default is response. |
| paramNames |
Yes |
array of string |
List of query parameter(s) to redact or remove. Must contain a minimum of 1
items. |
Table 7. Nested properties inside
telemetry
| Parameter |
Required |
Data type |
Details |
| keys |
Yes |
array of string |
List of attribute key(s) to redact or remove. Must contain a minimum of 1
items. |
| span |
No |
object |
Span whose attributes are being redacted. Defaults to root span. |
Table 8. Options for span
| Parameter |
Required |
Data type |
Details |
| rootSpan |
No |
enum (of string) |
References the root span of current transaction |
| policySpan |
Yes |
object |
Refers to internal span. Spans associated with policies are named after the policy
title. |
| httpSpan |
Yes |
object |
Refers to client spans associated with outgoing request/response. The name of its parent span
(e.g invoke span) will be used to reference this. |