v1

Documentation

Index

• Constants
• Variables
• type Configuration
  • func (c Configuration) ToConfig() []config.Pipeline
• type Connector
  • func (c Connector) ToConfig() config.Connector
• type DLQ
  • func (p DLQ) ToConfig() config.DLQ
• type Pipeline
  • func (p Pipeline) ToConfig() config.Pipeline
• type Processor
  • func (p Processor) ToConfig() config.Processor

Constants

const LatestVersion = "1.1"

const MajorVersion = "1"

Variables

var Changelog = internal.Changelog{
	"1.0": {{
		Field:      "pipelines.*.processors",
		ChangeType: internal.FieldDeprecated,
		Message:    "the order of processors is non-deterministic in configuration files with version 1.x, please upgrade to version 2.x",
	}, {
		Field:      "pipelines.*.connectors.*.processors",
		ChangeType: internal.FieldDeprecated,
		Message:    "the order of processors is non-deterministic in configuration files with version 1.x, please upgrade to version 2.x",
	}},
	"1.1": {{
		Field:      "pipelines.*.dead-letter-queue",
		ChangeType: internal.FieldIntroduced,
		Message:    "field dead-letter-queue was introduced in version 1.1, please update the pipeline config version",
	}},
}

Changelog should be adjusted every time we change the pipeline config and add a new config version. Based on the changelog the parser will output warnings.

Types

type Configuration

type Configuration struct {
	Version   string              `yaml:"version"`
	Pipelines map[string]Pipeline `yaml:"pipelines"`
}

func (Configuration) ToConfig

func (c Configuration) ToConfig() []config.Pipeline

type Connector

type Connector struct {
	Type       string               `yaml:"type"`
	Plugin     string               `yaml:"plugin"`
	Name       string               `yaml:"name"`
	Settings   map[string]string    `yaml:"settings"`
	Processors map[string]Processor `yaml:"processors,omitempty"`
}

func (Connector) ToConfig

func (c Connector) ToConfig() config.Connector

type DLQ

type DLQ struct {
	Plugin              string            `yaml:"plugin"`
	Settings            map[string]string `yaml:"settings"`
	WindowSize          *int              `yaml:"window-size"`
	WindowNackThreshold *int              `yaml:"window-nack-threshold"`
}

func (DLQ) ToConfig

func (p DLQ) ToConfig() config.DLQ

type Pipeline

type Pipeline struct {
	Status      string               `yaml:"status"`
	Name        string               `yaml:"name"`
	Description string               `yaml:"description"`
	Connectors  map[string]Connector `yaml:"connectors,omitempty"`
	Processors  map[string]Processor `yaml:"processors,omitempty"`
	DLQ         DLQ                  `yaml:"dead-letter-queue"`
}

func (Pipeline) ToConfig

func (p Pipeline) ToConfig() config.Pipeline

type Processor

type Processor struct {
	Type     string            `yaml:"type"`
	Settings map[string]string `yaml:"settings"`
	Workers  int               `yaml:"workers"`
}

func (Processor) ToConfig

func (p Processor) ToConfig() config.Processor