eventhandler

Documentation

Index

• type ChainedJobEventHandler
  • func NewChainedJobEventHandler(contextProvider ContextProvider) *ChainedJobEventHandler
  • func (r *ChainedJobEventHandler) AddHandlers(handlers ...JobEventHandler)
  • func (r *ChainedJobEventHandler) HandleJobEvent(ctx context.Context, event models.JobEvent) (err error)
• type ContextProvider
• type JobEventHandler
• type JobEventHandlerFunc
  • func (f JobEventHandlerFunc) HandleJobEvent(ctx context.Context, event models.JobEvent) error
• type Tracer
  • func NewTracer(path string) (*Tracer, error)
  • func NewTracerToFile(filename string) (*Tracer, error)
  • func (t *Tracer) HandleJobEvent(ctx context.Context, event models.JobEvent) error
  • func (t *Tracer) Shutdown() error
• type TracerContextProvider
  • func NewTracerContextProvider(nodeID string) *TracerContextProvider
  • func (t *TracerContextProvider) GetContext(ctx context.Context, jobID string) context.Context
  • func (t *TracerContextProvider) HandleJobEvent(ctx context.Context, event models.JobEvent) error
  • func (t *TracerContextProvider) Shutdown() error

Types

type ChainedJobEventHandler

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

An event handler implementation that chains multiple event handlers, and accepts a context provider to setup up the context once for all handlers.

func NewChainedJobEventHandler

func NewChainedJobEventHandler(contextProvider ContextProvider) *ChainedJobEventHandler

func (*ChainedJobEventHandler) AddHandlers

func (r *ChainedJobEventHandler) AddHandlers(handlers ...JobEventHandler)

func (*ChainedJobEventHandler) HandleJobEvent

func (r *ChainedJobEventHandler) HandleJobEvent(ctx context.Context, event models.JobEvent) (err error)

type ContextProvider

type ContextProvider interface {
	GetContext(ctx context.Context, jobID string) context.Context
}

Interface for a context provider that can be used to generate a context to be used to handle job events.

type JobEventHandler

type JobEventHandler interface {
	HandleJobEvent(ctx context.Context, event models.JobEvent) error
}

A job event handler is a component that is notified of events related to jobs.

type JobEventHandlerFunc

type JobEventHandlerFunc func(ctx context.Context, event models.JobEvent) error

function that implements the JobEventHandler interface

func (JobEventHandlerFunc) HandleJobEvent

func (f JobEventHandlerFunc) HandleJobEvent(ctx context.Context, event models.JobEvent) error

type Tracer

type Tracer struct {
	LogFile *os.File
	Logger  zerolog.Logger
}

Tracer is a JobEventHandler that will marshal the received event to a file-based log.

Note that we don't need any mutexes here because writing to an os.File is thread-safe (see https://github.com/rs/zerolog/blob/master/writer.go#L33)

func NewTracer

func NewTracer(path string) (*Tracer, error)

Returns an eventhandler.Tracer that writes to config.GetEventTracerPath(), or an error if the file can't be opened.

func NewTracerToFile

func NewTracerToFile(filename string) (*Tracer, error)

Returns an eventhandler.Tracer that writes to the specified filename, or an error if the file can't be opened.

func (*Tracer) HandleJobEvent

func (t *Tracer) HandleJobEvent(ctx context.Context, event models.JobEvent) error

HandleJobEvent implements JobEventHandler

func (*Tracer) Shutdown

func (t *Tracer) Shutdown() error

type TracerContextProvider

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

TracerContextProvider is a context provider that generates a context along with tracing information. It also implements JobEventHandler to end the local lifecycle context for a job when it is completed.

func NewTracerContextProvider

func NewTracerContextProvider(nodeID string) *TracerContextProvider

func (*TracerContextProvider) GetContext

func (t *TracerContextProvider) GetContext(ctx context.Context, jobID string) context.Context

func (*TracerContextProvider) HandleJobEvent

func (t *TracerContextProvider) HandleJobEvent(ctx context.Context, event models.JobEvent) error

func (*TracerContextProvider) Shutdown

func (t *TracerContextProvider) Shutdown() error