docs: add 13.x to 14.x upgrade guide - #1231
Merged
Merged
Conversation
solnic
marked this pull request as ready for review
September 24, 2026 13:53
![sentry[bot]](https://avatars.githubusercontent.com/in/12637?s=60&v=4){kind=small}
|
|
||
| ## Replace `:enable_logs` with `:logs` | ||
|
|
||
| The `:enable_logs` option was removed. Sentry validates its configuration when it starts, so an application that still sets `:enable_logs` fails to boot. |
There was a problem hiding this comment.
Bug: The upgrade documentation incorrectly states that using deprecated keys like :enable_logs will cause a boot failure. These keys are silently ignored, which can lead to silent misconfiguration.
Severity: MEDIUM
Suggested Fix
Update the documentation in pages/upgrade-14.x.md to accurately describe that old configuration keys are silently stripped, and will not cause a boot failure. Warn users to check their configuration to ensure features like logging are still enabled with the new keys.
Prompt for AI Agent
Review the code at the location below. A potential bug has been identified by an AI
agent. Verify if this is a real issue. If it is, propose a fix; if not, explain why it's
not valid.
Location: pages/upgrade-14.x.md#L7
Potential issue: The upgrade documentation at `pages/upgrade-14.x.md` incorrectly states
that using removed configuration options like `:enable_logs` or `:enable_metrics` will
cause the application to fail on boot. In reality, the configuration validation in
`lib/sentry/config.ex` uses `Keyword.take(@valid_keys)`, which silently strips any
unrecognized keys. Consequently, an application using these old keys will boot
successfully. This can lead to silent misconfigurations, such as a user removing
`enable_logs: true` without adding the new `logs` configuration, resulting in structured
logs no longer being sent without any warning.
Also affects:
pages/upgrade-14.x.md:34
Did we get this right? 👍 / 👎 to inform future reviews.
whatyouhide
approved these changes
Sep 24, 2026
whatyouhide
left a comment
whatyouhide
left a comment
Collaborator
There was a problem hiding this comment.
Lovely, no comments
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.
Upgrade guide for
14.0.0.