numpin

package

v0.0.0-...-857e381 Latest Latest Go to latest Published: Feb 15, 2017 License: MIT Imports: 3 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

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

This section is empty.

View Source

var MetricName = "numpin"

MetricName specifies the name of our metric

View Source

var MetricTTL = 10

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

This section is empty.

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

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

func NewInformer() *Informer

NewInformer returns an initialized Informer.

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

Name returns the name of this informer

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

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

func (npi *Informer) Shutdown() error

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