consumer

Documentation

Index

• Constants
• type Builder
• type CloseFunc
• type ExecutionSummary
• type Interface
• type WriterOp

Constants

const ContextKeyCommandName = contextKey("commandName")

Types

type Builder

type Builder interface {
	Build(*zap.SugaredLogger, WriterOp) (Interface, error)
}

Builder builds a consumer

type CloseFunc

type CloseFunc func(ExecutionSummary)

CloseFunc

type ExecutionSummary

type ExecutionSummary struct {
	Command     string
	ExitCode    int
	RunDuration time.Duration
}

ExecutionSummary describes a command execution

type Interface

type Interface interface {
	Consume(ctx context.Context, stdin, stderr io.Reader) CloseFunc
}

Interface consumes command output and emits telemetry data

type WriterOp

type WriterOp interface {
	NewEntry(value interface{}) (*entry.Entry, error)
	Write(ctx context.Context, e *entry.Entry) error
}

WriterOp is the consumer's interface to the stanza pipeline