Add Neurobooth logging reference + crash-dump runbook - #846
Merged
Conversation
There was no general logging document; log surfaces (the log_application DB table, the system-resource log, the on-disk crash/fallback/startup files) were only discoverable by reading log_manager.py, and the crash- dump capture steps lived only in issue threads. docs/logging.md indexes every logging surface — the DB log tables, the on-disk file logs, where the log directory resolves, and the PostgreSQLHandler reliability contract (reconnect + file fallback) — and points to the existing video_filename_tracking.md for recording-file registration. docs/booth_crash_dumps.md is the companion runbook: the two crash classes (SIGABRT abort vs native access violation) and the matching capture tools (ProcDump vs WER LocalDumps), the current WER config, and the cdb analysis recipe used to identify the warble.dll fault.
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
1 participant
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.
What
Two new docs, no code changes.
docs/logging.md— a general index of every logging surface: the DB log tables (log_application,log_system_resource,log_sensor_file, and the session/task/device provenance tables), the on-disk file logs (neurobooth_crash.log,neurobooth_db_log_fallback.log,neurobooth_startup.log), where the log directory resolves, and thePostgreSQLHandlerreliability contract (rate-limited reconnect + file fallback). Links toarch/video_filename_tracking.mdfor recording-file registration.docs/booth_crash_dumps.md— companion runbook: the two crash classes (SIGABRT abort vs native access violation) and their matching capture tools (ProcDump vs WER LocalDumps), the current WER config, ProcDump usage, and thecdb-from-WindowsApps analysis recipe used to identify thewarble.dllfault.Why
There was no general logging document — these surfaces were only discoverable by reading
log_manager.py, and crash-dump capture steps lived only in issue threads. Content is grounded in the currentlog_manager.py.Refs #710, #826, #824, #674, #845, #818.