Merge pull request #5932 from ethereum-optimism/cleanup/l2-geth-exporter

cleanup: delete l2geth-exporter

.github/CODEOWNERS

@@ -3,7 +3,6 @@
 /bss-core                       @ethereum-optimism/legacy-reviewers
 /gas-oracle                     @ethereum-optimism/legacy-reviewers
 /l2geth                         @ethereum-optimism/legacy-reviewers
-/l2geth-exporter                @ethereum-optimism/legacy-reviewers
 /packages/actor-tests           @ethereum-optimism/legacy-reviewers
 /packages/common-ts             @ethereum-optimism/typescript-reviewers
 /packages/contracts             @ethereum-optimism/contract-reviewers

.github/workflows/publish-canary.yml

@@ -29,9 +29,8 @@ jobs:
       hardhat-node: ${{ steps.packages.outputs.hardhat-node }}
       canary-docker-tag: ${{ steps.docker-image-name.outputs.canary-docker-tag }}
       op-exporter: ${{ steps.packages.outputs.op-exporter }}
-      l2geth-exporter: ${{ steps.packages.outputs.l2geth-exporter }}
       batch-submitter-service: ${{ steps.packages.outputs.batch-submitter-service }}
-      endpoint-monitor: ${{ steps.packages.outputs.l2geth-exporter }}
+      endpoint-monitor: ${{ steps.packages.outputs.endpoint-monitor }}
 
     steps:
       - name: Check out source code
@@ -458,43 +457,6 @@ jobs:
             GITCOMMIT=${{ steps.build_args.outputs.GITCOMMIT }}
             GITVERSION=${{ steps.build_args.outputs.GITVERSION }}
 
-  l2geth-exporter:
-    name: Publish l2geth-exporter Version ${{ needs.canary-publish.outputs.canary-docker-tag }}
-    needs: canary-publish
-    if: needs.canary-publish.outputs.l2geth-exporter != ''
-    runs-on: ubuntu-latest
-
-    steps:
-      - name: Checkout
-        uses: actions/checkout@v2
-      - name: Set up Docker Buildx
-        uses: docker/setup-buildx-action@v1
-
-      - name: Login to Docker Hub
-        uses: docker/login-action@v1
-        with:
-          username: ${{ secrets.DOCKERHUB_ACCESS_TOKEN_USERNAME }}
-          password: ${{ secrets.DOCKERHUB_ACCESS_TOKEN_SECRET }}
-
-      - name: Set build args
-        id: build_args
-        run: |
-          echo ::set-output name=GITDATE::"$(date +%d-%m-%Y)"
-          echo ::set-output name=GITVERSION::$(jq -r .version ./l2geth-exporter/package.json)
-          echo ::set-output name=GITCOMMIT::"$GITHUB_SHA"
-
-      - name: Build and push
-        uses: docker/build-push-action@v2
-        with:
-          context: .
-          file: ./l2geth-exporter/Dockerfile
-          push: true
-          tags: ethereumoptimism/l2geth-exporter:${{ needs.canary-publish.outputs.l2geth-exporter }}
-          build-args: |
-            GITDATE=${{ steps.build_args.outputs.GITDATE }}
-            GITCOMMIT=${{ steps.build_args.outputs.GITCOMMIT }}
-            GITVERSION=${{ steps.build_args.outputs.GITVERSION }}
-
   batch-submitter-service:
     name: Publish batch-submitter-service Version ${{ needs.canary-publish.outputs.canary-docker-tag }}
     needs: canary-publish

.github/workflows/release.yml

@@ -28,7 +28,6 @@ jobs:
       replica-healthcheck: ${{ steps.packages.outputs.replica-healthcheck }}
       hardhat-node: ${{ steps.packages.outputs.hardhat-node }}
       op-exporter: ${{ steps.packages.outputs.op-exporter }}
-      l2geth-exporter: ${{ steps.packages.outputs.l2geth-exporter }}
       batch-submitter-service: ${{ steps.packages.outputs.batch-submitter-service }}
       foundry: ${{ steps.packages.outputs.foundry }}
       endpoint-monitor: ${{ steps.packages.outputs.endpoint-monitor }}
@@ -190,43 +189,6 @@ jobs:
           push: true
           tags: ethereumoptimism/foundry:${{ needs.release.outputs.foundry }},ethereumoptimism/foundry:latest
 
-  l2geth-exporter:
-    name: Publish l2geth-exporter Version ${{ needs.release.outputs.l2geth-exporter}}
-    needs: release
-    if: needs.release.outputs.l2geth-exporter != ''
-    runs-on: ubuntu-latest
-
-    steps:
-      - name: Checkout
-        uses: actions/checkout@v2
-      - name: Set up Docker Buildx
-        uses: docker/setup-buildx-action@v1
-
-      - name: Login to Docker Hub
-        uses: docker/login-action@v1
-        with:
-          username: ${{ secrets.DOCKERHUB_ACCESS_TOKEN_USERNAME }}
-          password: ${{ secrets.DOCKERHUB_ACCESS_TOKEN_SECRET }}
-
-      - name: Set build args
-        id: build_args
-        run: |
-          echo ::set-output name=GITDATE::"$(date +%d-%m-%Y)"
-          echo ::set-output name=GITVERSION::$(jq -r .version ./l2geth-exporter/package.json)
-          echo ::set-output name=GITCOMMIT::"$GITHUB_SHA"
-
-      - name: Build and push
-        uses: docker/build-push-action@v2
-        with:
-          context: .
-          file: ./l2geth-exporter/Dockerfile
-          push: true
-          tags: ethereumoptimism/l2geth-exporter:${{ needs.release.outputs.l2geth-exporter }},ethereumoptimism/l2geth-exporter:latest
-          build-args: |
-            GITDATE=${{ steps.build_args.outputs.GITDATE }}
-            GITCOMMIT=${{ steps.build_args.outputs.GITCOMMIT }}
-            GITVERSION=${{ steps.build_args.outputs.GITVERSION }}
-
   op-exporter:
     name: Publish op-exporter Version ${{ needs.release.outputs.op-exporter}}
     needs: release

README.md

@@ -96,7 +96,6 @@ Refer to the Directory Structure section below to understand which packages are
 ├── <a href="./indexer">indexer</a>: indexes and syncs transactions
 ├── <a href="./infra/op-replica">infra/op-replica</a>: Deployment examples and resources for running an Optimism replica
 ├── <a href="./l2geth">l2geth</a>: Optimism client software, a fork of <a href="https://github.com/ethereum/go-ethereum/tree/v1.9.10">geth v1.9.10</a>
-├── <a href="./l2geth-exporter">l2geth-exporter</a>: A prometheus exporter to collect/serve metrics from an L2 geth node
 ├── <a href="./op-exporter">op-exporter</a>: A prometheus exporter to collect/serve metrics from an Optimism node
 ├── <a href="./proxyd">proxyd</a>: Configurable RPC request router and proxy
 └── <a href="./technical-documents">technical-documents</a>: audits and post-mortem documents

l2geth-exporter/.gitignore

-.env
-l2geth-exporter

l2geth-exporter/CHANGELOG.md

-# @eth-optimism/l2geth-exporter
-
-## 0.0.8
-
-### Patch Changes
-
-- e085354a8: build(deps): bump golang.org/x/crypto from 0.0.0-20220307211146-efcb8507fb70 to 0.1.0 in /l2geth-exporter
-- 9bee5c8cc: build(deps): bump golang.org/x/sys from 0.0.0-20220310020820-b874c991c1a5 to 0.1.0 in /l2geth-exporter
-
-## 0.0.7
-
-### Patch Changes
-
-- 896e23387: Fix: Adding proper debug output for L1 CTC Address env var in l2geth-exporter
-
-## 0.0.6
-
-### Patch Changes
-
-- 6f458607: Bump go-ethereum to 1.10.17
-
-## 0.0.5
-
-### Patch Changes
-
-- 373d0e6f: Added SCC collection
-
-## 0.0.4
-
-### Patch Changes
-
-- 160f4c3d: Update docker image to use golang 1.18.0
-
-## 0.0.3
-
-### Patch Changes
-
-- 2f2eaa44: Bump to go-ethereum v1.10.16
-
-## 0.0.2
-
-### Patch Changes
-
-- 71bfa3fe: Initial build

l2geth-exporter/Dockerfile

-FROM golang:1.18.0-alpine3.15 as builder
-
-COPY ./l2geth-exporter /app
-
-WORKDIR /app/
-RUN apk --no-cache add make jq bash git
-RUN make build
-
-FROM alpine:3.15
-RUN apk --no-cache add ca-certificates
-WORKDIR /root/
-COPY --from=builder /app/l2geth-exporter /usr/local/bin/
-ENTRYPOINT ["l2geth-exporter"]
-CMD ["--help"]

l2geth-exporter/Makefile

-SHELL := /bin/bash
-
-VERSION := `git describe --abbrev=0`
-GITCOMMIT := `git rev-parse HEAD`
-BUILDDATE := `date +%Y-%m-%d`
-BUILDUSER := `whoami`
-
-LDFLAGSSTRING +=-X main.GitCommit=$(GITCOMMIT)
-LDFLAGSSTRING +=-X main.GitDate=$(GITDATE)
-LDFLAGSSTRING +=-X main.GitVersion=$(GITVERSION)
-LDFLAGS :=-ldflags "$(LDFLAGSSTRING)"
-
-all: build
-
-build:
-	CGO_ENABLED=0 go build $(LDFLAGS)
-
-clean:
-	rm l2geth-exporter
-
-test:
-	go test -v ./...
-
-lint:
-	golangci-lint run ./...
-
-binding:
-	$(eval tempCTC := $(shell mktemp))
-
-	cat ../../packages/contracts/deployments/mainnet/CanonicalTransactionChain.json \
-		| jq -r .bytecode > $(tempCTC)
-
-	cat ../../packages/contracts/deployments/mainnet/CanonicalTransactionChain.json \
-		| jq .abi \
-		| abigen --pkg bindings \
-		--abi - \
-		--out bindings/CanonicalTransactionChain.go \
-		--type CanonicalTransactionChain \
-		--bin $(tempCTC)
-
-	rm $(tempCTC)
-
-	$(eval tempSCC := $(shell mktemp))
-
-	cat ../../packages/contracts/deployments/mainnet/StateCommitmentChain.json \
-		| jq -r .bytecode > $(tempSCC)
-
-	cat ../../packages/contracts/deployments/mainnet/StateCommitmentChain.json \
-		| jq .abi \
-		| abigen --pkg bindings \
-		--abi - \
-		--out bindings/StateCommitmentChain.go \
-		--type StateCommitmentChain \
-		--bin $(tempSCC)
-
-	rm $(tempSCC)
\ No newline at end of file

l2geth-exporter/collector.go

-package main
-
-import (
-	"github.com/prometheus/client_golang/prometheus"
-)
-
-//Define the metrics we wish to expose
-var (
-	addressTotalElements = prometheus.NewGaugeVec(
-		prometheus.GaugeOpts{
-			Name: "l2geth_total_elements",
-			Help: "GetTotalElements value."},
-		[]string{"state", "address"},
-	)
-	addressTotalElementsCallStatus = prometheus.NewCounterVec(
-		prometheus.CounterOpts{
-			Name: "l2geth_total_elements_call_status",
-			Help: "GetTotalElements call status."},
-		[]string{"status", "address"},
-	)
-)
-
-func init() {
-	//Register metrics with prometheus
-	prometheus.MustRegister(addressTotalElements)
-	prometheus.MustRegister(addressTotalElementsCallStatus)
-}

l2geth-exporter/go.mod

-module github.com/ethereum-optimism/optimism/l2geth-exporter
-
-go 1.18
-
-require (
-	github.com/ethereum/go-ethereum v1.10.17
-	github.com/prometheus/client_golang v1.11.1
-)
-
-require (
-	github.com/VictoriaMetrics/fastcache v1.9.0 // indirect
-	github.com/beorn7/perks v1.0.1 // indirect
-	github.com/btcsuite/btcd v0.22.0-beta // indirect
-	github.com/btcsuite/btcd/btcec/v2 v2.1.2 // indirect
-	github.com/cespare/xxhash/v2 v2.1.2 // indirect
-	github.com/deckarep/golang-set v1.8.0 // indirect
-	github.com/decred/dcrd/dcrec/secp256k1/v4 v4.0.1 // indirect
-	github.com/edsrzf/mmap-go v1.1.0 // indirect
-	github.com/fjl/memsize v0.0.1 // indirect
-	github.com/gballet/go-libpcsclite v0.0.0-20191108122812-4678299bea08 // indirect
-	github.com/go-ole/go-ole v1.2.6 // indirect
-	github.com/go-stack/stack v1.8.1 // indirect
-	github.com/golang/protobuf v1.5.2 // indirect
-	github.com/google/go-cmp v0.5.8 // indirect
-	github.com/google/uuid v1.3.0 // indirect
-	github.com/gorilla/websocket v1.5.0 // indirect
-	github.com/hashicorp/go-bexpr v0.1.11 // indirect
-	github.com/huin/goupnp v1.0.3 // indirect
-	github.com/mattn/go-colorable v0.1.12 // indirect
-	github.com/mattn/go-isatty v0.0.14 // indirect
-	github.com/mattn/go-runewidth v0.0.13 // indirect
-	github.com/matttproud/golang_protobuf_extensions v1.0.1 // indirect
-	github.com/mitchellh/mapstructure v1.4.3 // indirect
-	github.com/prometheus/client_model v0.2.0 // indirect
-	github.com/prometheus/common v0.30.0 // indirect
-	github.com/prometheus/procfs v0.7.3 // indirect
-	github.com/prometheus/tsdb v0.10.0 // indirect
-	github.com/rjeczalik/notify v0.9.2 // indirect
-	github.com/rs/cors v1.8.2 // indirect
-	github.com/shirou/gopsutil v3.21.11+incompatible // indirect
-	github.com/status-im/keycard-go v0.0.0-20211109104530-b0e0482ba91d // indirect
-	github.com/tklauser/go-sysconf v0.3.10 // indirect
-	github.com/tklauser/numcpus v0.4.0 // indirect
-	github.com/tyler-smith/go-bip39 v1.1.0 // indirect
-	github.com/yusufpapurcu/wmi v1.2.2 // indirect
-	golang.org/x/crypto v0.1.0 // indirect
-	golang.org/x/sys v0.1.0 // indirect
-	golang.org/x/time v0.0.0-20220224211638-0e9765cccd65 // indirect
-	google.golang.org/protobuf v1.27.1 // indirect
-	gopkg.in/natefinch/npipe.v2 v2.0.0-20160621034901-c1b8fa8bdcce // indirect
-)

l2geth-exporter/l1contracts/main.go

-package l1contracts
-
-import (
-	"context"
-	"math/big"
-
-	"github.com/ethereum-optimism/optimism/l2geth-exporter/bindings"
-	"github.com/ethereum/go-ethereum/accounts/abi/bind"
-	"github.com/ethereum/go-ethereum/common"
-	"github.com/ethereum/go-ethereum/ethclient"
-)
-
-// CTC interacts with the OVM Canonical Transaction Chain contract
-type CTC struct {
-	Address common.Address
-	Client  *ethclient.Client
-}
-
-// SCC interacts with the OVM State Commitment Chain contract
-type SCC struct {
-	Address common.Address
-	Client  *ethclient.Client
-}
-
-func (ctc *SCC) GetTotalElements(ctx context.Context) (*big.Int, error) {
-
-	contract, err := bindings.NewCanonicalTransactionChainCaller(ctc.Address, ctc.Client)
-	if err != nil {
-		return nil, err
-	}
-
-	totalElements, err := contract.GetTotalElements(&bind.CallOpts{
-		Context: ctx,
-	})
-	if err != nil {
-		return nil, err
-	}
-
-	return totalElements, nil
-
-}
-
-func (ctc *CTC) GetTotalElements(ctx context.Context) (*big.Int, error) {
-
-	contract, err := bindings.NewCanonicalTransactionChainCaller(ctc.Address, ctc.Client)
-	if err != nil {
-		return nil, err
-	}
-
-	totalElements, err := contract.GetTotalElements(&bind.CallOpts{
-		Context: ctx,
-	})
-	if err != nil {
-		return nil, err
-	}
-
-	return totalElements, nil
-
-}

l2geth-exporter/main.go

-package main
-
-import (
-	"context"
-	"math/big"
-	"net/http"
-	"os"
-	"time"
-
-	"github.com/ethereum-optimism/optimism/l2geth-exporter/l1contracts"
-	"github.com/ethereum/go-ethereum/common"
-	"github.com/ethereum/go-ethereum/ethclient"
-	"github.com/ethereum/go-ethereum/log"
-	"github.com/prometheus/client_golang/prometheus/promhttp"
-)
-
-var (
-	l1TimeoutSeconds = 5
-)
-
-func main() {
-	listenAddress := os.Getenv("LISTEN_ADDRESS")
-	if listenAddress == "" {
-		listenAddress = ":9100"
-	}
-
-	log.Root().SetHandler(log.CallerFileHandler(log.StdoutHandler))
-
-	l1Url := os.Getenv("L1_URL")
-	if l1Url == "" {
-		log.Error("L1_URL environmental variable is required")
-		os.Exit(1)
-	}
-	ctcAddress := os.Getenv("OVM_CTC_ADDRESS")
-	if ctcAddress == "" {
-		log.Error("OVM_CTC_ADDRESS environmental variable is required")
-		os.Exit(1)
-	}
-	sccAddress := os.Getenv("OVM_SCC_ADDRESS")
-	if sccAddress == "" {
-		log.Error("OVM_SCC_ADDRESS environmental variable is required")
-		os.Exit(1)
-	}
-	client, err := ethclient.Dial(l1Url)
-	if err != nil {
-		log.Error("Problem connecting to L1: %s", err)
-	}
-
-	http.Handle("/metrics", promhttp.Handler())
-	http.HandleFunc("/", func(w http.ResponseWriter, r *http.Request) {
-		w.Write([]byte(`<html>
-		<head><title>L2geth Exporter</title></head>
-		<body>
-		<h1>L2geth Exporter</h1>
-		<p><a href="/metrics">Metrics</a></p>
-		</body>
-		</html>`))
-	})
-	go getCTCTotalElements(ctcAddress, "ctc", client)
-	go getSCCTotalElements(sccAddress, "scc", client)
-
-	log.Info("Program starting", "listenAddress", listenAddress, "GETH_URL", l1Url, "CTC_ADDRESS", ctcAddress)
-	if err := http.ListenAndServe(listenAddress, nil); err != nil {
-		log.Error("Can't start http server", "error", err)
-	}
-
-}
-
-func getSCCTotalElements(address string, addressLabel string, client *ethclient.Client) {
-	scc := l1contracts.SCC{
-		Address: common.HexToAddress(address),
-		Client:  client,
-	}
-
-	ticker := time.NewTicker(30 * time.Second)
-	defer ticker.Stop()
-	for {
-		ctx, cancel := context.WithTimeout(context.Background(), time.Second*time.Duration(l1TimeoutSeconds))
-		totalElements, err := scc.GetTotalElements(ctx)
-		if err != nil {
-			addressTotalElementsCallStatus.WithLabelValues("error", addressLabel).Inc()
-			log.Error("Error calling GetTotalElements", "address", addressLabel, "error", err)
-			cancel()
-			continue
-		}
-		addressTotalElementsCallStatus.WithLabelValues("success", addressLabel).Inc()
-		totalElementsFloat, _ := new(big.Float).SetInt(totalElements).Float64()
-		addressTotalElements.WithLabelValues("latest", addressLabel).Set(totalElementsFloat)
-
-		log.Info(addressLabel, "TotalElements", totalElementsFloat)
-		cancel()
-		<-ticker.C
-
-	}
-}
-
-func getCTCTotalElements(address string, addressLabel string, client *ethclient.Client) {
-	ctc := l1contracts.CTC{
-		Address: common.HexToAddress(address),
-		Client:  client,
-	}
-
-	ticker := time.NewTicker(30 * time.Second)
-	defer ticker.Stop()
-	for {
-		ctx, cancel := context.WithTimeout(context.Background(), time.Second*time.Duration(l1TimeoutSeconds))
-		totalElements, err := ctc.GetTotalElements(ctx)
-		if err != nil {
-			addressTotalElementsCallStatus.WithLabelValues("error", addressLabel).Inc()
-			log.Error("Error calling GetTotalElements", "address", addressLabel, "error", err)
-			cancel()
-			continue
-		}
-		addressTotalElementsCallStatus.WithLabelValues("success", addressLabel).Inc()
-		totalElementsFloat, _ := new(big.Float).SetInt(totalElements).Float64()
-		addressTotalElements.WithLabelValues("latest", addressLabel).Set(totalElementsFloat)
-
-		log.Info(addressLabel, "TotalElements", totalElementsFloat)
-		cancel()
-		<-ticker.C
-
-	}
-}

l2geth-exporter/package.json

-{
-  "name": "@eth-optimism/l2geth-exporter",
-  "version": "0.0.8",
-  "private": true,
-  "devDependencies": {}
-}

package.json

@@ -9,7 +9,6 @@
       "batch-submitter",
       "bss-core",
       "gas-oracle",
-      "l2geth-exporter",
       "l2geth",
       "ops/docker/rpc-proxy",
       "ops/docker/hardhat",

specs/meta/versioning.md

@@ -31,7 +31,6 @@ Go modules which are not yet versioned:
 ./gas-oracle       (changesets)
 ./indexer          (changesets)
 ./l2geth           (changesets)
-./l2geth-exporter  (changesets)
 ./op-exporter      (changesets)
 ./proxyd           (changesets)
 ./state-surgery