hostimpl

Documentation

Overview

Package hostimpl implements a component to generate the 'host' metadata payload (also known as "v5").

Package hostimpl implements a component to generate the 'host' metadata payload (also known as "v5").

Index

• func Module() fxutil.Module
• type Payload
  • func (p *Payload) MarshalJSON() ([]byte, error)
  • func (p *Payload) SplitPayload(_ int) ([]marshaler.AbstractMarshaler, error)
• type StatusProvider
  • func (p StatusProvider) HTML(_ bool, buffer io.Writer) error
  • func (p StatusProvider) Index() int
  • func (p StatusProvider) JSON(_ bool, stats map[string]interface{}) error
  • func (p StatusProvider) Name() string
  • func (p StatusProvider) Text(_ bool, buffer io.Writer) error

Functions

func Module

func Module() fxutil.Module

Module defines the fx options for this component.

Types

type Payload

type Payload struct {
	utils.CommonPayload
	utils.Payload

	ResourcesPayload interface{} `json:"resources,omitempty"`
	GohaiPayload     string      `json:"gohai"`
}

Payload handles the JSON unmarshalling of the metadata payload

func (*Payload) MarshalJSON

func (p *Payload) MarshalJSON() ([]byte, error)

MarshalJSON serialization a Payload to JSON

func (*Payload) SplitPayload

func (p *Payload) SplitPayload(_ int) ([]marshaler.AbstractMarshaler, error)

SplitPayload breaks the payload into times number of pieces

type StatusProvider

type StatusProvider struct {
	Config config.Component
}

StatusProvider implements the status provider interface

func (StatusProvider) HTML

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

HTML renders the html output

func (StatusProvider) Index

func (p StatusProvider) Index() int

Index returns the index

func (StatusProvider) JSON

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

JSON populates the status map

func (StatusProvider) Name

func (p StatusProvider) Name() string

Name returns the name

func (StatusProvider) Text

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

Text renders the text output