Merge pull request #70 from asymmetric-research/exporter-rename

renamed solana_exporter -> solana-exporter

.github/workflows/go-test.yaml

@@ -25,8 +25,8 @@ jobs:
       - name: Test rpc package
         run: go test -v ./pkg/rpc
 
-      - name: Test solana_exporter
-        run: go test -v ./cmd/solana_exporter
+      - name: Test solana-exporter
+        run: go test -v ./cmd/solana-exporter
 
       - name: Run all tests with coverage
         run: go test -v -coverprofile=coverage.out ./...

.gitignore

@@ -3,4 +3,4 @@
 
 # builds:
 .builds
-/solana_exporter
+/solana-exporter

Dockerfile

@@ -3,7 +3,7 @@ FROM golang:1.22 as builder
 COPY . /opt
 WORKDIR /opt
 
-RUN CGO_ENABLED=0 go build -o /opt/bin/app github.com/asymmetric-research/solana_exporter/cmd/solana_exporter
+RUN CGO_ENABLED=0 go build -o /opt/bin/app github.com/asymmetric-research/solana-exporter/cmd/solana-exporter
 
 FROM scratch
 

README.md

@@ -10,7 +10,7 @@ To use the Solana Exporter, simply run the program with the desired
 [command line configuration](#Command-Line-Arguments), e.g.,
 
 ```shell
-solana_exporter \
+solana-exporter \
   -nodekey <VALIDATOR_IDENTITY_1> -nodekey <VALIDATOR_IDENTITY_2> \
   -balance-address <ADDRESS_1> -balance-address <ADDRESS_2> \
   -comprehensive-slot-tracking \
@@ -20,13 +20,13 @@ solana_exporter \
 ## Installation
 ### Build
 
-Assuming you already have [Go installed](https://go.dev/doc/install), the `solana_exporter` can be installed by 
+Assuming you already have [Go installed](https://go.dev/doc/install), the `solana-exporter` can be installed by 
 cloning this repository and building the binary:
 
 ```shell
-git clone https://github.com/asymmetric-research/solana_exporter.git
-cd solana_exporter
-CGO_ENABLED=0 go build ./cmd/solana_exporter
+git clone https://github.com/asymmetric-research/solana-exporter.git
+cd solana-exporter
+CGO_ENABLED=0 go build ./cmd/solana-exporter
 ```
 
 ## Configuration
@@ -56,13 +56,10 @@ The exporter is configured via the following command line arguments:
   * Configuring `-monitor-block-sizes` with many `-nodekey`'s can potentially strain the node - every block produced 
   by a configured `-nodekey` is fetched, and a typical block can be as large as 5MB.
 
-If you want verbose logs, specify `-v=<num>`. Higher verbosity means more debug output. For most users, the default
-verbosity level is fine. If you want detailed log output for missed blocks, run with `-v=1`.
-
 ## Metrics
 ### Overview
 
-The table below describes all the metrics collected by the `solana_exporter`:
+The table below describes all the metrics collected by the `solana-exporter`:
 
 | Metric                              | Description                                                                              | Labels                        |
 |-------------------------------------|------------------------------------------------------------------------------------------|-------------------------------|

cmd/solana_exporter/config.go → cmd/solana-exporter/config.go

@@ -4,8 +4,8 @@ import (
 	"context"
 	"flag"
 	"fmt"
-	"github.com/asymmetric-research/solana_exporter/pkg/rpc"
-	"github.com/asymmetric-research/solana_exporter/pkg/slog"
+	"github.com/asymmetric-research/solana-exporter/pkg/rpc"
+	"github.com/asymmetric-research/solana-exporter/pkg/slog"
 	"time"
 )
 
@@ -61,19 +61,19 @@ func NewExporterConfig(
 	)
 	if lightMode {
 		if comprehensiveSlotTracking {
-			return nil, fmt.Errorf("'-light-mode' is imcompatible with `-comprehensive-slot-tracking`")
+			return nil, fmt.Errorf("'-light-mode' is incompatible with `-comprehensive-slot-tracking`")
 		}
 
 		if monitorBlockSizes {
-			return nil, fmt.Errorf("'-light-mode' is imcompatible with `-monitor-block-sizes`")
+			return nil, fmt.Errorf("'-light-mode' is incompatible with `-monitor-block-sizes`")
 		}
 
 		if len(nodeKeys) > 0 {
-			return nil, fmt.Errorf("'-light-mode' is imcompatible with `-nodekey`")
+			return nil, fmt.Errorf("'-light-mode' is incompatible with `-nodekey`")
 		}
 
 		if len(balanceAddresses) > 0 {
-			return nil, fmt.Errorf("'-light-mode' is imcompatible with `-balance-addresses`")
+			return nil, fmt.Errorf("'-light-mode' is incompatible with `-balance-addresses`")
 		}
 	}
 

cmd/solana_exporter/desc.go → cmd/solana-exporter/desc.go

@@ -1,7 +1,7 @@
 package main
 
 import (
-	"github.com/asymmetric-research/solana_exporter/pkg/slog"
+	"github.com/asymmetric-research/solana-exporter/pkg/slog"
 	"github.com/prometheus/client_golang/prometheus"
 )
 

cmd/solana_exporter/exporter.go → cmd/solana-exporter/exporter.go

@@ -4,8 +4,8 @@ import (
 	"context"
 	"errors"
 	"fmt"
-	"github.com/asymmetric-research/solana_exporter/pkg/rpc"
-	"github.com/asymmetric-research/solana_exporter/pkg/slog"
+	"github.com/asymmetric-research/solana-exporter/pkg/rpc"
+	"github.com/asymmetric-research/solana-exporter/pkg/slog"
 	"github.com/prometheus/client_golang/prometheus"
 	"go.uber.org/zap"
 )

cmd/solana_exporter/exporter_test.go → cmd/solana-exporter/exporter_test.go

@@ -4,7 +4,7 @@ import (
 	"bytes"
 	"context"
 	"fmt"
-	"github.com/asymmetric-research/solana_exporter/pkg/rpc"
+	"github.com/asymmetric-research/solana-exporter/pkg/rpc"
 	"github.com/prometheus/client_golang/prometheus"
 	"github.com/prometheus/client_golang/prometheus/testutil"
 	"github.com/stretchr/testify/assert"

cmd/solana_exporter/main.go → cmd/solana-exporter/main.go

@@ -2,8 +2,8 @@ package main
 
 import (
 	"context"
-	"github.com/asymmetric-research/solana_exporter/pkg/rpc"
-	"github.com/asymmetric-research/solana_exporter/pkg/slog"
+	"github.com/asymmetric-research/solana-exporter/pkg/rpc"
+	"github.com/asymmetric-research/solana-exporter/pkg/slog"
 	"github.com/prometheus/client_golang/prometheus"
 	"github.com/prometheus/client_golang/prometheus/promhttp"
 	"net/http"

cmd/solana_exporter/main_test.go → cmd/solana-exporter/main_test.go

@@ -1,7 +1,7 @@
 package main
 
 import (
-	"github.com/asymmetric-research/solana_exporter/pkg/slog"
+	"github.com/asymmetric-research/solana-exporter/pkg/slog"
 	"os"
 	"testing"
 )

cmd/solana_exporter/slots.go → cmd/solana-exporter/slots.go

@@ -4,13 +4,13 @@ import (
 	"context"
 	"errors"
 	"fmt"
-	"github.com/asymmetric-research/solana_exporter/pkg/slog"
+	"github.com/asymmetric-research/solana-exporter/pkg/slog"
 	"go.uber.org/zap"
 	"slices"
 	"strings"
 	"time"
 
-	"github.com/asymmetric-research/solana_exporter/pkg/rpc"
+	"github.com/asymmetric-research/solana-exporter/pkg/rpc"
 	"github.com/prometheus/client_golang/prometheus"
 )
 

cmd/solana_exporter/slots_test.go → cmd/solana-exporter/slots_test.go

@@ -3,7 +3,7 @@ package main
 import (
 	"context"
 	"fmt"
-	"github.com/asymmetric-research/solana_exporter/pkg/rpc"
+	"github.com/asymmetric-research/solana-exporter/pkg/rpc"
 	"github.com/prometheus/client_golang/prometheus"
 	"github.com/prometheus/client_golang/prometheus/testutil"
 	"github.com/stretchr/testify/assert"

cmd/solana_exporter/utils.go → cmd/solana-exporter/utils.go

@@ -4,8 +4,8 @@ import (
 	"context"
 	"encoding/json"
 	"fmt"
-	"github.com/asymmetric-research/solana_exporter/pkg/rpc"
-	"github.com/asymmetric-research/solana_exporter/pkg/slog"
+	"github.com/asymmetric-research/solana-exporter/pkg/rpc"
+	"github.com/asymmetric-research/solana-exporter/pkg/slog"
 	"slices"
 )
 

cmd/solana_exporter/utils_test.go → cmd/solana-exporter/utils_test.go

@@ -4,7 +4,7 @@ import (
 	"context"
 	_ "embed"
 	"encoding/json"
-	"github.com/asymmetric-research/solana_exporter/pkg/rpc"
+	"github.com/asymmetric-research/solana-exporter/pkg/rpc"
 	"github.com/stretchr/testify/assert"
 	"testing"
 )
@@ -101,4 +101,5 @@ func TestCountVoteTransactions(t *testing.T) {
 	assert.NoError(t, err)
 	// https://explorer.solana.com/block/297609329
 	assert.Equal(t, 1048, voteCount)
+	assert.Equal(t, 446, len(block.Transactions)-voteCount)
 }

go.mod

@@ -1,4 +1,4 @@
-module github.com/asymmetric-research/solana_exporter
+module github.com/asymmetric-research/solana-exporter
 
 go 1.22
 

pkg/rpc/client.go

@@ -5,7 +5,7 @@ import (
 	"context"
 	"encoding/json"
 	"fmt"
-	"github.com/asymmetric-research/solana_exporter/pkg/slog"
+	"github.com/asymmetric-research/solana-exporter/pkg/slog"
 	"go.uber.org/zap"
 	"io"
 	"net/http"

pkg/rpc/client_test.go

@@ -7,6 +7,7 @@ import (
 )
 
 func newMethodTester(t *testing.T, method string, result any) (*MockServer, *Client) {
+	t.Helper()
 	return NewMockClient(t, map[string]any{method: result}, nil, nil, nil, nil)
 }
 

pkg/rpc/mock.go

@@ -4,7 +4,7 @@ import (
 	"context"
 	"encoding/json"
 	"fmt"
-	"github.com/asymmetric-research/solana_exporter/pkg/slog"
+	"github.com/asymmetric-research/solana-exporter/pkg/slog"
 	"go.uber.org/zap"
 	"net"
 	"net/http"

pkg/rpc/rpc_test.go

@@ -1,7 +1,7 @@
 package rpc
 
 import (
-	"github.com/asymmetric-research/solana_exporter/pkg/slog"
+	"github.com/asymmetric-research/solana-exporter/pkg/slog"
 	"os"
 	"testing"
 )