prometheus

Documentation

Index

• type Parameter
  • func WithAddress(address string) Parameter
  • func WithChainTime(chainTime chaintime.Service) Parameter
  • func WithCreateServer(createServer bool) Parameter
  • func WithLogLevel(logLevel zerolog.Level) Parameter
• type Service
  • func New(_ context.Context, params ...Parameter) (*Service, error)
  • func (s *Service) Accounts(state string, count uint64)
  • func (s *Service) AttestationAggregationCompleted(started time.Time, slot phase0.Slot, result string)
  • func (s *Service) AttestationAggregationCoverage(frac float64)
  • func (s *Service) AttestationsCompleted(started time.Time, slot phase0.Slot, count int, result string)
  • func (s *Service) BeaconCommitteeAggregators(aggregators int)
  • func (s *Service) BeaconCommitteeSubscribers(subscribers int)
  • func (s *Service) BeaconCommitteeSubscriptionCompleted(started time.Time, result string)
  • func (s *Service) BlockDelay(epochSlot uint, delay time.Duration)
  • func (s *Service) ClientOperation(provider string, operation string, succeeded bool, duration time.Duration)
  • func (s *Service) JobCancelled(class string)
  • func (s *Service) JobScheduled(class string)
  • func (s *Service) JobStartedOnSignal(class string)
  • func (s *Service) JobStartedOnTimer(class string)
  • func (s *Service) NewEpoch()
  • func (*Service) Presenter() string
  • func (s *Service) StrategyOperation(strategy string, provider string, operation string, duration time.Duration)
  • func (s *Service) SyncCommitteeAggregationCoverage(frac float64)
  • func (s *Service) SyncCommitteeAggregationsCompleted(started time.Time, slot phase0.Slot, count int, result string)
  • func (s *Service) SyncCommitteeGetHeadBlockFailedInc(slot phase0.Slot, block string)
  • func (s *Service) SyncCommitteeMessagesCompleted(started time.Time, slot phase0.Slot, count int, result string)
  • func (s *Service) SyncCommitteeMessagesHeadMismatchInc(slot phase0.Slot, headParentRoot, broadcastRoot string)
  • func (s *Service) SyncCommitteeSubscribers(subscribers int)
  • func (s *Service) SyncCommitteeSubscriptionCompleted(started time.Time, result string)
  • func (s *Service) SyncCommitteeSyncAggregateFoundInc(slot phase0.Slot, validatorIndex phase0.ValidatorIndex, ...)
  • func (s *Service) SyncCommitteeSyncAggregateMissingInc(slot phase0.Slot, validatorIndex phase0.ValidatorIndex, ...)

Types

type Parameter

type Parameter interface {
	// contains filtered or unexported methods
}

Parameter is the interface for service parameters.

func WithAddress

func WithAddress(address string) Parameter

WithAddress sets the address.

func WithChainTime

func WithChainTime(chainTime chaintime.Service) Parameter

WithChainTime sets the chaintime service.

func WithCreateServer

func WithCreateServer(createServer bool) Parameter

WithCreateServer creates a web server for metrics if true.

func WithLogLevel

func WithLogLevel(logLevel zerolog.Level) Parameter

WithLogLevel sets the log level for the module.

type Service

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

Service is a metrics service exposing metrics via prometheus.

func New

func New(_ context.Context, params ...Parameter) (*Service, error)

New creates a new prometheus metrics service.

func (*Service) Accounts

func (s *Service) Accounts(state string, count uint64)

Accounts sets the number of accounts in a given state.

func (*Service) AttestationAggregationCompleted

func (s *Service) AttestationAggregationCompleted(started time.Time, slot phase0.Slot, result string)

AttestationAggregationCompleted is called when an attestation aggregationprocess has completed.

func (*Service) AttestationAggregationCoverage

func (s *Service) AttestationAggregationCoverage(frac float64)

AttestationAggregationCoverage measures the attestation ratio of the attestation aggregation.

func (*Service) AttestationsCompleted

func (s *Service) AttestationsCompleted(started time.Time, slot phase0.Slot, count int, result string)

AttestationsCompleted is called when an attestation process has completed.

func (*Service) BeaconCommitteeAggregators

func (s *Service) BeaconCommitteeAggregators(aggregators int)

BeaconCommitteeAggregators sets the number of beacon committees for which our validators are aggregating.

func (*Service) BeaconCommitteeSubscribers

func (s *Service) BeaconCommitteeSubscribers(subscribers int)

BeaconCommitteeSubscribers sets the number of beacon committees to which our validators are subscribed.

func (*Service) BeaconCommitteeSubscriptionCompleted

func (s *Service) BeaconCommitteeSubscriptionCompleted(started time.Time, result string)

BeaconCommitteeSubscriptionCompleted is called when an beacon committee subscription process has completed.

func (*Service) BlockDelay

func (s *Service) BlockDelay(epochSlot uint, delay time.Duration)

BlockDelay provides the delay between the start of a slot and vouch receiving its block.

func (*Service) ClientOperation

func (s *Service) ClientOperation(provider string, operation string, succeeded bool, duration time.Duration)

ClientOperation registers an operation.

func (*Service) JobCancelled

func (s *Service) JobCancelled(class string)

JobCancelled is called when a scheduled job is cancelled.

func (*Service) JobScheduled

func (s *Service) JobScheduled(class string)

JobScheduled is called when a job is scheduled.

func (*Service) JobStartedOnSignal

func (s *Service) JobStartedOnSignal(class string)

JobStartedOnSignal is called when a scheduled job is started due to being manually signalled.

func (*Service) JobStartedOnTimer

func (s *Service) JobStartedOnTimer(class string)

JobStartedOnTimer is called when a scheduled job is started due to meeting its time.

func (*Service) NewEpoch

func (s *Service) NewEpoch()

NewEpoch is called when vouch starts processing a new epoch.

func (*Service) Presenter

func (*Service) Presenter() string

Presenter returns the presenter for the events.

func (*Service) StrategyOperation

func (s *Service) StrategyOperation(strategy string, provider string, operation string, duration time.Duration)

StrategyOperation provides a generic monitor for strategy operations.

func (*Service) SyncCommitteeAggregationCoverage

func (s *Service) SyncCommitteeAggregationCoverage(frac float64)

SyncCommitteeAggregationCoverage measures the message ratio of the sync committee aggregation.

func (*Service) SyncCommitteeAggregationsCompleted

func (s *Service) SyncCommitteeAggregationsCompleted(started time.Time, slot phase0.Slot, count int, result string)

SyncCommitteeAggregationsCompleted is called when a sync committee aggregation process has completed.

func (*Service) SyncCommitteeGetHeadBlockFailedInc

func (s *Service) SyncCommitteeGetHeadBlockFailedInc(slot phase0.Slot, block string)

SyncCommitteeGetHeadBlockFailedInc is called when validation for a sync committee fails due to being unable to retrieve the head block.

func (*Service) SyncCommitteeMessagesCompleted

func (s *Service) SyncCommitteeMessagesCompleted(started time.Time, slot phase0.Slot, count int, result string)

SyncCommitteeMessagesCompleted is called when a sync committee message process has completed.

func (*Service) SyncCommitteeMessagesHeadMismatchInc

func (s *Service) SyncCommitteeMessagesHeadMismatchInc(slot phase0.Slot, headParentRoot, broadcastRoot string)

SyncCommitteeMessagesHeadMismatchInc is called when a sync committee message was known to not match the next head block.

func (*Service) SyncCommitteeSubscribers

func (s *Service) SyncCommitteeSubscribers(subscribers int)

SyncCommitteeSubscribers sets the number of sync committees to which our validators are subscribed.

func (*Service) SyncCommitteeSubscriptionCompleted

func (s *Service) SyncCommitteeSubscriptionCompleted(started time.Time, result string)

SyncCommitteeSubscriptionCompleted is called when an sync committee subscription process has completed.

func (*Service) SyncCommitteeSyncAggregateFoundInc

func (s *Service) SyncCommitteeSyncAggregateFoundInc(slot phase0.Slot, validatorIndex phase0.ValidatorIndex, committeeIndex phase0.CommitteeIndex)

SyncCommitteeSyncAggregateFoundInc is called when our sync committee participation was included in the SyncAggregate for the next head.

func (*Service) SyncCommitteeSyncAggregateMissingInc

func (s *Service) SyncCommitteeSyncAggregateMissingInc(slot phase0.Slot, validatorIndex phase0.ValidatorIndex, committeeIndex phase0.CommitteeIndex)

SyncCommitteeSyncAggregateMissingInc is called when our sync committee participation was not included in the SyncAggregate for the next head.