Class LogsStringBuilderProcessor

Use the string builder processor to add a new attribute (without spaces or special characters) to a log with the result of the provided template. This enables aggregation of different attributes or raw strings into a single attribute.

The template is defined by both raw text and blocks with the syntax %{attribute_path}.

Notes:

  • The processor only accepts attributes with values or an array of values in the blocks.
  • If an attribute cannot be used (object or array of object), it is replaced by an empty string or the entire operation is skipped depending on your selection.
  • If the target attribute already exists, it is overwritten by the result of the template.
  • Results of the template cannot exceed 256 characters.

Hierarchy

  • LogsStringBuilderProcessor

Constructors

constructor

Properties

additionalProperties? isEnabled? isReplaceMissing? name? target template type

Constructors

constructor

Properties

Optional additionalProperties

additionalProperties?: {
    [key: string]: any;
}

A container for additional, undeclared properties. This is a holder for any undeclared properties as specified with the 'additionalProperties' keyword in the OAS document.

Type declaration

  • [key: string]: any

Optional isEnabled

isEnabled?: boolean

Whether or not the processor is enabled.

Optional isReplaceMissing

isReplaceMissing?: boolean

If true, it replaces all missing attributes of template by an empty string. If false (default), skips the operation for missing attributes.

Optional name

name?: string

Name of the processor.

target

target: string

The name of the attribute that contains the result of the template.

template

template: string

A formula with one or more attributes and raw text.

type

type: LogsStringBuilderProcessorType

Type of logs string builder processor.

Settings

Member Visibility

Theme

Generated using TypeDoc