update the as per the comment
This commit is contained in:
@@ -27,6 +27,7 @@ func (m metricsProvider) New(ctx context.Context, config map[string]string) (*te
|
||||
ServiceName: config["serviceName"],
|
||||
ServiceVersion: config["serviceVersion"],
|
||||
Environment: config["environment"],
|
||||
MetricsPort: config["metricsPort"],
|
||||
}
|
||||
|
||||
// Parse enableMetrics as boolean
|
||||
|
||||
@@ -56,7 +56,7 @@ func TestMetricsProviderNew_Success(t *testing.T) {
|
||||
require.NoError(t, err, "New() should not return error")
|
||||
require.NotNil(t, telemetryProvider, "New() should return non-nil provider")
|
||||
|
||||
// Test cleanup function if it exists
|
||||
// Metrics server is started inside provider when enabled; MetricsHandler is not exposed.
|
||||
if cleanup != nil {
|
||||
err := cleanup()
|
||||
assert.NoError(t, err, "cleanup() should not return error")
|
||||
@@ -165,12 +165,6 @@ func TestMetricsProviderNew_ConfigConversion(t *testing.T) {
|
||||
require.NoError(t, err, "New() should not return error")
|
||||
require.NotNil(t, telemetryProvider, "New() should return non-nil provider")
|
||||
|
||||
// Verify that the provider was created (we can't directly check internal config,
|
||||
// but we can verify the provider is functional)
|
||||
if tt.expectedConfig.EnableMetrics {
|
||||
assert.NotNil(t, telemetryProvider.MetricsHandler, "MetricsHandler should be set when metrics enabled")
|
||||
}
|
||||
|
||||
if cleanup != nil {
|
||||
err := cleanup()
|
||||
assert.NoError(t, err, "cleanup() should not return error")
|
||||
@@ -231,11 +225,6 @@ func TestMetricsProviderNew_BooleanParsing(t *testing.T) {
|
||||
require.NoError(t, err, "New() should not return error")
|
||||
require.NotNil(t, telemetryProvider, "New() should return non-nil provider")
|
||||
|
||||
// Verify metrics handler is set based on enableMetrics
|
||||
if tt.expected {
|
||||
assert.NotNil(t, telemetryProvider.MetricsHandler, "MetricsHandler should be set when metrics enabled")
|
||||
}
|
||||
|
||||
if cleanup != nil {
|
||||
err := cleanup()
|
||||
assert.NoError(t, err, "cleanup() should not return error")
|
||||
@@ -300,9 +289,6 @@ func TestMetricsProviderNew_DefaultValues(t *testing.T) {
|
||||
require.NoError(t, err, "New() should not return error with empty config")
|
||||
require.NotNil(t, telemetryProvider, "New() should return non-nil provider")
|
||||
|
||||
// Verify defaults are applied by checking that provider is functional
|
||||
assert.NotNil(t, telemetryProvider.MetricsHandler, "MetricsHandler should be set with defaults")
|
||||
|
||||
if cleanup != nil {
|
||||
err := cleanup()
|
||||
assert.NoError(t, err, "cleanup() should not return error")
|
||||
|
||||
@@ -3,6 +3,10 @@ package otelsetup
|
||||
import (
|
||||
"context"
|
||||
"fmt"
|
||||
"net"
|
||||
"net/http"
|
||||
"sync"
|
||||
"time"
|
||||
|
||||
clientprom "github.com/prometheus/client_golang/prometheus"
|
||||
clientpromhttp "github.com/prometheus/client_golang/prometheus/promhttp"
|
||||
@@ -28,6 +32,7 @@ type Config struct {
|
||||
ServiceVersion string `yaml:"serviceVersion"`
|
||||
EnableMetrics bool `yaml:"enableMetrics"`
|
||||
Environment string `yaml:"environment"`
|
||||
MetricsPort string `yaml:"metricsPort"`
|
||||
}
|
||||
|
||||
// DefaultConfig returns sensible defaults for telemetry configuration.
|
||||
@@ -37,6 +42,7 @@ func DefaultConfig() *Config {
|
||||
ServiceVersion: "dev",
|
||||
EnableMetrics: true,
|
||||
Environment: "development",
|
||||
MetricsPort: "9090",
|
||||
}
|
||||
}
|
||||
|
||||
@@ -49,6 +55,7 @@ func ToPluginConfig(cfg *Config) *plugin.Config {
|
||||
"serviceVersion": cfg.ServiceVersion,
|
||||
"enableMetrics": fmt.Sprintf("%t", cfg.EnableMetrics),
|
||||
"environment": cfg.Environment,
|
||||
"metricsPort": cfg.MetricsPort,
|
||||
},
|
||||
}
|
||||
}
|
||||
@@ -71,6 +78,9 @@ func (Setup) New(ctx context.Context, cfg *Config) (*telemetry.Provider, error)
|
||||
if cfg.Environment == "" {
|
||||
cfg.Environment = DefaultConfig().Environment
|
||||
}
|
||||
if cfg.MetricsPort == "" {
|
||||
cfg.MetricsPort = DefaultConfig().MetricsPort
|
||||
}
|
||||
|
||||
if !cfg.EnableMetrics {
|
||||
log.Info(ctx, "OpenTelemetry metrics disabled")
|
||||
@@ -115,11 +125,44 @@ func (Setup) New(ctx context.Context, cfg *Config) (*telemetry.Provider, error)
|
||||
log.Warnf(ctx, "Failed to start Go runtime instrumentation: %v", err)
|
||||
}
|
||||
|
||||
// Create metrics handler
|
||||
metricsHandler := clientpromhttp.HandlerFor(registry, clientpromhttp.HandlerOpts{})
|
||||
|
||||
// Create and start metrics HTTP server
|
||||
metricsMux := http.NewServeMux()
|
||||
metricsMux.Handle("/metrics", metricsHandler)
|
||||
|
||||
metricsServer := &http.Server{
|
||||
Addr: net.JoinHostPort("", cfg.MetricsPort),
|
||||
Handler: metricsMux,
|
||||
ReadTimeout: 10 * time.Second,
|
||||
WriteTimeout: 10 * time.Second,
|
||||
IdleTimeout: 30 * time.Second,
|
||||
}
|
||||
|
||||
var serverWg sync.WaitGroup
|
||||
serverWg.Add(1)
|
||||
go func() {
|
||||
defer serverWg.Done()
|
||||
log.Infof(ctx, "Metrics server listening on %s", metricsServer.Addr)
|
||||
if err := metricsServer.ListenAndServe(); err != nil && err != http.ErrServerClosed {
|
||||
log.Errorf(ctx, fmt.Errorf("metrics server ListenAndServe: %w", err), "error listening and serving metrics")
|
||||
}
|
||||
}()
|
||||
|
||||
return &telemetry.Provider{
|
||||
MeterProvider: meterProvider,
|
||||
MetricsHandler: clientpromhttp.HandlerFor(registry, clientpromhttp.HandlerOpts{}),
|
||||
Shutdown: func(ctx context.Context) error {
|
||||
return meterProvider.Shutdown(ctx)
|
||||
MeterProvider: meterProvider,
|
||||
Shutdown: func(shutdownCtx context.Context) error {
|
||||
log.Infof(ctx, "Shutting down metrics server...")
|
||||
// Shutdown the metrics server
|
||||
serverShutdownCtx, cancel := context.WithTimeout(shutdownCtx, 10*time.Second)
|
||||
defer cancel()
|
||||
if err := metricsServer.Shutdown(serverShutdownCtx); err != nil {
|
||||
log.Errorf(ctx, fmt.Errorf("metrics server shutdown: %w", err), "error shutting down metrics server")
|
||||
}
|
||||
serverWg.Wait()
|
||||
// Shutdown the meter provider
|
||||
return meterProvider.Shutdown(shutdownCtx)
|
||||
},
|
||||
}, nil
|
||||
}
|
||||
|
||||
@@ -2,8 +2,6 @@ package otelsetup
|
||||
|
||||
import (
|
||||
"context"
|
||||
"net/http"
|
||||
"net/http/httptest"
|
||||
"testing"
|
||||
|
||||
"github.com/stretchr/testify/assert"
|
||||
@@ -56,16 +54,7 @@ func TestSetup_New_Success(t *testing.T) {
|
||||
require.NotNil(t, provider.Shutdown, "Provider should have shutdown function")
|
||||
|
||||
if tt.cfg.EnableMetrics {
|
||||
assert.NotNil(t, provider.MetricsHandler, "MetricsHandler should be set when metrics enabled")
|
||||
assert.NotNil(t, provider.MeterProvider, "MeterProvider should be set when metrics enabled")
|
||||
|
||||
// Test that metrics handler works
|
||||
rec := httptest.NewRecorder()
|
||||
req := httptest.NewRequest("GET", "/metrics", nil)
|
||||
provider.MetricsHandler.ServeHTTP(rec, req)
|
||||
assert.Equal(t, http.StatusOK, rec.Code)
|
||||
} else {
|
||||
assert.Nil(t, provider.MetricsHandler, "MetricsHandler should be nil when metrics disabled")
|
||||
}
|
||||
|
||||
// Test shutdown
|
||||
@@ -123,15 +112,8 @@ func TestSetup_New_DefaultValues(t *testing.T) {
|
||||
require.NotNil(t, provider)
|
||||
|
||||
// Verify defaults are applied by checking that provider is functional
|
||||
assert.NotNil(t, provider.MetricsHandler, "MetricsHandler should be set with defaults")
|
||||
assert.NotNil(t, provider.MeterProvider, "MeterProvider should be set with defaults")
|
||||
|
||||
// Test metrics endpoint
|
||||
rec := httptest.NewRecorder()
|
||||
req := httptest.NewRequest("GET", "/metrics", nil)
|
||||
provider.MetricsHandler.ServeHTTP(rec, req)
|
||||
assert.Equal(t, http.StatusOK, rec.Code)
|
||||
|
||||
// Cleanup
|
||||
err = provider.Shutdown(ctx)
|
||||
assert.NoError(t, err)
|
||||
@@ -152,8 +134,7 @@ func TestSetup_New_MetricsDisabled(t *testing.T) {
|
||||
require.NoError(t, err)
|
||||
require.NotNil(t, provider)
|
||||
|
||||
// When metrics are disabled, MetricsHandler should be nil
|
||||
assert.Nil(t, provider.MetricsHandler, "MetricsHandler should be nil when metrics disabled")
|
||||
// When metrics are disabled, MetricsHandler should be nil and MeterProvider should be nil
|
||||
assert.Nil(t, provider.MeterProvider, "MeterProvider should be nil when metrics disabled")
|
||||
|
||||
// Shutdown should still work
|
||||
@@ -182,6 +163,7 @@ func TestToPluginConfig_Success(t *testing.T) {
|
||||
"serviceVersion": "1.0.0",
|
||||
"enableMetrics": "true",
|
||||
"environment": "test",
|
||||
"metricsPort": "",
|
||||
},
|
||||
},
|
||||
{
|
||||
@@ -198,6 +180,7 @@ func TestToPluginConfig_Success(t *testing.T) {
|
||||
"serviceVersion": "2.0.0",
|
||||
"enableMetrics": "false",
|
||||
"environment": "production",
|
||||
"metricsPort": "",
|
||||
},
|
||||
},
|
||||
{
|
||||
@@ -214,6 +197,7 @@ func TestToPluginConfig_Success(t *testing.T) {
|
||||
"serviceVersion": "",
|
||||
"enableMetrics": "true",
|
||||
"environment": "",
|
||||
"metricsPort": "",
|
||||
},
|
||||
},
|
||||
}
|
||||
@@ -263,11 +247,13 @@ func TestToPluginConfig_BooleanConversion(t *testing.T) {
|
||||
ServiceVersion: "1.0.0",
|
||||
EnableMetrics: tt.enableMetrics,
|
||||
Environment: "test",
|
||||
MetricsPort: "",
|
||||
}
|
||||
|
||||
result := ToPluginConfig(cfg)
|
||||
require.NotNil(t, result)
|
||||
assert.Equal(t, tt.expected, result.Config["enableMetrics"], "enableMetrics should be converted to string correctly")
|
||||
assert.Equal(t, "", result.Config["metricsPort"], "metricsPort should be included even when empty")
|
||||
})
|
||||
}
|
||||
}
|
||||
|
||||
Reference in New Issue
Block a user