Merge pull request #20 from cloudstruct/GH-15-metrics-docs

feat: document metrics endpoint

Author: wolf31o2

config.yaml.example

@@ -19,6 +19,17 @@ api:
   # This can also be set via the API_LISTEN_PORT environment variable
   port: 8090
 
+metrics:
+  # Listen address for the metrics endpoint
+  #
+  # This can also be set via the METRICS_LISTEN_ADDRESS environment variable
+  address:
+
+  # Listen port for the metrics endpoint
+  #
+  # This can also be set via the METRICS_LISTEN_PORT environment variable
+  port: 8081
+
 # 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

internal/api/api.go

@@ -66,8 +66,8 @@ func Start(cfg *config.Config) error {
 	go func() {
 		// TODO: return error if we cannot initialize metrics
 		_ = metricsRouter.Run(fmt.Sprintf("%s:%d",
-			cfg.Api.MetricsAddress,
-			cfg.Api.MetricsPort))
+			cfg.Metrics.ListenAddress,
+			cfg.Metrics.ListenPort))
 	}()
 
 	// Configure API routes

internal/config/config.go

@@ -16,6 +16,7 @@ const (
 type Config struct {
 	Logging LoggingConfig `yaml:"logging"`
 	Api     ApiConfig     `yaml:"api"`
+	Metrics MetricsConfig `yaml:"metrics"`
 	Debug   DebugConfig   `yaml:"debug"`
 	Node    NodeConfig    `yaml:"node"`
 }
@@ -27,15 +28,18 @@ type LoggingConfig struct {
 type ApiConfig struct {
 	ListenAddress  string `yaml:"address" envconfig:"API_LISTEN_ADDRESS"`
 	ListenPort     uint   `yaml:"port" envconfig:"API_LISTEN_PORT"`
-	MetricsAddress string `yaml:"metricsAddress" envconfig:"METRICS_LISTEN_ADDRESS"`
-	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 MetricsConfig struct {
+	ListenAddress string `yaml:"address" envconfig:"METRICS_LISTEN_ADDRESS"`
+	ListenPort    uint   `yaml:"port" envconfig:"METRICS_LISTEN_PORT"`
+}
+
 type NodeConfig struct {
 	Network      string `yaml:"network" envconfig:"NETWORK"`
 	NetworkMagic uint32 `yaml:"networkMagic" envconfig:"CARDANO_NODE_NETWORK_MAGIC"`
@@ -52,13 +56,15 @@ var globalConfig = &Config{
 	Api: ApiConfig{
 		ListenAddress:  "",
 		ListenPort:     8090,
-		MetricsAddress: "",
-		MetricsPort:    8081,
 	},
 	Debug: DebugConfig{
 		ListenAddress: "localhost",
 		ListenPort:    0,
 	},
+	Metrics: MetricsConfig{
+		ListenAddress: "",
+		ListenPort:    8081,
+	},
 	Node: NodeConfig{
 		Network:    "mainnet",
 		SocketPath: "/node-ipc/node.socket",