docs: add GC jobs, load-testing, troubleshooting, and logging conventions guides - #598
Merged
Merged
Conversation
Documents every scheduled cleanup pass (device/key GC, envelope GC, file cleanup, and the push-subscription backoff re-enable) with schedule, retention window, and configuring env var per job, plus the crash-safe hard-delete ordering, the reference-counting check, and the implications of every job running unguarded on every gateway node.
Documents seed.ts and run.ts (flags, required local topology), the recorded metrics and pass/fail thresholds, what baseline.json represents and how to refresh it, and how to triage a failed nightly loadtest-nightly run.
Documents five failures contributors actually hit: pnpm install failing on the repo's mixed npm/pnpm and nested-workspace lockfiles, migrations silently not applying because the drizzle journal omits them, floating Node/Rust toolchains causing works-locally-fails-in-CI, tests interfering through shared module-level counters, and web build failures from the same lockfile drift. Grounded in real commits (46eee04, d60b648) and the actual repo state rather than hypotheticals.
Documents lib/logger.ts's pino configuration, level control via LOG_LEVEL, the redact-list backstop, and states the no-content rule explicitly with safe vs. unsafe logging examples. Documents the correlation fields available for tracing a request/socket event, and notes that logger.ts currently has zero import sites — all existing logging goes through console.* or a hand-rolled wrapper, and new code should use the structured logger instead of adding more console.* calls.
|
@Dannyorji Great news! 🎉 Based on an automated assessment of this PR, the linked Wave issue(s) no longer count against your application limits. You can now already apply to more issues while waiting for a review of this PR. Keep up the great work! 🚀 |
This was referenced Aug 31, 2026
Closed
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
file cleanup, push-subscription backoff re-enable): schedule, retention
window, configuring env var, idempotency/crash-safety, the file
reference-counting check, and multi-node deployment implications.
topology, recorded metrics and pass/fail thresholds, what
baseline.json represents and how to refresh it, and how to triage a
failed nightly loadtest run.
pnpm install breaking on this repo's mixed npm/pnpm and
nested-workspace lockfiles, migrations silently not applying because
the drizzle journal omits them, floating Node/Rust toolchains causing
works-locally-fails-in-CI, tests interfering via shared in-process
counters, and web build failures from the same lockfile drift.
the redact-list backstop, the explicit no-content rule (ids/counts
only, never ciphertext/plaintext/payload), available correlation
fields, and that the logger currently has zero call sites — all
existing logging still goes through console.*, and new code should
use the structured logger instead of adding more.
Closes #552
Closes #553
Closes #560
Closes #565