metrics

package

v1.7.1 Latest Latest Go to latest Published: Nov 11, 2023 License: Apache-2.0 Imports: 3 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

This section is empty.

This section is empty.

func RegisterScan(metric *Metric)

RegisterScan fetches a metric handler and enqueues a metric

type Metric struct {
	Scanned int
	Updated int
	Failed  int
}

Metric is the data points of a single scan

func NewMetric(report types.Report) *Metric

NewMetric returns a Metric with the counts taken from the appropriate types.Report fields

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

Metrics is the handler processing all individual scan metrics

func Default() *Metrics

Default creates a new metrics handler if none exists, otherwise returns the existing one

func (metrics *Metrics) HandleUpdate(channel <-chan *Metric)

HandleUpdate dequeue the metric channel and processes it

func (metrics *Metrics) QueueIsEmpty() bool

QueueIsEmpty checks whether any messages are enqueued in the channel

func (metrics *Metrics) Register(metric *Metric)

Register registers metrics for an executed scan