453 lines
11 KiB
Go
453 lines
11 KiB
Go
// Copyright (C) 2018 Storj Labs, Inc.
|
|
// See LICENSE for copying information.
|
|
|
|
package main
|
|
|
|
import (
|
|
"bufio"
|
|
"context"
|
|
"encoding/csv"
|
|
"flag"
|
|
"fmt"
|
|
"io"
|
|
"os"
|
|
"strconv"
|
|
|
|
"github.com/gogo/protobuf/jsonpb"
|
|
"github.com/spf13/cobra"
|
|
"github.com/zeebo/errs"
|
|
"go.uber.org/zap"
|
|
|
|
"storj.io/storj/pkg/pb"
|
|
"storj.io/storj/pkg/process"
|
|
"storj.io/storj/pkg/provider"
|
|
"storj.io/storj/pkg/storj"
|
|
"storj.io/storj/pkg/transport"
|
|
)
|
|
|
|
var (
|
|
// Addr is the address of Capt Planet from command flags
|
|
Addr = flag.String("address", "[::1]:7778", "address of captplanet to inspect")
|
|
|
|
// ErrInspectorDial throws when there are errors dialing the inspector server
|
|
ErrInspectorDial = errs.Class("error dialing inspector server:")
|
|
|
|
// ErrRequest is for gRPC request errors after dialing
|
|
ErrRequest = errs.Class("error processing request:")
|
|
|
|
// ErrIdentity is for errors during identity creation for this CLI
|
|
ErrIdentity = errs.Class("error creating identity:")
|
|
|
|
// ErrArgs throws when there are errors with CLI args
|
|
ErrArgs = errs.Class("error with CLI args:")
|
|
|
|
// Commander CLI
|
|
rootCmd = &cobra.Command{
|
|
Use: "inspector",
|
|
Short: "CLI for interacting with Storj Kademlia network",
|
|
}
|
|
kadCmd = &cobra.Command{
|
|
Use: "kad",
|
|
Short: "commands for kademlia/overlay cache",
|
|
}
|
|
statsCmd = &cobra.Command{
|
|
Use: "statdb",
|
|
Short: "commands for statdb",
|
|
}
|
|
countNodeCmd = &cobra.Command{
|
|
Use: "count",
|
|
Short: "count nodes in kademlia and overlay",
|
|
RunE: CountNodes,
|
|
}
|
|
getBucketsCmd = &cobra.Command{
|
|
Use: "list-buckets",
|
|
Short: "get all buckets in overlay",
|
|
RunE: GetBuckets,
|
|
}
|
|
getBucketCmd = &cobra.Command{
|
|
Use: "ls <bucket_id>",
|
|
Short: "get all nodes in bucket",
|
|
Args: cobra.MinimumNArgs(1),
|
|
RunE: GetBucket,
|
|
}
|
|
pingNodeCmd = &cobra.Command{
|
|
Use: "ping <node_id> <ip:port>",
|
|
Short: "ping node at provided ID",
|
|
Args: cobra.MinimumNArgs(2),
|
|
RunE: PingNode,
|
|
}
|
|
lookupNodeCmd = &cobra.Command{
|
|
Use: "lookup <node_id>",
|
|
Short: "lookup a node by ID only",
|
|
Args: cobra.MinimumNArgs(1),
|
|
RunE: LookupNode,
|
|
}
|
|
getStatsCmd = &cobra.Command{
|
|
Use: "getstats <node_id>",
|
|
Short: "Get node stats",
|
|
Args: cobra.MinimumNArgs(1),
|
|
RunE: GetStats,
|
|
}
|
|
getCSVStatsCmd = &cobra.Command{
|
|
Use: "getcsvstats <path to node ID csv file>",
|
|
Short: "Get node stats from csv",
|
|
Args: cobra.MinimumNArgs(1),
|
|
RunE: GetCSVStats,
|
|
}
|
|
createStatsCmd = &cobra.Command{
|
|
// TODO: add args to usage
|
|
Use: "createstats",
|
|
Short: "Create node with stats",
|
|
Args: cobra.MinimumNArgs(5), // id, auditct, auditsuccessct, uptimect, uptimesuccessct
|
|
RunE: CreateStats,
|
|
}
|
|
createCSVStatsCmd = &cobra.Command{
|
|
// TODO: add args to usage
|
|
Use: "createcsvstats",
|
|
Short: "Create node stats from csv",
|
|
Args: cobra.MinimumNArgs(1),
|
|
RunE: CreateCSVStats,
|
|
}
|
|
)
|
|
|
|
// Inspector gives access to kademlia and overlay cache
|
|
type Inspector struct {
|
|
identity *provider.FullIdentity
|
|
client pb.InspectorClient
|
|
}
|
|
|
|
// NewInspector creates a new gRPC inspector server for access to kad
|
|
// and the overlay cache
|
|
func NewInspector(address string) (*Inspector, error) {
|
|
ctx := context.Background()
|
|
identity, err := provider.NewFullIdentity(ctx, 12, 4)
|
|
if err != nil {
|
|
return &Inspector{}, ErrIdentity.Wrap(err)
|
|
}
|
|
|
|
tc := transport.NewClient(identity)
|
|
conn, err := tc.DialAddress(ctx, address)
|
|
if err != nil {
|
|
return &Inspector{}, ErrInspectorDial.Wrap(err)
|
|
}
|
|
|
|
c := pb.NewInspectorClient(conn)
|
|
|
|
return &Inspector{
|
|
identity: identity,
|
|
client: c,
|
|
}, nil
|
|
}
|
|
|
|
// CountNodes returns the number of nodes in the cache and kademlia
|
|
func CountNodes(cmd *cobra.Command, args []string) (err error) {
|
|
i, err := NewInspector(*Addr)
|
|
if err != nil {
|
|
return ErrInspectorDial.Wrap(err)
|
|
}
|
|
|
|
count, err := i.client.CountNodes(context.Background(), &pb.CountNodesRequest{})
|
|
if err != nil {
|
|
return ErrRequest.Wrap(err)
|
|
}
|
|
|
|
fmt.Printf("---------- \n - Kademlia: %+v\n - Overlay: %+v\n", count.Kademlia, count.Overlay)
|
|
return nil
|
|
}
|
|
|
|
// GetBuckets returns all buckets in the overlay cache's routing table
|
|
func GetBuckets(cmd *cobra.Command, args []string) (err error) {
|
|
i, err := NewInspector(*Addr)
|
|
if err != nil {
|
|
return ErrInspectorDial.Wrap(err)
|
|
}
|
|
|
|
buckets, err := i.client.GetBuckets(context.Background(), &pb.GetBucketsRequest{})
|
|
if err != nil {
|
|
return ErrRequest.Wrap(err)
|
|
}
|
|
|
|
fmt.Printf("Buckets ---------------- \n Total Buckets: %+v\n", buckets.Total)
|
|
|
|
for index, b := range buckets.Ids {
|
|
fmt.Printf("%+v %+v\n", index, b)
|
|
}
|
|
return nil
|
|
}
|
|
|
|
// GetBucket returns a bucket with given `id`
|
|
func GetBucket(cmd *cobra.Command, args []string) (err error) {
|
|
i, err := NewInspector(*Addr)
|
|
if err != nil {
|
|
return ErrInspectorDial.Wrap(err)
|
|
}
|
|
nodeID, err := storj.NodeIDFromString(args[0])
|
|
if err != nil {
|
|
return err
|
|
}
|
|
|
|
bucket, err := i.client.GetBucket(context.Background(), &pb.GetBucketRequest{
|
|
Id: nodeID,
|
|
})
|
|
|
|
if err != nil {
|
|
return ErrRequest.Wrap(err)
|
|
}
|
|
|
|
fmt.Println(prettyPrintBucket(bucket))
|
|
return nil
|
|
}
|
|
|
|
// LookupNode starts a Kademlia lookup for the provided Node ID
|
|
func LookupNode(cmd *cobra.Command, args []string) (err error) {
|
|
i, err := NewInspector(*Addr)
|
|
if err != nil {
|
|
return ErrInspectorDial.Wrap(err)
|
|
}
|
|
|
|
n, err := i.client.LookupNode(context.Background(), &pb.LookupNodeRequest{
|
|
Id: args[0],
|
|
})
|
|
|
|
if err != nil {
|
|
return ErrRequest.Wrap(err)
|
|
}
|
|
|
|
fmt.Println(prettyPrintNode(n))
|
|
|
|
return nil
|
|
}
|
|
|
|
func prettyPrintNode(n *pb.LookupNodeResponse) string {
|
|
m := jsonpb.Marshaler{Indent: " ", EmitDefaults: false}
|
|
s, err := m.MarshalToString(n)
|
|
if err != nil {
|
|
zap.S().Error("error marshaling node: %s", n)
|
|
}
|
|
return s
|
|
}
|
|
|
|
func prettyPrintBucket(b *pb.GetBucketResponse) string {
|
|
m := jsonpb.Marshaler{Indent: " ", EmitDefaults: false}
|
|
s, err := m.MarshalToString(b)
|
|
if err != nil {
|
|
zap.S().Error("error marshaling bucket: %s", b.Id)
|
|
}
|
|
return s
|
|
}
|
|
|
|
// PingNode sends a PING RPC across the Kad network to check node availability
|
|
func PingNode(cmd *cobra.Command, args []string) (err error) {
|
|
nodeID, err := storj.NodeIDFromString(args[0])
|
|
if err != nil {
|
|
return err
|
|
}
|
|
|
|
i, err := NewInspector(*Addr)
|
|
if err != nil {
|
|
return ErrInspectorDial.Wrap(err)
|
|
}
|
|
|
|
fmt.Printf("Pinging node %s at %s", args[0], args[1])
|
|
|
|
p, err := i.client.PingNode(context.Background(), &pb.PingNodeRequest{
|
|
Id: nodeID,
|
|
Address: args[1],
|
|
})
|
|
|
|
var okayString string
|
|
if p.Ok {
|
|
okayString = "OK"
|
|
} else {
|
|
okayString = "Error"
|
|
}
|
|
fmt.Printf("\n -- Ping response: %s\n", okayString)
|
|
if err != nil {
|
|
fmt.Printf(" -- Error: %s", err)
|
|
}
|
|
return nil
|
|
}
|
|
|
|
// GetStats gets a node's stats from statdb
|
|
func GetStats(cmd *cobra.Command, args []string) (err error) {
|
|
i, err := NewInspector(*Addr)
|
|
if err != nil {
|
|
return ErrInspectorDial.Wrap(err)
|
|
}
|
|
|
|
nodeID, err := storj.NodeIDFromString(args[0])
|
|
if err != nil {
|
|
return err
|
|
}
|
|
|
|
res, err := i.client.GetStats(context.Background(), &pb.GetStatsRequest{
|
|
NodeId: nodeID,
|
|
})
|
|
if err != nil {
|
|
return ErrRequest.Wrap(err)
|
|
}
|
|
|
|
fmt.Printf("Stats for ID %s:\n", nodeID)
|
|
fmt.Printf("AuditSuccessRatio: %f, AuditCount: %d, UptimeRatio: %f, UptimeCount: %d,\n",
|
|
res.AuditRatio, res.AuditCount, res.UptimeRatio, res.UptimeCount)
|
|
return nil
|
|
}
|
|
|
|
// GetCSVStats gets node stats from statdb based on a csv
|
|
func GetCSVStats(cmd *cobra.Command, args []string) (err error) {
|
|
i, err := NewInspector(*Addr)
|
|
if err != nil {
|
|
return ErrInspectorDial.Wrap(err)
|
|
}
|
|
|
|
// get csv
|
|
csvPath := args[0]
|
|
csvFile, _ := os.Open(csvPath)
|
|
reader := csv.NewReader(bufio.NewReader(csvFile))
|
|
for {
|
|
line, err := reader.Read()
|
|
if err == io.EOF {
|
|
break
|
|
} else if err != nil {
|
|
return ErrArgs.Wrap(err)
|
|
}
|
|
|
|
nodeID, err := storj.NodeIDFromString(line[0])
|
|
if err != nil {
|
|
return err
|
|
}
|
|
res, err := i.client.GetStats(context.Background(), &pb.GetStatsRequest{
|
|
NodeId: nodeID,
|
|
})
|
|
if err != nil {
|
|
return ErrRequest.Wrap(err)
|
|
}
|
|
|
|
fmt.Printf("Stats for ID %s:\n", nodeID)
|
|
fmt.Printf("AuditSuccessRatio: %f, AuditCount: %d, UptimeRatio: %f, UptimeCount: %d,\n",
|
|
res.AuditRatio, res.AuditCount, res.UptimeRatio, res.UptimeCount)
|
|
}
|
|
return nil
|
|
}
|
|
|
|
// CreateStats creates a node with stats in statdb
|
|
func CreateStats(cmd *cobra.Command, args []string) (err error) {
|
|
i, err := NewInspector(*Addr)
|
|
if err != nil {
|
|
return ErrInspectorDial.Wrap(err)
|
|
}
|
|
|
|
nodeID, err := storj.NodeIDFromString(args[0])
|
|
if err != nil {
|
|
return err
|
|
}
|
|
auditCount, err := strconv.ParseInt(args[1], 10, 64)
|
|
if err != nil {
|
|
return ErrArgs.New("audit count must be an int")
|
|
}
|
|
auditSuccessCount, err := strconv.ParseInt(args[2], 10, 64)
|
|
if err != nil {
|
|
return ErrArgs.New("audit success count must be an int")
|
|
}
|
|
uptimeCount, err := strconv.ParseInt(args[3], 10, 64)
|
|
if err != nil {
|
|
return ErrArgs.New("uptime count must be an int")
|
|
}
|
|
uptimeSuccessCount, err := strconv.ParseInt(args[4], 10, 64)
|
|
if err != nil {
|
|
return ErrArgs.New("uptime success count must be an int")
|
|
}
|
|
|
|
_, err = i.client.CreateStats(context.Background(), &pb.CreateStatsRequest{
|
|
NodeId: nodeID,
|
|
AuditCount: auditCount,
|
|
AuditSuccessCount: auditSuccessCount,
|
|
UptimeCount: uptimeCount,
|
|
UptimeSuccessCount: uptimeSuccessCount,
|
|
})
|
|
if err != nil {
|
|
return ErrRequest.Wrap(err)
|
|
}
|
|
|
|
fmt.Printf("Created statdb entry for ID %s\n", nodeID)
|
|
return nil
|
|
}
|
|
|
|
// CreateCSVStats creates node with stats in statdb based on a CSV
|
|
func CreateCSVStats(cmd *cobra.Command, args []string) (err error) {
|
|
i, err := NewInspector(*Addr)
|
|
if err != nil {
|
|
return ErrInspectorDial.Wrap(err)
|
|
}
|
|
|
|
// get csv
|
|
csvPath := args[0]
|
|
csvFile, _ := os.Open(csvPath)
|
|
reader := csv.NewReader(bufio.NewReader(csvFile))
|
|
for {
|
|
line, err := reader.Read()
|
|
if err == io.EOF {
|
|
break
|
|
} else if err != nil {
|
|
return ErrArgs.Wrap(err)
|
|
}
|
|
|
|
nodeID, err := storj.NodeIDFromString(line[0])
|
|
if err != nil {
|
|
return err
|
|
}
|
|
auditCount, err := strconv.ParseInt(line[1], 10, 64)
|
|
if err != nil {
|
|
return ErrArgs.New("audit count must be an int")
|
|
}
|
|
auditSuccessCount, err := strconv.ParseInt(line[2], 10, 64)
|
|
if err != nil {
|
|
return ErrArgs.New("audit success count must be an int")
|
|
}
|
|
uptimeCount, err := strconv.ParseInt(line[3], 10, 64)
|
|
if err != nil {
|
|
return ErrArgs.New("uptime count must be an int")
|
|
}
|
|
uptimeSuccessCount, err := strconv.ParseInt(line[4], 10, 64)
|
|
if err != nil {
|
|
return ErrArgs.New("uptime success count must be an int")
|
|
}
|
|
|
|
_, err = i.client.CreateStats(context.Background(), &pb.CreateStatsRequest{
|
|
NodeId: nodeID,
|
|
AuditCount: auditCount,
|
|
AuditSuccessCount: auditSuccessCount,
|
|
UptimeCount: uptimeCount,
|
|
UptimeSuccessCount: uptimeSuccessCount,
|
|
})
|
|
if err != nil {
|
|
return ErrRequest.Wrap(err)
|
|
}
|
|
|
|
fmt.Printf("Created statdb entry for ID %s\n", nodeID)
|
|
}
|
|
return nil
|
|
}
|
|
|
|
func init() {
|
|
rootCmd.AddCommand(kadCmd)
|
|
rootCmd.AddCommand(statsCmd)
|
|
|
|
kadCmd.AddCommand(countNodeCmd)
|
|
kadCmd.AddCommand(getBucketsCmd)
|
|
kadCmd.AddCommand(getBucketCmd)
|
|
kadCmd.AddCommand(pingNodeCmd)
|
|
kadCmd.AddCommand(lookupNodeCmd)
|
|
|
|
statsCmd.AddCommand(getStatsCmd)
|
|
statsCmd.AddCommand(getCSVStatsCmd)
|
|
statsCmd.AddCommand(createStatsCmd)
|
|
statsCmd.AddCommand(createCSVStatsCmd)
|
|
|
|
flag.Parse()
|
|
}
|
|
|
|
func main() {
|
|
process.Exec(rootCmd)
|
|
}
|