logs: analyzer-v2

.golangci.yml

@@ -1,6 +1,8 @@
 version: "2"
+
 run:
   allow-parallel-runners: true
+
 linters:
   exclusions:
     generated: lax
@@ -9,3 +11,9 @@ linters:
       - common-false-positives
       - legacy
       - std-error-handling
+
+  settings:
+    staticcheck:
+      checks:
+        - all
+        - "-S1038"

Makefile

@@ -19,6 +19,10 @@ run-benchmark: build
 run-analyzer: build
 	@cd ${BINARY_DIR} && ./${BINARY_NAME} analyzer
 
+.PHONY: log-analyzer-v2
+log-analyzer-v2:
+	go run analyzer-v2/cmd/cmd.go
+
 ########## DOCKER
 .PHONY: docker-build
 docker-build:
@@ -57,6 +61,18 @@ dep:
 vet:
 	go vet ./...
 
+.PHONY: format
+format:
+	# `goimports` doesn't support simplify option ("-s"), hence we run `gofmt` separately
+	# just for that - see https://github.com/golang/go/issues/21476 for details.
+	gofmt -s -w $$(find . -name '*.go' -not -path "*mock*")
+	# Formatters such as goimports do not deem necessary to "skip" generated code and
+	# rather want generators to generate code that complies with the desired formats
+	# (see https://github.com/golang/go/issues/71676 for details). In practice however
+	# it's not always possible to fix that on the generator side, so we have to use a
+	# work-around here to filter out generated files on our own.
+	$(RUN_TOOL) goimports -l -w -local github.com/ssvlabs/ssv-pulse/ $$(find . -name '*.go' -not -path "*mock*")
+
 #https://github.com/golangci/golangci-lint/blob/HEAD/.golangci.reference.yml
 .PHONY: lint
 lint:

analyzer-v2/cmd/cmd.go

@@ -0,0 +1,138 @@
+package main
+
+import (
+	"fmt"
+	"os"
+	"strings"
+
+	"github.com/sanity-io/litter"
+	"github.com/spf13/cobra"
+	"github.com/spf13/viper"
+
+	"github.com/ssvlabs/ssv-pulse/analyzer-v2/config"
+	"github.com/ssvlabs/ssv-pulse/analyzer-v2/duties"
+	"github.com/ssvlabs/ssv-pulse/analyzer-v2/internal/environment"
+)
+
+const (
+	logFilesDirectoryFlag = "log-files-directory"
+)
+
+func init() {
+	CMD.Flags().String(logFilesDirectoryFlag, "", "Path to the directory containing SSV node log files for analysis, e.g. my-file-dir")
+
+	err := viper.BindPFlag("analyzer.log-files-directory", CMD.Flags().Lookup(logFilesDirectoryFlag))
+	if err != nil {
+		// TODO
+		panic(err)
+	}
+}
+
+func main() {
+	err := CMD.Execute()
+	if err != nil {
+		os.Exit(1)
+	}
+	os.Exit(0)
+}
+
+var CMD = &cobra.Command{
+	Use:   "ssv-pulse-analyze-v2",
+	Short: "CLI for analyzing log files emitted by SSV node",
+	RunE: func(cmd *cobra.Command, args []string) error {
+		cfg, err := parseConfig()
+		if err != nil {
+			return fmt.Errorf("parse config: %w", err)
+		}
+
+		fmt.Println(fmt.Sprintf("config %s is loaded: %s", viper.ConfigFileUsed(), litter.Sdump(cfg)))
+		fmt.Println()
+
+		err = cfg.Validate()
+		if err != nil {
+			return fmt.Errorf("validate config: %w", err)
+		}
+
+		filesAll, err := os.ReadDir(cfg.LogFilesDirectory)
+		if err != nil {
+			return fmt.Errorf("could not read logs directory: %w", err)
+		}
+		filesLog := make([]os.DirEntry, 0, len(filesAll))
+		for _, file := range filesAll {
+			if file.IsDir() {
+				continue
+			}
+			if strings.HasSuffix(file.Name(), ".log") || strings.HasSuffix(file.Name(), ".logs") || strings.HasSuffix(file.Name(), ".txt") {
+				filesLog = append(filesLog, file)
+			}
+		}
+
+		if len(filesLog) == 0 {
+			return fmt.Errorf("no log files found in %s", cfg.LogFilesDirectory)
+		}
+
+		blockchain, err := environment.BlockchainByName(cfg.Blockchain)
+		if err != nil {
+			return fmt.Errorf("get blockchain by name: %w", err)
+		}
+
+		logParser, err := environment.LogParserByName(cfg.LogFormat)
+		if err != nil {
+			return fmt.Errorf("get log parser by name: %w", err)
+		}
+
+		if cfg.AnalyzeCommitteeDuty {
+			fmt.Println(fmt.Sprintf("analyzing COMMITTEE duty: target slot=%d, duty_id=%s", cfg.TargetSlot, cfg.DutyID))
+			a := duties.NewCommittee(blockchain, logParser)
+			err := duties.Analyze(a, cfg.LogFilesDirectory, filesLog, cfg.DutyID, cfg.TargetSlot)
+			if err != nil {
+				return fmt.Errorf("analyze proposer duty: %w", err)
+			}
+		}
+		if cfg.AnalyzeProposerDuty {
+			fmt.Println(fmt.Sprintf("analyzing PROPOSER duty: target slot=%d, duty_id=%s", cfg.TargetSlot, cfg.DutyID))
+			a := duties.NewProposer(blockchain, logParser)
+			err := duties.Analyze(a, cfg.LogFilesDirectory, filesLog, cfg.DutyID, cfg.TargetSlot)
+			if err != nil {
+				return fmt.Errorf("analyze proposer duty: %w", err)
+			}
+		}
+		if cfg.AnalyzeAggregatorDuty {
+			fmt.Println(fmt.Sprintf("analyzing AGGREGATOR duty: target slot=%d, duty_id=%s", cfg.TargetSlot, cfg.DutyID))
+			a := duties.NewAggregator(blockchain, logParser)
+			err := duties.Analyze(a, cfg.LogFilesDirectory, filesLog, cfg.DutyID, cfg.TargetSlot)
+			if err != nil {
+				return fmt.Errorf("analyze aggregator duty: %w", err)
+			}
+		}
+		if cfg.AnalyzeSyncCommitteeContribution {
+			fmt.Println(fmt.Sprintf("analyzing SYNC_COMMITTEE_CONTRIBUTION duty: target slot=%d, duty_id=%s", cfg.TargetSlot, cfg.DutyID))
+			a := duties.NewSyncCommitteeContribution(blockchain, logParser)
+			err := duties.Analyze(a, cfg.LogFilesDirectory, filesLog, cfg.DutyID, cfg.TargetSlot)
+			if err != nil {
+				return fmt.Errorf("analyze sync_committee_contribution duty: %w", err)
+			}
+		}
+
+		return nil
+	},
+}
+
+func parseConfig() (*config.Config, error) {
+	viper.SetConfigName("config.yaml")
+	viper.SetConfigType("yaml")
+
+	viper.AddConfigPath(".")
+	viper.AddConfigPath("./analyzer-v2/config")
+
+	var cfg config.Config
+
+	if err := viper.ReadInConfig(); err != nil {
+		return nil, fmt.Errorf("read config: %w", err)
+	}
+	if err := viper.Unmarshal(&cfg); err != nil {
+		return nil, fmt.Errorf("unmarshal config: %w", err)
+	}
+
+	return &cfg, nil
+}

analyzer-v2/config/config.go

@@ -0,0 +1,44 @@
+package config
+
+import (
+	"fmt"
+
+	"github.com/attestantio/go-eth2-client/spec/phase0"
+)
+
+type Config struct {
+	LogFilesDirectory string `mapstructure:"log-files-directory"`
+
+	Blockchain string `mapstructure:"blockchain"`
+
+	LogFormat string `mapstructure:"log-format"`
+
+	AnalyzeCommitteeDuty             bool `mapstructure:"analyze-committee-duty"`
+	AnalyzeProposerDuty              bool `mapstructure:"analyze-proposer-duty"`
+	AnalyzeAggregatorDuty            bool `mapstructure:"analyze-aggregator-duty"`
+	AnalyzeSyncCommitteeContribution bool `mapstructure:"analyze-sync-committee-contribution-duty"`
+
+	DutyID     string      `mapstructure:"duty-id"`
+	TargetSlot phase0.Slot `mapstructure:"target-slot"`
+}
+
+func (c *Config) Validate() error {
+	if c.LogFilesDirectory == "" {
+		return fmt.Errorf("❕ 'log-files-directory' was not specified")
+	}
+	if c.Blockchain == "" {
+		return fmt.Errorf("❕ 'blockchain' was not specified")
+	}
+	if c.LogFormat == "" {
+		return fmt.Errorf("❕ 'log-format' was not specified")
+	}
+	if c.DutyID == "" && c.TargetSlot == 0 {
+		return fmt.Errorf("❕ at least one of `duty-id`, 'target-slot' must be specified")
+	}
+
+	if !c.AnalyzeCommitteeDuty && !c.AnalyzeProposerDuty && !c.AnalyzeAggregatorDuty && !c.AnalyzeSyncCommitteeContribution {
+		return fmt.Errorf("❕ must specify at least 1 duty analyzer")
+	}
+
+	return nil
+}

analyzer-v2/config/config.yaml

@@ -0,0 +1,35 @@
+log-files-directory: /Users/iurii/Downloads/target
+#log-files-directory: /Users/iurii/Downloads/p2p
+#log-files-directory: /Users/iurii/Downloads/hashkey
+#log-files-directory: /Users/iurii/Downloads/kraken
+
+blockchain: hoodi
+#blockchain: mainnet
+
+log-format: standard
+#log-format: external
+
+#analyze-committee-duty: true
+analyze-committee-duty: false
+analyze-proposer-duty: true
+#analyze-proposer-duty: false
+
+#analyze-aggregator-duty: true
+analyze-aggregator-duty: false
+#analyze-sync-committee-contribution-duty: true
+analyze-sync-committee-contribution-duty: false
+
+#duty-id: COMMITTEE-1_2_3_4-e415902-s13308893
+#duty-id: COMMITTEE-1_2_3_4-
+#duty-id: COMMITTEE-53_54_55_56-
+#duty-id: COMMITTEE-1_2_417_418-e50846-s1627077
+#
+target-slot: 2845052
+
+
+
+
+
+
+
+