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

• type Payload
  • func (p *Payload) MarshalJSON() ([]byte, error)
• type Provides
  • func NewComponent(deps Requires) Provides
• type Requires
• 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

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

type Provides

type Provides struct {
	compdef.Out

	Comp                 hostComp.Component
	MetadataProvider     runnerdef.Provider
	FlareProvider        flaretypes.Provider
	StatusHeaderProvider status.HeaderInformationProvider
	Endpoint             api.AgentEndpointProvider
	GohaiEndpoint        api.AgentEndpointProvider
}

Provides defines the output of the host metadata component

func NewComponent

func NewComponent(deps Requires) Provides

NewComponent creates a new host metadata component

type Requires

type Requires struct {
	compdef.In

	Log        log.Component
	Config     config.Component
	Resources  resources.Component
	Serializer serializer.MetricSerializer
	Hostname   hostnameinterface.Component
}

Requires defines the dependencies for the host metadata component

type StatusProvider

type StatusProvider struct {
	Config   config.Component
	Hostname hostnameinterface.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