2017-02-13 15:46:53 +00:00
|
|
|
// Package numpin implements an ipfs-cluster informer which determines how many
|
|
|
|
// items this peer is pinning and returns it as api.Metric
|
|
|
|
package numpin
|
|
|
|
|
|
|
|
import (
|
2018-06-27 04:03:15 +00:00
|
|
|
"context"
|
2017-02-13 15:46:53 +00:00
|
|
|
"fmt"
|
2022-03-22 09:56:16 +00:00
|
|
|
"sync"
|
2017-02-13 15:46:53 +00:00
|
|
|
|
2022-06-15 09:19:17 +00:00
|
|
|
"github.com/ipfs-cluster/ipfs-cluster/api"
|
2019-06-14 10:41:11 +00:00
|
|
|
|
2018-10-17 13:28:03 +00:00
|
|
|
rpc "github.com/libp2p/go-libp2p-gorpc"
|
2017-02-13 15:46:53 +00:00
|
|
|
|
2018-06-27 04:03:15 +00:00
|
|
|
"go.opencensus.io/trace"
|
2017-02-13 15:46:53 +00:00
|
|
|
)
|
|
|
|
|
|
|
|
// MetricName specifies the name of our metric
|
|
|
|
var MetricName = "numpin"
|
|
|
|
|
|
|
|
// Informer is a simple object to implement the ipfscluster.Informer
|
|
|
|
// and Component interfaces
|
|
|
|
type Informer struct {
|
2022-03-22 09:56:16 +00:00
|
|
|
config *Config
|
|
|
|
|
|
|
|
mu sync.Mutex
|
2017-02-13 15:46:53 +00:00
|
|
|
rpcClient *rpc.Client
|
|
|
|
}
|
|
|
|
|
2017-02-15 14:16:16 +00:00
|
|
|
// NewInformer returns an initialized Informer.
|
Issue #162: Rework configuration format
The following commit reimplements ipfs-cluster configuration under
the following premises:
* Each component is initialized with a configuration object
defined by its module
* Each component decides how the JSON representation of its
configuration looks like
* Each component parses and validates its own configuration
* Each component exposes its own defaults
* Component configurations are make the sections of a
central JSON configuration file (which replaces the current
JSON format)
* Component configurations implement a common interface
(config.ComponentConfig) with a set of common operations
* The central configuration file is managed by a
config.ConfigManager which:
* Registers ComponentConfigs
* Assigns the correspondent sections from the JSON file to each
component and delegates the parsing
* Delegates the JSON generation for each section
* Can be notified when the configuration is updated and must be
saved to disk
The new service.json would then look as follows:
```json
{
"cluster": {
"id": "QmTVW8NoRxC5wBhV7WtAYtRn7itipEESfozWN5KmXUQnk2",
"private_key": "<...>",
"secret": "00224102ae6aaf94f2606abf69a0e278251ecc1d64815b617ff19d6d2841f786",
"peers": [],
"bootstrap": [],
"leave_on_shutdown": false,
"listen_multiaddress": "/ip4/0.0.0.0/tcp/9096",
"state_sync_interval": "1m0s",
"ipfs_sync_interval": "2m10s",
"replication_factor": -1,
"monitor_ping_interval": "15s"
},
"consensus": {
"raft": {
"heartbeat_timeout": "1s",
"election_timeout": "1s",
"commit_timeout": "50ms",
"max_append_entries": 64,
"trailing_logs": 10240,
"snapshot_interval": "2m0s",
"snapshot_threshold": 8192,
"leader_lease_timeout": "500ms"
}
},
"api": {
"restapi": {
"listen_multiaddress": "/ip4/127.0.0.1/tcp/9094",
"read_timeout": "30s",
"read_header_timeout": "5s",
"write_timeout": "1m0s",
"idle_timeout": "2m0s"
}
},
"ipfs_connector": {
"ipfshttp": {
"proxy_listen_multiaddress": "/ip4/127.0.0.1/tcp/9095",
"node_multiaddress": "/ip4/127.0.0.1/tcp/5001",
"connect_swarms_delay": "7s",
"proxy_read_timeout": "10m0s",
"proxy_read_header_timeout": "5s",
"proxy_write_timeout": "10m0s",
"proxy_idle_timeout": "1m0s"
}
},
"monitor": {
"monbasic": {
"check_interval": "15s"
}
},
"informer": {
"disk": {
"metric_ttl": "30s",
"metric_type": "freespace"
},
"numpin": {
"metric_ttl": "10s"
}
}
}
```
This new format aims to be easily extensible per component. As such,
it already surfaces quite a few new options which were hardcoded
before.
Additionally, since Go API have changed, some redundant methods have been
removed and small refactoring has happened to take advantage of the new
way.
License: MIT
Signed-off-by: Hector Sanjuan <hector@protocol.ai>
2017-10-11 18:23:03 +00:00
|
|
|
func NewInformer(cfg *Config) (*Informer, error) {
|
|
|
|
err := cfg.Validate()
|
|
|
|
if err != nil {
|
|
|
|
return nil, err
|
|
|
|
}
|
|
|
|
|
|
|
|
return &Informer{
|
|
|
|
config: cfg,
|
|
|
|
}, nil
|
2017-02-13 15:46:53 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
// SetClient provides us with an rpc.Client which allows
|
|
|
|
// contacting other components in the cluster.
|
|
|
|
func (npi *Informer) SetClient(c *rpc.Client) {
|
2022-03-22 09:56:16 +00:00
|
|
|
npi.mu.Lock()
|
2017-02-13 15:46:53 +00:00
|
|
|
npi.rpcClient = c
|
2022-03-22 09:56:16 +00:00
|
|
|
npi.mu.Unlock()
|
2017-02-13 15:46:53 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
// Shutdown is called on cluster shutdown. We just invalidate
|
|
|
|
// any metrics from this point.
|
2018-06-27 04:03:15 +00:00
|
|
|
func (npi *Informer) Shutdown(ctx context.Context) error {
|
2020-04-14 17:58:00 +00:00
|
|
|
_, span := trace.StartSpan(ctx, "informer/numpin/Shutdown")
|
2018-06-27 04:03:15 +00:00
|
|
|
defer span.End()
|
|
|
|
|
2022-03-22 09:56:16 +00:00
|
|
|
npi.mu.Lock()
|
2017-02-13 15:46:53 +00:00
|
|
|
npi.rpcClient = nil
|
2022-03-22 09:56:16 +00:00
|
|
|
npi.mu.Unlock()
|
2017-02-13 15:46:53 +00:00
|
|
|
return nil
|
|
|
|
}
|
|
|
|
|
|
|
|
// Name returns the name of this informer
|
|
|
|
func (npi *Informer) Name() string {
|
|
|
|
return MetricName
|
|
|
|
}
|
|
|
|
|
2021-09-13 12:12:36 +00:00
|
|
|
// 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.
|
2022-03-19 01:52:46 +00:00
|
|
|
func (npi *Informer) GetMetrics(ctx context.Context) []api.Metric {
|
2018-06-27 04:03:15 +00:00
|
|
|
ctx, span := trace.StartSpan(ctx, "informer/numpin/GetMetric")
|
|
|
|
defer span.End()
|
|
|
|
|
2022-03-22 09:56:16 +00:00
|
|
|
npi.mu.Lock()
|
|
|
|
rpcClient := npi.rpcClient
|
|
|
|
npi.mu.Unlock()
|
|
|
|
|
|
|
|
if rpcClient == nil {
|
2022-03-19 01:52:46 +00:00
|
|
|
return []api.Metric{
|
|
|
|
{
|
|
|
|
Valid: false,
|
|
|
|
},
|
|
|
|
}
|
2017-02-13 15:46:53 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
// make use of the RPC API to obtain information
|
|
|
|
// about the number of pins in IPFS. See RPCAPI docs.
|
2022-03-22 09:56:16 +00:00
|
|
|
in := make(chan []string, 1)
|
|
|
|
in <- []string{"recursive", "direct"}
|
|
|
|
close(in)
|
|
|
|
out := make(chan api.IPFSPinInfo, 1024)
|
|
|
|
|
|
|
|
errCh := make(chan error, 1)
|
|
|
|
go func() {
|
|
|
|
defer close(errCh)
|
|
|
|
err := rpcClient.Stream(
|
|
|
|
ctx,
|
|
|
|
"", // Local call
|
|
|
|
"IPFSConnector", // Service name
|
|
|
|
"PinLs", // Method name
|
|
|
|
in,
|
|
|
|
out,
|
|
|
|
)
|
|
|
|
errCh <- err
|
|
|
|
}()
|
|
|
|
|
|
|
|
n := 0
|
|
|
|
for range out {
|
|
|
|
n++
|
|
|
|
}
|
|
|
|
|
|
|
|
err := <-errCh
|
2017-02-13 15:46:53 +00:00
|
|
|
|
|
|
|
valid := err == nil
|
|
|
|
|
2022-03-19 01:52:46 +00:00
|
|
|
m := api.Metric{
|
2021-10-06 12:10:06 +00:00
|
|
|
Name: MetricName,
|
2022-03-22 09:56:16 +00:00
|
|
|
Value: fmt.Sprintf("%d", n),
|
2021-10-06 12:10:06 +00:00
|
|
|
Valid: valid,
|
|
|
|
Partitionable: false,
|
2017-02-13 15:46:53 +00:00
|
|
|
}
|
|
|
|
|
2018-05-07 06:50:03 +00:00
|
|
|
m.SetTTL(npi.config.MetricTTL)
|
2022-03-19 01:52:46 +00:00
|
|
|
return []api.Metric{m}
|
2017-02-13 15:46:53 +00:00
|
|
|
}
|