output

Documentation

Index

• func Description(async, batches bool, content string) string
• func MetadataFields() docs.FieldSpecs
• type Metadata
  • func NewMetadata() Metadata
  • func (m Metadata) Filter() (*MetadataFilter, error)
• type MetadataFilter
  • func (f *MetadataFilter) Iter(m types.Metadata, fn func(k, v string) error) error

Functions

func Description

func Description(async, batches bool, content string) string

Description appends standard feature descriptions to an output description based on various features of the output.

func MetadataFields

func MetadataFields() docs.FieldSpecs

MetadataFields returns a docs spec for the fields within a metadata config struct.

Types

type Metadata

type Metadata struct {
	ExcludePrefixes []string `json:"exclude_prefixes" yaml:"exclude_prefixes"`
}

Metadata describes actions to be performed on message metadata before being sent to an output destination.

func NewMetadata

func NewMetadata() Metadata

NewMetadata returns a Metadata configuration struct with default values.

func (Metadata) Filter

func (m Metadata) Filter() (*MetadataFilter, error)

Filter attempts to construct a metadata filter.

type MetadataFilter

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

MetadataFilter provides a way to filter metadata keys based on a Metadata config.

func (*MetadataFilter) Iter

func (f *MetadataFilter) Iter(m types.Metadata, fn func(k, v string) error) error

Iter applies a function to each metadata key value pair that passes the filter.