pipeline

Documentation

Index

• func AllMetadata() (results []plugins.Metadata)
• func ExporterMetadata() (results []plugins.Metadata)
• func HandlePanic(logger *log.Logger)
• func ImporterMetadata() (results []plugins.Metadata)
• func ProcessorMetadata() (results []plugins.Metadata)
• type ErrOverrideConflict
  • func (e ErrOverrideConflict) Error() string
• type Pipeline
  • func MakePipeline(ctx context.Context, cfg *data.Config, logger *log.Logger) (Pipeline, error)
• type PluginLogFormatter
  • func (f PluginLogFormatter) Format(entry *log.Entry) ([]byte, error)
• type Status

Functions

func AllMetadata

func AllMetadata() (results []plugins.Metadata)

AllMetadata gets a slice with metadata from all registered plugins.

func ExporterMetadata

func ExporterMetadata() (results []plugins.Metadata)

ExporterMetadata gets a slice with metadata for all importers.Exporter plugins.

func HandlePanic

func HandlePanic(logger *log.Logger)

HandlePanic function to log panics in a common way

func ImporterMetadata

func ImporterMetadata() (results []plugins.Metadata)

ImporterMetadata gets a slice with metadata for all importers.Importer plugins.

func ProcessorMetadata

func ProcessorMetadata() (results []plugins.Metadata)

ProcessorMetadata gets a slice with metadata for all importers.Processor plugins.

Types

type ErrOverrideConflict

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

ErrOverrideConflict is used when there are two different round overrides detected.

func (ErrOverrideConflict) Error

func (e ErrOverrideConflict) Error() string

Error implements the error interface.

type Pipeline

type Pipeline interface {
	Init() error
	Start()
	Stop()
	Error() error
	Wait()
	Status() (Status, error)
}

Pipeline is a struct that orchestrates the entire sequence of events, taking in importers, processors and exporters and generating the result

func MakePipeline

func MakePipeline(ctx context.Context, cfg *data.Config, logger *log.Logger) (Pipeline, error)

MakePipeline creates a Pipeline

type PluginLogFormatter

type PluginLogFormatter struct {
	Formatter *log.JSONFormatter
	Type      string
	Name      string
}

PluginLogFormatter formats the log message with special conduit tags

func (PluginLogFormatter) Format

func (f PluginLogFormatter) Format(entry *log.Entry) ([]byte, error)

Format allows this to be used as a logrus formatter

type Status

type Status struct {
	Round uint64 `json:"round"`
}

Status is a struct that contains the current pipeline status.