Repository navigation
feat(docs): Apply new quick start template to PHP quick start guides - #19988
sentry-junior[bot] wants to merge 3 commits into
Conversation
Co-Authored-By: Shannon Anahata <shannon.anahata@sentry.io>
|
The latest updates on your projects. Learn more about Vercel for GitHub.
1 Skipped Deployment
|
|
The plan checks loads of the rewritten quick start page. It also checks client errors on that page and sibling PHP guide loads. An issue escalates when that page stops loading, client errors appear, or PHP not-found counts rise. Services: Mention PlanWhat changedGET /platforms/php/ now serves a single-column PHP quick start without onboarding option checkboxes. The init snippet always sets tracing and profiling. The page adds Send Logs, Send Application Metrics, and Verify Your Setup. This change ships when sentry-docs deploys. The path is product docs content, so develop-docs does not ship it. RiskA bad MDX compile can 404 this page at runtime. New Expandable markup on this page can throw client errors. Users can no longer toggle features on this page. A broken PHP platform tree can cut loads on the Laravel and Symfony guides. Those guides still link from this page. Intended effectThe new headings and the always-on snippet are not in telemetry. Use
Regression watchThis rewrite can 404 the PHP index, throw in new client components, or cut sibling PHP guide traffic.
Not observableThe live heading text and the removal of onboarding checkboxes are not queryable. Pageload span |
…ck start guides Co-Authored-By: Shannon Anahata <shannon.anahata@sentry.io>
|
|
||
| - You need a [Sentry account](https://sentry.io/signup/) and project | ||
| - Your Laravel application needs to run on PHP 7.2 or later | ||
| - Your application needs to meet your Laravel version's PHP requirements (PHP 8.2 or later for Laravel 11) |
There was a problem hiding this comment.
This seems a bit redundant. We already mention Laravel 11.x below. We wrote PHP 7.2 before because that is the minimum version our SDK requires, so I would keep it to not suggest we raised our minimum and avoid confusion
| # Send request headers, cookies, and IP address. | ||
| SENTRY_SEND_DEFAULT_PII=true |
There was a problem hiding this comment.
Maybe it's better to not include this and instead add a reference in the text to the new data collection options. send_default_pii will go away very soon in favour of data collection.
We might have a env variable to turn the defaults on/off, but right now it needs to be specified in the config directly
| ## Install | ||
|
|
||
| Install the `sentry/sentry-laravel` package: | ||
| Install Sentry Laravel SDK 4.28.0 or later. This requires PHP SDK 4.31.0 or later, where Logs and Application Metrics don't need enable options: |
There was a problem hiding this comment.
Not sure if it makes sense to mention the PHP SDK version, we bump it regularly and having people pin this manually is not recommended
| ## Install | ||
|
|
||
| Install the `sentry/sentry-symfony` bundle: | ||
| Install Sentry Symfony SDK 5.13.0 or later. This requires PHP SDK 4.31.0 or later, where Logs and Application Metrics don't need enable options: |
There was a problem hiding this comment.
Not sure if it makes sense to mention the PHP SDK version, we bump it regularly and having people pin this manually is not recommended
| # Send request headers, cookies, and IP address. | ||
| send_default_pii: true |
There was a problem hiding this comment.
We have remove send_default_pii here in favour of data collection, which will collect things by default
DESCRIBE YOUR PR
Applies the quick start template from #19295 (Ember) to the PHP, Laravel, and Symfony guides. The guides keep their single-column layouts and walk through Error Monitoring, Tracing, Profiling, Logs, and Application Metrics, including how to verify captured data in Sentry.
The examples require PHP SDK 4.31.0+, Laravel SDK 4.28.0+, or Symfony SDK 5.13.0+ so the logging and metrics APIs work without deprecated enable options. The framework guides configure their native logging integrations, including installing Symfony's optional MonologBundle. The plain PHP guide includes Composer autoloading, manual transaction instrumentation, and explicit log and metric flushing.
Also clarifies Excimer activation and Laravel's PHP requirements, corrects the
php.inisyntax, restores Laravel's Artisan diagnostic command, and links additional PHP features.IS YOUR CHANGE URGENT?
PRE-MERGE CHECKLIST
via shannon.anahata.
--
View Junior Session [Sentry]