Update analysis insights table
What does this PR do? What is the motivation?
Updates the table of insights in the docs for the automated analysis feature with all insights currently implemented.
Merge instructions
Merge readiness:
- [ ] Ready for merge
For Datadog employees:
Your branch name MUST follow the <name>/<description> convention and include the forward slash (/). Without this format, your pull request will not pass CI, the GitLab pipeline will not run, and you won't get a branch preview. Getting a branch preview makes it easier for us to check any issues with your PR, such as broken links.
If your branch doesn't follow this format, rename it or create a new branch and PR.
[6/5/2025] Merge queue has been disabled on the documentation repo. If you have write access to the repo, the PR has been reviewed by a Documentation team member, and all of the required checks have passed, you can use the Squash and Merge button to merge the PR. If you don't have write access, or you need help, reach out in the #documentation channel in Slack.
Additional notes
Preview links (active after the build_preview check completes)
Modified Files
- https://docs-staging.datadoghq.com/hdafgard/update-insights-table/profiler/automated_analysis
Thanks so much for this, Henrik! I made some suggestions for readability and consistency. Take a look and feel free to take them or leave them as you see fit.
One thing I was wondering is whether you thought the table might be a little easier to navigate if we sorted them alphabetically by name within each priority group. If you'd like help with that, let me know; I have an extension I can do it with quickly 🙂
That would be super helpful actually, thanks!
@hdafgard - Was there a reason to omit the ratio insights? I'm not entirely sure what they represent but I'm curious
- VM operations ratio
- GC pause ratio
- Explicit GC ratio
Are we omitting these because they're not out yet?
- CPU Bursts
- CPU burst saturation
I noticed these weren't on the list but were in the inventory. Were they too niche or were they reworded?
- Java blocking
- Long GC pauses
- GC options
- Unbalanced parallelism
- DebugNonSafepoints
- Service likely idle
@janine-c - would the table make more sense split by language like we do in other profiler docs?
@hdafgard - Was there a reason to omit the ratio insights? I'm not entirely sure what they represent but I'm curious
- VM operations ratio
- GC pause ratio
- Explicit GC ratio
Are we omitting these because they're not out yet?
- CPU Bursts
- CPU burst saturation
I noticed these weren't on the list but were in the inventory. Were they too niche or were they reworded?
- Java blocking
- Long GC pauses
- GC options
- Unbalanced parallelism
- DebugNonSafepoints
- Service likely idle
@janine-c - would the table make more sense split by language like we do in other profiler docs?
A few of these were already in there but under different names, the rest I've added with the exception of the idle insight since it's a bit trivial. But we can always add that later if we feel the need for it.
@hdafgard @brantigua I just pushed up a change where I alphabetized the insight names and split them into language tabs. No pressure at all to use that approach! It'll take a few minutes to build in the preview, but let me know if that helps :)
Ah, GitHub seems to be having some sort of incident, so this build might take a while.
I updated the branch from master and the build works now. @brantigua I think this looks good, WDYT?