condition

Documentation

Overview

Package condition contains logical operators that, based on their configuration, return boolean values from messages under certain circumstances.

Index

• Variables
• func Descriptions() string
• func SanitiseConfig(conf Config) (interface{}, error)
• type Config
  • func NewConfig() Config
  • func (m *Config) UnmarshalJSON(bytes []byte) error
  • func (m *Config) UnmarshalYAML(unmarshal func(interface{}) error) error
• type Type
  • func New(conf Config, log log.Modular, stats metrics.Type) (Type, error)
• type TypeSpec

Variables

var Constructors = map[string]TypeSpec{}

Constructors is a map of all condition types with their specs.

Functions

func Descriptions

func Descriptions() string

Descriptions returns a formatted string of collated descriptions of each type.

func SanitiseConfig

func SanitiseConfig(conf Config) (interface{}, error)

SanitiseConfig returns a sanitised version of the Config, meaning sections that aren't relevant to behaviour are removed.

Types

type Config

type Config struct {
	Type string `json:"type" yaml:"type"`
}

Config is the all encompassing configuration struct for all condition types.

func NewConfig

func NewConfig() Config

NewConfig returns a configuration struct fully populated with default values.

func (*Config) UnmarshalJSON

func (m *Config) UnmarshalJSON(bytes []byte) error

UnmarshalJSON ensures that when parsing configs that are in a slice the default values are still applied.

func (*Config) UnmarshalYAML

func (m *Config) UnmarshalYAML(unmarshal func(interface{}) error) error

UnmarshalYAML ensures that when parsing configs that are in a slice the default values are still applied.

type Type

type Type interface {
	// Check tests a message against a configured condition.
	Check(msg types.Message) bool
}

Type reads a message, calculates a condition and returns a boolean.

func New

func New(conf Config, log log.Modular, stats metrics.Type) (Type, error)

New creates a condition type based on a condition configuration.

type TypeSpec

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

TypeSpec Constructor and a usage description for each condition type.