Mint module metrics + refactor on metric names (#819)

<!-- < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < ☺
v           ✰  Thanks for creating a PR! You're awesome! ✰
v Please note that maintainers will only review those PRs with a
completed PR template.
☺ > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > >  -->

## Purpose of Changes and their Description
* Add mint metrics on events

## Are these changes tested and documented?

- [x] If tested, please describe how. If not, why tests are not needed.
-- unit and integration tests
- [x] If documented, please describe where. If not, describe why docs
are not needed. -- fixed docs on module `README`s
- [x] Added to `Unreleased` section of `CHANGELOG.md`?

---------

Signed-off-by: Diego C <xmariachi@gmail.com>
Co-authored-by: Arnaud Mimart <33665250+amimart@users.noreply.github.com>

Author: 2 people

CHANGELOG.md

@@ -70,6 +70,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 ### Added
 * [#781](https://github.com/allora-network/allora-chain/pull/781) Enable pebbledb
 * [#818](https://github.com/allora-network/allora-chain/pull/818) Emit new `EventNetworkInferences` event when closing worker nonce
+* [#819](https://github.com/allora-network/allora-chain/pull/819) Mint module metrics + refactor on metric names
 
 ### Changed
 * [#815](https://github.com/allora-network/allora-chain/pull/815) Refund ecosystem account when invalid topic to reward 

x/emissions/README.md

@@ -1,29 +1,21 @@
 Emissions Module
 =============================================
 
-## Dependencies
+The `emissions` module is a core component of the Allora Network that manages the topic definition, actor participation, economic incentives, rewards system and more. This is the main part of the implementation of the [Allora Whitepaper](https://research.assets.allora.network/allora.0x10001.pdf). 
 
-golang v1.21+
-GNU make
-docker
+Key Features:
+- Topic Management: Creation and management of prediction topics
+- Stake Management: Handling of stakes for workers and reputers
+- Reward Distribution: Calculation and distribution of rewards based on performance
+- Delegation System: Support for stake delegation to reputers
+- Performance Metrics: Tracking of worker, reputer, and forecaster scores
+- Fee Collection: Management of network fees and revenue distribution
 
-## Build
-```bash
-# get deps
-go mod tidy
 
-# rebuild the autogenerated protobuf files
-make proto-all
+## Monitoring
 
-# build the module, making sure the source compiles
-make
-```
-
-Then somewhere else you have a minimal-chain running:
-```bash
-cd ../minimal-chain
-go mod tidy
-make install
-make init
-allorad start
-```
+Allora node emits its own `emissions` module metrics in each event, query and tx.
+event: `allora_emissions_event_total`
+query/tx: `allora_emissions_request_total` for occurrences, `allora_emissions_request_duration_ms` for latency measures.
+Different labels are applied where appropriate (eg "topic_id", "address", "nonce", etc.)
+See `x/emissions/metrics/` for details.

x/emissions/metrics/metrics_util.go

@@ -13,11 +13,11 @@ import (
 // Measures RPC endpoint request throughput
 // Metric Name:
 //
-//	allora_rpc_request_counter
+//	allora_emissions_request_counter
 func IncrementRpcRequestCounter(endpoint string, err *error) {
 	success := *err == nil
 	telemetry.IncrCounterWithLabels(
-		[]string{"allora", "request", "counter"},
+		[]string{"allora", "emissions", "request", "counter"},
 		float32(1),
 		[]metrics.Label{
 			telemetry.NewLabel("endpoint", endpoint),
@@ -29,10 +29,10 @@ func IncrementRpcRequestCounter(endpoint string, err *error) {
 // Measures the RPC request latency in milliseconds
 // Metric Name:
 //
-//	allora_rpc_request_latency_ms
+//	allora_request_duration_ms
 func MeasureRpcRequestLatency(endpoint string, startTime time.Time) {
 	metrics.MeasureSinceWithLabels(
-		[]string{"allora", "request", "latency_ms"},
+		[]string{"allora", "emissions", "request", "duration_ms"},
 		startTime.UTC(),
 		[]metrics.Label{
 			telemetry.NewLabel("endpoint", endpoint),
@@ -44,10 +44,10 @@ func MeasureRpcRequestLatency(endpoint string, startTime time.Time) {
 // This metric counts the number of events produced by the system.
 // Metric Name:
 //
-//	allora_loadtest_produce_count
+//	allora_emissions_produce_count
 func IncrProducerEventCount(msgType string) {
 	telemetry.IncrCounterWithLabels(
-		[]string{"allora", "loadtest", "produce", "count"},
+		[]string{"allora", "emissions", "event", "total"},
 		1,
 		[]metrics.Label{telemetry.NewLabel("msg_type", msgType)},
 	)

x/emissions/module/autocli.go

@@ -492,7 +492,7 @@ func (am AppModule) AutoCLIOptions() *autocliv1.ModuleOptions {
 				{
 					RpcMethod: "GetWorkerLatestInferenceByTopicId",
 					Use:       "worker-latest-inference [topic_id] [worker_address]",
-					Short:     "Get the latest inference for a given worker and topic",
+					Short:     "Get the latest inference for a given worker and topic within a worker submission window",
 					PositionalArgs: []*autocliv1.PositionalArgDescriptor{
 						{ProtoField: "topic_id"},
 						{ProtoField: "worker_address"},

x/mint/README.md

@@ -0,0 +1,4 @@
+Mint Module
+=============================================
+
+The `mint` module is based on the `x/mint` module, modified to implement allora-specific tokenomics.

x/mint/metrics/labels.go

@@ -0,0 +1,8 @@
+package metrics
+
+//nolint:gosec // These are event labels, not credentials
+const (
+	TOKENOMICS_SET_EVENT                = "tokenomics_set_event"
+	ECOSYSTEM_TOKEN_MINT_SET_EVENT      = "ecosystem_token_mint_set_event"
+	REWARD_CURRENT_BLOCK_EMISSION_EVENT = "reward_current_block_emission_event"
+)

x/mint/metrics/metrics_util.go

@@ -0,0 +1,21 @@
+// This is copied from the sei-chain
+// source: https://github.com/sei-protocol/sei-chain/blob/main/utils/metrics/metrics_util.go
+package metrics
+
+import (
+	"github.com/cosmos/cosmos-sdk/telemetry"
+	metrics "github.com/hashicorp/go-metrics"
+)
+
+// IncrProducerEventCount increments the counter for events produced.
+// This metric counts the number of events produced by the system.
+// Metric Name:
+//
+//	allora_mint_produce_count
+func IncrProducerEventCount(msgType string) {
+	telemetry.IncrCounterWithLabels(
+		[]string{"allora", "mint", "event", "total"},
+		1,
+		[]metrics.Label{telemetry.NewLabel("msg_type", msgType)},
+	)
+}

x/mint/types/events.go

@@ -2,11 +2,13 @@ package types
 
 import (
 	"cosmossdk.io/math"
+	metrics "github.com/allora-network/allora-chain/x/mint/metrics"
 	sdk "github.com/cosmos/cosmos-sdk/types"
 	"github.com/cosmos/gogoproto/proto"
 )
 
 func EmitNewTokenomicsSetEvent(ctx sdk.Context, stakedTokenAmount, circulatingAmount, emissionsAmount math.Int) {
+	metrics.IncrProducerEventCount(metrics.TOKENOMICS_SET_EVENT)
 	err := ctx.EventManager().EmitTypedEvent(NewTokenomicsSetEventBase(stakedTokenAmount, circulatingAmount, emissionsAmount))
 	if err != nil {
 		ctx.Logger().Warn("Error emitting EmitNewTokenomicsSetEvent", "error", err)
@@ -22,6 +24,7 @@ func NewTokenomicsSetEventBase(stakedTokenAmount, circulatingAmount, emissionsAm
 }
 
 func EmitNewEcosystemTokenMintSetEvent(ctx sdk.Context, blockHeight uint64, amount math.Int) {
+	metrics.IncrProducerEventCount(metrics.ECOSYSTEM_TOKEN_MINT_SET_EVENT)
 	err := ctx.EventManager().EmitTypedEvent(EcosystemTokenMintSetEventBase(blockHeight, amount))
 	if err != nil {
 		ctx.Logger().Warn("Error emitting EmitNewEcosystemTokenMintSetEvent", "error", err)
@@ -36,6 +39,7 @@ func EcosystemTokenMintSetEventBase(blockHeight uint64, tokenAmount math.Int) pr
 }
 
 func EmitNewRewardCurrentBlockEmissionEvent(ctx sdk.Context, blockHeight uint64, amount math.Int) {
+	metrics.IncrProducerEventCount(metrics.REWARD_CURRENT_BLOCK_EMISSION_EVENT)
 	err := ctx.EventManager().EmitTypedEvent(RewardCurrentBlockEmissionEventBase(blockHeight, amount))
 	if err != nil {
 		ctx.Logger().Warn("Error emitting EmitNewRewardCurrentBlockEmissionEvent", "error", err)