Repository navigation
docs(logger): document log file, headless stdout, handlers and Logfami - #3
Merged
Merged
Conversation
Documents the logging changes of kanimaru/twitcher#143: - additional/logger.md: rewritten around the two jobs of the logger (console while developing, log file for support); levels incl. warn, attributes, file settings, finding the file, headless stdout, custom handlers with the record contract. Corrects the claim that console settings apply immediately; they're read when a logger is created. - additional/logfami.md: new page for the standalone library: pipelines, formats, resource, redaction, sinks, engine capture, extending. - introduction/support.md: "Send Us Your Log File" with the user data paths per operating system. - additional/index.md and the sidebar: Logger (missing from the sidebar before) and Logfami. Code samples were run in Godot 4.7; the site builds without dead links. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01Q278jksbLv9nSTcfSLAMKA
- Explain the auto_install opt-out as it now works (first log call, not script load) and that uninstall() switches it off; the editor needs uninstall(). - Session header examples include process.pid; the prose names pid and runtime. - The headless JSON example shows the full resource object. - "every record" → "every record at info level and above". - Support page: the file is written while the per-component console logs are off, not while file logging is off; lists twitcher.2.log and mentions godot.log in the same folder. - Explicit type on the preload constant, per the style rules. - Record-keys sentence reworded; apikey, "warning" and error.type added where the code has them. - Lambda tip updated for TwitchLoggerManager.remove_lambda_handlers(). Site builds; cross-page anchors verified against the generated HTML. Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01Q278jksbLv9nSTcfSLAMKA
TwitchLogLevel was removed from Twitcher in favour of LogfamiLevel. Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01Q278jksbLv9nSTcfSLAMKA
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.
Documentation for kanimaru/twitcher#143 (file logging, kanimaru/twitcher#123). Merge it together with or after that PR, since the pages describe features that only exist from there on.
Changes
additional/logger.md: rewritten around the logger's two jobs: console output while developing, and the log file for support.wants()and instance suffixes.auto, plus a tip aboutflush_stdout_on_print.auto_installopt-out as it works after the review round (first log call), and a tip on lambda handlers.additional/logfami.md(new): the standalone library. Pipelines, quick start, levels, the three formats, resource, redaction rules, file/stdout/memory sinks, engine error capture, connecting other libraries, extending.introduction/support.md: new "Send Us Your Log File" section with the user data path per OS (including custom user dirs) and which files to send.additional/index.mdand sidebar: Logger (it was missing from the sidebar) and Logfami.Verification
process.pidin header examples, an abbreviated resource, an overstated "every record", a support-page sentence contradictingfile/level = off, a sample without an explicit type, a few completeness gaps) are fixed inaf1c713.vitepress buildpasses with no dead links; the three cross-page#anchorlinks were checked against the generated HTML (the emoji heading has an explicit{#send-us-your-log-file}anchor).🤖 Generated with Claude Code
https://claude.ai/code/session_01Q278jksbLv9nSTcfSLAMKA