Merge pull request #1502 from ethereum-optimism/bwilson/l2geth-exporter

Bwilson/l2geth exporter

.changeset/purple-cups-camp.md

+---
+'@eth-optimism/l2geth-exporter': patch
+---
+
+Initial build

.github/workflows/publish-canary.yml

@@ -28,6 +28,7 @@ jobs:
       proxyd: ${{ steps.packages.outputs.proxyd }}
       rpc-proxy : ${{ steps.packages.outputs.rpc-proxy }}
       op-exporter : ${{ steps.packages.outputs.op-exporter }}
+      l2geth-exporter : ${{ steps.packages.outputs.l2geth-exporter }}
 
     steps:
       - name: Check out source code
@@ -443,6 +444,43 @@ 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 ./go/l2geth-exporter/package.json)
+          echo ::set-output name=GITCOMMIT::"$GITHUB_SHA"
+
+      - name: Build and push
+        uses: docker/build-push-action@v2
+        with:
+          context: .
+          file: ./ops/docker/Dockerfile.l2geth-exporter
+          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 }}
+
   rpc-proxy:
     name: Publish rpc-proxy Version ${{ needs.canary-publish.outputs.canary-docker-tag }}
     needs: canary-publish

.github/workflows/release.yml

@@ -24,6 +24,7 @@ jobs:
       rpc-proxy: ${{ steps.packages.outputs.rpc-proxy }}
       hardhat-node: ${{ steps.packages.outputs.hardhat-node }}
       op-exporter : ${{ steps.packages.outputs.op-exporter }}
+      l2geth-exporter : ${{ steps.packages.outputs.l2geth-exporter }}
 
     steps:
       - name: Checkout Repo
@@ -196,6 +197,43 @@ jobs:
             GITCOMMIT=${{ steps.build_args.outputs.GITCOMMIT }}
             GITVERSION=${{ steps.build_args.outputs.GITVERSION }}
 
+  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 ./go/l2geth-exporter/package.json)
+          echo ::set-output name=GITCOMMIT::"$GITHUB_SHA"
+
+      - name: Build and push
+        uses: docker/build-push-action@v2
+        with:
+          context: .
+          file: ./ops/docker/Dockerfile.l2geth-exporter
+          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

go/l2geth-exporter/.envrc

+dotenv .env

go/l2geth-exporter/.gitignore

+.env
+l2geth-exporter

go/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 temp := $(shell mktemp))
+
+	cat ../../packages/contracts/deployments/mainnet/CanonicalTransactionChain.json \
+		| jq -r .bytecode > $(temp)
+
+	cat ../../packages/contracts/deployments/mainnet/CanonicalTransactionChain.json \
+		| jq .abi \
+		| abigen --pkg bindings \
+		--abi - \
+		--out bindings/CanonicalTransactionChain.go \
+		--type CanonicalTransactionChain \
+		--bin $(temp)
+
+	rm $(temp)

go/l2geth-exporter/collector.go

+package main
+
+import (
+	"github.com/prometheus/client_golang/prometheus"
+)
+
+//Define the metrics we wish to expose
+var (
+	ctcTotalElements = prometheus.NewGaugeVec(
+		prometheus.GaugeOpts{
+			Name: "l2geth_ctc_total_elements",
+			Help: "CTC GetTotalElements value."},
+		[]string{"state"},
+	)
+	ctcTotalElementsCallSuccess = prometheus.NewGauge(
+		prometheus.GaugeOpts{
+			Name: "l2geth_ctc_total_elements_call_success",
+			Help: "CTC GetTotalElements call success."},
+	)
+)
+
+func init() {
+	//Register metrics with prometheus
+	prometheus.MustRegister(ctcTotalElements)
+	prometheus.MustRegister(ctcTotalElementsCallSuccess)
+}

go/l2geth-exporter/go.mod

+module github.com/ethereum-optimism/optimism/go/l2geth-exporter
+
+go 1.16
+
+require (
+	github.com/ethereum/go-ethereum v1.10.8
+	github.com/prometheus/client_golang v1.11.0
+)

go/l2geth-exporter/l1contracts/main.go

+package l1contracts
+
+import (
+	"context"
+	"math/big"
+
+	"github.com/ethereum-optimism/optimism/go/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 CTC contract
+type CTC struct {
+	Address common.Address
+	Client  *ethclient.Client
+}
+
+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
+
+}

go/l2geth-exporter/main.go

+package main
+
+import (
+	"context"
+	"math/big"
+	"net/http"
+	"os"
+	"time"
+
+	"github.com/ethereum-optimism/optimism/go/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("CTC_ADDRESS")
+	if ctcAddress == "" {
+		log.Error("CTC_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, 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 getCTCTotalElements(address 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 {
+			ctcTotalElementsCallSuccess.Set(0)
+			log.Error("Error calling GetTotalElements", "error", err)
+			cancel()
+			continue
+		}
+		ctcTotalElementsCallSuccess.Set(1)
+		totalElementsFloat, _ := new(big.Float).SetInt(totalElements).Float64()
+		ctcTotalElements.WithLabelValues(
+			"latest").Set(totalElementsFloat)
+		log.Info("ctc updated", "ctcTotalElements", totalElementsFloat)
+		cancel()
+		<-ticker.C
+
+	}
+}

go/l2geth-exporter/package.json

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

ops/docker/Dockerfile.l2geth-exporter

+FROM golang:1.16 as builder
+
+ADD ./go/l2geth-exporter /app/
+WORKDIR /app/
+RUN make build
+
+FROM alpine:latest
+RUN apk --no-cache add ca-certificates
+WORKDIR /root/
+COPY --from=builder /app/l2geth-exporter /usr/local/bin/
+ENTRYPOINT ["l2geth-exporter"]
+CMD ["--help"]

package.json

@@ -11,6 +11,7 @@
       "specs",
       "go/gas-oracle",
       "go/batch-submitter",
+      "go/l2geth-exporter",
       "go/proxyd",
       "go/op-exporter",
       "ops/docker/rpc-proxy",