functions

Documentation

Index

• func CustomFunctions[K any]() map[string]ottl.Factory[K]
• func NewCidrMatchFactory[K any]() ottl.Factory[K]
• func NewDeriveSourceTypeFactory[K any]() ottl.Factory[K]
• func NewExistsFactory[K any]() ottl.Factory[K]
• func NewIpLocationFactory[K any]() ottl.Factory[K]
• func NewIsInFactory[K any]() ottl.Factory[K]
• func NewLookupFactory[K any]() ottl.Factory[K]
• type CidrMatchArguments
• type Config
• type DeriveSourceTypeArguments
• type GrokPattern
• type IpLocationArguments
• type IsInArguments
• type LookupArguments
• type PatternConfig
• type SourceTypeConfig

Functions

func CustomFunctions

func CustomFunctions[K any]() map[string]ottl.Factory[K]

func NewCidrMatchFactory

func NewCidrMatchFactory[K any]() ottl.Factory[K]

NewCidrMatchFactory Factory function to create a new instance of cidrMatch

func NewDeriveSourceTypeFactory

func NewDeriveSourceTypeFactory[K any]() ottl.Factory[K]

func NewExistsFactory

func NewExistsFactory[K any]() ottl.Factory[K]

func NewIpLocationFactory

func NewIpLocationFactory[K any]() ottl.Factory[K]

NewIpLocationFactory Create the factory for the iplocation function

func NewIsInFactory

func NewIsInFactory[K any]() ottl.Factory[K]

func NewLookupFactory

func NewLookupFactory[K any]() ottl.Factory[K]

Types

type CidrMatchArguments

type CidrMatchArguments[K any] struct {
	Subnet ottl.StringGetter[K]
	IP     ottl.StringGetter[K]
}

CidrMatchArguments Define the arguments struct for the cidrMatch function

type Config

type Config struct {
	Patterns []PatternConfig `yaml:"patterns"`
}

type DeriveSourceTypeArguments

type DeriveSourceTypeArguments[K any] struct {
	Target       ottl.StringGetter[K]
	ReceiverType ottl.StringGetter[K]
}

type GrokPattern

type GrokPattern struct {
	CompiledPattern *grok.Grok
	SourceType      string
	MandatoryFields map[string]string
}

type IpLocationArguments

type IpLocationArguments[K any] struct {
	Target ottl.StringGetter[K] // Target is the IP address to locate
}

IpLocationArguments holds the target IP

type IsInArguments

type IsInArguments[K any] struct {
	Target ottl.StringGetter[K]
	List   []string
}

type LookupArguments

type LookupArguments[K any] struct {
	LookupKey ottl.StringGetter[K]
	Lookup    []string // Array in [key1, value1, key2, value2, ...] format
	DefaultTo string
}

type PatternConfig

type PatternConfig struct {
	SourceTypes []SourceTypeConfig `yaml:"sourceTypes"`
}

type SourceTypeConfig

type SourceTypeConfig struct {
	GrokExpr        string   `yaml:"grokExpr"`
	Type            string   `yaml:"type"`
	MandatoryFields []string `yaml:"mandatoryFields"`
	ReceiverTypes   []string `yaml:"receiverTypes"`
}