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

• Variables
• type Informer
  • func NewInformer() *Informer
  • func (npi *Informer) GetMetric() api.Metric
  • func (npi *Informer) Name() string
  • func (npi *Informer) SetClient(c *rpc.Client)
  • func (npi *Informer) Shutdown() error

Variables

var MetricName = "numpin"

MetricName specifies the name of our metric

var MetricTTL = 10

MetricTTL specifies how long our reported metric is valid in seconds.

Types

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() *Informer

NewInformer returns an initialized Informer.

func (*Informer) GetMetric

func (npi *Informer) GetMetric() api.Metric

GetMetric contacts the IPFSConnector component and requests the `pin ls` command. We return the number of pins in IPFS.

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() error

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