docs(miner): add an 'Observing your miner' Grafana/ledger observability guide - #5424
Conversation
…ty guide Add packages/gittensory-miner/docs/observability.md documenting how to point Grafana at the miner's local SQLite ledgers (attempt-log + prediction-ledger) via the read-only frser-sqlite datasources shipped in grafana/provisioning/datasources/ams-ledgers.yml (JSONbored#5184): install the plugin, mount GITTENSORY_MINER_CONFIG_DIR read-only at /ams-ledgers, and load a dashboard from grafana/dashboards/. Concrete copy-pasteable steps; cross-references DEPLOYMENT.md and is linked from coding-agent-driver.md so it is discoverable from the existing entry point. Docs only — observability/Grafana setup, not a duplication of the general ops runbook (JSONbored#5190). Closes JSONbored#5190
|
Superagent didn't find any vulnerabilities or security issues in this PR. |
|
Tip 🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩 ✅ Gittensory review result - approve/merge recommendedReview updated: 2026-07-12 19:03:23 UTC
✅ Suggested Action - Approve/Merge
Review summary Nits — 6 non-blocking
Review context
Contributor next steps
Signal definitions
[BETA] Chat with GittensoryAsk Gittensory a question about this PR directly in a comment — grounded only in the same cached, public-safe facts shown above, never a new claim.
Full command reference: https://gittensory.aethereal.dev/docs/gittensory-commands 🟩 Safe / merged · 🟦 Advisory · 🟨 Held for review · 🟥 Blocked / closed 💰 Earn for open-source contributions like this. Gittensor lets GitHub contributors earn for the work they already do — register to start earning →. Checked by Gittensory, a quiet PR intelligence layer for OSS maintainers.
|
…audit (#5435) Two real false positives, both currently red on main: - The audit only scanned packages/gittensory-miner/lib and bin for env var reads, missing packages/gittensory-engine/src/miner/ (a real dependency the miner uses for coding-agent driver construction). MINER_CODING_AGENT_CLAUDE_MODEL/CODEX_MODEL/TIMEOUT_MS are genuinely read there (driver-factory.ts) but were flagged as undocumented-in-code. - extractFilePathClaims recorded a markdown link's full target verbatim, including any #anchor fragment, then checked that string against existsSync -- so "README.md#coding-agent-driver-configuration" was checked as a literal (nonexistent) filename instead of "README.md" with a heading fragment. Both were introduced by #5423/#5424 documenting real, working miner config but tripping the audit's own scan gaps, not actual DEPLOYMENT.md drift. Added a regression test for each, verified to fail on the prior code and pass on the fix.
Adds
packages/gittensory-miner/docs/observability.md— the miner-specific guide for pointing Grafana at the local SQLite ledgers (#5190). Documentation only.Contents
attempt-log.sqlite3(attempt_log_events) andprediction-ledger.sqlite3ledgers underGITTENSORY_MINER_CONFIG_DIR.frser-sqlite-datasourceentries shipped ingrafana/provisioning/datasources/ams-ledgers.yml(from Provision a Grafana datasource for AMS's local SQLite ledgers (attempt log + prediction ledger) #5184): install the plugin, mount the config dir read-only at/ams-ledgers, restart.grafana/dashboards/and point panels at theAMS Attempt Log/AMS Prediction Ledgerdatasources (incl.json_extractfor payload fields).coding-agent-driver.md(the existing entry point) so it's discoverable; cross-referencesDEPLOYMENT.md; does not duplicate the general ops runbook.Validation
ams-ledgers.yml,grafana/dashboards/,DEPLOYMENT.mdall exist; no dead links — deliberately does not reference a not-yet-existing dashboard file).miner-mcp-tool-docs-parity+miner-operations-runbookdoc tests still pass after the added cross-reference. Docs only — no code, no CI-logic surface.Closes #5190