report

Documentation

Index

• func Init(ctx context.Context, cfg Config)
• func Register(ctx context.Context, name string, builder Builder)
• type Builder
• type Config
• type Driver
  • func Open(ctx context.Context, id string, step int) Driver

Functions

func Init

func Init(ctx context.Context, cfg Config)

Init initialize reporter with config

func Register

func Register(ctx context.Context, name string, builder Builder)

Register register report builder in the catalog

Types

type Builder

type Builder func(config map[string]interface{}, id string, step int) Driver

Builder report driver builder

type Config

type Config struct {
	Driver string                 `yaml:"driver"`
	Config map[string]interface{} `yaml:"config"`
}

Config report configuration structure

type Driver

type Driver interface {
	// Type returns type of the driver
	Type() string
	// PushString pushes string to report
	PushString(ctx context.Context, report string)
	// PushReader pushes io.Reader to report to allow streaming of log to report
	PushReader(ctx context.Context, report io.Reader)
	// Close close the report
	Close(ctx context.Context)
}

Driver report driver interface

func Open

func Open(ctx context.Context, id string, step int) Driver

Open start the report