Skip to content

feat: document support for blackfire in paas native - #2468

Open
Shadrack Nicholas (shadracnicholas) wants to merge 3 commits into
mainfrom
docs-support-blackfire
Open

feat: document support for blackfire in paas native#2468
Shadrack Nicholas (shadracnicholas) wants to merge 3 commits into
mainfrom
docs-support-blackfire

Conversation

@shadracnicholas

Copy link
Copy Markdown
Member

Summary

Documents the Blackfire integration for Shopware PaaS Native.

  • Adds products/paas/shopware/monitoring/blackfire.md covering the full setup.
  • Updates monitoring/index.md, which previously stated that Blackfire is not supported.
  • Adds a services.blackfire reference section to fundamentals/application-yaml.md.

Related links

Checklist

  • I reviewed affected links, code samples, and cross-references, including PageRef references where relevant.
  • I added or updated redirects in .gitbook.yaml if pages were moved, renamed, or deleted.
  • I updated .wordlist.txt (and sorted it) if spellcheck flags new legitimate terms.
  • Any required dependent changes in downstream modules have already been merged and published.
  • This pull request is ready for review.

Notes

Four points are called out deliberately in the new page because they are easy to get wrong:

  • Server ID / Server Token are the agent credentials and belong in the vault. Client ID / Client Token are personal and belong in the browser extension. Mixing them up produces a confusing failure.
  • Both secrets must exist before enabling the service. A missing one fails the whole deployment, not just profiling.
  • Blackfire and OpenTelemetry tracing are mutually exclusive, so Tempo stays empty in Grafana while Blackfire is enabled.
  • The page also notes that CDN cached pages cannot be profiled, since a cached response never reaches PHP.

Copilot AI lite review requested due to automatic review settings August 21, 2026 09:51
@shopware-dev-docs-connector

shopware-dev-docs-connector Bot commented Aug 21, 2026

Copy link
Copy Markdown

Developer Docs healthcheck

Status: Completed with success.
Repository: shopware/docs
Commit: 0dd3e1d
Preview: https://developer-documentation-7kpjmlorh-shopware-frontends.vercel.app
Workflow run: #5012

@github-actions

Copy link
Copy Markdown
Contributor

📢 Developer Announcement Recommendation

Recommendation: ❌ No Announcement Recommended

No developer announcement signals were detected.

This PR does not appear to introduce developer-facing changes that require a community announcement.

Copilot AI left a comment

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.

Pull request overview

This PR updates the Shopware PaaS Native documentation to reflect and explain support for Blackfire profiling, adding a dedicated setup guide and updating related reference/index pages.

Changes:

  • Adds a new Blackfire profiling setup page for Shopware PaaS Native.
  • Updates the Monitoring overview to state that Blackfire is supported and links to the new page.
  • Extends the application.yaml reference with a services.blackfire section.

Reviewed changes

Copilot reviewed 3 out of 3 changed files in this pull request and generated 1 comment.

File Description
products/paas/shopware/monitoring/index.md Updates Monitoring overview messaging to reflect Blackfire support and links to the new page.
products/paas/shopware/monitoring/blackfire.md New documentation page describing Blackfire setup, required secrets, enablement, and usage constraints.
products/paas/shopware/fundamentals/application-yaml.md Adds reference documentation for services.blackfire configuration and links to the setup guide.

💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.

Comment thread products/paas/shopware/monitoring/blackfire.md Outdated
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants