|
| 1 | +# Quickwit + OpenTelemetry Plan |
| 2 | + |
| 3 | +## Goals |
| 4 | +- Export traces, logs, and metrics to Quickwit over OTLP. |
| 5 | +- Keep telemetry optional via environment variables. |
| 6 | +- Provide simple search and dashboards on Quickwit indexes. |
| 7 | + |
| 8 | +## Quickwit Facts (from docs) |
| 9 | +- `quickwit run` exposes: REST UI on 7280, OTLP/HTTP on 7281, OTLP/gRPC on 7282. |
| 10 | +- Health probe: `GET /api/v1/health` on port 7280. |
| 11 | +- Config path can be mounted at `/quickwit/config/quickwit.yaml`. |
| 12 | + |
| 13 | +## Steps |
| 14 | +1. **Cleanup** |
| 15 | + - Delete OpenObserve docs, env vars, and Docker services. |
| 16 | + - Remove `OpenObserveConfig`, `OpenObserveClient`, and related wiring in `src/main.rs`, `src/state.rs`, `src/modules/observability_v1/`. |
| 17 | + - Drop OpenObserve helpers from tests and scripts. |
| 18 | +2. **Exporters** |
| 19 | + - Add `QuickwitConfig` and OTLP exporters inside `src/utils/telemetry.rs` (or equivalent module). |
| 20 | + - Update `AppState` to hold an optional Quickwit client used by observability routes. |
| 21 | + - Extend `.env.example` with `QUICKWIT_INGEST_URL`, `QUICKWIT_ACCESS_TOKEN`, optional index IDs, and `ENABLE_QUICKWIT_OTEL` flag. |
| 22 | +3. **Quickwit Services** |
| 23 | + - Replace `docker-compose.observability.yml` with Quickwit + MinIO. |
| 24 | + - Add `observability/quickwit/config/quickwit.yaml` and CLI bootstrap script for indexes. |
| 25 | + - Update smoke tests to push sample OTLP data and query Quickwit. |
| 26 | +4. **Docs & Rollout** |
| 27 | + - Refresh `docs/MODULES_OVERVIEW.md`, README, and any runbooks to reference Quickwit. |
| 28 | + - Document migration steps (feature flag on staging, data backfill, production cutover). |
| 29 | + |
| 30 | +## Validation |
| 31 | +- Unit tests fallback to in-memory subscriber when Quickwit is disabled. |
| 32 | +- Smoke script sends OTLP spans via `otel-cli` and checks Quickwit REST search. |
| 33 | +- Monitor ingest latency, error rates, and retention during staging dry run. |
| 34 | + |
| 35 | +## Deliverables |
| 36 | +- Updated telemetry code paths and env vars. |
| 37 | +- Quickwit-aware Docker compose and bootstrap assets. |
| 38 | +- Full removal of OpenObserve references in source, tests, and docs. |
0 commit comments