ref: extend captureMessage example #15448
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}
|
|
||
| // Optionally, specify a severity level. | ||
| // Supported levels: debug, info, warning, error, fatal. | ||
| \Sentry\captureMessage('This is a test', \Sentry\Severity::warning()); |
There was a problem hiding this comment.
Bug: PHP captureMessage example incorrectly passes Sentry Severity::warning() as a second parameter, which is not supported.
Severity: CRITICAL | Confidence: 1.00
🔍 Detailed Analysis
The PHP documentation example for Sentry captureMessage incorrectly includes Sentry Severity::warning() as a second parameter. The PHP SDK's captureMessage function does not accept a severity parameter directly; severity is typically set via Sentry withScope. Users copying this example will encounter a TypeError at runtime, as the function signature does not match the provided arguments.
💡 Suggested Fix
Update the example to use Sentry withScope for setting severity, e.g., Sentry withScope(function ($scope) { $scope->setLevel( Sentry Severity::warning()); Sentry captureMessage('message'); });.
🤖 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: platform-includes/capture-message/php.mdx#L6
Potential issue: The PHP documentation example for `
Sentry
captureMessage` incorrectly includes `
Sentry
Severity::warning()` as a second parameter. The PHP SDK's `captureMessage` function does
not accept a severity parameter directly; severity is typically set via `
Sentry
withScope`. Users copying this example will encounter a `TypeError` at runtime, as the
function signature does not match the provided arguments.
Did we get this right? 👍 / 👎 to inform future reviews.
Bundle ReportChanges will decrease total bundle size by 405 bytes (-0.0%) ⬇️. This is within the configured threshold ✅ Detailed changes
Affected Assets, Files, and Routes:view changes for bundle: sentry-docs-client-array-pushAssets Changed:
view changes for bundle: sentry-docs-server-cjsAssets Changed:
|
Adds another example for
captureMessageso it aligns with the changes done in JS.#9979
DESCRIBE YOUR PR
Tell us what you're changing and why. If your PR resolves an issue, please link it so it closes automatically.
IS YOUR CHANGE URGENT?
Help us prioritize incoming PRs by letting us know when the change needs to go live.
SLA
Thanks in advance for your help!
PRE-MERGE CHECKLIST
Make sure you've checked the following before merging your changes:
LEGAL BOILERPLATE
Look, I get it. The entity doing business as "Sentry" was incorporated in the State of Delaware in 2015 as Functional Software, Inc. and is gonna need some rights from me in order to utilize my contributions in this here PR. So here's the deal: I retain all rights, title and interest in and to my contributions, and by keeping this boilerplate intact I confirm that Sentry can use, modify, copy, and redistribute my contributions, under Sentry's choice of terms.
EXTRA RESOURCES