rename

README

Rename plugin

It renames the fields of the event. You can provide an unlimited number of config parameters. Each parameter handled as cfg.FieldSelector:string. When override is set to false, the field won't be renamed in the case of field name collision. Sequence of rename operations isn't guaranteed. Use different actions for prioritization.

Example:

pipelines:
  example_pipeline:
    ...
    actions:
    - type: rename
      override: false
      my_object.field.subfield: new_sub_field
    ...

The resulting event could look like:

{
  "my_object": {
    "field": {
      "new_sub_field":"value"
    }
  },

Generated using insane-doc

Documentation

Index

• type Config
• type Plugin
  • func (p *Plugin) Do(event *pipeline.Event) pipeline.ActionResult
  • func (p *Plugin) Start(config pipeline.AnyConfig, _ *pipeline.ActionPluginParams)
  • func (p *Plugin) Stop()

Types

type Config

type Config map[string]interface{}

type Plugin

type Plugin struct {
	// contains filtered or unexported fields
}

{ introduction It renames the fields of the event. You can provide an unlimited number of config parameters. Each parameter handled as `cfg.FieldSelector`:`string`. When `override` is set to `false`, the field won't be renamed in the case of field name collision. Sequence of rename operations isn't guaranteed. Use different actions for prioritization.

**Example:** ```yaml pipelines:

example_pipeline:
  ...
  actions:
  - type: rename
    override: false
    my_object.field.subfield: new_sub_field
  ...

```

The resulting event could look like: ```yaml

{
  "my_object": {
    "field": {
      "new_sub_field":"value"
    }
  },

``` }

func (*Plugin) Do

func (p *Plugin) Do(event *pipeline.Event) pipeline.ActionResult

func (*Plugin) Start

func (p *Plugin) Start(config pipeline.AnyConfig, _ *pipeline.ActionPluginParams)

func (*Plugin) Stop

func (p *Plugin) Stop()