Edge Delta Delete Field Processor

The Edge Delta delete field processor deletes fields.

3 minute read

Overview

This processor is used to remove a specified key and its associated value from a target field or object within a data object. It is useful for cleaning up data items by eliminating unnecessary or sensitive information.

See a hands-on example in Pipeline Quickstart: Delete Attributes.

Configuration

In this example, the server.address attribute is deleted if a log meets the event name condition:

This configuration generates the following YAML:

- name: Multi Processor_54e6
  type: sequence
  processors:
  - type: ottl_transform
    metadata: '{"id":"P4XMAOFQw3Qcvc-lY8227","type":"delete-field","name":"Delete
      Field"}'
    condition: attributes["event.name"] == "proxy.access"
    data_types:
    - log
    statements: delete_key(attributes, "server.address")

Options

Select a telemetry type

You can specify, log, metric, trace or all. It is specified using the interface, which generates a YAML list item for you under the data_types parameter. This defines the data item types against which the processor must operate. If data_types is not specified, the default value is all. It is optional.

It is defined in YAML as follows:

- name: multiprocessor
  type: sequence
  processors:
  - type: <processor type>
    data_types:
    - log

condition

The condition parameter contains a conditional phrase of an OTTL statement. It restricts operation of the processor to only data items where the condition is met. Those data items that do not match the condition are passed without processing. You configure it in the interface and an OTTL condition is generated. It is optional. You can select one of the following operators:

Operator	Name	Description	Example
`==`	Equal to	Returns `true` if both values are exactly the same	`attributes["status"] == "OK"`
`!=`	Not equal to	Returns `true` if the values are not the same	`attributes["level"] != "debug"`
`>`	Greater than	Returns `true` if the left value is greater than the right	`attributes["duration_ms"] > 1000`
`>=`	Greater than or equal	Returns `true` if the left value is greater than or equal to the right	`attributes["score"] >= 90`
`<`	Less than	Returns `true` if the left value is less than the right	`attributes["load"] < 0.75`
`<=`	Less than or equal	Returns `true` if the left value is less than or equal to the right	`attributes["retries"] <= 3`
`matches`	Regex match	Returns `true` if the string matches a regular expression	`isMatch(attributes["name"], ".*\\.name$"`

It is defined in YAML as follows:

- name: _multiprocessor
  type: sequence
  processors:
  - type: <processor type>
    condition: attributes["request"]["path"] == "/json/view"

OTTL statements

The statements YAML parameter defines the operation of the processor. It is defined by populating the Field options in the tool. It is specified as one or more OTTL statements and is a required parameter.

- name: Multiprocessor
  type: sequence
  processors:
  - type: <processor type>
    statements: |-
      <OTTL statement>
      <OTTL statement>

Delete from

You specify the field path for the field you want to delete. You can click Add row to specify additional fields to delete.

Final

Determines whether successfully processed data items should continue through the remaining processors in the same processor stack. If final is set to true, data items output by this processor are not passed to subsequent processors within the node—they are instead emitted to downstream nodes in the pipeline (e.g., a destination). Failed items are always passed to the next processor, regardless of this setting.

The UI provides a slider to configure this setting. The default is false. It is defined in YAML as follows:

- name: multiprocessor
  type: sequence
  processors:
    - type: <processor type>
    final: true