agentmetrics

Documentation

Overview

Package agentmetrics collects metrics from the agent process itself and submits them to cloud monitoring.

Index

• type HealthMonitor
• type Parameters
• type Service
  • func NewService(ctx context.Context, params Parameters) (*Service, error)
  • func (s *Service) Start(ctx context.Context)

Types

type HealthMonitor

type HealthMonitor interface {
	Register(name string) (*heartbeat.Spec, error)
	GetStatuses() map[string]bool
}

HealthMonitor is anything that can register and monitor entities capable of producing heart beats.

type Parameters

type Parameters struct {
	BackOffs      *cloudmonitoring.BackOffIntervals
	Config        *cfgpb.Configuration
	HealthMonitor HealthMonitor
	// contains filtered or unexported fields
}

Parameters aggregates the potential configuration values and inputs for Service.

type Service

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

Service encapsulates the logic required to collect information on the agent process and to submit the data to cloud monitoring.

func NewService

func NewService(ctx context.Context, params Parameters) (*Service, error)

NewService constructs and initializes a Service instance by using the provided parameters.

func (*Service) Start

func (s *Service) Start(ctx context.Context)

Start performs any initial checks and then begins the collect-submit loop.