numpin

package

v1.0.1 Latest Latest Go to latest Published: May 6, 2022 License: Apache-2.0, MIT, Apache-2.0, + 1 more Imports: 11 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

Repository

github.com/ipfs/ipfs-cluster

Links

Open Source Insights

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
type Informer
- func NewInformer(cfg *Config) (*Informer, error)

Constants ¶

View Source

const (
	DefaultMetricTTL = 10 * time.Second
)

These are the default values for a Config.

Variables ¶

View Source

var MetricName = "numpin"

MetricName specifies the name of our metric

Functions ¶

This section is empty.

Types ¶

type Config ¶ added in v0.2.0

type Config struct {
	config.Saver

	MetricTTL time.Duration
}

Config allows to initialize an Informer.

func (*Config) ApplyEnvVars ¶ added in v0.10.0

func (cfg *Config) ApplyEnvVars() error

ApplyEnvVars fills in any Config fields found as environment variables.

func (*Config) ConfigKey ¶ added in v0.2.0

func (cfg *Config) ConfigKey() string

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

func (*Config) Default ¶ added in v0.2.0

func (cfg *Config) Default() error

Default initializes this Config with sensible values.

func (*Config) LoadJSON ¶ added in v0.2.0

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

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

func (*Config) ToDisplayJSON ¶ added in v0.13.0

func (cfg *Config) ToDisplayJSON() ([]byte, error)

ToDisplayJSON returns JSON config as a string.

func (*Config) ToJSON ¶ added in v0.2.0

func (cfg *Config) ToJSON() ([]byte, error)

ToJSON generates a human-friendly JSON representation of this Config.

func (*Config) Validate ¶ added in v0.2.0

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 ¶ added in v0.14.2

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.

Source Files ¶

View all Source files

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL