Merge remote-tracking branch 'origin/main' into GH-8-metrics

Author: wolf31o2

Makefile

@@ -13,11 +13,14 @@ $(BINARY): $(GO_FILES)
 	go mod tidy
 	go build -o $(BINARY) ./cmd/$(BINARY)
 
-.PHONY: build image
+.PHONY: build clean image
 
 # Alias for building program binary
 build: $(BINARY)
 
+clean:
+	rm -f $(BINARY)
+
 # Build docker image
 image: build
 	docker build -t cloudstruct/$(BINARY) .

cmd/cardano-submit-api/main.go

@@ -6,6 +6,8 @@ import (
 	"github.com/cloudstruct/go-cardano-submit-api/internal/api"
 	"github.com/cloudstruct/go-cardano-submit-api/internal/config"
 	"github.com/cloudstruct/go-cardano-submit-api/internal/logging"
+	"net/http"
+	_ "net/http/pprof"
 	"os"
 )
 
@@ -36,6 +38,17 @@ func main() {
 		}
 	}()
 
+	// Start debug listener
+	if cfg.Debug.ListenPort > 0 {
+		logger.Infof("starting debug listener on %s:%d", cfg.Debug.ListenAddress, cfg.Debug.ListenPort)
+		go func() {
+			err := http.ListenAndServe(fmt.Sprintf("%s:%d", cfg.Debug.ListenAddress, cfg.Debug.ListenPort), nil)
+			if err != nil {
+				logger.Fatalf("failed to start debug listener: %s", err)
+			}
+		}()
+	}
+
 	// Start API listener
 	logger.Infof("starting API listener on %s:%d", cfg.Api.ListenAddress, cfg.Api.ListenPort)
 	if err := api.Start(cfg); err != nil {

config.yaml.example

@@ -19,6 +19,20 @@ api:
   # This can also be set via the API_LISTEN_PORT environment variable
   port: 8090
 
+# The debug endpoint provides access to pprof for debugging purposes. This is
+# disabled by default, but it can be enabled by setting the port to a non-zero
+# value
+debug:
+  # Listen address for the debug endpoint
+  #
+  # This can also be set via the DEBUG_ADDRESS environment variable
+  address: localhost
+
+  # Listen port for the debug endpoint
+  #
+  # This can also be set via the DEBUG_PORT environment variable
+  port: 0
+
 node:
   # Path to UNIX socket file for cardano-node
   #

go.mod

@@ -3,7 +3,7 @@ module github.com/cloudstruct/go-cardano-submit-api
 go 1.17
 
 require (
-	github.com/cloudstruct/go-ouroboros-network v0.13.0
+	github.com/cloudstruct/go-ouroboros-network v0.13.1
 	github.com/fxamacker/cbor/v2 v2.4.0
 	github.com/gin-contrib/zap v0.0.2
 	github.com/gin-gonic/gin v1.7.7

go.sum

@@ -54,8 +54,8 @@ github.com/chzyer/logex v1.1.10/go.mod h1:+Ywpsq7O8HXn0nuIou7OrIPyXbp3wmkHB+jjWR
 github.com/chzyer/readline v0.0.0-20180603132655-2972be24d48e/go.mod h1:nSuG5e5PlCu98SY8svDHJxuZscDgtXS6KTTbou5AhLI=
 github.com/chzyer/test v0.0.0-20180213035817-a1ea475d72b1/go.mod h1:Q3SI9o4m/ZMnBNeIyt5eFwwo7qiLfzFZmjNmxjkiQlU=
 github.com/client9/misspell v0.3.4/go.mod h1:qj6jICC3Q7zFZvVWo7KLAzC3yx5G7kyvSDkc90ppPyw=
-github.com/cloudstruct/go-ouroboros-network v0.13.0 h1:q6l4QQocuDTz0TOynEo5jwe9R+9tCL6vLJpWdMer9kc=
-github.com/cloudstruct/go-ouroboros-network v0.13.0/go.mod h1:06ggUMerJLwKJkVi5DLX1QMDz8r+R8o92rht7Z4ss9k=
+github.com/cloudstruct/go-ouroboros-network v0.13.1 h1:/F9fXKXLmGPdMQrqyBovbTbLUZdj/7cG0qjA/a31cZk=
+github.com/cloudstruct/go-ouroboros-network v0.13.1/go.mod h1:06ggUMerJLwKJkVi5DLX1QMDz8r+R8o92rht7Z4ss9k=
 github.com/cncf/udpa/go v0.0.0-20191209042840-269d4d468f6f/go.mod h1:M8M6+tZqaGXZJjfX53e64911xZQV5JYwmTeXPW+k8Sc=
 github.com/davecgh/go-spew v1.1.0/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38=
 github.com/davecgh/go-spew v1.1.1 h1:vj9j/u1bqnvCEfJOwUhtlOARqs3+rkHYY13jYWTU97c=

internal/api/api.go

@@ -106,15 +106,13 @@ func handleSubmitTx(c *gin.Context) {
 			},
 		},
 	}
-	go func() {
-		err, ok := <-errorChan
-		if ok {
-			logger.Errorf("failure communicating with node: %s", err)
-			c.String(500, "failure communicating with node")
-			doneChan <- true
-		}
-	}()
 	oConn, err := ouroboros.New(oOpts)
+	defer func() {
+		// We have to close the channel to break out of the async error handler goroutine
+		close(errorChan)
+		// Close Ouroboros connection
+		oConn.Close()
+	}()
 	if err != nil {
 		logger.Errorf("failure creating Ouroboros connection: %s", err)
 		c.String(500, "failure communicating with node")
@@ -133,6 +131,15 @@ func handleSubmitTx(c *gin.Context) {
 			return
 		}
 	}
+	// Start async error handler
+	go func() {
+		err, ok := <-errorChan
+		if ok {
+			logger.Errorf("failure communicating with node: %s", err)
+			c.String(500, "failure communicating with node")
+			doneChan <- true
+		}
+	}()
 	// TODO: figure out better way to determine era
 	if err = oConn.LocalTxSubmission.SubmitTx(block.TX_TYPE_ALONZO, rawTx); err != nil {
 		logger.Errorf("failure submitting transaction: %s", err)
@@ -141,6 +148,4 @@ func handleSubmitTx(c *gin.Context) {
 	}
 	// Wait for async process to finish
 	<-doneChan
-	// We have to close the channel to break out of the Goroutine waiting on it
-	close(errorChan)
 }

internal/config/config.go

@@ -16,6 +16,7 @@ const (
 type Config struct {
 	Logging LoggingConfig `yaml:"logging"`
 	Api     ApiConfig     `yaml:"api"`
+	Debug   DebugConfig   `yaml:"debug"`
 	Node    NodeConfig    `yaml:"node"`
 }
 
@@ -30,6 +31,11 @@ type ApiConfig struct {
 	MetricsPort    uint   `yaml:"metricsPort" envconfig:"METRICS_LISTEN_PORT"`
 }
 
+type DebugConfig struct {
+	ListenAddress string `yaml:"address" envconfig:"DEBUG_ADDRESS"`
+	ListenPort    uint   `yaml:"port" envconfig:"DEBUG_PORT"`
+}
+
 type NodeConfig struct {
 	Network      string `yaml:"network" envconfig:"NETWORK"`
 	NetworkMagic uint32 `yaml:"networkMagic" envconfig:"CARDANO_NODE_NETWORK_MAGIC"`
@@ -49,6 +55,10 @@ var globalConfig = &Config{
 		MetricsAddress: "",
 		MetricsPort:    8091,
 	},
+	Debug: DebugConfig{
+		ListenAddress: "localhost",
+		ListenPort:    0,
+	},
 	Node: NodeConfig{
 		Network:    "mainnet",
 		SocketPath: "/node-ipc/node.socket",