-
Notifications
You must be signed in to change notification settings - Fork 367
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
feat(x/metrics): add module for emiting custom chain metrics (backport …
…#1668) (#1674) * feat(x/metrics): add module for emiting custom chain metrics (#1668) * initialize x/metrics with metrics collection * include global labels in x/metrics metrics * add x/metrics spec * add x/metrics test coverage * update changelog (cherry picked from commit 9a0aed7) # Conflicts: # CHANGELOG.md # app/app.go # go.mod * fix merge conflicts, add docker-build command --------- Co-authored-by: Robert Pirtle <Astropirtle@gmail.com>
- Loading branch information
1 parent
64964fc
commit e4c2bf6
Showing
13 changed files
with
456 additions
and
4 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1 @@ | ||
| golang 1.18.10 |
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
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 |
|---|---|---|
| @@ -0,0 +1,12 @@ | ||
| package metrics | ||
|
|
||
| import ( | ||
| "github.com/kava-labs/kava/x/metrics/types" | ||
|
|
||
| sdk "github.com/cosmos/cosmos-sdk/types" | ||
| ) | ||
|
|
||
| // BeginBlocker publishes metrics at the start of each block. | ||
| func BeginBlocker(ctx sdk.Context, metrics *types.Metrics) { | ||
| metrics.LatestBlockHeight.Set(float64(ctx.BlockHeight())) | ||
| } |
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,45 @@ | ||
| package metrics_test | ||
|
|
||
| import ( | ||
| "testing" | ||
|
|
||
| kitmetrics "github.com/go-kit/kit/metrics" | ||
| "github.com/stretchr/testify/require" | ||
|
|
||
| sdk "github.com/cosmos/cosmos-sdk/types" | ||
| tmproto "github.com/tendermint/tendermint/proto/tendermint/types" | ||
|
|
||
| "github.com/kava-labs/kava/app" | ||
| "github.com/kava-labs/kava/x/metrics" | ||
| "github.com/kava-labs/kava/x/metrics/types" | ||
| ) | ||
|
|
||
| type MockGauge struct { | ||
| value float64 | ||
| } | ||
|
|
||
| func (mg *MockGauge) With(labelValues ...string) kitmetrics.Gauge { return mg } | ||
| func (mg *MockGauge) Set(value float64) { mg.value = value } | ||
| func (*MockGauge) Add(_ float64) {} | ||
|
|
||
| func ctxWithHeight(height int64) sdk.Context { | ||
| tApp := app.NewTestApp() | ||
| tApp.InitializeFromGenesisStates() | ||
| return tApp.NewContext(false, tmproto.Header{Height: height}) | ||
| } | ||
|
|
||
| func TestBeginBlockEmitsLatestHeight(t *testing.T) { | ||
| gauge := MockGauge{} | ||
| myMetrics := &types.Metrics{ | ||
| LatestBlockHeight: &gauge, | ||
| } | ||
|
|
||
| metrics.BeginBlocker(ctxWithHeight(1), myMetrics) | ||
| require.EqualValues(t, 1, gauge.value) | ||
|
|
||
| metrics.BeginBlocker(ctxWithHeight(100), myMetrics) | ||
| require.EqualValues(t, 100, gauge.value) | ||
|
|
||
| metrics.BeginBlocker(ctxWithHeight(17e6), myMetrics) | ||
| require.EqualValues(t, 17e6, gauge.value) | ||
| } |
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,132 @@ | ||
| package metrics | ||
|
|
||
| import ( | ||
| "encoding/json" | ||
|
|
||
| "github.com/gorilla/mux" | ||
| "github.com/grpc-ecosystem/grpc-gateway/runtime" | ||
| "github.com/spf13/cobra" | ||
|
|
||
| "github.com/cosmos/cosmos-sdk/client" | ||
| "github.com/cosmos/cosmos-sdk/codec" | ||
| codectypes "github.com/cosmos/cosmos-sdk/codec/types" | ||
| sdk "github.com/cosmos/cosmos-sdk/types" | ||
| "github.com/cosmos/cosmos-sdk/types/module" | ||
|
|
||
| abci "github.com/tendermint/tendermint/abci/types" | ||
|
|
||
| "github.com/kava-labs/kava/x/metrics/types" | ||
| ) | ||
|
|
||
| var ( | ||
| _ module.AppModule = AppModule{} | ||
| _ module.AppModuleBasic = AppModuleBasic{} | ||
| ) | ||
|
|
||
| // AppModuleBasic app module basics object | ||
| type AppModuleBasic struct{} | ||
|
|
||
| // RegisterRESTRoutes implements module.AppModuleBasic. | ||
| func (AppModuleBasic) RegisterRESTRoutes(client.Context, *mux.Router) {} | ||
|
|
||
| // Name returns the module name | ||
| func (AppModuleBasic) Name() string { | ||
| return types.ModuleName | ||
| } | ||
|
|
||
| // RegisterLegacyAminoCodec register module codec | ||
| // Deprecated: unused but necessary to fulfill AppModuleBasic interface | ||
| func (AppModuleBasic) RegisterLegacyAminoCodec(cdc *codec.LegacyAmino) {} | ||
|
|
||
| // DefaultGenesis default genesis state | ||
| func (AppModuleBasic) DefaultGenesis(_ codec.JSONCodec) json.RawMessage { | ||
| return []byte("{}") | ||
| } | ||
|
|
||
| // ValidateGenesis module validate genesis | ||
| func (AppModuleBasic) ValidateGenesis(_ codec.JSONCodec, _ client.TxEncodingConfig, _ json.RawMessage) error { | ||
| return nil | ||
| } | ||
|
|
||
| // RegisterInterfaces implements InterfaceModule.RegisterInterfaces | ||
| func (a AppModuleBasic) RegisterInterfaces(registry codectypes.InterfaceRegistry) {} | ||
|
|
||
| // RegisterGRPCGatewayRoutes registers the gRPC Gateway routes for the module. | ||
| func (a AppModuleBasic) RegisterGRPCGatewayRoutes(clientCtx client.Context, mux *runtime.ServeMux) {} | ||
|
|
||
| // GetTxCmd returns the root tx command for the module. | ||
| func (AppModuleBasic) GetTxCmd() *cobra.Command { | ||
| return nil | ||
| } | ||
|
|
||
| // GetQueryCmd returns no root query command for the module. | ||
| func (AppModuleBasic) GetQueryCmd() *cobra.Command { | ||
| return nil | ||
| } | ||
|
|
||
| //____________________________________________________________________________ | ||
|
|
||
| // AppModule app module type | ||
| type AppModule struct { | ||
| AppModuleBasic | ||
| metrics *types.Metrics | ||
| } | ||
|
|
||
| // RegisterRESTRoutes implements module.AppModule. | ||
| func (AppModule) RegisterRESTRoutes(client.Context, *mux.Router) {} | ||
|
|
||
| // NewAppModule creates a new AppModule object | ||
| func NewAppModule(telemetryOpts types.TelemetryOptions) AppModule { | ||
| return AppModule{ | ||
| AppModuleBasic: AppModuleBasic{}, | ||
| metrics: types.NewMetrics(telemetryOpts), | ||
| } | ||
| } | ||
|
|
||
| // Name module name | ||
| func (am AppModule) Name() string { | ||
| return am.AppModuleBasic.Name() | ||
| } | ||
|
|
||
| // RegisterInvariants register module invariants | ||
| func (am AppModule) RegisterInvariants(_ sdk.InvariantRegistry) {} | ||
|
|
||
| // Route module message route name | ||
| // Deprecated: unused but necessary to fulfill AppModule interface | ||
| func (am AppModule) Route() sdk.Route { return sdk.Route{} } | ||
|
|
||
| // QuerierRoute module querier route name | ||
| // Deprecated: unused but necessary to fulfill AppModule interface | ||
| func (AppModule) QuerierRoute() string { return types.ModuleName } | ||
|
|
||
| // LegacyQuerierHandler returns no sdk.Querier. | ||
| // Deprecated: unused but necessary to fulfill AppModule interface | ||
| func (am AppModule) LegacyQuerierHandler(_ *codec.LegacyAmino) sdk.Querier { | ||
| return nil | ||
| } | ||
|
|
||
| // ConsensusVersion implements AppModule/ConsensusVersion. | ||
| func (AppModule) ConsensusVersion() uint64 { return 1 } | ||
|
|
||
| // RegisterServices registers module services. | ||
| func (am AppModule) RegisterServices(cfg module.Configurator) {} | ||
|
|
||
| // InitGenesis module init-genesis | ||
| func (am AppModule) InitGenesis(ctx sdk.Context, _ codec.JSONCodec, _ json.RawMessage) []abci.ValidatorUpdate { | ||
| return []abci.ValidatorUpdate{} | ||
| } | ||
|
|
||
| // ExportGenesis module export genesis | ||
| func (am AppModule) ExportGenesis(_ sdk.Context, cdc codec.JSONCodec) json.RawMessage { | ||
| return nil | ||
| } | ||
|
|
||
| // BeginBlock module begin-block | ||
| func (am AppModule) BeginBlock(ctx sdk.Context, req abci.RequestBeginBlock) { | ||
| BeginBlocker(ctx, am.metrics) | ||
| } | ||
|
|
||
| // EndBlock module end-block | ||
| func (am AppModule) EndBlock(_ sdk.Context, _ abci.RequestEndBlock) []abci.ValidatorUpdate { | ||
| return []abci.ValidatorUpdate{} | ||
| } |
Oops, something went wrong.