metrics

Documentation

Overview

Package metrics tracks various metrics that measure the performance of vouch.

Index

• type AccountManagerMonitor
• type AttestationAggregationMonitor
• type AttestationMonitor
• type BeaconBlockProposalMonitor
• type BeaconCommitteeSubscriptionMonitor
• type ClientMonitor
• type ControllerMonitor
• type SchedulerMonitor
• type Service

Types

type AccountManagerMonitor

type AccountManagerMonitor interface {
	// Accounts sets the number of accounts in a given state.
	Accounts(state string, count uint64)
}

AccountManagerMonitor provides methods to monitor the account manager.

type AttestationAggregationMonitor

type AttestationAggregationMonitor interface {
	// AttestationAggregationCompleted is called when an attestation aggregation process has completed.
	AttestationAggregationCompleted(started time.Time, result string)

	// AttestationAggregationCoverage measures the attestation ratio of the attestation aggregation.
	AttestationAggregationCoverage(frac float64)
}

AttestationAggregationMonitor provides methods to monitor the attestation aggregation process.

type AttestationMonitor

type AttestationMonitor interface {
	// AttestationsCompleted is called when a attestation process has completed.
	AttestationCompleted(started time.Time, result string)
}

AttestationMonitor provides methods to monitor the attestation process.

type BeaconBlockProposalMonitor

type BeaconBlockProposalMonitor interface {
	// BeaconBlockProposalCompleted is called when a block proposal process has completed.
	BeaconBlockProposalCompleted(started time.Time, result string)
}

BeaconBlockProposalMonitor provides methods to monitor the block proposal process.

type BeaconCommitteeSubscriptionMonitor

type BeaconCommitteeSubscriptionMonitor interface {
	// BeaconCommitteeSubscriptionCompleted is called when an beacon committee subscription process has completed.
	BeaconCommitteeSubscriptionCompleted(started time.Time, result string)
	// BeaconCommitteeSubscribers sets the number of beacon committees to which our validators are subscribed.
	BeaconCommitteeSubscribers(subscribers int)
	// BeaconCommitteeAggregators sets the number of beacon committees for which our validators are aggregating.
	BeaconCommitteeAggregators(aggregators int)
}

BeaconCommitteeSubscriptionMonitor provides methods to monitor the outcome of beacon committee subscriptions.

type ClientMonitor

type ClientMonitor interface {
	// ClientOperation provides a generic monitor for client operations.
	ClientOperation(provider string, name string, succeeded bool, duration time.Duration)
}

ClientMonitor provides methods to monitor client connections.

type ControllerMonitor

type ControllerMonitor interface {
	// NewEpoch is called when vouch starts processing a new epoch.
	NewEpoch()
	// BlockDelay provides the delay between the start of a slot and vouch receiving its block.
	BlockDelay(delay time.Duration)
}

ControllerMonitor provides methods to monitor the controller service.

type SchedulerMonitor

type SchedulerMonitor interface {
	// JobScheduled is called when a job is scheduled.
	JobScheduled()
	// JobCancelled is called when a scheduled job is cancelled.
	JobCancelled()
	// JobStartedOnTimer is called when a scheduled job is started due to meeting its time.
	JobStartedOnTimer()
	// JobStartedOnSignal is called when a scheduled job is started due to being manually signal.
	JobStartedOnSignal()
}

SchedulerMonitor provides methods to monitor the scheduler service.

type Service

type Service interface{}

Service is the generic metrics service.