pubsubmon

package

v1.0.1 Latest Latest Go to latest Published: May 6, 2022 License: Apache-2.0, MIT, Apache-2.0, + 1 more 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 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(ctx context.Context, cfg *Config, psub *pubsub.PubSub, peers PeersFunc) (*Monitor, error)
type PeersFunc

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) ApplyEnvVars ¶ added in v0.10.0

func (cfg *Config) ApplyEnvVars() error

ApplyEnvVars fills in any Config fields found as environment variables.

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) ToDisplayJSON ¶ added in v0.13.0

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

ToDisplayJSON returns JSON config as a string.

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(
	ctx context.Context,
	cfg *Config,
	psub *pubsub.PubSub,
	peers PeersFunc,
) (*Monitor, error)

New creates a new PubSub monitor, using the given host, config and PeersFunc. The PeersFunc can be nil. In this case, no metric filtering is done based on peers (any peer is considered part of the peerset).

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) LatestForPeer ¶ added in v0.14.5

func (mon *Monitor) LatestForPeer(ctx context.Context, name string, pid peer.ID) api.Metric

LatestForPeer returns the latest metric received for a peer (it may have expired). It returns nil if no metric exists.

func (*Monitor) LatestMetrics ¶

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 peer.

func (*Monitor) LogMetric ¶

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

LogMetric stores a metric so it can later be retrieved.

func (*Monitor) MetricNames ¶ added in v0.12.0

func (mon *Monitor) MetricNames(ctx context.Context) []string

MetricNames lists all metric names.

func (*Monitor) PublishMetric ¶

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

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

type PeersFunc ¶ added in v0.11.0

type PeersFunc func(context.Context) ([]peer.ID, error)

PeersFunc allows the Monitor to filter and discard metrics that do not belong to a given peerset.

Source Files ¶

View all Source files

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