Agent

This formatter parses a user agent string and outputs it as metadata fields to the set target.

Parameters

Fields

An array of the fields to extract from the user agent. Available fields are: “mozilla”, “platform”, “os”, “localization”, “engine”, “engine-version”, “browser”, “browser-version”, “bot”, “mobile”. By default this is set to [“platform”,”os”,”localization”,”browser”].

Prefix

Defines a prefix for each of the keys generated. By default this is set to “”.

Parameters (from core.SimpleFormatter)

Source

This value chooses the part of the message the data to be formatted should be read from. Use “” to target the message payload; other values specify the name of a metadata field to target. By default this parameter is set to “”.

Target

This value chooses the part of the message the formatted data should be stored 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 “”.

ApplyTo

Use this to set Source and Target to the same value. This setting will be ignored if either Source or Target is set to something else but “”. 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

exampleConsumer:
  Type: consumer.Console
  Streams: stdin
  Modulators:
    - format.Agent
      Source: user_agent