-
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.
initialize x/metrics with metrics collection
- Loading branch information
1 parent
b01062a
commit 9368851
Showing
7 changed files
with
238 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 |
|---|---|---|
| @@ -0,0 +1,11 @@ | ||
| package metrics | ||
|
|
||
| import ( | ||
| "github.com/kava-labs/kava/x/metrics/types" | ||
|
|
||
| sdk "github.com/cosmos/cosmos-sdk/types" | ||
| ) | ||
|
|
||
| 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,125 @@ | ||
| package metrics | ||
|
|
||
| import ( | ||
| "encoding/json" | ||
|
|
||
| "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{} | ||
|
|
||
| // 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 | ||
| } | ||
|
|
||
| // 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{} | ||
| } |
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,9 @@ | ||
| package types | ||
|
|
||
| const ( | ||
| // Name of the module | ||
| ModuleName = "metrics" | ||
|
|
||
| // Name of the CometBFT metrics namespace. Used to emulate future cometBFT metrics. | ||
| CometBFTMetricNamespace = "cometbft" | ||
| ) |
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,81 @@ | ||
| package types | ||
|
|
||
| import ( | ||
| "github.com/go-kit/kit/metrics" | ||
| "github.com/go-kit/kit/metrics/discard" | ||
| prometheus "github.com/go-kit/kit/metrics/prometheus" | ||
| stdprometheus "github.com/prometheus/client_golang/prometheus" | ||
| "github.com/spf13/cast" | ||
|
|
||
| servertypes "github.com/cosmos/cosmos-sdk/server/types" | ||
| ) | ||
|
|
||
| // TelemetryOptions defines the app configurations for the x/metrics module | ||
| type TelemetryOptions struct { | ||
| // CometBFT config value for instrumentation.prometheus (config.toml) | ||
| PrometheusEnabled bool | ||
| // Namespace for CometBFT metrics. Used to emulate CometBFT metrics. | ||
| CometBFTMetricsNamespace string | ||
| // A list of keys and values used as labels on all metrics | ||
| GlobalLabelsAndValues []string | ||
| } | ||
|
|
||
| // TelemetryOptionsFromAppOpts creates the TelemetryOptions from server AppOptions | ||
| func TelemetryOptionsFromAppOpts(appOpts servertypes.AppOptions) TelemetryOptions { | ||
| prometheusEnabled := cast.ToBool(appOpts.Get("instrumentation.prometheus")) | ||
| if !prometheusEnabled { | ||
| return TelemetryOptions{ | ||
| GlobalLabelsAndValues: []string{}, | ||
| } | ||
| } | ||
| return TelemetryOptions{ | ||
| PrometheusEnabled: true, | ||
| CometBFTMetricsNamespace: cast.ToString(appOpts.Get("instrumentation.namespace")), | ||
| GlobalLabelsAndValues: []string{ | ||
| // TODO: can i get the chain id in this context? | ||
| }, | ||
| } | ||
| } | ||
|
|
||
| // Metrics contains metrics exposed by this module. | ||
| // They use go-kit metrics like CometBFT as opposed to using cosmos-sdk telemetry | ||
| // because the sdk's telemetry only supports float32s, whereas go-kit prometheus | ||
| // metrics correctly handle float64s (and thus a larger number of int64s) | ||
| type Metrics struct { | ||
| // The height of the latest block. | ||
| // This gauges exactly emulates the default blocksync metric in CometBFT v0.38+ | ||
| // It should be removed when | ||
| // see https://github.com/cometbft/cometbft/blob/v0.38.0-rc3/blocksync/metrics.gen.go | ||
| LatestBlockHeight metrics.Gauge | ||
| } | ||
|
|
||
| // NewMetrics creates a new Metrics object based on whether or not prometheus instrumentation is enabled. | ||
| func NewMetrics(opts TelemetryOptions) *Metrics { | ||
| if opts.PrometheusEnabled { | ||
| return PrometheusMetrics(opts) | ||
| } | ||
| return NoopMetrics() | ||
| } | ||
|
|
||
| // PrometheusMetrics returns the gauges for when prometheus instrumentation is enabled. | ||
| func PrometheusMetrics(opts TelemetryOptions) *Metrics { | ||
| labels := []string{} | ||
| for i := 0; i < len(opts.GlobalLabelsAndValues); i += 2 { | ||
| labels = append(labels, opts.GlobalLabelsAndValues[i]) | ||
| } | ||
| return &Metrics{ | ||
| LatestBlockHeight: prometheus.NewGaugeFrom(stdprometheus.GaugeOpts{ | ||
| Namespace: opts.CometBFTMetricsNamespace, | ||
| Subsystem: "blocksync", | ||
| Name: "latest_block_height", | ||
| Help: "The height of the latest block.", | ||
| }, labels).With(opts.GlobalLabelsAndValues...), | ||
| } | ||
| } | ||
|
|
||
| // NoopMetrics are a do-nothing placeholder used when prometheus instrumentation is not enabled. | ||
| func NoopMetrics() *Metrics { | ||
| return &Metrics{ | ||
| LatestBlockHeight: discard.NewGauge(), | ||
| } | ||
| } |