Skip to content

Convert gauges into metrics #136

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
jannikluhn wants to merge 2 commits into
base: main
Choose a base branch
from
+35 −35
Open

Convert gauges into metrics #136

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
42e8345
metrics: use counters instead of gauges for monotonic totals
jannikluhn Aug 12, 2026
adc5105
metrics: rename counters to the _total suffix convention
jannikluhn Aug 14, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
22 changes: 11 additions & 11 deletions internal/usecase/crypto.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -120,7 +120,7 @@ func (uc *CryptoUsecase) getSigner(ctx context.Context) (*bind.TransactOpts, *ht
chainID, err := uc.ethClient.ChainID(ctx)
if err != nil {
log.Err(err).Msg("err encountered while querying chain id")
metrics.TotalFailedRPCCalls.Inc()
metrics.FailedRPCCalls.Inc()
err := httpError.NewHttpError(
"error encountered while querying chain id",
"",
Expand Down Expand Up @@ -168,7 +168,7 @@ func (uc *CryptoUsecase) GetDecryptionKey(ctx context.Context, identity string)
registrationData, err := uc.shutterRegistryContract.Registrations(nil, [32]byte(identityBytes))
if err != nil {
log.Err(err).Msg("err encountered while querying contract")
metrics.TotalFailedRPCCalls.Inc()
metrics.FailedRPCCalls.Inc()
err := httpError.NewHttpError(
"error while querying for identity from the contract",
"",
Expand Down Expand Up @@ -301,7 +301,7 @@ func (uc *CryptoUsecase) GetDataForEncryption(ctx context.Context, address strin
blockNumber, err := uc.ethClient.BlockNumber(ctx)
if err != nil {
log.Err(err).Msg("err encountered while querying for recent block")
metrics.TotalFailedRPCCalls.Inc()
metrics.FailedRPCCalls.Inc()
err := httpError.NewHttpError(
"error encountered while querying for recent block",
"",
Expand All @@ -313,7 +313,7 @@ func (uc *CryptoUsecase) GetDataForEncryption(ctx context.Context, address strin
eon, err := uc.keyperSetManagerContract.GetKeyperSetIndexByBlock(nil, blockNumber)
if err != nil {
log.Err(err).Msg("err encountered while querying keyper set index")
metrics.TotalFailedRPCCalls.Inc()
metrics.FailedRPCCalls.Inc()
err := httpError.NewHttpError(
"error encountered while querying for keyper set index",
"",
Expand All @@ -325,7 +325,7 @@ func (uc *CryptoUsecase) GetDataForEncryption(ctx context.Context, address strin
eonKeyBytes, err := uc.keyBroadcastContract.GetEonKey(nil, eon)
if err != nil {
log.Err(err).Msg("err encountered while querying for eon key")
metrics.TotalFailedRPCCalls.Inc()
metrics.FailedRPCCalls.Inc()
err := httpError.NewHttpError(
"error encountered while querying for eon key",
"",
Expand Down Expand Up @@ -442,7 +442,7 @@ func (uc *CryptoUsecase) RegisterIdentity(ctx context.Context, decryptionTimesta
blockNumber, err := uc.ethClient.BlockNumber(ctx)
if err != nil {
log.Err(err).Msg("err encountered while querying for recent block")
metrics.TotalFailedRPCCalls.Inc()
metrics.FailedRPCCalls.Inc()
err := httpError.NewHttpError(
"error encountered while querying for recent block",
"",
Expand All @@ -454,7 +454,7 @@ func (uc *CryptoUsecase) RegisterIdentity(ctx context.Context, decryptionTimesta
eon, err := uc.keyperSetManagerContract.GetKeyperSetIndexByBlock(nil, blockNumber)
if err != nil {
log.Err(err).Msg("err encountered while querying keyper set index")
metrics.TotalFailedRPCCalls.Inc()
metrics.FailedRPCCalls.Inc()
err := httpError.NewHttpError(
"error encountered while querying for keyper set index",
"",
Expand All @@ -466,7 +466,7 @@ func (uc *CryptoUsecase) RegisterIdentity(ctx context.Context, decryptionTimesta
eonKeyBytes, err := uc.keyBroadcastContract.GetEonKey(nil, eon)
if err != nil {
log.Err(err).Msg("err encountered while querying for eon key")
metrics.TotalFailedRPCCalls.Inc()
metrics.FailedRPCCalls.Inc()
err := httpError.NewHttpError(
"error encountered while querying for eon key",
"",
Expand Down Expand Up @@ -496,7 +496,7 @@ func (uc *CryptoUsecase) RegisterIdentity(ctx context.Context, decryptionTimesta
registrationData, err := uc.shutterRegistryContract.Registrations(nil, [32]byte(identity))
if err != nil {
log.Err(err).Msg("err encountered while querying contract")
metrics.TotalFailedRPCCalls.Inc()
metrics.FailedRPCCalls.Inc()
err := httpError.NewHttpError(
"error while querying for registrations from the contract",
"",
Expand Down Expand Up @@ -525,7 +525,7 @@ func (uc *CryptoUsecase) RegisterIdentity(ctx context.Context, decryptionTimesta
tx, err := uc.shutterRegistryContract.Register(&opts, eon, identityPrefix, decryptionTimestamp)
if err != nil {
log.Err(err).Msg("failed to send transaction")
metrics.TotalFailedRPCCalls.Inc()
metrics.FailedRPCCalls.Inc()
err := httpError.NewHttpError(
"failed to register identity",
"",
Expand All @@ -537,7 +537,7 @@ func (uc *CryptoUsecase) RegisterIdentity(ctx context.Context, decryptionTimesta
// we return the transaction hash in response to allow
// users the ability to monitor it themselves

metrics.TotalSuccessfulIdentityRegistration.Inc()
metrics.SuccessfulIdentityRegistrations.Inc()
return &RegisterIdentityResponse{
Eon: eon,
Identity: common.PrefixWith0x(hex.EncodeToString(identity)),
Expand Down
16 changes: 8 additions & 8 deletions internal/usecase/eventtrigger.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -288,7 +288,7 @@ func (uc *CryptoUsecase) RegisterEventIdentity(ctx context.Context, eventTrigger
blockNumber, err := uc.ethClient.BlockNumber(ctx)
if err != nil {
log.Err(err).Msg("err encountered while querying for recent block")
metrics.TotalFailedRPCCalls.Inc()
metrics.FailedRPCCalls.Inc()
err := httpError.NewHttpError(
"error encountered while querying for recent block",
"",
Expand All @@ -300,7 +300,7 @@ func (uc *CryptoUsecase) RegisterEventIdentity(ctx context.Context, eventTrigger
eon, err := uc.keyperSetManagerContract.GetKeyperSetIndexByBlock(nil, blockNumber)
if err != nil {
log.Err(err).Msg("err encountered while querying keyper set index")
metrics.TotalFailedRPCCalls.Inc()
metrics.FailedRPCCalls.Inc()
err := httpError.NewHttpError(
"error encountered while querying for keyper set index",
"",
Expand All @@ -312,7 +312,7 @@ func (uc *CryptoUsecase) RegisterEventIdentity(ctx context.Context, eventTrigger
eonKeyBytes, err := uc.keyBroadcastContract.GetEonKey(nil, eon)
if err != nil {
log.Err(err).Msg("err encountered while querying for eon key")
metrics.TotalFailedRPCCalls.Inc()
metrics.FailedRPCCalls.Inc()
err := httpError.NewHttpError(
"error encountered while querying for eon key",
"",
Expand All @@ -335,7 +335,7 @@ func (uc *CryptoUsecase) RegisterEventIdentity(ctx context.Context, eventTrigger
chainId, err := uc.ethClient.ChainID(ctx)
if err != nil {
log.Err(err).Msg("err encountered while quering chain id")
metrics.TotalFailedRPCCalls.Inc()
metrics.FailedRPCCalls.Inc()
err := httpError.NewHttpError(
"error encountered while querying chain id",
"",
Expand Down Expand Up @@ -411,7 +411,7 @@ func (uc *CryptoUsecase) RegisterEventIdentity(ctx context.Context, eventTrigger
tx, err := uc.shutterEventRegistryContract.Register(&opts, eon, identityPrefix, eventTriggerDefinition, ttl)
if err != nil {
log.Err(err).Msg("failed to send transaction")
metrics.TotalFailedRPCCalls.Inc()
metrics.FailedRPCCalls.Inc()
err := httpError.NewHttpError(
"failed to register identity",
"",
Expand Down Expand Up @@ -441,7 +441,7 @@ func (uc *CryptoUsecase) RegisterEventIdentity(ctx context.Context, eventTrigger

go uc.updateEventIdentityExpirationBlockNumber(tx.Hash(), eon, identity, ttl)

metrics.TotalSuccessfulIdentityRegistration.Inc()
metrics.SuccessfulIdentityRegistrations.Inc()
return &RegisterIdentityResponse{
Eon: eon,
Identity: common.PrefixWith0x(hex.EncodeToString(identity)),
Expand Down Expand Up @@ -560,7 +560,7 @@ func (uc *CryptoUsecase) GetEventDecryptionKey(ctx context.Context, identity str
blockNumber, err := uc.ethClient.BlockNumber(ctx)
if err != nil {
log.Err(err).Msg("err encountered while querying for recent block")
metrics.TotalFailedRPCCalls.Inc()
metrics.FailedRPCCalls.Inc()
err := httpError.NewHttpError(
"error encountered while querying for recent block",
"",
Expand All @@ -572,7 +572,7 @@ func (uc *CryptoUsecase) GetEventDecryptionKey(ctx context.Context, identity str
eonUint, err := uc.keyperSetManagerContract.GetKeyperSetIndexByBlock(nil, blockNumber)
if err != nil {
log.Err(err).Msg("err encountered while querying current eon")
metrics.TotalFailedRPCCalls.Inc()
metrics.FailedRPCCalls.Inc()
err := httpError.NewHttpError(
"error encountered while querying current eon",
"",
Expand Down
30 changes: 15 additions & 15 deletions metrics/metrics.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,32 +2,32 @@ package metrics

import "github.com/prometheus/client_golang/prometheus"

var TotalSuccessfulIdentityRegistration = prometheus.NewGauge(
prometheus.GaugeOpts{
var SuccessfulIdentityRegistrations = prometheus.NewCounter(
prometheus.CounterOpts{
Namespace: "shutter_api",
Name: "total_successful_identities_registration",
Help: "counter of successful identity registration",
Name: "successful_identity_registrations_total",
Help: "Count of successful identity registrations.",
},
)

var TotalDecryptionKeysReceived = prometheus.NewGauge(
prometheus.GaugeOpts{
var DecryptionKeysReceived = prometheus.NewCounter(
prometheus.CounterOpts{
Namespace: "shutter_api",
Name: "total_decryption_keys_received",
Help: "counter of total dec keys received",
Name: "decryption_keys_received_total",
Help: "Count of decryption keys received from the keypers.",
},
)

var TotalFailedRPCCalls = prometheus.NewGauge(
prometheus.GaugeOpts{
var FailedRPCCalls = prometheus.NewCounter(
prometheus.CounterOpts{
Namespace: "shutter_api",
Name: "total_failed_rpc_calls",
Help: "Counter of failed rpc calls",
Name: "failed_rpc_calls_total",
Help: "Count of failed RPC calls.",
},
)

func InitMetrics() {
prometheus.MustRegister(TotalSuccessfulIdentityRegistration)
prometheus.MustRegister(TotalDecryptionKeysReceived)
prometheus.MustRegister(TotalFailedRPCCalls)
prometheus.MustRegister(SuccessfulIdentityRegistrations)
prometheus.MustRegister(DecryptionKeysReceived)
prometheus.MustRegister(FailedRPCCalls)

@ylembachar ylembachar Aug 25, 2026

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This alert will be impacted if we add this change: https://github.com/shutter-network/keyper-metrics/blob/main/config/vmalert/alerts.rules.yaml#L23 if you could please open an issue/PR to fix it, thanks

@jannikluhn jannikluhn Aug 25, 2026

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Done, issue and PR

}
2 changes: 1 addition & 1 deletion watcher/watcher.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,7 @@ func (w *Watcher) Start(ctx context.Context, runner service.Runner) error {
}); err != nil {
log.Err(err).Msg("failed to insert decryption key")
}
metrics.TotalDecryptionKeysReceived.Inc()
metrics.DecryptionKeysReceived.Inc()
}
}
}
Expand Down