Description
Can be used for the following scenarios:
- Mask specified fields with a valid null value for the field type (i.e. 0, false, empty string, and so on).
- Replace any string or numeric field using the
replacement property.
Use the concrete transformation type designed for the record key (org.apache.kafka.connect.transforms.MaskField$Key) or value (org.apache.kafka.connect.transforms.MaskField$Value).
Examples
Mask value
This configuration snippet shows how to use MaskField to mask the value of a
field.
"transforms": "MaskField",
"transforms.MaskField.type": "org.apache.kafka.connect.transforms.MaskField$Value",
"transforms.MaskField.fields": "string_field"
This masks string_field, transforming the original message as seen
here:
{"integer_field":22, "string_field":"foo"}
into the result here:
{"integer_field":22, "string_field":""}
Replace value
This configuration snippet shows how to use MaskField to replace the value of a field. There are three transformations in the example. The first and second replace a value in a single field. The third is applied to both office and mobile phone number fields.
"transforms": "SSNMask,IPMask,PhoneMask",
"transforms.SSNMask.type": "org.apache.kafka.connect.transforms.MaskField$Value"
"transforms.SSNMask.fields": "SSN"
"transforms.SSNMask.replacement": "***-***-****"
"transforms.IPMask.type": "org.apache.kafka.connect.transforms.MaskField$Value"
"transforms.IPMask.fields": "IPAddress"
"transforms.IPMask.replacement": "xxx.xxx.xxx.xxx"
"transforms.PhoneMask.type": "org.apache.kafka.connect.transforms.MaskField$Value"
"transforms.PhoneMask.fields": "office,mobile"
"transforms.PhoneMask.replacement": "+0-000-000-0000"
Predicates
Transformations can be configured with predicates so that the transformation
is applied only to records which satisfy a condition. You can use predicates in
a transformation chain and, when combined with the Apache Kafka® Filter, predicates can conditionally filter out specific records.
Predicates are specified in the connector configuration. The following properties are used:
predicates: A set of aliases for predicates applied to one or more transformations.predicates.$alias.type: Fully qualified class name for the predicate.predicates.$alias.$predicateSpecificConfig: Configuration properties for the predicate.
All transformations have the implicit config properties predicate and
negate. A predicular predicate is associated with a transformation by
setting the transformation’s predicate configuration to the predicate’s alias.
The predicate’s value can be reversed using the negate configuration
property.
Kafka Connect includes the following predicates:
org.apache.kafka.connect.predicates.TopicNameMatches: Matches records in a topic with a name matching a particular Java regular expression.org.apache.kafka.connect.predicates.HasHeaderKey: Matches records which have a header with the given key.org.apache.kafka.connect.predicates.RecordIsTombstone: Matches tombstone records (that is, records with a null value).
Predicate Examples
Example 1:
You have a source connector that produces records to many different topics and
you want to do the following:
- Filter out the records in the
foo topic entirely.
- Apply the
ExtractField transformation with the field name other_field to records in all topics, except the topic bar.
To do this, you need to first filter out the records destined for the topic
foo. The Filter transformation removes records from further processing.
Next, you use the TopicNameMatches predicate to apply the transformation
only to records in topics which match a certain regular expression. The only
configuration property for TopicNameMatches is a Java regular expression
used as a pattern for matching against the topic name. The following example
shows this configuration:
transforms=Filter
transforms.Filter.type=org.apache.kafka.connect.transforms.Filter
transforms.Filter.predicate=IsFoo
predicates=IsFoo
predicates.IsFoo.type=org.apache.kafka.connect.predicates.TopicNameMatches
predicates.IsFoo.pattern=foo
Using this configuration, ExtractField is then applied only when the topic
name of the record is not bar. The reason you can’t use TopicNameMatches
directly is because it would apply the transformation to matching topic names,
not topic names which do not match. The transformation’s implicit negate
configuration properties inverts the set of records which a predicate matches.
This configuration addition is shown below:
transforms=Filter,Extract
transforms.Filter.type=org.apache.kafka.connect.transforms.Filter
transforms.Filter.predicate=IsFoo
transforms.Extract.type=org.apache.kafka.connect.transforms.ExtractField$Key
transforms.Extract.field=other_field
transforms.Extract.predicate=IsBar
transforms.Extract.negate=true
predicates=IsFoo,IsBar
predicates.IsFoo.type=org.apache.kafka.connect.predicates.TopicNameMatches
predicates.IsFoo.pattern=foo
predicates.IsBar.type=org.apache.kafka.connect.predicates.TopicNameMatches
predicates.IsBar.pattern=bar
Example 2:
The following configuration shows how to use a predicate in a transformation
chain with the ExtractField transformation and the negate=true
configuration property:
transforms=t2
transforms.t2.predicate=has-my-prefix
transforms.t2.negate=true
transforms.t2.type=org.apache.kafka.connect.transforms.ExtractField$Key
transforms.t2.field=c1
predicates=has-my-prefix
predicates.has-my-prefix.type=org.apache.kafka.connect.predicates.TopicNameMatch
predicates.has-my-prefix.pattern=my-prefix-.*
The transform t2 is only applied when the predicate has-my-prefix is
false (using the negate=true parameter). The predicate is configured by the
keys with prefix predicates.has-my-prefix. The predicate class is
org.apache.kafka.connect.predicates.TopicNameMatch and it’s pattern
parameter has the value my-prefix-.* . With this configuration, the
transformation is applied only to records where the topic name does not
start with my-prefix-.
Tip
The benefit of defining the predicate separately from the transform is it
makes it easier to apply the same predicate to multiple transforms. For
example, you can have one set of transforms use one predicate and another set
of transforms use the same predicate for negation.