Update options + symfony specific integrations doc #14891
+105
−0
Conversation
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
|
The latest updates on your projects. Learn more about Vercel for GitHub.
1 Skipped Deployment
|
Bundle ReportChanges will increase total bundle size by 36.87kB (0.16%) ⬆️. 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:
|
sfanahata
reviewed
Sep 15, 2025
|
|
||
| This integration catches all global uncaught exceptions and emits events when an error occurs. | ||
|
|
||
| To do so, it ensures that Sentry's `ErrorHandler` is registered, and adds a callback to it as an exception listener. |
There was a problem hiding this comment.
Suggested change
| To do so, it ensures that Sentry's `ErrorHandler` is registered, and adds a callback to it as an exception listener. | |
| It does this by ensuring that Sentry's `ErrorHandler` is registered, and adds a callback to it as an exception listener. |
sfanahata
reviewed
Sep 15, 2025
|
|
||
| This integration hooks into the global PHP `error_handler` and emits events when an error occurs. | ||
|
|
||
| To do so, it ensures that Sentry's `ErrorHandler` is registered, and adds a callback to it as an error listener. By default, the `ErrorHandler` reserves 16 KiB of memory to handle fatal errors. When handling out of memory errors, the `ErrorHandler` additionally increases the [`memory_limit`](https://www.php.net/manual/en/ini.core.php#ini.memory-limit) by an additional 5 MiB to have enough room to send the out of memory event to Sentry. This change is only done once and only affects the handling of the out of memory error. |
There was a problem hiding this comment.
Suggested change
| To do so, it ensures that Sentry's `ErrorHandler` is registered, and adds a callback to it as an error listener. By default, the `ErrorHandler` reserves 16 KiB of memory to handle fatal errors. When handling out of memory errors, the `ErrorHandler` additionally increases the [`memory_limit`](https://www.php.net/manual/en/ini.core.php#ini.memory-limit) by an additional 5 MiB to have enough room to send the out of memory event to Sentry. This change is only done once and only affects the handling of the out of memory error. | |
| It does this by ensuring that Sentry's `ErrorHandler` is registered, and adds a callback to it as an error listener. By default, the `ErrorHandler` reserves 16 KiB of memory to handle fatal errors. When handling out of memory errors, the `ErrorHandler` additionally increases the [`memory_limit`](https://www.php.net/manual/en/ini.core.php#ini.memory-limit) by an additional 5 MiB to have enough room to send the out of memory event to Sentry. This change is only done once and only affects the handling of the out of memory error. |
sfanahata
reviewed
Sep 15, 2025
| To change the amount of memory reserved for fatal error handling or the amount the `memory_limit` is increased when handling an out of memory error, you can register the fatal error handler yourself before calling `\Sentry\init(...)`: | ||
|
|
||
| ```php | ||
| // The amount of reserved memory every request (in bytes), this has to be a positive integer amount of bytes. Defaults to 16 KiB |
There was a problem hiding this comment.
Suggested change
| // The amount of reserved memory every request (in bytes), this has to be a positive integer amount of bytes. Defaults to 16 KiB | |
| // The amount of reserved memory for every request (in bytes), this has to be a positive integer in bytes. Defaults to 16 KiB |
sfanahata
reviewed
Sep 15, 2025
| ```php | ||
| // The amount of reserved memory every request (in bytes), this has to be a positive integer amount of bytes. Defaults to 16 KiB | ||
| $errorHandler = \Sentry\ErrorHandler::registerOnceFatalErrorHandler(16 * 1024); | ||
| // The amount of memory in bytes to increase the `memory_limit` to when handling a out of memory error, can also be set to `null` to disable increasing the `memory_limit`. Defaults to 5 MiB |
There was a problem hiding this comment.
Suggested change
| // The amount of memory in bytes to increase the `memory_limit` to when handling a out of memory error, can also be set to `null` to disable increasing the `memory_limit`. Defaults to 5 MiB | |
| // The amount of memory in bytes to increase the `memory_limit` to when handling an out of memory error. It can also be set to `null` to disable increasing the `memory_limit`. Defaults to 5 MiB |
sfanahata
reviewed
Sep 15, 2025
|
|
||
| This integration catches all fatal errors and emits the corresponding events. | ||
|
|
||
| To do so, it ensures that Sentry's `ErrorHandler` is registered, and adds a callback to it as a fatal error listener. |
There was a problem hiding this comment.
Suggested change
| To do so, it ensures that Sentry's `ErrorHandler` is registered, and adds a callback to it as a fatal error listener. | |
| It does this by ensuring that Sentry's `ErrorHandler` is registered, and adds a callback to it as a fatal error listener. |
sfanahata
reviewed
Sep 15, 2025
|
|
||
| - HTTP method | ||
| - URL (including the query string) | ||
| - Body (by default only if the body is 10Kb or less) |
There was a problem hiding this comment.
Suggested change
| - Body (by default only if the body is 10Kb or less) | |
| - Body (only if the body is 10Kb or less) |
sfanahata
reviewed
Sep 15, 2025
|
|
||
| ### Use a Callback to Customize Integrations | ||
|
|
||
| For advanced cases, you can provide a callback (service) instead of a fixed list to customize integrations. See how to reference callables in Symfony configuration here: <PlatformLink to="/platforms/php/guides/symfony/configuration/symfony-options/#callables">Callables in Symfony Options</PlatformLink>. |
There was a problem hiding this comment.
This link does not exist. The closest I could find was this: /platforms/php/guides/symfony/configuration/options/, however I could not find the #callables option. Is that in a separate PR?
sfanahata
requested changes
Sep 15, 2025
|
@sfanahata Thanks for the review. I updated the broken link, it now points correctly to https://docs.sentry.io/platforms/php/guides/symfony/configuration/symfony-options/#callables |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
…rations
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