printer

Documentation

Index

• type Broadcast
  • func NewBroadcast(printerConfigs []Config, containerMode ContainerMode) (*Broadcast, error)
  • func (b *Broadcast) Close()
  • func (b *Broadcast) Epilogue(stats metrics.Stats)
  • func (b *Broadcast) Init() error
  • func (b *Broadcast) Preamble()
  • func (b *Broadcast) Print(event trace.Event)
• type Config
• type ContainerMode
• type EventPrinter
  • func New(config Config) (EventPrinter, error)
• type PolicyEventPrinter
  • func NewPolicyEventPrinter(pConfigs []Config, policies []policy.PolicyFile, containerMode ContainerMode) (*PolicyEventPrinter, error)
  • func (pp *PolicyEventPrinter) Close()
  • func (pp *PolicyEventPrinter) Epilogue(stats metrics.Stats)
  • func (pp *PolicyEventPrinter) Init() error
  • func (pp *PolicyEventPrinter) Preamble()
  • func (pp *PolicyEventPrinter) Print(event trace.Event)

Types

type Broadcast

type Broadcast struct {
	PrinterConfigs []Config
	// contains filtered or unexported fields
}

Broadcast is a printer that broadcasts events to multiple printers

func NewBroadcast

func NewBroadcast(printerConfigs []Config, containerMode ContainerMode) (*Broadcast, error)

NewBroadcast creates a new Broadcast printer

func (*Broadcast) Close

func (b *Broadcast) Close()

Close closes Broadcast printer

func (*Broadcast) Epilogue

func (b *Broadcast) Epilogue(stats metrics.Stats)

func (*Broadcast) Init

func (b *Broadcast) Init() error

func (*Broadcast) Preamble

func (b *Broadcast) Preamble()

func (*Broadcast) Print

func (b *Broadcast) Print(event trace.Event)

Print broadcasts the event to all printers

type Config

type Config struct {
	Kind          string
	OutPath       string
	OutFile       io.WriteCloser
	ContainerMode ContainerMode
	RelativeTS    bool
}

type ContainerMode

type ContainerMode int

const (
	ContainerModeDisabled ContainerMode = iota
	ContainerModeEnabled
	ContainerModeEnriched
)

type EventPrinter

type EventPrinter interface {
	// Init serves as the initializer method for every event Printer type
	Init() error
	// Preamble prints something before event printing begins (one time)
	Preamble()
	// Epilogue prints something after event printing ends (one time)
	Epilogue(stats metrics.Stats)
	// Print prints a single event
	Print(event trace.Event)
	// dispose of resources
	Close()
}

func New

func New(config Config) (EventPrinter, error)

type PolicyEventPrinter

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

PolicyEventPrinter is an EventPrinter that prints events based on a policy Each policy can define a global action or action per events. A map is created between policy:event or policy to printerName which is used to send events to the correct printer

func NewPolicyEventPrinter

func NewPolicyEventPrinter(pConfigs []Config, policies []policy.PolicyFile, containerMode ContainerMode) (*PolicyEventPrinter, error)

NewPolicyEventPrinter creates a new PolicyEventPrinter

func (*PolicyEventPrinter) Close

func (pp *PolicyEventPrinter) Close()

dispose of resources

func (*PolicyEventPrinter) Epilogue

func (pp *PolicyEventPrinter) Epilogue(stats metrics.Stats)

Epilogue prints something after event printing ends (one time)

func (*PolicyEventPrinter) Init

func (pp *PolicyEventPrinter) Init() error

Init serves as the initializer method for every event Printer type

func (*PolicyEventPrinter) Preamble

func (pp *PolicyEventPrinter) Preamble()

Preamble prints something before event printing begins (one time)

func (*PolicyEventPrinter) Print

func (pp *PolicyEventPrinter) Print(event trace.Event)

Print prints a single event