Skip to content

feat(docs): Apply new quick start template to PHP quick start guides - #19988

Open
sentry-junior[bot] wants to merge 3 commits into
masterfrom
docs/quickstart-template-php
Open

sentry-junior[bot] wants to merge 3 commits into
masterfrom
docs/quickstart-template-php

Conversation

@sentry-junior

@sentry-junior sentry-junior Bot commented Oct 15, 2026 •

Copy link
Copy Markdown
Contributor

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.ini syntax, restores Laravel's Artisan diagnostic command, and links additional PHP features.

IS YOUR CHANGE URGENT?

  • Urgent deadline (GA date, etc.): YYYY-MM-DD
  • Other deadline: YYYY-MM-DD
  • No deadline: Not urgent, can wait up to 1 week+

PRE-MERGE CHECKLIST

  • Checked Vercel preview for correctness, including links
  • PR was reviewed and approved by any necessary SMEs (subject matter experts)
  • PR was reviewed and approved by a member of the Sentry docs team

via shannon.anahata.

--

View Junior Session [Sentry]

Co-Authored-By: Shannon Anahata <shannon.anahata@sentry.io>
@vercel

vercel Bot commented Oct 15, 2026 •

Copy link
Copy Markdown

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated
sentry-docs Ready Ready Preview Oct 29, 2026 12:26am UTC
1 Skipped Deployment
Project Deployment Actions Updated
develop-docs Ignored Ignored Preview Oct 29, 2026 12:26am UTC

Request Review

@github-actions github-actions Bot added the Priority: Normal Docs review has no urgent deadline label Oct 15, 2026
@cursor

cursor Bot commented Oct 15, 2026 •

Copy link
Copy Markdown
Contributor

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: sentry-docs.

Mention @change-monitor in a comment to update the plan.

Plan

What changed

GET /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.

Risk

A 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 effect

The new headings and the always-on snippet are not in telemetry. Use docs.page.load for path /platforms/php/ as proof the rewritten page still mounts. absent means that count falls near zero while the Laravel and Symfony guides still load.

Signal Baseline Rule Source
docs.page.load for path:/platforms/php/ as a share of the three PHP quick start paths Last 24h 2026-10-14T00:03:07Z to 2026-10-15T00:03:07Z: 24 loads, 18% of 131. Prior 24h 2026-10-13T00:03:07Z to 2026-10-14T00:03:07Z: 25 loads, 20% of 125. Count band 24-25 per 24h. Share band 18-20%. Hold the share in 18-20% and the count in 24-25 per 24h. Volume is low. Treat a drop to zero as absent. Treat a move of a few counts as noise. Sentry org sentry project docs. Query sum(value, docs.page.load, counter, none) with environment:production path:/platforms/php/. Compare with the same metric for path:/platforms/php/guides/laravel/ and path:/platforms/php/guides/symfony/.

Regression watch

This rewrite can 404 the PHP index, throw in new client components, or cut sibling PHP guide traffic.

Signal Baseline Rule Source
Client error events on https://docs.sentry.io/platforms/php/ Last 24h 2026-10-14T00:03:07Z to 2026-10-15T00:03:07Z: 0 events. Prior 24h 2026-10-13T00:03:07Z to 2026-10-14T00:03:07Z: 0 events. Rate 0 of 24 page loads, 0%. Hold at 0 events and 0% of docs.page.load on this path. Sentry org sentry project docs. Query environment:production http.url:"https://docs.sentry.io/platforms/php/" with count().
docs.page.not_found for requested_path:platforms/php Last 24h 2026-10-14T00:03:07Z to 2026-10-15T00:03:07Z: 0. Prior 24h 2026-10-13T00:03:07Z to 2026-10-14T00:03:07Z: 1. Band 0-1 per 24h. Hold in 0-1 per 24h. This counter is a fault. If it rises, inspect logs for MDX file not found at runtime. Those logs were 0 in the last 48h. Sentry org sentry project docs. Query sum(value, docs.page.not_found, counter, none) with environment:production requested_path:"platforms/php".
docs.page.load for Laravel quick start path:/platforms/php/guides/laravel/ Last 24h: 78. Prior 24h: 68. Count band 68-78 per 24h. Share of the three paths 54-60%. Hold the count in 68-78 per 24h and the share in 54-60%. Same docs.page.load metric with path:/platforms/php/guides/laravel/.
docs.page.load for Symfony quick start path:/platforms/php/guides/symfony/ Last 24h: 29. Prior 24h: 32. Count band 29-32 per 24h. Share of the three paths 22-26%. Hold the count in 29-32 per 24h and the share in 22-26%. Same docs.page.load metric with path:/platforms/php/guides/symfony/.

Not observable

The live heading text and the removal of onboarding checkboxes are not queryable. Pageload span failure_rate() on this URL was 85-100% at n=13-27 and is not a health signal. Server http.server spans for this path are not present. Pages are static on the CDN.

…ck start guides

Co-Authored-By: Shannon Anahata <shannon.anahata@sentry.io>
@sfanahata sfanahata changed the title feat(docs): Apply new quick start template to PHP quick start guide feat(docs): Apply new quick start template to PHP quick start guides Oct 15, 2026

- 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)

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

Comment on lines +41 to +42
# Send request headers, cookies, and IP address.
SENTRY_SEND_DEFAULT_PII=true

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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:

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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:

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

Comment on lines +47 to +48
# Send request headers, cookies, and IP address.
send_default_pii: true

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We have remove send_default_pii here in favour of data collection, which will collect things by default

This branch was successfully deployed

1 active deployment
Preview – sentry-docs — f2be4e0e Deployed Oct 29, 2026 by vercel[bot]
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Priority: Normal Docs review has no urgent deadline

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant