disk

Documentation

Overview

Package disk implements an ipfs-cluster informer which determines the current RepoSize of the ipfs daemon datastore and returns it as an api.Metric.

Index

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

Variables

var MetricName = "disk"

MetricName specifies the name of our metric

var MetricTTL = 30

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 (disk *Informer) GetMetric() api.Metric

GetMetric uses the IPFSConnector the current repository size and returns it in a metric.

func (*Informer) Name

func (disk *Informer) Name() string

Name returns the name of this informer.

func (*Informer) SetClient

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

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

func (*Informer) Shutdown

func (disk *Informer) Shutdown() error

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