pubsubmon

package

v0.4.0 Latest Latest Go to latest Published: May 30, 2018 License: MIT Imports: 15 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/kishansagathiya/ipfs-cluster

Links

Open Source Insights

Documentation ¶

Overview ¶

Package pubsubmon implements a PeerMonitor component for IPFS Cluster that uses PubSub to send and receive metrics.

Index ¶

Constants
Variables
type Config
type Monitor
- func New(h host.Host, cfg *Config) (*Monitor, error)

Constants ¶

View Source

const (
	DefaultCheckInterval = 15 * time.Second
)

Default values for this Config.

Variables ¶

View Source

var PubsubTopic = "monitor.metrics"

PubsubTopic specifies the topic used to publish Cluster metrics.

Functions ¶

This section is empty.

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 New ¶

func New(h host.Host, cfg *Config) (*Monitor, error)

New creates a new PubSub monitor, using the given host and 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.

Source Files ¶

View all Source files

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL