Skip to content

Added new page for automated analysis, as well as screenshots #29406

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

Jump to bottom
Merged
merged 15 commits into from
May 19, 2025
Merged

Added new page for automated analysis, as well as screenshots #29406

merged 15 commits into from
May 19, 2025
+95 −15

Conversation

brantigua
Copy link
Contributor

@brantigua brantigua commented May 16, 2025 •
edited
Loading

What does this PR do? What is the motivation?

This PR is to add documentation for our new feature: Automated Analysis. This includes general explanations, where to find the analysis, as well as a list of current insights.

Merge instructions

Merge readiness:

  • Ready for merge

For Datadog employees:
Merge queue is enabled in this repo. Your branch name MUST follow the <name>/<description> convention and include the forward slash (/). Without this format, your pull request will not pass in 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.

To have your PR automatically merged after it receives the required reviews, add the following PR comment:

/merge

Additional notes

@brantigua brantigua requested a review from a team as a code owner May 16, 2025 21:06
@github-actions github-actions bot added Architecture Everything related to the Doc backend Images Images are added/removed with this PR labels May 16, 2025
@github-actions GitHub Actions
Copy link
Contributor

github-actions bot commented May 16, 2025 •
edited
Loading

Preview links (active after the build_preview check completes)

New or renamed files

Modified Files

@janine-c janine-c added the editorial review Waiting on a more in-depth review label May 16, 2025
@janine-c
Copy link
Contributor

Created DOCS-10940 for editorial review 🙂

@brett0000FF brett0000FF self-assigned this May 16, 2025
brett0000FF
brett0000FF reviewed May 19, 2025
View reviewed changes
Copy link
Contributor

@brett0000FF brett0000FF left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looking good--thanks for the draft! Let me know if you have any questions about my suggestions. Please feel free to disagree with any of them. 🙂

content/en/profiler/automated_analysis.md
@@ -0,0 +1,114 @@
---
title: Automated Analysis
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

High-level question, but what's the reason we call this Automated Analysis instead of Recommendations like we have for APM, CCM, DBM?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I've pushed for that in the past but many of these insights are missing a vital piece to make then a Recommendation which is: always having a clear impact statement.

We can say that the findings here can help with a given issue, but it's hard to definitely tie that to an impact (example: fixing GC issues will reduce CPU load but we can't concretely say by how much due to many other factors). However, when we do have that info, we promote that insight and it will show up in APM recommendations

@brantigua brantigua requested review from a team as code owners May 19, 2025 17:12
@github-actions github-actions bot added the Guide Content impacting a guide label May 19, 2025
@brantigua brantigua force-pushed the bryan.antigua/automated-analysis branch from 52e68f3 to 1ec19bb Compare May 19, 2025 18:12
@github-actions github-actions bot removed the Guide Content impacting a guide label May 19, 2025
brantigua and others added 10 commits May 19, 2025 14:14
@brantigua @brett0000FF
Update content/en/profiler/automated_analysis.md
d83113d 
Co-authored-by: Brett Blue <[email protected]>
@brantigua @brett0000FF
Update content/en/profiler/automated_analysis.md
91a1b8c 
Co-authored-by: Brett Blue <[email protected]>
@brantigua @brett0000FF
Update content/en/profiler/automated_analysis.md
ef0b317 
Co-authored-by: Brett Blue <[email protected]>
@brantigua @brett0000FF
Update content/en/profiler/automated_analysis.md
a0876a4 
Co-authored-by: Brett Blue <[email protected]>
@brantigua @brett0000FF
Update content/en/profiler/automated_analysis.md
322f3c4 
Co-authored-by: Brett Blue <[email protected]>
@brantigua @brett0000FF
Update content/en/profiler/automated_analysis.md
267edf5 
Co-authored-by: Brett Blue <[email protected]>
@brantigua @brett0000FF
Update content/en/profiler/connect_traces_and_profiles.md
e73bdd3 
Co-authored-by: Brett Blue <[email protected]>
@brantigua @brett0000FF
Update content/en/profiler/automated_analysis.md
e7d25fd 
Co-authored-by: Brett Blue <[email protected]>
@brantigua @brett0000FF
Update content/en/profiler/automated_analysis.md
546b7be 
Co-authored-by: Brett Blue <[email protected]>
updated based on teams comments
28a93ff
@brett0000FF brett0000FF removed the request for review from a team May 19, 2025 18:29
brett0000FF
brett0000FF approved these changes May 19, 2025
View reviewed changes
Copy link
Contributor

@brett0000FF brett0000FF left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Note I switched to use a normal markdown table. Happy to revert if you disagree before we merge. Thanks!

@brantigua
Copy link
Contributor Author

/merge

@dd-devflow
Copy link

dd-devflow bot commented May 19, 2025 •
edited
Loading

View all feedbacks in Devflow UI.

2025-05-19 20:49:15 UTC ℹ️ Start processing command /merge

2025-05-19 20:49:24 UTC ℹ️ MergeQueue: waiting for PR to be ready

This merge request is not mergeable yet, because of pending checks/missing approvals. It will be added to the queue as soon as checks pass and/or get approvals.
Note: if you pushed new commits since the last approval, you may need additional approval.
You can remove it from the waiting list with /remove command.

2025-05-19 20:51:16 UTC ℹ️ MergeQueue: merge request added to the queue

The expected merge time in master is approximately 21m (p90).

2025-05-19 21:10:07 UTC ℹ️ MergeQueue: This merge request was merged

@dd-mergequeue dd-mergequeue bot merged commit 9d4652a into master May 19, 2025
20 of 25 checks passed
@dd-mergequeue dd-mergequeue bot deleted the bryan.antigua/automated-analysis branch May 19, 2025 21:10
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@brett0000FF brett0000FF brett0000FF approved these changes

Assignees

@brett0000FF brett0000FF

Labels
Architecture Everything related to the Doc backend editorial review Waiting on a more in-depth review Images Images are added/removed with this PR mergequeue-status: done okr11
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@brantigua @janine-c @brett0000FF