docs(agent): add agent observability section#18371
Conversation
|
The latest updates on your projects. Learn more about Vercel for GitHub.
1 Skipped Deployment
|
![sentry[bot]](https://avatars.githubusercontent.com/in/12637?s=60&v=4){kind=small}
| 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. |
There was a problem hiding this comment.
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.
coolguyzone
left a comment
coolguyzone
left a comment
There was a problem hiding this comment.
Looks good to me! Pls address the sentrybot comment before merge.
2 participants
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