feat: api and indexer instrumented with metrics by dhyaniarun1993 · Pull Request #221 · ChainSafe/canton-middleware

dhyaniarun1993 · 2026-04-17T08:19:11Z

Closes #205

…toring

// fails the other is cancelled

…toring

codecov-commenter · 2026-04-17T08:21:39Z

Codecov Report

❌ Patch coverage is 10.06787% with 795 lines in your changes missing coverage. Please review.
⚠️ Please upload report for BASE (main@14e507f). Learn more about missing BASE report.

Files with missing lines	Patch %	Lines
pkg/indexer/store/instrumented.go	0.00%	213 Missing ⚠️
pkg/ethrpc/store/instrumented.go	0.00%	117 Missing ⚠️
pkg/userstore/instrumented.go	0.00%	93 Missing ⚠️
pkg/indexer/client/instrumented.go	0.00%	63 Missing ⚠️
pkg/app/indexer/server.go	0.00%	46 Missing ⚠️
pkg/app/api/server.go	0.00%	41 Missing ⚠️
pkg/app/http/metrics.go	0.00%	25 Missing ⚠️
pkg/app/http/middleware.go	0.00%	22 Missing ⚠️
pkg/ethrpc/store/metrics.go	0.00%	22 Missing ⚠️
pkg/indexer/store/metrics.go	0.00%	22 Missing ⚠️
... and 11 more

❌ Your patch status has failed because the patch coverage (10.06%) is below the target coverage (50.00%). You can increase the patch coverage or adjust the target coverage.

Additional details and impacted files

@@           Coverage Diff           @@
##             main     #221   +/-   ##
=======================================
  Coverage        ?   29.67%           
=======================================
  Files           ?      147           
  Lines           ?    11008           
  Branches        ?        0           
=======================================
  Hits            ?     3267           
  Misses          ?     7471           
  Partials        ?      270

Flag	Coverage Δ
unittests	`29.67% <10.06%> (?)`

Flags with carried forward coverage won't be shown. Click here to find out more.

Files with missing lines	Coverage Δ
pkg/config/config.go	`71.18% <ø> (ø)`
pkg/ethrpc/miner/metrics.go	`100.00% <100.00%> (ø)`
pkg/ethrpc/miner/miner.go	`97.84% <100.00%> (ø)`
pkg/indexer/engine/metrics.go	`100.00% <100.00%> (ø)`
pkg/indexer/engine/processor.go	`67.06% <100.00%> (ø)`
pkg/relayer/engine/metrics.go	`94.95% <100.00%> (ø)`
internal/metrics/metrics.go	`0.00% <0.00%> (ø)`
pkg/cantonsdk/client/options.go	`0.00% <0.00%> (ø)`
pkg/relayer/store/metrics.go	`0.00% <0.00%> (ø)`
pkg/app/relayer/server.go	`0.00% <0.00%> (ø)`
... and 17 more

🚀 New features to boost your workflow:

❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

gemini-code-assist

Code Review

This pull request implements comprehensive Prometheus metrics instrumentation across the API server, indexer, relayer, and Canton SDK, including dedicated monitoring endpoints and updated deployment configurations. It also introduces a robust suite of end-to-end tests covering user registration, JSON-RPC facades, and bridge deposit/withdrawal flows. Feedback highlights the need to remove an outdated compile-time guard in the API middleware, address a risky type assertion in the instrumented indexer store to prevent potential panics, and refactor the indexer's monitoring server initialization to ensure architectural consistency across the codebase.

Resolved conflicts in: - pkg/app/api/server.go: kept main's initServices refactor and new AcceptWorker/submitter wiring while layering this branch's metrics registerer through evmStore, transferCache, miner, HTTP middleware, and the optional metrics server (serveAll). - pkg/app/http/middleware.go: combined RequestMetricsMiddleware (this branch) and CORSMiddleware (main) into a single file. - pkg/app/indexer/server.go: kept main's multi-template fetcher (offers + holdings) and wrapped the resulting store/processor in this branch's Prometheus metrics. - pkg/cantonsdk/client/client.go: kept main's net/http import (used by the new registry client). - pkg/config/config.go: kept Monitoring on APIServer (this branch) alongside main's TokenProvider/AcceptWorker/SkipWhitelistCheck/ CORSOrigins fields. Carried this branch's instrumentation forward by adding pass-through metrics for the new main methods: InsertHolding/TakeHolding, InsertPendingOffer/MarkOfferAccepted, ListPendingOffersForParty/ ListAllPendingOffers, ListCustodialUsers, GetMempoolEntriesByStatus, GetPendingOffersForParty/GetAllPendingOffers (indexer HTTP client). Updated the indexer processor's per-event-type counters to type-switch on the new heterogeneous Batch[any]; only ParsedEvent contributes to EventType/EffectiveTime metrics.

sadiq1971 · 2026-06-02T07:53:03Z

/gemini review

gemini-code-assist

Code Review

This pull request introduces comprehensive Prometheus metrics instrumentation across the Canton Middleware components, including the API server, Indexer, Relayer, Canton SDK client, and database stores, along with Grafana dashboards and Prometheus scraping configurations. The review feedback highlights three key improvement opportunities: preventing potential nil pointer dereference panics in the batch processor and HTTP metrics middleware, and optimizing HTTP request logging performance by replacing fmt.Sprintf with strconv.Itoa in the middleware hot path.

Important

The consumer version of Gemini Code Assist on GitHub is being sunset. Starting June 18, 2026, new organization installations will be blocked, and all code review activity will officially cease on July 17, 2026.
For more details on the timeline and next steps, please review the Help Documentation.

Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com>

sadiq1971 · 2026-06-03T01:06:57Z

+	reg sharedmetrics.NamespacedRegisterer,
 	logger *zap.Logger,
 ) (*services, error) {
 	userStore := userstore.NewStore(dbBun)


Any reason we are not passing the instrumented userstore here?

Thanks for pointing it out. I think it got missed while resolving the merge conflict. Fixing

sadiq1971 · 2026-06-03T01:13:33Z

 	if url == "" {
 		return nil, fmt.Errorf("indexer URL is required: set token_provider.indexer.url or accept_worker.indexer_url")
 	}
 	c, err := indexerclient.New(url, nil)


Shouldn't we use InstrumentedClient for indexer?

Thanks for pointing it out. I think it got missed while resolving the merge conflict. Fixing

sadiq1971 · 2026-06-03T01:16:54Z

+
+	if s.cfg.Monitoring != nil && s.cfg.Monitoring.Enabled {
+		if s.cfg.Monitoring.Server == nil {
+			return fmt.Errorf("monitoring is enabled but server config is nil")


Returning before g.Wait() abandons the already-started HTTP server goroutine and skips graceful shutdown. This should be a config-validation error at load time (the Monitoring struct is validate:"required", not a runtime check after a goroutine is live. Validate up front and you can delete the runtime guard entirely.

True, we already have validate in the config. This is dead code. We can drop this.

dhyaniarun1993 added 19 commits April 14, 2026 17:31

feat(relayer): add per-module metrics

ebbc2fb

review and lint fixes

34abd88

fixes

3a3d058

refactor

4e260a3

more improvements

8d9015f

added todo

c0042f8

fixed ChainHeadPosition

7e775b1

ReadinessSyncDuration removed

f4d1d93

improve SetLastProcessedBlock in engine

9f2e1ac

fix(relayer): serve /metrics on dedicated monitoring port

8d16538

feat: add Prometheus and Grafana to Docker Compose

2bd3b4f

review fixes

9ed3f5e

Merge branch 'fix/relayer-metrics-port' into feat/docker-compose-moni…

5f74c4d

…toring

review fixes

e5c8483

main merged

eb8f991

if either server

0a5c58a

// fails the other is cancelled

lintfix

c168163

Merge branch 'fix/relayer-metrics-port' into feat/docker-compose-moni…

2376458

…toring

feat: api and indexer instrumented with metrics

808abf1

dhyaniarun1993 self-assigned this Apr 17, 2026

gemini-code-assist Bot reviewed Apr 17, 2026

View reviewed changes

Comment thread pkg/app/api/middleware.go Outdated

Comment thread pkg/indexer/store/instrumented.go Outdated

Comment thread pkg/app/indexer/server.go

review fixes

c00d263

Base automatically changed from feat/docker-compose-monitoring to main April 17, 2026 09:05

Merge branch 'main' into feat/api-indexer-metrics

fa5f5aa

dhyaniarun1993 requested review from sadiq1971 and salindne April 17, 2026 11:05

dhyaniarun1993 marked this pull request as ready for review April 17, 2026 11:06

dhyaniarun1993 added 2 commits April 17, 2026 18:37

improvements

ff21c83

feat(grafana): dashboard added (#224)

1bd4585

dhyaniarun1993 added 2 commits June 1, 2026 19:30

lint fixes

160b04a

gemini-code-assist Bot reviewed Jun 2, 2026

View reviewed changes

Comment thread pkg/indexer/engine/processor.go

Comment thread pkg/app/http/middleware.go

Comment thread pkg/app/http/middleware.go Outdated

dhyaniarun1993 and others added 4 commits June 2, 2026 13:28

Update pkg/indexer/engine/processor.go

c3faca2

Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com>

Update pkg/app/http/middleware.go

ca805b8

Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com>

nil guard check added

6547449

fixes

666b64b

sadiq1971 reviewed Jun 3, 2026

View reviewed changes

review fixes

17d61dc

Conversation

dhyaniarun1993 commented Apr 17, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

codecov-commenter commented Apr 17, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

gemini-code-assist Bot left a comment

Choose a reason for hiding this comment

Code Review

Uh oh!

Uh oh!

Uh oh!

Uh oh!

sadiq1971 commented Jun 2, 2026

Uh oh!

gemini-code-assist Bot left a comment

Choose a reason for hiding this comment

Code Review

Uh oh!

Uh oh!

Uh oh!

Uh oh!

sadiq1971 Jun 3, 2026

Choose a reason for hiding this comment

Uh oh!

dhyaniarun1993 Jun 3, 2026

Choose a reason for hiding this comment

Uh oh!

sadiq1971 Jun 3, 2026

Choose a reason for hiding this comment

Uh oh!

dhyaniarun1993 Jun 3, 2026

Choose a reason for hiding this comment

Uh oh!

sadiq1971 Jun 3, 2026

Choose a reason for hiding this comment

Uh oh!

dhyaniarun1993 Jun 3, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

dhyaniarun1993 commented Apr 17, 2026 •

edited

Loading

codecov-commenter commented Apr 17, 2026 •

edited

Loading

dhyaniarun1993 Jun 3, 2026 •

edited

Loading