nodestats

package

v1.14.0 Latest Latest Go to latest Published: Mar 25, 2024 License: Apache-2.0 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

View Source

const (
	// PeriodicReportInterval is the interval for generating periodic reports
	PeriodicReportInterval = 5 * time.Minute
)

This section is empty.

This section is empty.

type APILocalStats struct {
	// contains filtered or unexported fields
}

APILocalStats is the struct for getting API stats

func NewAPILocalStats() *APILocalStats

NewAPILocalStats creates a new APILocalStats

func (s *APILocalStats) BuildReport() string

BuildReport builds a report of the API stats

func (s *APILocalStats) ReportCall(report APIReport, size int64)

ReportCall reports a call to the API

type APIReport struct {
	Method       string
	HandlingTime time.Duration
	Success      bool
}

APIReport is the report of an API call

type DiskStatus struct {
	All  uint64 `json:"All"`
	Used uint64 `json:"Used"`
	Free uint64 `json:"Free"`
}

DiskStatus is the status of the disk

type NodeStats struct {
	// contains filtered or unexported fields
}

NodeStats is the struct for getting node stats

func NewNodeStats(stats ...StatsReporter) *NodeStats

NewNodeStats creates a new NodeStats

func (s *NodeStats) Start(ctx context.Context) error

Start starts the node stats

func (s *NodeStats) Stop(ctx context.Context) error

Stop stops the node stats

type StatsReporter interface {
	BuildReport() string
}

StatsReporter is the interface for stats reporter