docs(native): remove mention of enable_logs/metrics - #19041
docs(native): remove mention of enable_logs/metrics#19041JoshuaMoelans wants to merge 2 commits into
Conversation
|
The latest updates on your projects. Learn more about Vercel for GitHub.
1 Skipped Deployment
|
![sentry[bot]](https://avatars.githubusercontent.com/in/12637?s=60&v=4){kind=small}
|
|
||
| ## Usage | ||
|
|
There was a problem hiding this comment.
Bug: The removal of the logging setup documentation for the Native SDK creates a risk. If merged before the corresponding SDK update, logging may silently fail for new users.
Severity: MEDIUM
Suggested Fix
To mitigate the risk of a documentation-SDK mismatch, either restore the setup instructions until the dependent SDK PR is released, or add a note explicitly stating that logs are zero-config and which SDK version is required for this behavior. This would provide clarity similar to how the Go SDK documentation handles it.
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: docs/platforms/native/logs/index.mdx#L15-L17
Potential issue: The pull request removes the "Setup" section from the Native logs
documentation, including the `enable_logs` option, assuming that logs will become
zero-config after an upcoming SDK release (`sentry-native#1980`). However, if this
documentation change is merged before the corresponding SDK is released, new users will
lack the necessary setup instructions. This will likely cause logging to fail silently,
as the SDK would still require the now-undocumented configuration. The documentation for
other zero-config SDKs, like Go, explicitly states this behavior, whereas these changes
simply remove the section, creating ambiguity.
Did we get this right? 👍 / 👎 to inform future reviews.
There was a problem hiding this comment.
yeah so that's why I added the big
| <SdkOption name="enable_logs" type="bool" defaultValue="true"> | ||
|
|
||
| This option enables the [logging integration](/platforms/native/logs), which allows the SDK to capture logs and send them to Sentry. | ||
|
|
||
| </SdkOption> | ||
|
|
There was a problem hiding this comment.
TBD: do we want to just remove them in their entirety, OR keep them around with a "removed in 0.x.x" warning?
1 participant
DESCRIBE YOUR PR
removing mention of the now-removed options to enable logs/metrics
do not merge before getsentry/sentry-native#1980 is released
IS YOUR CHANGE URGENT?
Help us prioritize incoming PRs by letting us know when the change needs to go live.