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
• type SignerMonitor
• type SyncCommitteeAggregationMonitor
• type SyncCommitteeMessageMonitor
• type SyncCommitteeSubscriptionMonitor
• type SyncCommitteeVerificationMonitor
• type ValidatorsManagerMonitor

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, slot phase0.Slot, 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 an attestation process has completed.
	AttestationsCompleted(started time.Time, slot phase0.Slot, count int, 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, slot phase0.Slot, result string)

	// BeaconBlockProposalSource is called to tag the source of a beacon block proposal.
	BeaconBlockProposalSource(source string)
}

BeaconBlockProposalMonitor provides methods to monitor the block proposal process.

type BeaconCommitteeSubscriptionMonitor

type BeaconCommitteeSubscriptionMonitor interface {
	// BeaconCommitteeSubscriptionCompleted is called when a 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)
	// StrategyOperation provides a generic monitor for strategy operations.
	StrategyOperation(strategy string, provider string, operation string, 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(epochSlot uint, 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(class string)
	// JobCancelled is called when a scheduled job is cancelled.
	JobCancelled(class string)
	// JobStartedOnTimer is called when a scheduled job is started due to meeting its time.
	JobStartedOnTimer(class string)
	// JobStartedOnSignal is called when a scheduled job is started due to being manually signal.
	JobStartedOnSignal(class string)
}

SchedulerMonitor provides methods to monitor the scheduler service.

type Service

type Service interface {
	// Presenter provides the presenter for this service.
	Presenter() string
}

Service is the generic metrics service.

type SignerMonitor

type SignerMonitor interface{}

SignerMonitor provides methods to monitor signers.

type SyncCommitteeAggregationMonitor

type SyncCommitteeAggregationMonitor interface {
	// SyncCommitteeAggregationsCompleted is called when a sync committee aggregation process has completed.
	SyncCommitteeAggregationsCompleted(started time.Time, slot phase0.Slot, count int, result string)

	// SyncCommitteeAggregationCoverage measures the contribution ratio of the sync committee aggregation.
	SyncCommitteeAggregationCoverage(frac float64)
}

SyncCommitteeAggregationMonitor provides methods to monitor the sync committee aggregation process.

type SyncCommitteeMessageMonitor

type SyncCommitteeMessageMonitor interface {
	// SyncCommitteeMessagesCompleted is called when a sync committee message process has completed.
	SyncCommitteeMessagesCompleted(started time.Time, slot phase0.Slot, count int, result string)
}

SyncCommitteeMessageMonitor provides methods to monitor the sync committee message process.

type SyncCommitteeSubscriptionMonitor

type SyncCommitteeSubscriptionMonitor interface {
	// SyncCommitteeSubscriptionCompleted is called when a sync committee subscription process has completed.
	SyncCommitteeSubscriptionCompleted(started time.Time, result string)
	// SyncCommitteeSubscribers sets the number of sync committees to which our validators are subscribed.
	SyncCommitteeSubscribers(subscribers int)
}

SyncCommitteeSubscriptionMonitor provides methods to monitor the outcome of sync committee subscriptions.

type SyncCommitteeVerificationMonitor

type SyncCommitteeVerificationMonitor interface {
	// SyncCommitteeSyncAggregateFoundInc is called when our sync committee participation was included in the SyncAggregate for the next head.
	SyncCommitteeSyncAggregateFoundInc()
	// SyncCommitteeSyncAggregateMissingInc is called when our sync committee participation was not included in the SyncAggregate for the next head.
	SyncCommitteeSyncAggregateMissingInc()
	// SyncCommitteeGetHeadBlockFailedInc is called when validation for a sync committee fails due to being unable to retrieve the head block.
	SyncCommitteeGetHeadBlockFailedInc()
	// SyncCommitteeMessagesHeadMismatchInc is called when a sync committee message was known to not match the next head block.
	// The count is the number of Sync Committee assigned validators.
	SyncCommitteeMessagesHeadMismatchInc(count int)
	// SyncCommitteeCurrentCountSet is called to set the current number of sync committee assigned validators.
	SyncCommitteeCurrentCountSet(count int)
}

SyncCommitteeVerificationMonitor provides methods to monitor the sync committee verification process.

type ValidatorsManagerMonitor

type ValidatorsManagerMonitor interface{}

ValidatorsManagerMonitor provides methods to monitor the validators manager.