numpin

Documentation

Overview

Package numpin implements an ipfs-cluster informer which determines how many items this peer is pinning and returns it as api.Metric

Index

• Constants
• Variables
• type Config
  • func (cfg *Config) ApplyEnvVars() error
  • func (cfg *Config) ConfigKey() string
  • func (cfg *Config) Default() error
  • func (cfg *Config) LoadJSON(raw []byte) error
  • func (cfg *Config) ToDisplayJSON() ([]byte, error)
  • func (cfg *Config) ToJSON() ([]byte, error)
  • func (cfg *Config) Validate() error
• type Informer
  • func NewInformer(cfg *Config) (*Informer, error)
  • func (npi *Informer) GetMetrics(ctx context.Context) []api.Metric
  • func (npi *Informer) Name() string
  • func (npi *Informer) SetClient(c *rpc.Client)
  • func (npi *Informer) Shutdown(ctx context.Context) error

Constants

const (
	DefaultMetricTTL = 10 * time.Second
)

These are the default values for a Config.

Variables

var MetricName = "numpin"

MetricName specifies the name of our metric

Types

type Config

type Config struct {
	config.Saver

	MetricTTL time.Duration
}

Config allows to initialize an Informer.

func (*Config) ApplyEnvVars

func (cfg *Config) ApplyEnvVars() error

ApplyEnvVars fills in any Config fields found as environment variables.

func (*Config) ConfigKey

func (cfg *Config) ConfigKey() string

ConfigKey returns a human-friendly identifier for this Config's type.

func (*Config) Default

func (cfg *Config) Default() error

Default initializes this Config with sensible values.

func (*Config) LoadJSON

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

LoadJSON parses a raw JSON byte-slice as generated by ToJSON().

func (*Config) ToDisplayJSON

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 configuration have sensible values.

type Informer

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

Informer is a simple object to implement the ipfscluster.Informer and Component interfaces

func NewInformer

func NewInformer(cfg *Config) (*Informer, error)

NewInformer returns an initialized Informer.

func (*Informer) GetMetrics

func (npi *Informer) GetMetrics(ctx context.Context) []api.Metric

GetMetrics contacts the IPFSConnector component and requests the `pin ls` command. We return the number of pins in IPFS. It must always return at least one metric.

func (*Informer) Name

func (npi *Informer) Name() string

Name returns the name of this informer

func (*Informer) SetClient

func (npi *Informer) SetClient(c *rpc.Client)

SetClient provides us with an rpc.Client which allows contacting other components in the cluster.

func (*Informer) Shutdown

func (npi *Informer) Shutdown(ctx context.Context) error

Shutdown is called on cluster shutdown. We just invalidate any metrics from this point.