-
Notifications
You must be signed in to change notification settings - Fork 28
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Metrics for sync committee validation
- Loading branch information
Showing
6 changed files
with
158 additions
and
2 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -99,7 +99,6 @@ func (s *Service) setupSyncCommitteeMessageMetrics() error { | |
return err | ||
} | ||
} | ||
|
||
return nil | ||
} | ||
|
||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,112 @@ | ||
// Copyright © 2021 - 2024 Attestant Limited. | ||
// Licensed under the Apache License, Version 2.0 (the "License"); | ||
// you may not use this file except in compliance with the License. | ||
// You may obtain a copy of the License at | ||
// | ||
// http://www.apache.org/licenses/LICENSE-2.0 | ||
// | ||
// Unless required by applicable law or agreed to in writing, software | ||
// distributed under the License is distributed on an "AS IS" BASIS, | ||
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
// See the License for the specific language governing permissions and | ||
// limitations under the License. | ||
|
||
package prometheus | ||
|
||
import ( | ||
"errors" | ||
"strconv" | ||
|
||
"github.com/attestantio/go-eth2-client/spec/phase0" | ||
"github.com/prometheus/client_golang/prometheus" | ||
) | ||
|
||
func (s *Service) setupSyncCommitteeValidationMetrics() error { | ||
s.syncCommitteeValidationHeadMismatches = prometheus.NewCounterVec(prometheus.CounterOpts{ | ||
Namespace: "vouch", | ||
Subsystem: "synccommitteevalidation", | ||
Name: "mismatches_total", | ||
Help: "The number of sync committee messages we broadcast that did not match the next head root.", | ||
}, []string{"slot", "head_parent_root", "broadcast_root"}) | ||
if err := prometheus.Register(s.syncCommitteeValidationHeadMismatches); err != nil { | ||
var alreadyRegisteredError prometheus.AlreadyRegisteredError | ||
if ok := errors.As(err, &alreadyRegisteredError); ok { | ||
s.syncCommitteeValidationHeadMismatches = alreadyRegisteredError.ExistingCollector.(*prometheus.CounterVec) | ||
} else { | ||
return err | ||
} | ||
} | ||
|
||
s.syncCommitteeValidationGetHeadFailures = prometheus.NewCounterVec(prometheus.CounterOpts{ | ||
Namespace: "vouch", | ||
Subsystem: "synccommitteevalidation", | ||
Name: "get_head_failures_total", | ||
Help: "The number of times sync committee validation failed due to being unable to retrieve the head block.", | ||
}, []string{"slot", "block"}) | ||
if err := prometheus.Register(s.syncCommitteeValidationGetHeadFailures); err != nil { | ||
var alreadyRegisteredError prometheus.AlreadyRegisteredError | ||
if ok := errors.As(err, &alreadyRegisteredError); ok { | ||
s.syncCommitteeValidationGetHeadFailures = alreadyRegisteredError.ExistingCollector.(*prometheus.CounterVec) | ||
} else { | ||
return err | ||
} | ||
} | ||
|
||
s.syncCommitteeValidationAggregateFound = prometheus.NewCounterVec(prometheus.CounterOpts{ | ||
Namespace: "vouch", | ||
Subsystem: "synccommitteevalidation", | ||
Name: "found_total", | ||
Help: "The number of sync committee messages that were included in the sync aggregate.", | ||
}, []string{"slot", "validator_index", "contribution_index"}) | ||
if err := prometheus.Register(s.syncCommitteeValidationAggregateFound); err != nil { | ||
var alreadyRegisteredError prometheus.AlreadyRegisteredError | ||
if ok := errors.As(err, &alreadyRegisteredError); ok { | ||
s.syncCommitteeValidationAggregateFound = alreadyRegisteredError.ExistingCollector.(*prometheus.CounterVec) | ||
} else { | ||
return err | ||
} | ||
} | ||
|
||
s.syncCommitteeValidationAggregateMissing = prometheus.NewCounterVec(prometheus.CounterOpts{ | ||
Namespace: "vouch", | ||
Subsystem: "synccommitteevalidation", | ||
Name: "missing_total", | ||
Help: "The number of sync committee messages that were not included in the sync aggregate.", | ||
}, []string{"slot", "validator_index", "contribution_index"}) | ||
if err := prometheus.Register(s.syncCommitteeValidationAggregateMissing); err != nil { | ||
var alreadyRegisteredError prometheus.AlreadyRegisteredError | ||
if ok := errors.As(err, &alreadyRegisteredError); ok { | ||
s.syncCommitteeValidationAggregateMissing = alreadyRegisteredError.ExistingCollector.(*prometheus.CounterVec) | ||
} else { | ||
return err | ||
} | ||
} | ||
|
||
return nil | ||
} | ||
|
||
// SyncCommitteeSyncAggregateFoundInc is called when our sync committee participation was included in the SyncAggregate for the next head. | ||
func (s *Service) SyncCommitteeSyncAggregateFoundInc(slot phase0.Slot, validatorIndex phase0.ValidatorIndex, committeeIndex phase0.CommitteeIndex) { | ||
converter := func(unitToConvert uint64) string { | ||
return strconv.FormatUint(unitToConvert, 10) | ||
} | ||
s.syncCommitteeValidationAggregateFound.WithLabelValues(converter(uint64(slot)), converter(uint64(validatorIndex)), converter(uint64(committeeIndex))).Add(1) | ||
} | ||
|
||
// SyncCommitteeSyncAggregateMissingInc is called when our sync committee participation was not included in the SyncAggregate for the next head. | ||
func (s *Service) SyncCommitteeSyncAggregateMissingInc(slot phase0.Slot, validatorIndex phase0.ValidatorIndex, committeeIndex phase0.CommitteeIndex) { | ||
converter := func(unitToConvert uint64) string { | ||
return strconv.FormatUint(unitToConvert, 10) | ||
} | ||
s.syncCommitteeValidationAggregateMissing.WithLabelValues(converter(uint64(slot)), converter(uint64(validatorIndex)), converter(uint64(committeeIndex))).Add(1) | ||
} | ||
|
||
// SyncCommitteeGetHeadBlockFailedInc is called when validation for a sync committee fails due to being unable to retrieve the head block. | ||
func (s *Service) SyncCommitteeGetHeadBlockFailedInc(slot phase0.Slot, block string) { | ||
s.syncCommitteeValidationGetHeadFailures.WithLabelValues(strconv.FormatUint(uint64(slot), 10), block).Add(1) | ||
} | ||
|
||
// SyncCommitteeMessagesHeadMismatchInc is called when a sync committee message was known to not match the next head block. | ||
func (s *Service) SyncCommitteeMessagesHeadMismatchInc(slot phase0.Slot, headParentRoot, broadcastRoot string) { | ||
s.syncCommitteeValidationAggregateMissing.WithLabelValues(strconv.FormatUint(uint64(slot), 10), headParentRoot, broadcastRoot).Add(1) | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters