Files
silo-server/internal/recommendations/embeddings/client.go
203a18ae83 feat(observability): OpenTelemetry logs+traces with secret redaction and slog standardization (#290)
* feat(observability): OpenTelemetry logs+traces with secret redaction

Part of #265. Adds opt-in OpenTelemetry (logs + traces) alongside the existing
stderr + opslog pipeline, plus secret redaction on all sinks. Default-off: with
no OTEL_* / SILO_OTEL_ENABLED config, behavior is unchanged.

Bootstrap (internal/telemetry):
- Setup() builds one shared resource, a TracerProvider (parent-based trace-id
  ratio sampler), a LoggerProvider, and the W3C TraceContext+Baggage propagator
  from env. It installs NO MeterProvider — metrics stay on Prometheus, and the
  built-in no-op global MeterProvider keeps the trace instrumentation libs from
  double-emitting. Shutdown is deferred with a flush timeout.
- Logs are bridged via otelslog fan-out (slog.MultiHandler), level-gated by the
  shared LevelVar and best-effort so a failing collector can't break the console
  or DB branches. stderr + opslog stay untouched.

Secret redaction (internal/logredact):
- A slog.Handler masks secret-keyed attributes (password, token, api_key,
  authorization, cookie, ...) — including .With-bound attrs, nested groups,
  secret-keyed group subtrees, and values behind a LogValuer — on the console
  and OTLP sinks, with a no-op fast path when a record has no secret keys.
  opslog.shouldRedact delegates to logredact.SecretKey so all sinks share one
  marker list.

Rotation is infra-managed (no custom file sink): container runtime for stderr,
collector/backend for OTLP, opslog partition-pruning for the DB. Documented in
docs/architecture/observability.md.

Verification: go build ./..., go vet, gofmt -l — clean; go test
./internal/telemetry/ ./internal/logredact/ -race pass.

AI-use disclosure: implemented with AI assistance (Claude Code), including
adversarial reviews that hardened the bootstrap and fixed two redaction leak
paths; reviewed by the author.

* refactor(observability): slog context+component sweep, sloglint gate (phase 3)

Part of #265. Builds on the OTel bootstrap + redaction commit.

Standardizes every log call site onto the context-carrying slog variants so
records correlate with the active OpenTelemetry trace, and locks the standard
in with a machine gate so future code (human- or AI-authored) can't drift back.

- Call-site sweep: converted the remaining slog.<Level>(...) calls to the
  slog.<Level>Context(ctx, ...) form wherever a context.Context is in scope
  (background/init calls with no ctx are left as-is), across 183 files. Applied
  via a type-aware AST codemod. Log levels and message strings are preserved
  verbatim; a component attr (canonical per-package name) is added to direct
  package-level slog calls. Bound-logger calls keep their existing .With
  bindings. The main.go and telemetry package conversions rode with their file
  in the previous commit to keep each file within a single commit.
- Enforcement (.golangci.yml): enable sloglint with context=scope, static-msg,
  key-naming-case=snake, no-mixed-args. After the sweep all four report zero
  violations repo-wide (tests included), so make lint / CI now blocks any
  regression to the non-context form. The gate ships with the sweep because it
  cannot be green until the legacy sites are converted.

Metrics remain on Prometheus; no behavior change to /metrics or Grafana.

Verification: go build ./..., go vet ./..., gofmt -l — clean; sloglint (all 4
rules) 0 violations repo-wide; log levels verified unchanged.

AI-use disclosure: implemented with AI assistance (Claude Code), including the
codemod; reviewed by the author.

* fix(observability): honor per-signal OTLP protocol and secret WithGroup names

Two Codex review findings on PR #290:

- telemetry: OTEL_EXPORTER_OTLP_{TRACES,LOGS}_PROTOCOL now override the
  generic OTEL_EXPORTER_OTLP_PROTOCOL per signal, so mixed collector
  setups (e.g. HTTP logs + gRPC traces) build the right exporter.
- logredact: entering a group whose name is secret-bearing (e.g.
  WithGroup("authorization")) now masks every leaf in that subtree,
  matching how slog.Group("authorization", ...) is masked as a whole.

* fix(observability): address review feedback on telemetry bootstrap

- Telemetry setup failure no longer kills boot: Setup returns usable
  no-op providers alongside the error and main logs and continues with
  telemetry disabled, honoring the best-effort contract.
- Honor OTEL_TRACES_SAMPLER (always_on/off, traceidratio, parentbased_*
  variants); unsupported values fall back to parentbased_traceidratio.
- Attach node identity as semconv service.instance.id instead of the
  non-semconv node.name.
- Rename opslog retention-scope log attrs to target_component/target_level
  so they no longer collide with the canonical component routing key, and
  tag those lines with component=opslog.
- Fix stale levelGated comment casing; use WarnContext in the telemetry
  shutdown defer; document the LogValuer double-resolve on the redaction
  slow path.

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>

---------

Co-authored-by: Quick <31828688+Quick104@users.noreply.github.com>
Co-authored-by: Claude Fable 5 <noreply@anthropic.com>
2026-07-09 08:53:52 -04:00

269 lines
7.0 KiB
Go

package embeddings
import (
"bytes"
"context"
"encoding/json"
"fmt"
"io"
"log/slog"
"net/http"
"strconv"
"strings"
"time"
)
// ClientConfig holds embedding client configuration.
type ClientConfig struct {
BaseURL string
Model string
APIKey string // empty for Ollama
}
// Client calls an embeddings API (OpenAI-compatible or Gemini).
type Client struct {
cfg ClientConfig
httpClient *http.Client
}
// NewClient creates a new embedding client.
func NewClient(cfg ClientConfig) *Client {
return &Client{
cfg: cfg,
httpClient: &http.Client{Timeout: 10 * time.Minute},
}
}
// isGemini returns true if the base URL points to the Google Generative AI API.
func (c *Client) isGemini() bool {
return strings.Contains(c.cfg.BaseURL, "generativelanguage.googleapis.com")
}
// --- OpenAI-compatible types ---
type embeddingRequest struct {
Model string `json:"model"`
Input []string `json:"input"`
}
type embeddingResponse struct {
Data []struct {
Embedding []float32 `json:"embedding"`
Index int `json:"index"`
} `json:"data"`
}
// --- Gemini types ---
type geminiEmbedRequest struct {
Requests []geminiEmbedSingle `json:"requests"`
}
type geminiEmbedSingle struct {
Model string `json:"model"`
Content geminiContent `json:"content"`
}
type geminiContent struct {
Parts []geminiPart `json:"parts"`
}
type geminiPart struct {
Text string `json:"text"`
}
type geminiEmbedResponse struct {
Embeddings []struct {
Values []float32 `json:"values"`
} `json:"embeddings"`
}
// Embed generates embeddings for the given texts.
// Returns one []float32 per input text, in the same order.
// Retries on transient errors (5xx) and rate limits (429) with backoff.
func (c *Client) Embed(ctx context.Context, texts []string) ([][]float32, error) {
if c.isGemini() {
return c.embedGemini(ctx, texts)
}
return c.embedOpenAI(ctx, texts)
}
func (c *Client) embedOpenAI(ctx context.Context, texts []string) ([][]float32, error) {
req := embeddingRequest{
Model: c.cfg.Model,
Input: texts,
}
body, err := json.Marshal(req)
if err != nil {
return nil, fmt.Errorf("marshal embedding request: %w", err)
}
url := c.cfg.BaseURL + "/v1/embeddings"
maxAttempts := 6
var resp *http.Response
for attempt := 0; attempt < maxAttempts; attempt++ {
httpReq, reqErr := http.NewRequestWithContext(ctx, http.MethodPost, url, bytes.NewReader(body))
if reqErr != nil {
return nil, fmt.Errorf("create request: %w", reqErr)
}
httpReq.Header.Set("Content-Type", "application/json")
if c.cfg.APIKey != "" {
httpReq.Header.Set("Authorization", "Bearer "+c.cfg.APIKey)
}
resp, err = c.httpClient.Do(httpReq)
if err != nil {
if attempt < maxAttempts-1 {
time.Sleep(time.Duration(attempt+1) * time.Second)
continue
}
return nil, fmt.Errorf("embedding request failed: %w", err)
}
// Success
if resp.StatusCode == http.StatusOK {
break
}
respBody, _ := io.ReadAll(resp.Body)
resp.Body.Close()
// Rate limited — wait using Retry-After header or exponential backoff.
if resp.StatusCode == http.StatusTooManyRequests {
if attempt >= maxAttempts-1 {
return nil, fmt.Errorf("embedding API returned %d: %s", resp.StatusCode, string(respBody))
}
wait := rateLimitBackoff(resp, attempt)
slog.WarnContext(ctx, "rate limited by embedding API, waiting", "component", "recommendations", "attempt", attempt+1, "wait", wait)
select {
case <-ctx.Done():
return nil, ctx.Err()
case <-time.After(wait):
}
continue
}
// Server error — retry with backoff.
if resp.StatusCode >= 500 && attempt < maxAttempts-1 {
time.Sleep(time.Duration(attempt+1) * time.Second)
continue
}
// Non-retryable error (4xx except 429).
return nil, fmt.Errorf("embedding API returned %d: %s", resp.StatusCode, string(respBody))
}
defer resp.Body.Close()
var embResp embeddingResponse
if err := json.NewDecoder(resp.Body).Decode(&embResp); err != nil {
return nil, fmt.Errorf("decode embedding response: %w", err)
}
results := make([][]float32, len(texts))
for _, d := range embResp.Data {
if d.Index < len(results) {
results[d.Index] = d.Embedding
}
}
return results, nil
}
func (c *Client) embedGemini(ctx context.Context, texts []string) ([][]float32, error) {
modelRef := "models/" + c.cfg.Model
greq := geminiEmbedRequest{
Requests: make([]geminiEmbedSingle, len(texts)),
}
for i, t := range texts {
greq.Requests[i] = geminiEmbedSingle{
Model: modelRef,
Content: geminiContent{Parts: []geminiPart{{Text: t}}},
}
}
body, err := json.Marshal(greq)
if err != nil {
return nil, fmt.Errorf("marshal gemini embedding request: %w", err)
}
url := fmt.Sprintf("%s/v1beta/%s:batchEmbedContents?key=%s", c.cfg.BaseURL, modelRef, c.cfg.APIKey)
maxAttempts := 6
var resp *http.Response
for attempt := 0; attempt < maxAttempts; attempt++ {
httpReq, reqErr := http.NewRequestWithContext(ctx, http.MethodPost, url, bytes.NewReader(body))
if reqErr != nil {
return nil, fmt.Errorf("create request: %w", reqErr)
}
httpReq.Header.Set("Content-Type", "application/json")
resp, err = c.httpClient.Do(httpReq)
if err != nil {
if attempt < maxAttempts-1 {
time.Sleep(time.Duration(attempt+1) * time.Second)
continue
}
return nil, fmt.Errorf("gemini embedding request failed: %w", err)
}
if resp.StatusCode == http.StatusOK {
break
}
respBody, _ := io.ReadAll(resp.Body)
resp.Body.Close()
if resp.StatusCode == http.StatusTooManyRequests {
if attempt >= maxAttempts-1 {
return nil, fmt.Errorf("gemini embedding API returned %d: %s", resp.StatusCode, string(respBody))
}
wait := rateLimitBackoff(resp, attempt)
slog.WarnContext(ctx, "rate limited by gemini embedding API, waiting", "component", "recommendations", "attempt", attempt+1, "wait", wait)
select {
case <-ctx.Done():
return nil, ctx.Err()
case <-time.After(wait):
}
continue
}
if resp.StatusCode >= 500 && attempt < maxAttempts-1 {
time.Sleep(time.Duration(attempt+1) * time.Second)
continue
}
return nil, fmt.Errorf("gemini embedding API returned %d: %s", resp.StatusCode, string(respBody))
}
defer resp.Body.Close()
var gresp geminiEmbedResponse
if err := json.NewDecoder(resp.Body).Decode(&gresp); err != nil {
return nil, fmt.Errorf("decode gemini embedding response: %w", err)
}
results := make([][]float32, len(texts))
for i, emb := range gresp.Embeddings {
if i < len(results) {
results[i] = emb.Values
}
}
return results, nil
}
// rateLimitBackoff returns how long to wait after a 429 response.
// Uses the Retry-After header if present, otherwise exponential backoff.
func rateLimitBackoff(resp *http.Response, attempt int) time.Duration {
if ra := resp.Header.Get("Retry-After"); ra != "" {
if secs, err := strconv.Atoi(ra); err == nil && secs > 0 {
return time.Duration(secs) * time.Second
}
}
// Exponential backoff: 10s, 20s, 40s, 60s, 60s ...
wait := 10 * time.Second * (1 << attempt)
if wait > 60*time.Second {
wait = 60 * time.Second
}
return wait
}