basic

Documentation

Overview

Package basic implements a basic PeerMonitor component for IPFS Cluster. This component is in charge of logging metrics and triggering alerts when a peer goes down.

Index

• Constants
• type Config
  • func (cfg *Config) ConfigKey() string
  • func (cfg *Config) Default() error
  • func (cfg *Config) LoadJSON(raw []byte) error
  • func (cfg *Config) ToJSON() ([]byte, error)
  • func (cfg *Config) Validate() error
• type Monitor
  • func NewMonitor(cfg *Config) (*Monitor, error)
  • func (mon *Monitor) Alerts() <-chan api.Alert
  • func (mon *Monitor) LatestMetrics(name string) []api.Metric
  • func (mon *Monitor) LogMetric(m api.Metric) error
  • func (mon *Monitor) PublishMetric(m api.Metric) error
  • func (mon *Monitor) SetClient(c *rpc.Client)
  • func (mon *Monitor) Shutdown() error

Constants

const (
	DefaultCheckInterval = 15 * time.Second
)

Default values for this Config.

Types

type Config

type Config struct {
	config.Saver

	CheckInterval time.Duration
}

Config allows to initialize a Monitor and customize some parameters.

func (*Config) ConfigKey

func (cfg *Config) ConfigKey() string

ConfigKey provides a human-friendly identifier for this type of Config.

func (*Config) Default

func (cfg *Config) Default() error

Default sets the fields of this Config to sensible values.

func (*Config) LoadJSON

func (cfg *Config) LoadJSON(raw []byte) error

LoadJSON sets the fields of this Config to the values defined by the JSON representation of it, as generated by ToJSON.

func (*Config) ToJSON

func (cfg *Config) ToJSON() ([]byte, error)

ToJSON generates a human-friendly JSON representation of this Config.

func (*Config) Validate

func (cfg *Config) Validate() error

Validate checks that the fields of this Config have working values, at least in appearance.

type Monitor

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

Monitor is a component in charge of monitoring peers, logging metrics and detecting failures

func NewMonitor

func NewMonitor(cfg *Config) (*Monitor, error)

NewMonitor creates a new monitor using the given config.

func (*Monitor) Alerts

func (mon *Monitor) Alerts() <-chan api.Alert

Alerts returns a channel on which alerts are sent when the monitor detects a failure.

func (*Monitor) LatestMetrics

func (mon *Monitor) LatestMetrics(name string) []api.Metric

LatestMetrics returns last known VALID metrics of a given type. A metric is only valid if it has not expired and belongs to a current cluster peers.

func (*Monitor) LogMetric

func (mon *Monitor) LogMetric(m api.Metric) error

LogMetric stores a metric so it can later be retrieved.

func (*Monitor) PublishMetric

func (mon *Monitor) PublishMetric(m api.Metric) error

PublishMetric broadcasts a metric to all current cluster peers.

func (*Monitor) SetClient

func (mon *Monitor) SetClient(c *rpc.Client)

SetClient saves the given rpc.Client for later use

func (*Monitor) Shutdown

func (mon *Monitor) Shutdown() error

Shutdown stops the peer monitor. It particular, it will not deliver any alerts.