Phase 1: Windows log collection + full-text search
Extends the agent, ingest, storage, api, and web with Windows Event Log/ETW sourcing and Tantivy-backed free-text search, per the approved Phase 1 plan. - CLAUDE.md: materialized on disk (never existed as a file before) with a new Phase 1 "done looks like" section. - agent: Windows Event Log (EvtSubscribe) and ETW sources, Windows service wrapper (install/uninstall/run-service), both feature- and target_os-gated so Linux builds/tests/clippy stay unaffected. Also fixed two pre-existing Phase 0 clippy gaps (dead-code on default-features-only builds, a type-inference edge case) found while testing every feature combination properly for the first time. UNVERIFIED on real Windows -- no Windows toolchain existed anywhere in the build environment; flagged prominently in three places. - proto/ingest: new record_id field, assigned once server-side in ingest's gRPC front end so ClickHouse and Tantivy agree on the same ID for the same record. - storage: record_id column + bloom filter index, verified against a live ClickHouse. - search: new service, Tantivy index, rskafka consumer as an independent second consumer group on the same Redpanda topic ingest already reads. - api/web: new /search endpoint and page, sharing the query page's result-table shape and component. - hack/windows-fixture: sends realistic Windows-shaped data straight to ingest, so the pipeline's handling of it is verifiable without a Windows host. Verified end-to-end on the live docker-compose stack: the same record_id comes back from both /query and /search for the same log line, including for windows-fixture's synthetic Windows Event Log data. Real bugs found and fixed along the way: api/Dockerfile missing proto/ in its build context, search's logs being completely silent (RUST_LOG gap), and search/target/ missing from .gitignore/.dockerignore.
This commit is contained in:
+17
-11
@@ -5,13 +5,16 @@ ingest, and ClickHouse, to a browser table. This is the actual
|
||||
"done" criterion for Phase 0 — if this doesn't work, Phase 0 isn't done,
|
||||
regardless of what any individual component's tests say.
|
||||
|
||||
**This sequence has not been run end-to-end** in the environment that
|
||||
built it (no Docker available there — see the caveats each component's
|
||||
summary already flagged). Individual pieces are unit-tested and built
|
||||
successfully in isolation; this document is the logical sequence to run
|
||||
for real, not a report that it's been run. Expect to debug something on
|
||||
first attempt, and treat the "Troubleshooting" section at the bottom as a
|
||||
starting point, not an exhaustive list.
|
||||
**Update:** this sequence has since been run for real, more than once,
|
||||
against a live Docker install — not just written and trusted. Two real
|
||||
bugs turned up doing that (ClickHouse's official image silently disabling
|
||||
network access without a password set; `rpk`'s exact flag syntax) and got
|
||||
fixed; see the git history around the "Fix two bugs found by actually
|
||||
running the Phase 0 pipeline end-to-end" commit if you want the details.
|
||||
The steps below reflect what was actually run, not just planned. The
|
||||
"Troubleshooting" section below is still worth reading first if something
|
||||
doesn't work — it's not an exhaustive list, but it does reflect real
|
||||
failures encountered, not hypothetical ones.
|
||||
|
||||
## Prerequisites
|
||||
|
||||
@@ -113,12 +116,15 @@ Reading the system journal generally needs root (or membership in the
|
||||
by distro, root is the reliable path for this runbook):
|
||||
|
||||
```sh
|
||||
sudo ./target/release/sentry-agent
|
||||
sudo RUST_LOG=info ./target/release/sentry-agent
|
||||
```
|
||||
|
||||
Leave it running in this terminal — you should see a `connected to ingest
|
||||
service` log line. If you see a TLS or connection error instead, stop
|
||||
here and check the Troubleshooting section before continuing.
|
||||
`RUST_LOG=info` matters: `tracing_subscriber`'s default filter is
|
||||
otherwise strict enough to suppress even the startup log line, and the
|
||||
agent will look like it's silently doing nothing. Leave it running in
|
||||
this terminal — you should see a `connected to ingest service` log line.
|
||||
If you see a TLS or connection error instead, stop here and check the
|
||||
Troubleshooting section before continuing.
|
||||
|
||||
## 6. Generate a test log line
|
||||
|
||||
|
||||
Reference in New Issue
Block a user