Clear¶
This formatter erases the message payload or deletes a metadata key.
Parameters (from core.SimpleFormatter)¶
ApplyTo
This value chooses the part of the message the formatting should be applied to. Use “” to target the message payload; other values specify the name of a metadata field to target. By default this parameter is set to “”.
SkipIfEmpty
When set to true, this formatter will not be applied to data that is empty or - in case of metadata - not existing. By default this parameter is set to false
Examples¶
This example removes the “pipe” key from the metadata produced by consumer.Console.
exampleConsumer:
Type: consumer.Console
Streams: stdin
Modulators:
- format.Clear
ApplyTo: pipe