go-ethereum/statediff/indexer/database/sql/metrics/metrics.go

// VulcanizeDB
// Copyright © 2021 Vulcanize

// This program is free software: you can redistribute it and/or modify
// it under the terms of the GNU Affero General Public License as published by
// the Free Software Foundation, either version 3 of the License, or
// (at your option) any later version.

// This program is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
// GNU Affero General Public License for more details.

// You should have received a copy of the GNU Affero General Public License
// along with this program.  If not, see <http://www.gnu.org/licenses/>.

package metrics

import (
	"strings"

	"github.com/ethereum/go-ethereum/statediff/indexer/interfaces"

	"github.com/ethereum/go-ethereum/metrics"
)

const (
	namespace = "statediff"
)

// Build a fully qualified metric name
func metricName(subsystem, name string) string {
	if name == "" {
		return ""
	}
	parts := []string{namespace, name}
	if subsystem != "" {
		parts = []string{namespace, subsystem, name}
	}
	// Prometheus uses _ but geth metrics uses / and replaces
	return strings.Join(parts, "/")
}

type WriterMetricsHandles struct {
	// The total number of processed blocks
	Blocks metrics.Counter
	// The total number of processed transactions
	Transactions metrics.Counter
	// The total number of processed receipts
	Receipts metrics.Counter
	// The total number of processed logs
	Logs metrics.Counter
	// The total number of access list entries processed
	AccessListEntries metrics.Counter
}

type IndexerMetricsHandles struct {
	// Time spent waiting for free postgres tx
	TimeFreePostgres metrics.Timer
	// Postgres transaction commit duration
	TimePostgresCommit metrics.Timer
	// Header processing time
	TimeHeaderProcessing metrics.Timer
	// Uncle processing time
	TimeUncleProcessing metrics.Timer
	// Tx and receipt processing time
	TimeTxAndRecProcessing metrics.Timer
	// State, storage, and code combined processing time
	TimeStateStoreCodeProcessing metrics.Timer
}

func RegisterWriterMetrics(reg metrics.Registry, version string) WriterMetricsHandles {
	ctx := WriterMetricsHandles{
		Blocks:            metrics.NewCounter(),
		Transactions:      metrics.NewCounter(),
		Receipts:          metrics.NewCounter(),
		Logs:              metrics.NewCounter(),
		AccessListEntries: metrics.NewCounter(),
	}
	subsys := "writer"
	reg.Register(metricName(subsys, version+"/"+"blocks"), ctx.Blocks)
	reg.Register(metricName(subsys, version+"/"+"transactions"), ctx.Transactions)
	reg.Register(metricName(subsys, version+"/"+"receipts"), ctx.Receipts)
	reg.Register(metricName(subsys, version+"/"+"logs"), ctx.Logs)
	reg.Register(metricName(subsys, version+"/"+"access_list_entries"), ctx.AccessListEntries)
	return ctx
}

func RegisterIndexerMetrics(reg metrics.Registry) IndexerMetricsHandles {
	ctx := IndexerMetricsHandles{
		TimeFreePostgres:             metrics.NewTimer(),
		TimePostgresCommit:           metrics.NewTimer(),
		TimeHeaderProcessing:         metrics.NewTimer(),
		TimeUncleProcessing:          metrics.NewTimer(),
		TimeTxAndRecProcessing:       metrics.NewTimer(),
		TimeStateStoreCodeProcessing: metrics.NewTimer(),
	}
	subsys := "indexer"
	reg.Register(metricName(subsys, "t_free_postgres"), ctx.TimeFreePostgres)
	reg.Register(metricName(subsys, "t_postgres_commit"), ctx.TimePostgresCommit)
	reg.Register(metricName(subsys, "t_header_processing"), ctx.TimeHeaderProcessing)
	reg.Register(metricName(subsys, "t_uncle_processing"), ctx.TimeUncleProcessing)
	reg.Register(metricName(subsys, "t_tx_receipt_processing"), ctx.TimeTxAndRecProcessing)
	reg.Register(metricName(subsys, "t_state_store_code_processing"), ctx.TimeStateStoreCodeProcessing)
	return ctx
}

type dbMetricsHandles struct {
	// Maximum number of open connections to the sql
	maxOpen metrics.Gauge
	// The number of established connections both in use and idle
	open metrics.Gauge
	// The number of connections currently in use
	inUse metrics.Gauge
	// The number of idle connections
	idle metrics.Gauge
	// The total number of connections waited for
	waitedFor metrics.Counter
	// The total time blocked waiting for a new connection
	blockedMilliseconds metrics.Counter
	// The total number of connections closed due to SetMaxIdleConns
	closedMaxIdle metrics.Counter
	// The total number of connections closed due to SetConnMaxLifetime
	closedMaxLifetime metrics.Counter
}

func RegisterDBMetrics(reg metrics.Registry) dbMetricsHandles {
	ctx := dbMetricsHandles{
		maxOpen:             metrics.NewGauge(),
		open:                metrics.NewGauge(),
		inUse:               metrics.NewGauge(),
		idle:                metrics.NewGauge(),
		waitedFor:           metrics.NewCounter(),
		blockedMilliseconds: metrics.NewCounter(),
		closedMaxIdle:       metrics.NewCounter(),
		closedMaxLifetime:   metrics.NewCounter(),
	}
	subsys := "connections"
	reg.Register(metricName(subsys, "max_open"), ctx.maxOpen)
	reg.Register(metricName(subsys, "open"), ctx.open)
	reg.Register(metricName(subsys, "in_use"), ctx.inUse)
	reg.Register(metricName(subsys, "idle"), ctx.idle)
	reg.Register(metricName(subsys, "waited_for"), ctx.waitedFor)
	reg.Register(metricName(subsys, "blocked_milliseconds"), ctx.blockedMilliseconds)
	reg.Register(metricName(subsys, "closed_max_idle"), ctx.closedMaxIdle)
	reg.Register(metricName(subsys, "closed_max_lifetime"), ctx.closedMaxLifetime)
	return ctx
}

func (met *dbMetricsHandles) Update(stats interfaces.Stats) {
	met.maxOpen.Update(stats.MaxOpen())
	met.open.Update(stats.Open())
	met.inUse.Update(stats.InUse())
	met.idle.Update(stats.Idle())
	met.waitedFor.Inc(stats.WaitCount())
	met.blockedMilliseconds.Inc(stats.WaitDuration().Milliseconds())
	met.closedMaxIdle.Inc(stats.MaxIdleClosed())
	met.closedMaxLifetime.Inc(stats.MaxLifetimeClosed())
}