feat(x/evm): migrate x/evm metrics to OpenTelemetry Meter API #3423
There are no files selected for viewing
This file contains hidden or 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 hidden or 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 hidden or 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,35 @@ | ||
| services: | ||
| prometheus: | ||
| container_name: sei-prometheus | ||
| image: prom/prometheus:latest | ||
| ports: | ||
| - "9099:9090" | ||
| volumes: | ||
| - ./docker_compose_monitoring/prometheus.yaml:/etc/prometheus/prometheus.yml:ro | ||
| command: | ||
| - --config.file=/etc/prometheus/prometheus.yml | ||
| - --storage.tsdb.path=/prometheus | ||
| - --web.enable-lifecycle | ||
| networks: | ||
| - localnet | ||
|
|
||
| grafana: | ||
| container_name: sei-grafana | ||
| image: grafana/grafana:latest | ||
| ports: | ||
| - "3000:3000" | ||
| volumes: | ||
| - ./docker_compose_monitoring/grafana-datasource.yaml:/etc/grafana/provisioning/datasources/grafana-datasource.yaml:ro | ||
| - ./docker_compose_monitoring/grafana-dashboards.yaml:/etc/grafana/provisioning/dashboards/grafana-dashboards.yaml:ro | ||
| - ./monitornode/dashboards:/var/lib/grafana/dashboards:ro | ||
| environment: | ||
| - GF_SECURITY_ADMIN_USER=admin | ||
| - GF_SECURITY_ADMIN_PASSWORD=admin | ||
| - GF_USERS_ALLOW_SIGN_UP=false | ||
| depends_on: | ||
| - prometheus | ||
| networks: | ||
| - localnet | ||
|
|
||
| networks: | ||
| localnet: |
This file contains hidden or 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 @@ | ||
| apiVersion: 1 | ||
| providers: | ||
| - name: default | ||
| orgId: 1 | ||
| folder: "" | ||
| type: file | ||
| disableDeletion: false | ||
| updateIntervalSeconds: 30 | ||
| options: | ||
| path: /var/lib/grafana/dashboards | ||
| foldersFromFilesStructure: false | ||
|
Comment on lines
+1
to
+11
Contributor
There was a problem hiding this comment. I don't have context on these dashboards here. Are these to spin up dashboards for the docker compose personal stack? Seems like yes but want to confirm. We're creating a mirror in the platform deployment, is that right? |
||
This file contains hidden or 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,8 @@ | ||
| apiVersion: 1 | ||
|
Contributor
There was a problem hiding this comment. Lots of docker compose pieces here. I'm slightly leaning towards us not creating these and just supporting them on the new platform Grafana. Seems like complexity & scope that isn't worth it's weight to me although I like that we are thinking about the tooling end of this. |
||
| datasources: | ||
| - name: Prometheus | ||
| type: prometheus | ||
| access: proxy | ||
| url: http://prometheus:9090 | ||
| isDefault: true | ||
| editable: false | ||
This file contains hidden or 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,16 @@ | ||
| global: | ||
| scrape_interval: 15s | ||
| evaluation_interval: 15s | ||
|
|
||
| scrape_configs: | ||
| - job_name: 'sei-localnet' | ||
| metrics_path: '/metrics' | ||
| params: | ||
| format: ['prometheus'] | ||
| static_configs: | ||
| - targets: | ||
| - 'sei-node-0:1317' | ||
| - 'sei-node-1:1317' | ||
| - 'sei-node-2:1317' | ||
| - 'sei-node-3:1317' | ||
| scrape_interval: 5s |
This file contains hidden or 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 |
|---|---|---|
|
|
@@ -12,7 +12,7 @@ import ( | |
| sdkerrors "github.com/sei-protocol/sei-chain/sei-cosmos/types/errors" | ||
| upgradekeeper "github.com/sei-protocol/sei-chain/sei-cosmos/x/upgrade/keeper" | ||
| "github.com/sei-protocol/sei-chain/utils" | ||
| utilmetrics "github.com/sei-protocol/sei-chain/utils/metrics" | ||
| "github.com/sei-protocol/sei-chain/x/evm/derived" | ||
| evmkeeper "github.com/sei-protocol/sei-chain/x/evm/keeper" | ||
| "github.com/sei-protocol/sei-chain/x/evm/state" | ||
|
|
@@ -127,7 +127,8 @@ func (fc EVMFeeCheckDecorator) getMinimumFee(ctx sdk.Context) *big.Int { | |
| func (fc EVMFeeCheckDecorator) CalculatePriority(ctx sdk.Context, txData ethtx.TxData) *big.Int { | ||
| gp := txData.EffectiveGasPrice(utils.Big0) | ||
| if !ctx.IsCheckTx() && !ctx.IsReCheckTx() { | ||
| utilmetrics.HistogramEvmEffectiveGasPrice(gp) // TODO(PLT-330): remove once evm_effective_gas_price verified | ||
| evmAnteMetrics.effectiveGasPrice.Record(ctx.Context(), float64(gp.Uint64())) | ||
|
There was a problem hiding this comment. Gas price Uint64 truncation silently corrupts OTel histogramLow Severity
  Reviewed by Cursor Bugbot for commit 72e518f. Configure here. |
||
| } | ||
| priority := sdk.NewDecFromBigInt(gp).Quo(fc.evmKeeper.GetPriorityNormalizer(ctx)).TruncateInt().BigInt() | ||
| if priority.Cmp(big.NewInt(antedecorators.MaxPriority)) > 0 { | ||
|
|
||
This file contains hidden or 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,59 @@ | ||
| package ante | ||
|
|
||
| import ( | ||
| "sync" | ||
|
|
||
| "go.opentelemetry.io/otel" | ||
| "go.opentelemetry.io/otel/metric" | ||
| ) | ||
|
|
||
| type evmAnteMetricsType struct { | ||
| once sync.Once | ||
|
|
||
| // Nonce tracking | ||
| pendingNonce metric.Int64Counter | ||
| nonceMismatch metric.Int64Counter | ||
|
|
||
| // Gas price histogram | ||
| effectiveGasPrice metric.Float64Histogram | ||
|
|
||
| // Association errors | ||
| associationError metric.Int64Counter | ||
| } | ||
|
|
||
| var evmAnteMetrics evmAnteMetricsType | ||
|
|
||
| func mustAnteMetric[V any](v V, err error) V { | ||
| if err != nil { | ||
| panic(err) | ||
| } | ||
| return v | ||
|
Comment on lines
+26
to
+30
Contributor
There was a problem hiding this comment. nit: you're doing this but in different ways across packages. Consider consolidating into a single place for all your metrics structs to reuse. |
||
| } | ||
|
|
||
| // InitEvmAnteMetrics registers all OTel instruments for the x/evm ante package. | ||
| // Safe to call concurrently; instruments are registered exactly once. | ||
| func InitEvmAnteMetrics() { | ||
| evmAnteMetrics.once.Do(func() { | ||
| meter := otel.Meter("evm_ante") | ||
|
|
||
| evmAnteMetrics.pendingNonce = mustAnteMetric(meter.Int64Counter( | ||
| "evm_pending_nonce_total", | ||
| metric.WithDescription("EVM pending nonce events by type (added, expired, rejected, accepted)"), | ||
| )) | ||
|
|
||
| evmAnteMetrics.nonceMismatch = mustAnteMetric(meter.Int64Counter( | ||
| "evm_nonce_mismatch_total", | ||
| metric.WithDescription("EVM nonce mismatches by cause (too_high, too_low)"), | ||
| )) | ||
|
|
||
| evmAnteMetrics.effectiveGasPrice = mustAnteMetric(meter.Float64Histogram( | ||
| "evm_effective_gas_price", | ||
| metric.WithDescription("Effective gas price for EVM transactions"), | ||
| )) | ||
|
|
||
| evmAnteMetrics.associationError = mustAnteMetric(meter.Int64Counter( | ||
| "evm_ante_association_error_total", | ||
| metric.WithDescription("EVM address association errors by scenario and address type"), | ||
| )) | ||
| }) | ||
| } | ||
This file contains hidden or 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,32 @@ | ||
| package ante | ||
|
|
||
| import ( | ||
| "context" | ||
| "testing" | ||
|
|
||
| "go.opentelemetry.io/otel" | ||
| "go.opentelemetry.io/otel/attribute" | ||
| otelmetric "go.opentelemetry.io/otel/metric" | ||
| "go.opentelemetry.io/otel/metric/noop" | ||
| ) | ||
|
|
||
| func TestInitEvmAnteMetricsNoPanic(t *testing.T) { | ||
| otel.SetMeterProvider(noop.NewMeterProvider()) | ||
| InitEvmAnteMetrics() | ||
| } | ||
|
|
||
| func TestEvmAnteMetricsAllInstrumentsUsable(t *testing.T) { | ||
| otel.SetMeterProvider(noop.NewMeterProvider()) | ||
| InitEvmAnteMetrics() | ||
|
|
||
| ctx := context.Background() | ||
|
|
||
| for _, event := range []string{"added", "expired", "rejected", "accepted"} { | ||
| evmAnteMetrics.pendingNonce.Add(ctx, 1, otelmetric.WithAttributes(attribute.String("event", event))) | ||
| } | ||
| for _, cause := range []string{"too_high", "too_low"} { | ||
| evmAnteMetrics.nonceMismatch.Add(ctx, 1, otelmetric.WithAttributes(attribute.String("cause", cause))) | ||
| } | ||
| evmAnteMetrics.effectiveGasPrice.Record(ctx, 1e9) | ||
| evmAnteMetrics.associationError.Add(ctx, 1, otelmetric.WithAttributes(attribute.String("scenario", "associate_tx_insufficient_funds"), attribute.String("type", "sei"))) | ||
| } |
This file contains hidden or 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 hidden or 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 hidden or 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 hidden or 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
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Grafana and Prometheus were adding a lot of noise to the logs so added --no-attach flag. Their logs can still be viewed with
docker logs sei-grafanaanddocker logs sei-prometheus