status

Documentation

Overview

Package status fetch information needed to render the 'remote agents' section of the status page

Index

• func GetProvider(registry remoteagentregistry.Component) status.Provider
• type Provider
  • func (p Provider) HTML(_ bool, _ io.Writer) error
  • func (p Provider) JSON(_ bool, stats map[string]interface{}) error
  • func (p Provider) Name() string
  • func (p Provider) Section() string
  • func (p Provider) Text(_ bool, buffer io.Writer) error

Functions

func GetProvider

func GetProvider(registry remoteagentregistry.Component) status.Provider

GetProvider returns status.Provider

Types

type Provider

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

Provider provides the functionality to populate the status output

func (Provider) HTML

func (p Provider) HTML(_ bool, _ io.Writer) error

HTML renders the html output

func (Provider) JSON

func (p Provider) JSON(_ bool, stats map[string]interface{}) error

JSON populates the status map

func (Provider) Name

func (p Provider) Name() string

Name returns the name

func (Provider) Section

func (p Provider) Section() string

Section return the section

func (Provider) Text

func (p Provider) Text(_ bool, buffer io.Writer) error

Text renders the text output