benvin
c05ccfcb5d
logarchiver replaces the plain Vector archiver leg of the centralized logging stack (argocd-apps #296) with a Go service that archives raw logs from NATS JetStream to S3 as zstd-compressed, OpenPGP-encrypted, indexed objects, plus an operator CLI to search the index and retrieve/decrypt archived logs. It adds the things that outgrew Vector: zstd compression, encryption keyed from Ben's Vault GPG secrets engine, a searchable ClickHouse index, and sink-conditional acks (a batch is acknowledged to JetStream only after the object is durably in S3 AND indexed). Service (`logarchiver run`): - Durable JetStream pull consumer (stream LOGS, durable archiver, subject filter default logs.k8s.vault.>), explicit acks, independent offsets. - Batch per subject by size/count/time -> NDJSON -> zstd -> encrypt -> S3 PUT -> ClickHouse index row -> ack. On any failure the batch is Nak'd and redelivered, so nothing is lost on a sink outage. - Encryption is a wrapped-DEK envelope (container LARC1): the bulk is AES-256-GCM framed under a random data key, and only that 32-byte key is OpenPGP-encrypted to the engine's public key. This is because the Vault GPG engine does whole-payload decrypt only; retrieval round-trips just the tiny wrapped key regardless of object size. Public key fetched from the engine or a mounted file (configurable); key fingerprint recorded per object; periodic pubkey refresh for rotation. - Prometheus metrics, structured slog, graceful drain on shutdown. CLI: - `search` queries the index (subject/host/time) and lists matching objects. - `fetch` downloads, decrypts via the Vault GPG engine, unzstds and emits NDJSON (optionally re-filtered by host/time). - `init-schema` creates/prints the ClickHouse archive_index DDL. - cobra `completion` subcommands. Config via file+env (k8s-friendly, secrets from env), boundaries (NATS/S3/ ClickHouse/Vault) behind interfaces with unit tests (config, batching, host/subject extraction, crypto roundtrip with a test key, ack-after-persist with fakes, search query building). go build/vet/test -race clean; golangci-lint v2 clean. Woodpecker CI: build/test/pre-commit on PR; on v* tag a container image plus a Gitea binary release + rpm-internal RPM. Docs per subcommand + architecture + retrieval runbook + deployment drop-in. Claude-Session: https://claude.ai/code/session_015ur3i7D2azsMAWTSVABApv
40 lines
1.2 KiB
Markdown
40 lines
1.2 KiB
Markdown
# `logarchiver search`
|
|
|
|
Query the ClickHouse archive index for objects matching a subject/host/time
|
|
window. Prints one row per matching S3 object with event counts and sizes; use
|
|
the object keys with [`fetch`](fetch.md).
|
|
|
|
```sh
|
|
logarchiver search [flags]
|
|
```
|
|
|
|
## Flags
|
|
|
|
| Flag | Meaning |
|
|
|---|---|
|
|
| `--subject` | NATS-style subject glob: `*` matches one token, `>` matches the rest. e.g. `logs.vm.*`, `logs.k8s.vault.>`. |
|
|
| `--host` | Source host to match: exact, or a glob containing `*`. |
|
|
| `--from` | Start of window: RFC3339, `YYYY-MM-DD`, or a relative duration like `-24h`. |
|
|
| `--to` | End of window (same formats). |
|
|
| `--limit` | Max objects (default 100; `0` = no limit). |
|
|
| `--json` | Emit results as JSON instead of a table. |
|
|
|
|
An object matches the time window when its `[min_ts, max_ts]` overlaps
|
|
`[from, to]`. Objects are ordered by `min_ts`.
|
|
|
|
## Examples
|
|
|
|
```sh
|
|
# Vault audit logs from a node in the last day.
|
|
logarchiver search --subject 'logs.k8s.vault.>' --host node-1 --from -24h
|
|
|
|
# All VM logs for a host in July, as JSON.
|
|
logarchiver search --subject 'logs.vm.*' --host db-1 \
|
|
--from 2026-07-01 --to 2026-08-01 --json
|
|
```
|
|
|
|
## Config
|
|
|
|
Uses `index.*` (ClickHouse address/database/table/credentials). Requires
|
|
`index.enabled: true`.
|