Merge pull request #7519 from Sabnock01/sabnock/issue-6741

chore: op-service metrics cleanup

op-batcher/cmd/doc/cmd.go

-package doc
-
-import (
-	"encoding/json"
-	"fmt"
-	"os"
-	"strings"
-
-	"github.com/ethereum-optimism/optimism/op-batcher/metrics"
-	"github.com/olekukonko/tablewriter"
-	"github.com/urfave/cli/v2"
-)
-
-var Subcommands = cli.Commands{
-	{
-		Name:  "metrics",
-		Usage: "Dumps a list of supported metrics to stdout",
-		Flags: []cli.Flag{
-			&cli.StringFlag{
-				Name:  "format",
-				Value: "markdown",
-				Usage: "Output format (json|markdown)",
-			},
-		},
-		Action: func(ctx *cli.Context) error {
-			m := metrics.NewMetrics("default")
-			supportedMetrics := m.Document()
-			format := ctx.String("format")
-
-			if format != "markdown" && format != "json" {
-				return fmt.Errorf("invalid format: %s", format)
-			}
-
-			if format == "json" {
-				enc := json.NewEncoder(os.Stdout)
-				return enc.Encode(supportedMetrics)
-			}
-
-			table := tablewriter.NewWriter(os.Stdout)
-			table.SetBorders(tablewriter.Border{Left: true, Top: false, Right: true, Bottom: false})
-			table.SetCenterSeparator("|")
-			table.SetAutoWrapText(false)
-			table.SetHeader([]string{"Metric", "Description", "Labels", "Type"})
-			var data [][]string
-			for _, metric := range supportedMetrics {
-				labels := strings.Join(metric.Labels, ",")
-				data = append(data, []string{metric.Name, metric.Help, labels, metric.Type})
-			}
-			table.AppendBulk(data)
-			table.Render()
-			return nil
-		},
-	},
-}

op-batcher/cmd/main.go

@@ -7,10 +7,11 @@ import (
 	"github.com/urfave/cli/v2"
 
 	"github.com/ethereum-optimism/optimism/op-batcher/batcher"
-	"github.com/ethereum-optimism/optimism/op-batcher/cmd/doc"
 	"github.com/ethereum-optimism/optimism/op-batcher/flags"
+	"github.com/ethereum-optimism/optimism/op-batcher/metrics"
 	"github.com/ethereum-optimism/optimism/op-service/cliapp"
 	oplog "github.com/ethereum-optimism/optimism/op-service/log"
+	"github.com/ethereum-optimism/optimism/op-service/metrics/doc"
 	"github.com/ethereum/go-ethereum/log"
 )
 
@@ -33,7 +34,7 @@ func main() {
 	app.Commands = []*cli.Command{
 		{
 			Name:        "doc",
-			Subcommands: doc.Subcommands,
+			Subcommands: doc.NewSubcommands(metrics.NewMetrics("default")),
 		},
 	}
 

op-node/cmd/doc/cmd.go

-package doc
-
-import (
-	"encoding/json"
-	"fmt"
-	"os"
-	"strings"
-
-	"github.com/ethereum-optimism/optimism/op-node/metrics"
-	"github.com/olekukonko/tablewriter"
-	"github.com/urfave/cli/v2"
-)
-
-var Subcommands = cli.Commands{
-	{
-		Name:  "metrics",
-		Usage: "Dumps a list of supported metrics to stdout",
-		Flags: []cli.Flag{
-			&cli.StringFlag{
-				Name:  "format",
-				Value: "markdown",
-				Usage: "Output format (json|markdown)",
-			},
-		},
-		Action: func(ctx *cli.Context) error {
-			m := metrics.NewMetrics("default")
-			supportedMetrics := m.Document()
-			format := ctx.String("format")
-
-			if format != "markdown" && format != "json" {
-				return fmt.Errorf("invalid format: %s", format)
-			}
-
-			if format == "json" {
-				enc := json.NewEncoder(os.Stdout)
-				return enc.Encode(supportedMetrics)
-			}
-
-			table := tablewriter.NewWriter(os.Stdout)
-			table.SetBorders(tablewriter.Border{Left: true, Top: false, Right: true, Bottom: false})
-			table.SetCenterSeparator("|")
-			table.SetAutoWrapText(false)
-			table.SetHeader([]string{"Metric", "Description", "Labels", "Type"})
-			var data [][]string
-			for _, metric := range supportedMetrics {
-				labels := strings.Join(metric.Labels, ",")
-				data = append(data, []string{metric.Name, metric.Help, labels, metric.Type})
-			}
-			table.AppendBulk(data)
-			table.Render()
-			return nil
-		},
-	},
-}

op-node/cmd/main.go

@@ -11,7 +11,6 @@ import (
 
 	opnode "github.com/ethereum-optimism/optimism/op-node"
 	"github.com/ethereum-optimism/optimism/op-node/chaincfg"
-	"github.com/ethereum-optimism/optimism/op-node/cmd/doc"
 	"github.com/ethereum-optimism/optimism/op-node/cmd/genesis"
 	"github.com/ethereum-optimism/optimism/op-node/cmd/p2p"
 	"github.com/ethereum-optimism/optimism/op-node/flags"
@@ -21,6 +20,7 @@ import (
 	opservice "github.com/ethereum-optimism/optimism/op-service"
 	"github.com/ethereum-optimism/optimism/op-service/cliapp"
 	oplog "github.com/ethereum-optimism/optimism/op-service/log"
+	"github.com/ethereum-optimism/optimism/op-service/metrics/doc"
 )
 
 var (
@@ -66,7 +66,7 @@ func main() {
 		},
 		{
 			Name:        "doc",
-			Subcommands: doc.Subcommands,
+			Subcommands: doc.NewSubcommands(metrics.NewMetrics("default")),
 		},
 	}
 

op-node/metrics/metrics.go

@@ -82,8 +82,8 @@ type Metrics struct {
 
 	metrics.RPCMetrics
 
-	L1SourceCache *CacheMetrics
-	L2SourceCache *CacheMetrics
+	L1SourceCache *metrics.CacheMetrics
+	L2SourceCache *metrics.CacheMetrics
 
 	DerivationIdle prometheus.Gauge
 
@@ -177,8 +177,8 @@ func NewMetrics(procName string) *Metrics {
 
 		RPCMetrics: metrics.MakeRPCMetrics(ns, factory),
 
-		L1SourceCache: NewCacheMetrics(factory, ns, "l1_source_cache", "L1 Source cache"),
-		L2SourceCache: NewCacheMetrics(factory, ns, "l2_source_cache", "L2 Source cache"),
+		L1SourceCache: metrics.NewCacheMetrics(factory, ns, "l1_source_cache", "L1 Source cache"),
+		L2SourceCache: metrics.NewCacheMetrics(factory, ns, "l2_source_cache", "L2 Source cache"),
 
 		DerivationIdle: factory.NewGauge(prometheus.GaugeOpts{
 			Namespace: ns,

op-proposer/cmd/doc/cmd.go

-package doc
-
-import (
-	"encoding/json"
-	"fmt"
-	"os"
-	"strings"
-
-	"github.com/ethereum-optimism/optimism/op-proposer/metrics"
-	"github.com/olekukonko/tablewriter"
-	"github.com/urfave/cli/v2"
-)
-
-var Subcommands = cli.Commands{
-	{
-		Name:  "metrics",
-		Usage: "Dumps a list of supported metrics to stdout",
-		Flags: []cli.Flag{
-			&cli.StringFlag{
-				Name:  "format",
-				Value: "markdown",
-				Usage: "Output format (json|markdown)",
-			},
-		},
-		Action: func(ctx *cli.Context) error {
-			m := metrics.NewMetrics("default")
-			supportedMetrics := m.Document()
-			format := ctx.String("format")
-
-			if format != "markdown" && format != "json" {
-				return fmt.Errorf("invalid format: %s", format)
-			}
-
-			if format == "json" {
-				enc := json.NewEncoder(os.Stdout)
-				return enc.Encode(supportedMetrics)
-			}
-
-			table := tablewriter.NewWriter(os.Stdout)
-			table.SetBorders(tablewriter.Border{Left: true, Top: false, Right: true, Bottom: false})
-			table.SetCenterSeparator("|")
-			table.SetAutoWrapText(false)
-			table.SetHeader([]string{"Metric", "Description", "Labels", "Type"})
-			var data [][]string
-			for _, metric := range supportedMetrics {
-				labels := strings.Join(metric.Labels, ",")
-				data = append(data, []string{metric.Name, metric.Help, labels, metric.Type})
-			}
-			table.AppendBulk(data)
-			table.Render()
-			return nil
-		},
-	},
-}

op-proposer/cmd/main.go

@@ -6,11 +6,12 @@ import (
 
 	"github.com/urfave/cli/v2"
 
-	"github.com/ethereum-optimism/optimism/op-proposer/cmd/doc"
 	"github.com/ethereum-optimism/optimism/op-proposer/flags"
+	"github.com/ethereum-optimism/optimism/op-proposer/metrics"
 	"github.com/ethereum-optimism/optimism/op-proposer/proposer"
 	"github.com/ethereum-optimism/optimism/op-service/cliapp"
 	oplog "github.com/ethereum-optimism/optimism/op-service/log"
+	"github.com/ethereum-optimism/optimism/op-service/metrics/doc"
 	"github.com/ethereum/go-ethereum/log"
 )
 
@@ -33,7 +34,7 @@ func main() {
 	app.Commands = []*cli.Command{
 		{
 			Name:        "doc",
-			Subcommands: doc.Subcommands,
+			Subcommands: doc.NewSubcommands(metrics.NewMetrics("default")),
 		},
 	}
 

op-node/metrics/caching.go → op-service/metrics/caching.go

 package metrics
 
 import (
-	"github.com/ethereum-optimism/optimism/op-service/metrics"
 	"github.com/prometheus/client_golang/prometheus"
 )
 
@@ -34,7 +33,7 @@ func (m *CacheMetrics) CacheGet(typeLabel string, hit bool) {
 	}
 }
 
-func NewCacheMetrics(factory metrics.Factory, ns string, name string, displayName string) *CacheMetrics {
+func NewCacheMetrics(factory Factory, ns string, name string, displayName string) *CacheMetrics {
 	return &CacheMetrics{
 		SizeVec: factory.NewGaugeVec(prometheus.GaugeOpts{
 			Namespace: ns,

op-service/metrics/doc/cmd.go

+package doc
+
+import (
+	"encoding/json"
+	"fmt"
+	"os"
+	"strings"
+
+	"github.com/olekukonko/tablewriter"
+	"github.com/urfave/cli/v2"
+
+	"github.com/ethereum-optimism/optimism/op-service/metrics"
+)
+
+type Metrics interface {
+	Document() []metrics.DocumentedMetric
+}
+
+func NewSubcommands(m Metrics) cli.Commands {
+	return cli.Commands{
+		{
+			Name:  "metrics",
+			Usage: "Dumps a list of supported metrics to stdout",
+			Flags: []cli.Flag{
+				&cli.StringFlag{
+					Name:  "format",
+					Value: "markdown",
+					Usage: "Output format (json|markdown)",
+				},
+			},
+			Action: func(ctx *cli.Context) error {
+				supportedMetrics := m.Document()
+				format := ctx.String("format")
+
+				if format != "markdown" && format != "json" {
+					return fmt.Errorf("invalid format: %s", format)
+				}
+
+				if format == "json" {
+					enc := json.NewEncoder(os.Stdout)
+					return enc.Encode(supportedMetrics)
+				}
+
+				table := tablewriter.NewWriter(os.Stdout)
+				table.SetBorders(tablewriter.Border{Left: true, Top: false, Right: true, Bottom: false})
+				table.SetCenterSeparator("|")
+				table.SetAutoWrapText(false)
+				table.SetHeader([]string{"Metric", "Description", "Labels", "Type"})
+				var data [][]string
+				for _, metric := range supportedMetrics {
+					labels := strings.Join(metric.Labels, ",")
+					data = append(data, []string{metric.Name, metric.Help, labels, metric.Type})
+				}
+				table.AppendBulk(data)
+				table.Render()
+				return nil
+			},
+		},
+	}
+}