inspector

Documentation

Overview

Package inspector provides a private endpoint for monitoring status.

Index

• Variables
• type Endpoint
  • func NewEndpoint(log *zap.Logger, pieceStore *pieces.Store, contact *contact.Service, ...) *Endpoint
  • func (inspector *Endpoint) Dashboard(ctx context.Context, in *internalpb.DashboardRequest) (out *internalpb.DashboardResponse, err error)
  • func (inspector *Endpoint) Stats(ctx context.Context, in *internalpb.StatsRequest) (out *internalpb.StatSummaryResponse, err error)

Variables

var (

	// Error is the default error class for piecestore monitor errors.
	Error = errs.Class("piecestore inspector")
)

Types

type Endpoint

type Endpoint struct {
	internalpb.DRPCPieceStoreInspectorUnimplementedServer
	// contains filtered or unexported fields
}

Endpoint implements the inspector endpoints.

architecture: Endpoint

func NewEndpoint

func NewEndpoint(
	log *zap.Logger,
	pieceStore *pieces.Store,
	contact *contact.Service,
	pingStats *contact.PingStats,
	usageDB bandwidth.DB,
	pieceStoreConfig piecestore.OldConfig,
	dashboardAddress net.Addr,
	externalAddress string) *Endpoint

NewEndpoint creates piecestore inspector instance.

func (*Endpoint) Dashboard

func (inspector *Endpoint) Dashboard(ctx context.Context, in *internalpb.DashboardRequest) (out *internalpb.DashboardResponse, err error)

Dashboard returns dashboard information.

func (*Endpoint) Stats

func (inspector *Endpoint) Stats(ctx context.Context, in *internalpb.StatsRequest) (out *internalpb.StatSummaryResponse, err error)

Stats returns current statistics about the storage node.