pipeline

Documentation

Overview

Package pipeline provides log processing pipeline functionality

Index

• type Pipeline
  • func NewPipeline(processingRules []*config.ProcessingRule, endpoints *config.Endpoints, ...) *Pipeline
  • func (p *Pipeline) Flush(ctx context.Context)
  • func (p *Pipeline) Start()
  • func (p *Pipeline) Stop()
• type Provider
  • func NewMockProvider() Provider
  • func NewProcessorOnlyProvider(diagnosticMessageReceiver diagnostic.MessageReceiver, ...) Provider
  • func NewProvider(numberOfPipelines int, sink sender.Sink, ...) Provider

Types

type Pipeline

type Pipeline struct {
	InputChan chan *message.Message
	// contains filtered or unexported fields
}

Pipeline processes and sends messages to the backend

func NewPipeline

func NewPipeline(
	processingRules []*config.ProcessingRule,
	endpoints *config.Endpoints,
	senderImpl sender.PipelineComponent,
	diagnosticMessageReceiver diagnostic.MessageReceiver,
	serverlessMeta sender.ServerlessMeta,
	hostname hostnameinterface.Component,
	cfg pkgconfigmodel.Reader,
	compression logscompression.Component,
	instanceID string,
) *Pipeline

NewPipeline returns a new Pipeline

func (*Pipeline) Flush

func (p *Pipeline) Flush(ctx context.Context)

Flush flushes synchronously the processor and sender managed by this pipeline.

func (*Pipeline) Start

func (p *Pipeline) Start()

Start launches the pipeline

func (*Pipeline) Stop

func (p *Pipeline) Stop()

Stop stops the pipeline

type Provider

type Provider interface {
	Start()
	Stop()
	NextPipelineChan() chan *message.Message
	GetOutputChan() chan *message.Message
	NextPipelineChanWithMonitor() (chan *message.Message, *metrics.CapacityMonitor)
	// Flush flushes all pipeline contained in this Provider
	Flush(ctx context.Context)
}

Provider provides message channels

func NewMockProvider

func NewMockProvider() Provider

NewMockProvider creates a new provider that will not provide any pipelines.

func NewProcessorOnlyProvider

func NewProcessorOnlyProvider(diagnosticMessageReceiver diagnostic.MessageReceiver, processingRules []*config.ProcessingRule, hostname hostnameinterface.Component) Provider

NewProcessorOnlyProvider is used by the logs check subcommand as the feature does not require the functionalities of the log pipeline other then the processor.

func NewProvider

func NewProvider(
	numberOfPipelines int,
	sink sender.Sink,
	diagnosticMessageReceiver diagnostic.MessageReceiver,
	processingRules []*config.ProcessingRule,
	endpoints *config.Endpoints,
	destinationsContext *client.DestinationsContext,
	status statusinterface.Status,
	hostname hostnameinterface.Component,
	cfg pkgconfigmodel.Reader,
	compression logscompression.Component,
	legacyMode bool,
	serverless bool,
) Provider

NewProvider returns a new Provider