disk

Documentation

Overview

Package disk implements an ipfs-cluster informer which can provide different disk-related metrics from the IPFS daemon as an api.Metric.

Index

• Constants
• 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() (raw []byte, err error)
  • func (cfg *Config) Validate() error
• type Informer
  • func NewInformer(cfg *Config) (*Informer, error)
  • func (disk *Informer) GetMetrics(ctx context.Context) []api.Metric
  • func (disk *Informer) Name() string
  • func (disk *Informer) SetClient(c *rpc.Client)
  • func (disk *Informer) Shutdown(ctx context.Context) error
• type MetricType
  • func (t MetricType) String() string

Constants

const (
	DefaultMetricTTL  = 30 * time.Second
	DefaultMetricType = MetricFreeSpace
)

Default values for disk Config

Types

type Config

type Config struct {
	config.Saver

	MetricTTL  time.Duration
	MetricType MetricType
}

Config is used to initialize an Informer and customize the type and parameters of the metric it produces.

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 type of Metric.

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 reads the fields of this Config from a JSON byteslice 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() (raw []byte, err error)

ToJSON generates a JSON-formatted human-friendly 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 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 using the given InformerConfig.

func (*Informer) GetMetrics

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

GetMetrics returns the metric obtained by this Informer. It must always return at least one metric.

func (*Informer) Name

func (disk *Informer) Name() string

Name returns the name of the metric issued by 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(ctx context.Context) error

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

type MetricType

type MetricType int

MetricType identifies the type of metric to fetch from the IPFS daemon.

const (
	// MetricFreeSpace provides the available space reported by IPFS
	MetricFreeSpace MetricType = iota
	// MetricRepoSize provides the used space reported by IPFS
	MetricRepoSize
)

func (MetricType) String

func (t MetricType) String() string

String returns a string representation for MetricType.