ShieldGate Docs

Observability

OpenTelemetry and Prometheus

Export traces and metrics from ShieldGate hosts.

Goal

Wire ShieldGate into your existing observability stack.

Steps

  1. Review OpenTelemetry options on Api/Proxy/Worker hosts (OTLP endpoints, service names).
  2. Enable the Prometheus exporter endpoint where configured.
  3. Scrape metrics from your Prometheus (or compatible) agent.
  4. Correlate with Analytics for product-level WAF views vs infra metrics.

Verify

  • OTLP collector receives spans/metrics.
  • Prometheus targets show the ShieldGate scrape as UP.

Tips

  • Keep cardinality under control—prefer bounded labels.
  • Use /health and /ready for probes; use OTel for deep performance.