statusinterface

Documentation

Overview

Package statusinterface describes status methods required in logs agent modules

Index

• type Status
  • func NewStatusProviderMock() Status

Types

type Status

type Status interface {
	// AddGlobalWarning keeps track of a warning message to display on the status.
	AddGlobalWarning(key string, warning string)

	// RemoveGlobalWarning loses track of a warning message
	// that does not need to be displayed on the status anymore.
	RemoveGlobalWarning(key string)
}

Status is the type for status methods

func NewStatusProviderMock

func NewStatusProviderMock() Status

NewStatusProviderMock returns a mock instance of statusinterface to be used in tests