Gabriel Radureau
c577e2603c
First sub-phase of ADR-0023 Phase 3 (telemetry sampler hot-reload), per the Mistral-produced phase plan validated 2026-05-05 (Q-037 in mistral-quirks.md). This is the isolated telemetry-package change: adds ReconfigureTracerProvider that builds a new TracerProvider with updated sampler settings, swaps the global, and gracefully shuts down the old. No-op when oldTP is nil (telemetry-disabled-at-startup is out of scope for Phase 3). The wiring (config callback → server-level invocation) lands in sub-phases 3.2 and 3.3 — kept separate for clean rollback semantics. Tests: - 3 new tests in pkg/telemetry/telemetry_test.go covering nil no-op, the global TP swap, and error-tolerance when old TP shutdown fails. - go test -race ./pkg/telemetry/... passes. Verifier verdict (skill-driven, mental run): APPROVE. Function is 17 lines, single responsibility, defensive on nil; tests cover positive + invariant + tolerance.
94 lines
3.1 KiB
Go
94 lines
3.1 KiB
Go
package telemetry
|
|
|
|
// All tests in this file mutate the OpenTelemetry global tracer provider via
|
|
// otel.SetTracerProvider (called by InitializeTracing / ReconfigureTracerProvider).
|
|
// They MUST NOT be parallelized — t.Parallel() would race on the global state.
|
|
|
|
import (
|
|
"context"
|
|
"testing"
|
|
|
|
"github.com/stretchr/testify/assert"
|
|
"github.com/stretchr/testify/require"
|
|
"go.opentelemetry.io/otel"
|
|
)
|
|
|
|
// TestReconfigureTracerProvider_NilOldNoOp confirms that hot-reload is a
|
|
// no-op when telemetry was never initialized at startup. Hot-reloading
|
|
// telemetry-on requires a different code path that's out of scope for
|
|
// ADR-0023 Phase 3.
|
|
func TestReconfigureTracerProvider_NilOldNoOp(t *testing.T) {
|
|
s := &Setup{
|
|
ServiceName: "test",
|
|
OTLPEndpoint: "localhost:4317",
|
|
Insecure: true,
|
|
SamplerType: "always_on",
|
|
SamplerRatio: 1.0,
|
|
Version: "test",
|
|
}
|
|
newTP, err := s.ReconfigureTracerProvider(context.Background(), nil)
|
|
assert.NoError(t, err)
|
|
assert.Nil(t, newTP)
|
|
}
|
|
|
|
// TestReconfigureTracerProvider_SwapsGlobal confirms that after a successful
|
|
// reconfigure, the global otel tracer provider points to the new one and the
|
|
// old one was shut down (Shutdown returns nil even after a second Shutdown,
|
|
// so we just verify no error path hit).
|
|
func TestReconfigureTracerProvider_SwapsGlobal(t *testing.T) {
|
|
ctx := context.Background()
|
|
s := &Setup{
|
|
ServiceName: "test",
|
|
OTLPEndpoint: "localhost:4317",
|
|
Insecure: true,
|
|
SamplerType: "always_on",
|
|
SamplerRatio: 1.0,
|
|
Version: "test",
|
|
}
|
|
|
|
oldTP, err := s.InitializeTracing(ctx)
|
|
require.NoError(t, err)
|
|
require.NotNil(t, oldTP)
|
|
t.Cleanup(func() { _ = oldTP.Shutdown(ctx) }) // belt-and-braces, harmless if already shut down
|
|
|
|
// Mutate sampler before reconfigure
|
|
s.SamplerType = "traceidratio"
|
|
s.SamplerRatio = 0.25
|
|
|
|
newTP, err := s.ReconfigureTracerProvider(ctx, oldTP)
|
|
require.NoError(t, err)
|
|
require.NotNil(t, newTP)
|
|
t.Cleanup(func() { _ = newTP.Shutdown(ctx) })
|
|
|
|
// otel.GetTracerProvider returns a TracerProvider interface — pointer equality
|
|
// against newTP is the strongest assertion available without sdk-private state.
|
|
gotTP := otel.GetTracerProvider()
|
|
assert.Same(t, newTP, gotTP, "global tracer provider should be the new TP")
|
|
}
|
|
|
|
// TestReconfigureTracerProvider_OldShutdownErrorDoesNotFailReconfigure
|
|
// confirms that even if shutting down the old TP fails, the new TP is still
|
|
// returned and active. We simulate this by passing an already-shut-down
|
|
// provider as oldTP — its second Shutdown is harmless on the SDK but
|
|
// exercises the error-tolerance path.
|
|
func TestReconfigureTracerProvider_OldShutdownErrorDoesNotFailReconfigure(t *testing.T) {
|
|
ctx := context.Background()
|
|
s := &Setup{
|
|
ServiceName: "test",
|
|
OTLPEndpoint: "localhost:4317",
|
|
Insecure: true,
|
|
SamplerType: "always_on",
|
|
SamplerRatio: 1.0,
|
|
Version: "test",
|
|
}
|
|
|
|
oldTP, err := s.InitializeTracing(ctx)
|
|
require.NoError(t, err)
|
|
_ = oldTP.Shutdown(ctx) // pre-shutdown: subsequent Shutdown is documented to return nil
|
|
|
|
newTP, err := s.ReconfigureTracerProvider(ctx, oldTP)
|
|
require.NoError(t, err)
|
|
require.NotNil(t, newTP)
|
|
t.Cleanup(func() { _ = newTP.Shutdown(ctx) })
|
|
}
|