mirror of
https://github.com/lukaszraczylo/graphql-monitoring-proxy.git
synced 2026-10-22 06:38:13 +00:00
fix(circuitbreaker): guard nil monitoring to prevent boot panic
Starting with ENABLE_CIRCUIT_BREAKER=true panicked at boot: parseConfig -> initCircuitBreaker registers a metrics gauge, but cfg.Monitoring is assigned later by StartMonitoringServer, so the registration dereferenced a nil *MetricsSetup. Add nil-receiver guards to the MetricsSetup registration methods (RegisterMetricsGauge/GaugeFunc/Counter, RegisterFloatCounter, RegisterMetricsSummary/Histogram), matching their existing 'return a dummy to prevent panics' contract. The guard is a no-op for non-nil receivers, so existing callers are unaffected. The breaker and the admin dashboard (which reads gobreaker state directly) keep working. Add regression tests for the nil-receiver methods and for initCircuitBreaker with nil monitoring.
This commit is contained in:
@@ -109,6 +109,11 @@ func (ms *MetricsSetup) ListActiveMetrics() []string {
|
||||
}
|
||||
|
||||
func (ms *MetricsSetup) RegisterMetricsGauge(metric_name string, labels map[string]string, val float64) *metrics.Gauge {
|
||||
if ms == nil {
|
||||
// Monitoring may not be initialized yet (e.g. during config parsing,
|
||||
// before the monitoring server starts). Return a dummy to prevent panics.
|
||||
return &metrics.Gauge{}
|
||||
}
|
||||
if err := validate_metrics_name(metric_name); err != nil {
|
||||
log.Error(&libpack_logger.LogMessage{
|
||||
Message: "RegisterMetricsGauge() error - invalid metric name",
|
||||
@@ -125,6 +130,9 @@ func (ms *MetricsSetup) RegisterMetricsGauge(metric_name string, labels map[stri
|
||||
// RegisterMetricsGaugeFunc registers a gauge with a callback function that is called on every scrape
|
||||
// This is useful for metrics that need to return a dynamic value
|
||||
func (ms *MetricsSetup) RegisterMetricsGaugeFunc(metric_name string, labels map[string]string, fn func() float64) *metrics.Gauge {
|
||||
if ms == nil {
|
||||
return &metrics.Gauge{}
|
||||
}
|
||||
if err := validate_metrics_name(metric_name); err != nil {
|
||||
log.Error(&libpack_logger.LogMessage{
|
||||
Message: "RegisterMetricsGaugeFunc() error - invalid metric name",
|
||||
@@ -137,6 +145,9 @@ func (ms *MetricsSetup) RegisterMetricsGaugeFunc(metric_name string, labels map[
|
||||
}
|
||||
|
||||
func (ms *MetricsSetup) RegisterMetricsCounter(metric_name string, labels map[string]string) *metrics.Counter {
|
||||
if ms == nil {
|
||||
return &metrics.Counter{}
|
||||
}
|
||||
if err := validate_metrics_name(metric_name); err != nil {
|
||||
log.Error(&libpack_logger.LogMessage{
|
||||
Message: "RegisterMetricsCounter() error - invalid metric name",
|
||||
@@ -152,6 +163,9 @@ func (ms *MetricsSetup) RegisterMetricsCounter(metric_name string, labels map[st
|
||||
}
|
||||
|
||||
func (ms *MetricsSetup) RegisterFloatCounter(metric_name string, labels map[string]string) *metrics.FloatCounter {
|
||||
if ms == nil {
|
||||
return &metrics.FloatCounter{}
|
||||
}
|
||||
if err := validate_metrics_name(metric_name); err != nil {
|
||||
log.Error(&libpack_logger.LogMessage{
|
||||
Message: "RegisterFloatCounter() error - invalid metric name",
|
||||
@@ -164,6 +178,9 @@ func (ms *MetricsSetup) RegisterFloatCounter(metric_name string, labels map[stri
|
||||
}
|
||||
|
||||
func (ms *MetricsSetup) RegisterMetricsSummary(metric_name string, labels map[string]string) *metrics.Summary {
|
||||
if ms == nil {
|
||||
return &metrics.Summary{}
|
||||
}
|
||||
if err := validate_metrics_name(metric_name); err != nil {
|
||||
log.Error(&libpack_logger.LogMessage{
|
||||
Message: "RegisterMetricsSummary() error - invalid metric name",
|
||||
@@ -176,6 +193,9 @@ func (ms *MetricsSetup) RegisterMetricsSummary(metric_name string, labels map[st
|
||||
}
|
||||
|
||||
func (ms *MetricsSetup) RegisterMetricsHistogram(metric_name string, labels map[string]string) *metrics.Histogram {
|
||||
if ms == nil {
|
||||
return &metrics.Histogram{}
|
||||
}
|
||||
if err := validate_metrics_name(metric_name); err != nil {
|
||||
log.Error(&libpack_logger.LogMessage{
|
||||
Message: "RegisterMetricsHistogram() error - invalid metric name",
|
||||
|
||||
@@ -0,0 +1,25 @@
|
||||
package libpack_monitoring
|
||||
|
||||
import (
|
||||
"testing"
|
||||
|
||||
"github.com/stretchr/testify/require"
|
||||
)
|
||||
|
||||
// TestRegistrationMethods_NilReceiver_NoPanic verifies that the metric
|
||||
// registration methods tolerate a nil *MetricsSetup receiver. Callers may
|
||||
// register metrics before the monitoring server has constructed the global
|
||||
// MetricsSetup (e.g. circuit breaker init during config parsing); these
|
||||
// methods must return a non-nil dummy instead of panicking.
|
||||
func TestRegistrationMethods_NilReceiver_NoPanic(t *testing.T) {
|
||||
var ms *MetricsSetup // nil
|
||||
|
||||
require.NotPanics(t, func() {
|
||||
require.NotNil(t, ms.RegisterMetricsGauge("g", nil, 1))
|
||||
require.NotNil(t, ms.RegisterMetricsGaugeFunc("gf", nil, func() float64 { return 1 }))
|
||||
require.NotNil(t, ms.RegisterMetricsCounter("c", nil))
|
||||
require.NotNil(t, ms.RegisterFloatCounter("fc", nil))
|
||||
require.NotNil(t, ms.RegisterMetricsSummary("s", nil))
|
||||
require.NotNil(t, ms.RegisterMetricsHistogram("h", nil))
|
||||
})
|
||||
}
|
||||
Reference in New Issue
Block a user