docs: v5.1 upgrade notes for the eager file open and Rails Semantic Logger v5.1 - #382
Merged
Conversation
…ic Logger v5.1 The v5.1 upgrade section covered only the appender deprecations. Document the file appender's eager open too, since it changes observable behavior: a bad log path now raises from add_appender in the calling thread, and the log file is created as soon as the appender is added rather than on first write. rails.md: add an "Upgrading to v5.1" section for the companion gem's matching release, covering the boot-time fallback that the eager open makes reachable and the removal of Sidekiq v4/v5/v6 support. Also record the rubocop_todo burndown result in CLAUDE.md, and regenerate llms-full.txt. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
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.
The v5.1 upgrade section covered only the appender deprecations. This documents the file appender's eager open as well, and adds the matching upgrade notes for the companion gem's v5.1 release.
upgrading.md
The eager open changes observable behavior, so it belongs in the upgrade notes:
SemanticLogger.add_appenderin the calling thread, instead of surfacing later on the appender thread while messages are lostAlso flags the case worth reviewing: code that adds appenders inside a
rescueor a conditional written on the assumption that creation could never fail.The section intro was rewritten, since it opened with "v5.1 deprecates several legacy appenders and one appender option" and that is no longer the whole story.
rails.md
New "Upgrading to v5.1" section for rails_semantic_logger v5.1, covering:
:warn. Previously the app booted against an appender that silently dropped every message, so anyone who has been running with an unwritable log path without noticing will find out on upgrade.logged_job_attributes,skip_default_job_logging).I checked the rest of
rails.mdagainst the v5.1 deprecations while I was in there: it never mentions the:sentryor:new_relicappenders, and its one Elasticsearch example already omitstype:, so nothing there went stale.llms-full.txtregenerated viabundle exec rake llms_full.Also carries a small
CLAUDE.mdedit recording the rubocop_todo burndown result (32 -> 27 cops).The matching gem release is reidmorrison/rails_semantic_logger#324.
🤖 Generated with Claude Code