basic

package

v0.10.0 Latest Latest Go to latest Published: Mar 7, 2019 License: Apache-2.0, MIT Imports: 16 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/ipfs/ipfs-cluster

Links

Open Source Insights

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
type Monitor
- func NewMonitor(cfg *Config) (*Monitor, error)

Constants ¶

View Source

const (
	DefaultCheckInterval = 15 * time.Second
)

Default values for this Config.

Variables ¶

This section is empty.

Functions ¶

This section is empty.

Types ¶

type Config ¶ added in v0.2.0

type Config struct {
	config.Saver

	CheckInterval time.Duration
}

Config allows to initialize a Monitor and customize some parameters.

func (*Config) ApplyEnvVars ¶ added in v0.10.0

func (cfg *Config) ApplyEnvVars() error

ApplyEnvVars fills in any Config fields found as environment variables.

func (*Config) ConfigKey ¶ added in v0.2.0

func (cfg *Config) ConfigKey() string

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

func (*Config) Default ¶ added in v0.2.0

func (cfg *Config) Default() error

Default sets the fields of this Config to sensible values.

func (*Config) LoadJSON ¶ added in v0.2.0

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 ¶ added in v0.2.0

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

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

func (*Config) Validate ¶ added in v0.2.0

func (cfg *Config) Validate() error

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

type Monitor ¶ added in v0.2.0

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

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

func NewMonitor ¶ added in v0.2.0

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

NewMonitor creates a new monitor using the given config.

func (*Monitor) Alerts ¶ added in v0.2.0

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 ¶ added in v0.4.0

func (mon *Monitor) LatestMetrics(ctx context.Context, 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 ¶ added in v0.2.0

func (mon *Monitor) LogMetric(ctx context.Context, m *api.Metric) error

LogMetric stores a metric so it can later be retrieved.

func (*Monitor) PublishMetric ¶ added in v0.4.0

func (mon *Monitor) PublishMetric(ctx context.Context, m *api.Metric) error

PublishMetric broadcasts a metric to all current cluster peers.

func (*Monitor) SetClient ¶ added in v0.2.0

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

SetClient saves the given rpc.Client for later use

func (*Monitor) Shutdown ¶ added in v0.2.0

func (mon *Monitor) Shutdown(ctx context.Context) 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