Document storage tuning, thread debugging, MQTT durable sessions, analytics config#489
Open
kriszyp wants to merge 1 commit into
Open
Document storage tuning, thread debugging, MQTT durable sessions, analytics config#489kriszyp wants to merge 1 commit into
kriszyp wants to merge 1 commit into
Conversation
…lytics Fill in documentation gaps identified by reviewing harper-pro/core against the reference docs: - New Storage Tuning page covering writeAsync, compression dictionary/ threshold, blobPaths, prefetchWrites, noReadAhead, pageSize, caching, maxTransactionQueueTime, and the storage.reclamation.* sub-properties (threshold/interval/evictionFactor) — previously schema-only. - New Worker Thread Debugging page covering threads.debug.* (port, startingPort, host, waitForDebugger), Chrome DevTools and VS Code attach instructions, SSH-tunneled remote debugging, and an expanded treatment of threads.heapSnapshotNearLimit. - MQTT overview: full Durable Sessions section (cleanStart/ sessionExpiryInterval, hdb_durable_session storage, audit-log catch-up, per-node scope) and a note on hdb_session_will for Last Will durability. Fix a duplicate Last Will heading. - Analytics overview: full analytics.* config reference including the previously undocumented storageInterval, plus replicate, logging, and aggregatePeriod. - configuration/options.md: annotate threads.heapSnapshotNearLimit and threads.debug, expand storage.reclamation.* with per-property defaults, add analytics.storageInterval and analytics.logging, link storage section to the new Storage Tuning page. - Cross-links from configuration/overview.md and database/overview.md; sidebar entries for both new pages. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
🚀 Preview DeploymentYour preview deployment is ready! 🔗 Preview URL: https://preview.harper-documentation.harperfabric.com/pr-489 This preview will update automatically when you push new commits. |
cb1kenobi
approved these changes
May 14, 2026
Member
Ethan-Arrowood
left a comment
There was a problem hiding this comment.
Generally lgtm with a minor nit.
Also don't forget to format!
|
|
||
| ### `analytics.aggregatePeriod` | ||
|
|
||
| Type: `number` (seconds) • Default: `60` |
Member
There was a problem hiding this comment.
Suggested change
| Type: `number` (seconds) • Default: `60` | |
| Type: `number` (seconds) - Default: `60` |
Not going to block on this, but this whole double space and special dot character (at least its not on my keyboard) seems extra. Most of the docs use regular characters like - here.
|
|
||
| ### `storage.reclamation.interval` | ||
|
|
||
| Type: `duration string` • Default: `1h` |
Member
There was a problem hiding this comment.
Is `duration string` accurate here? It should it be `string` (duration)
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
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
Fills in documentation gaps identified by reviewing
harper-pro/coreagainst the reference docs. Adds two new reference pages and expands four existing sections so user-facing capabilities that previously lived only inconfig-root.schema.jsonor release notes are now properly documented.What changed
New pages
reference/database/storage-tuning.md— deep dive onstorage.*for production tuning:writeAsyncdurability tradeoffs, compression dictionary/threshold, multi-pathblobPaths,prefetchWrites/noReadAhead/pageSize/caching,maxTransactionQueueTime, and the fullstorage.reclamation.*reference (threshold,interval,evictionFactor) plus workload recipes.reference/configuration/debugging.md—threads.debug.*(port, startingPort, host, waitForDebugger), Chrome DevTools + VS Code attach instructions, SSH-tunneled remote debugging, and an expandedthreads.heapSnapshotNearLimitsection.Expanded sections
reference/mqtt/overview.md— new Durable Sessions section (cleanStart/sessionExpiryInterval,hdb_durable_sessionstorage, audit-log catch-up, per-node scope) and a note onhdb_session_willfor Last Will durability. Also fixes a duplicate### Last Willheading.reference/analytics/overview.md— fullanalytics.*config reference, including the previously undocumentedstorageInterval, plusreplicate,logging, andaggregatePeriod.reference/configuration/options.md— annotatedthreads.heapSnapshotNearLimitandthreads.debug, expandedstorage.reclamation.*with per-property defaults, addedanalytics.storageIntervalandanalytics.logging, linked the storage section to the new Storage Tuning page.reference/configuration/overview.mdandreference/database/overview.md— cross-links to the new pages.sidebarsReference.ts— registered both new pages.Why
A review of public-facing surfaces in
harper-pro/coreagainst the docs surfaced several config keys, behaviors, and APIs that were either schema-only (storage.reclamation.*,analytics.storageInterval,threads.debug.*sub-options) or present in code but missing user-facing guidance (MQTT durable sessions, blob-path strategies, write durability tradeoffs). The features are user-visible and operationally important, so documenting them reduces the gap between schema knowledge and what an operator can reasonably do without reading source.Test plan
npm run buildsucceeds locally — only pre-existing broken-anchor warning unrelated to this change🤖 Generated with Claude Code