DBM Getting Started: update guide for orders app example - #37074
Conversation
Replace pgbench/sysbench references with the new Go orders app: - Describe 3-container setup (db, agent, orders app) with signals table - Add MySQL support (make mysql) and DD_SITE note for non-US1 users - Call out the orders.status full-table-scan as the built-in slow query - Change explain plan step from Index Scan to Seq Scan with fix shown - Add APM ↔ DBM correlation section - Note mysql.queries metric for MySQL dashboard users Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
Preview links (active after the
|
|
added DOCS-14556 to track review |
jeff-morgan-dd
left a comment
jeff-morgan-dd
left a comment
There was a problem hiding this comment.
Hi Sangeeta, thanks for this one! Please see notes inline.
| 4. Find a query in the table with data in the {{< ui >}}Explain Plan{{< /ui >}} column and click on it to open the Sample Details page. | ||
|
|
||
| 5. Under {{< ui >}}Explain Plan{{< /ui >}}, click {{< ui >}}List View{{< /ui >}}. This Explain Plan at the bottom of the Explain Plan Sample page shows that the query requires an {{< ui >}}Index Scan{{< /ui >}}. | ||
| 5. Under {{< ui >}}Explain Plan{{< /ui >}}, click {{< ui >}}List View{{< /ui >}}. This Explain Plan at the bottom of the Explain Plan Sample page shows that the query performs a **Seq Scan** on the `orders` table. Because there is no index on the `status` column, PostgreSQL reads every row in the table to find matches. |
There was a problem hiding this comment.
This new content seems to be getting very in the weeds on how to resolve a specific type of slow query, and seems a bit out of place on a Getting Started page. Can you reframe to be more general about what the Explain Plan list view shows? And maybe we can have a separate, more detailed troubleshooting page for different types of slow queries that might show up here?
There was a problem hiding this comment.
The Correlate traces section below is a good example of how specific we should probably get on a Getting Started page.
There was a problem hiding this comment.
Reframed this to be very general
Co-authored-by: jeff-morgan-dd <jeff.morgan@datadoghq.com>
Co-authored-by: jeff-morgan-dd <jeff.morgan@datadoghq.com>
Co-authored-by: jeff-morgan-dd <jeff.morgan@datadoghq.com>
Remove specific Seq Scan diagnosis, cause explanation, and SQL fix recipe. Replace with a general description of what the list view shows, consistent with the level of detail in other Getting Started sections. Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
jeff-morgan-dd
left a comment
jeff-morgan-dd
left a comment
There was a problem hiding this comment.
Thanks Sangeeta, looks good! Appoved, i'm just committing 2 small fixes around emdashes.
Co-authored-by: jeff-morgan-dd <jeff.morgan@datadoghq.com>
|
/merge |
|
View all feedbacks in Devflow UI.
This pull request is not mergeable according to GitHub. Common reasons include pending required checks, missing approvals, or merge conflicts — but it could also be blocked by other repository rules or settings.
sangeeta.shivajirao@datadoghq.com unqueued this merge request |
|
/merge -c |
|
View all feedbacks in Devflow UI.
|
gh-worker-dd-devflow-36fce6
Bot
added
mergequeue-status: removed
and removed
mergequeue-status: waiting
labels
3 participants
Summary
Updates the Getting Started with Database Monitoring guide to reflect the new Go orders app in dd-database-monitoring-example.
orders.statushas no index), lock contention, and APM↔DBM correlationmake mysql) and aDD_SITEnote for non-US1 usersCREATE INDEX idx_orders_status ON orders(status))mysql.queriesas the MySQL equivalent metric in the dashboard widget sectionScreenshots needed
The following images need to be replaced/added before this PR merges:
dbm_qm_sort_time.pngdbm_qs_explain_plan_duration.pngdbm_qs_explain_plan_list_view.pngdbm_apm_correlation.pngTest plan
[7]APM Traces reference link resolves correctly🤖 Generated with Claude Code