Ilia Denisov
dcd8de8b00
- pkg/telemetry: shared OTel provider bootstrap (none/stdout/otlp + W3C
propagators + Go runtime metrics); backend/internal/telemetry becomes a thin
facade keeping its gin middleware.
- Telemetry parity: gateway and the Telegram connector gain telemetry runtimes
and config (GATEWAY_/TELEGRAM_ SERVICE_NAME + OTEL_*); otelgrpc instruments the
backend push server, the gateway's backend+connector clients and the connector
server. Default exporter stays none (collector/dashboards are Stage 14).
- Operational metrics (variant attribute on game-scoped ones): game_replay_duration,
game_move_validate_duration, games_started_total, games_abandoned_total,
game_cache_active, chat_messages_total{kind}, gateway edge_request_duration.
Wired via the SetMetrics setter pattern (default no-op meter).
- TODO-3: account.GuestReaper deletes guests with no game seat past
BACKEND_GUEST_RETENTION (default 30d, swept every BACKEND_GUEST_REAP_INTERVAL).
- Tests: pkg/telemetry exporter selection; game/social/edge metric recording via
a manual reader; config (otlp accepted, guest knobs); inttest guest reaper.
- Docs: PLAN.md re-scopes Stage 12 and adds Stage 13 (alphabet-on-wire) + Stage 14
(CI/deploy) with the agreed dictionary-versioning resolution; ARCHITECTURE 11/13,
TESTING, the three READMEs and FUNCTIONAL(+ru) updated.
69 lines
2.4 KiB
Go
69 lines
2.4 KiB
Go
// Package telemetry owns the backend's OpenTelemetry wiring. The provider
|
|
// bootstrap (exporter selection, propagators, shutdown, Go runtime metrics) is
|
|
// shared across the Scrabble services in scrabble/pkg/telemetry; this package is a
|
|
// thin backend-flavoured facade over it (the "scrabble-backend" default service
|
|
// name) plus the backend-specific gin request-timing middleware (middleware.go),
|
|
// which uses the registered global tracer so requests are timed and logged even
|
|
// when the exporter is "none".
|
|
package telemetry
|
|
|
|
import (
|
|
"context"
|
|
|
|
"go.opentelemetry.io/otel/trace"
|
|
"go.uber.org/zap"
|
|
|
|
pkgtel "scrabble/pkg/telemetry"
|
|
)
|
|
|
|
// Exporter selectors, re-exported from scrabble/pkg/telemetry so the backend's
|
|
// config and tests need not import the shared package directly.
|
|
const (
|
|
ExporterNone = pkgtel.ExporterNone
|
|
ExporterStdout = pkgtel.ExporterStdout
|
|
ExporterOTLP = pkgtel.ExporterOTLP
|
|
)
|
|
|
|
// DefaultServiceName labels traces and metrics when BACKEND_SERVICE_NAME is unset.
|
|
const DefaultServiceName = "scrabble-backend"
|
|
|
|
// Config selects the telemetry providers' service name and exporters. It aliases
|
|
// the shared configuration type.
|
|
type Config = pkgtel.Config
|
|
|
|
// Runtime owns the shared OpenTelemetry providers. It aliases the shared runtime
|
|
// type, so callers keep using telemetry.Runtime.
|
|
type Runtime = pkgtel.Runtime
|
|
|
|
// DefaultConfig returns the backend's telemetry configuration: the
|
|
// "scrabble-backend" service name and both exporters off (so no collector is
|
|
// required locally or in CI).
|
|
func DefaultConfig() Config {
|
|
return pkgtel.DefaultConfig(DefaultServiceName)
|
|
}
|
|
|
|
// New constructs the telemetry runtime, registers the global providers and the
|
|
// W3C propagators, and returns the Runtime. Callers must invoke Runtime.Shutdown
|
|
// during process exit.
|
|
func New(ctx context.Context, cfg Config) (*Runtime, error) {
|
|
return pkgtel.New(ctx, cfg)
|
|
}
|
|
|
|
// TraceFieldsFromContext returns zap fields identifying the active span, or nil
|
|
// when ctx carries no valid span context. Collocated here so callers (the
|
|
// request-timing middleware and the access log) do not import the OpenTelemetry
|
|
// API directly.
|
|
func TraceFieldsFromContext(ctx context.Context) []zap.Field {
|
|
if ctx == nil {
|
|
return nil
|
|
}
|
|
sc := trace.SpanContextFromContext(ctx)
|
|
if !sc.IsValid() {
|
|
return nil
|
|
}
|
|
return []zap.Field{
|
|
zap.String("otel_trace_id", sc.TraceID().String()),
|
|
zap.String("otel_span_id", sc.SpanID().String()),
|
|
}
|
|
}
|