statusimpl

Documentation

Overview

Package statusimpl implements the Status component.

Index

• func GetStatus() map[string]interface{}
• func MockModule() fxutil.Module
• func Module() fxutil.Module
• func New() trapsStatus.Component
• type Provider
  • func (p Provider) HTML(_ bool, buffer io.Writer) error
  • func (Provider) JSON(_ bool, stats map[string]interface{}) error
  • func (Provider) Name() string
  • func (Provider) Section() string
  • func (p Provider) Text(_ bool, buffer io.Writer) error

Functions

func GetStatus

func GetStatus() map[string]interface{}

GetStatus returns key-value data for use in status reporting of the traps server.

func MockModule

func MockModule() fxutil.Module

MockModule defines a fake Component

func Module

func Module() fxutil.Module

Module defines the fx options for this component.

func New

func New() trapsStatus.Component

New creates a new status manager component

Types

type Provider

type Provider struct{}

Provider provides the functionality to populate the status output

func (Provider) HTML

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

HTML renders the html output

func (Provider) JSON

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

JSON populates the status map

func (Provider) Name

func (Provider) Name() string

Name returns the name

func (Provider) Section

func (Provider) Section() string

Section return the section

func (Provider) Text

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

Text renders the text output