Skip to content

docs(agent): add agent observability section #18371

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
Litarnus wants to merge 1 commit into
base: master
Choose a base branch
from
+10 −0
Open

docs(agent): add agent observability section #18371

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 10 additions & 0 deletions docs/platforms/php/agent/index.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -119,3 +119,13 @@ The default builder-created client includes fallback delivery. If the local
agent handoff fails, the client sends the envelope directly to Sentry using the
normal SDK HTTP client. This preserves delivery, but the request loses the
latency benefit while the agent is unavailable.

## Observability

To monitor events sent through the agent, add a dashboard widget in Sentry.
Click "Add Widget" on a dashboard, then select the "Errors" dataset. Choose a
time-series visualization, set the Y-Axis to `count()`, and add
`sentry.php.agent` to Group by.

The chart shows error counts grouped by the `sentry.php.agent` tag, so you can
see how many events were handled by the agent.
Comment on lines +125 to +131

@sentry sentry Bot Jun 11, 2026

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.

Bug: The documentation for monitoring PHP agent events is misleading, as it suggests using the "Errors" dataset which omits non-error events like transactions handled by the agent.
Severity: LOW

Suggested Fix

Update the documentation to clarify that the suggested dashboard widget only monitors error events. Alternatively, provide instructions for monitoring all event types handled by the agent, possibly by using a different dataset or multiple widgets, to give a complete view of the agent's activity.

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: docs/platforms/php/agent/index.mdx#L125-L131

Potential issue: The documentation instructs users to monitor events handled by the PHP
agent by creating a dashboard widget that queries the "Errors" dataset. This is
misleading because the PHP agent processes various types of events, including errors,
transactions, and profiles, not just errors. The "Errors" dataset likely only contains
error-type events. Consequently, the suggested chart will only show a subset of the
events handled by the agent, potentially leading users to underestimate the agent's
activity, especially if they have performance monitoring (transactions) enabled.

Did we get this right? 👍 / 👎 to inform future reviews.

Loading