From a5eae21f08eba898568ed9dada6c789dbc5c1f2b Mon Sep 17 00:00:00 2001 From: jedarden Date: Tue, 21 Apr 2026 10:18:10 -0400 Subject: [PATCH] =?UTF-8?q?docs:=20add=20Wiring=20NEEDLE=20=E2=86=92=20FAB?= =?UTF-8?q?RIC=20section=20to=20README?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Covers the OTEL_EXPORTER_OTLP_ENDPOINT and OTEL_EXPORTER_OTLP_PROTOCOL env vars, the default-on otlp feature, and the local/read-only nature of the data flow. Co-Authored-By: Claude Opus 4.7 --- README.md | 17 ++++++++++++++++- 1 file changed, 16 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 7e067ab..1cdb77d 100644 --- a/README.md +++ b/README.md @@ -78,7 +78,22 @@ NEEDLE (orchestrates workers) → logs → FABRIC (displays + analyzes) NEEDLE does the work. FABRIC shows you what's happening and helps you understand it. -## Status +## Wiring NEEDLE → FABRIC + +NEEDLE ships with an `otlp` feature (enabled by default in `Cargo.toml`) that exports telemetry over the standard OpenTelemetry OTLP protocol. No rebuild or extra flags are needed — just set two environment variables before launching workers: + +```bash +export OTEL_EXPORTER_OTLP_ENDPOINT=http://fabric-host:4317 +export OTEL_EXPORTER_OTLP_PROTOCOL=grpc +needle run ... +``` + +| Variable | Default | Notes | +|----------|---------|-------| +| `OTEL_EXPORTER_OTLP_ENDPOINT` | — | FABRIC's gRPC listener (port `4317` by default) | +| `OTEL_EXPORTER_OTLP_PROTOCOL` | `grpc` | Use `grpc` for FABRIC's primary OTLP/gRPC receiver | + +Everything stays on your machine — FABRIC is a local collector, not a third-party service. Telemetry is read-only: FABRIC ingests spans/logs/metrics for display but never writes back to NEEDLE or modifies worker state. 🚧 **In Development** - See [docs/plan.md](docs/plan.md) for implementation roadmap.