fi-fhir docs
Contents
Operations Guide
Documentation for deploying and operating fi-fhir in production environments.
Contents
- Production Hardening - Security best practices
- Operations Runbook - Troubleshooting and procedures
Quick Links
| Task | Document |
|---|---|
| Secure a deployment | Production Hardening |
| Troubleshoot issues | Operations Runbook |
| Monitor performance | Observability |
| Configure health checks | Health Endpoints |
Deployment Options
Docker Compose (Development)
docker-compose up -dKubernetes (Production)
# Using Kustomize
kubectl apply -k deploy/kubernetes/overlays/production/
# Using Helm
helm install fi-fhir deploy/helm/fi-fhir/ -f values-prod.yamlObservability
Metrics
Prometheus metrics are exposed at /metrics:
workflow_events_processed_total
workflow_action_duration_seconds
workflow_action_errors_total
workflow_dlq_size
workflow_circuit_breaker_state
Tracing
OpenTelemetry tracing is configured via environment:
FI_FHIR_TRACING_ENABLED=true
OTEL_EXPORTER_OTLP_ENDPOINT=http://jaeger:4318Logging
Structured JSON logs with trace correlation:
{
"level": "info",
"msg": "event processed",
"event_id": "evt_abc123",
"trace_id": "abc123def456",
"span_id": "span789"
}Health Endpoints
| Endpoint | Purpose | Response |
|---|---|---|
/health | Liveness | {"status": "ok"} |
/ready | Readiness | Checks dependencies |
/metrics | Prometheus | Metrics in text format |