Configure SmithDB observability

SmithDB is optional and available in beta. Configure observability after you deploy SmithDB services and before you tune capacity or migrate historical data.

SmithDB components expose application metrics and can export logs and traces to your existing observability stack.

Configure observability before tuning capacity or migrating historical data. It provides the signals needed to validate changes and investigate failures.

Metrics

Each SmithDB component exposes application metrics at the fixed /metrics path on its HTTP port. Configure your monitoring stack to discover the pods by adding scrape annotations to each component:

Sample Prometheus configuration

smithdb:
  query:
    deployment:
      annotations:
        prometheus.io/scrape: "true"
        prometheus.io/path: "/metrics"
        prometheus.io/port: "8060"
  ingestion:
    deployment:
      annotations:
        prometheus.io/scrape: "true"
        prometheus.io/path: "/metrics"
        prometheus.io/port: "8050"
  compaction:
    deployment:
      annotations:
        prometheus.io/scrape: "true"
        prometheus.io/path: "/metrics"
        prometheus.io/port: "8070"
  compactionWorker:
    deployment:
      annotations:
        prometheus.io/scrape: "true"
        prometheus.io/path: "/metrics"
        prometheus.io/port: "9000"
  clusterManager:
    deployment:
      annotations:
        prometheus.io/scrape: "true"
        prometheus.io/path: "/metrics"
        prometheus.io/port: "8090"

Use your monitoring provider’s pod annotations instead when it does not discover standard Prometheus annotations. Monitor the PostgreSQL metastore, Kubernetes nodes, and cloud services through your infrastructure observability.

Logs and traces

SmithDB uses the chart-level OpenTelemetry tracing configuration. Because SmithDB supports OTLP gRPC only, it exports logs and traces when config.observability.tracing.enabled is true and config.observability.tracing.exporter is grpc:

config:
  observability:
    tracing:
      enabled: true
      endpoint: "otel-collector.observability.svc.cluster.local:4317"
      exporter: "grpc"

When the chart-level exporter is http, SmithDB OTLP export remains disabled and SmithDB logs continue to use console output. The chart includes SmithDB pod and container names as OpenTelemetry resource attributes automatically. To customize SmithDB log filtering, set RUST_LOG for all SmithDB workloads through smithdb.commonEnv:

smithdb:
  commonEnv:
    - name: RUST_LOG
      value: "warn,smithdb_query=debug,vortex=warn"

Ensure the collector is reachable from the SmithDB namespace, then confirm telemetry arrives after applying the chart.

Get started by cloud provider

Deploy with Terraform

Setup guides

Configuration

Connect external services

SmithDB (optional)

Platform auth & access control

Self-hosted observability

Hybrid

Scripts

Reference

Configure SmithDB observability

Metrics

Logs and traces

See also

​Metrics

​Logs and traces

​See also

Metrics

Logs and traces

See also