Merge pull request #14 from cloudstruct/feature/debug-endpoint

feat: optional debug endpoint

Author: agaffney

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
   #

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"`
 }
 
@@ -28,6 +29,11 @@ type ApiConfig struct {
 	ListenPort    uint   `yaml:"port" envconfig:"API_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"`
@@ -45,6 +51,10 @@ var globalConfig = &Config{
 		ListenAddress: "",
 		ListenPort:    8090,
 	},
+	Debug: DebugConfig{
+		ListenAddress: "localhost",
+		ListenPort:    0,
+	},
 	Node: NodeConfig{
 		Network:    "mainnet",
 		SocketPath: "/node-ipc/node.socket",