Update compare profiles documentation #31452

c-moller · 2025-09-04T12:25:50Z

What does this PR do? What is the motivation?

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

github-actions · 2025-09-04T12:31:13Z

Preview links (active after the `build_preview` check completes)

Modified Files

https://docs-staging.datadoghq.com/carys.moller/profiling-compare/profiler/compare_profiles

brett0000FF

Thanks a bunch for making these updates! Really appreciate it. I just left a couple of suggestions for you. Main ones are:

Adding a link to the Comparison view (note we have to put the link at the bottom of the page as well).
Un-deleting the old images and videos (temporarily).

brett0000FF · 2025-09-05T20:17:19Z

content/en/profiler/compare_profiles.md


 ### Comparing recent versions

-On the Aggregation view, select a service to see its aggregated profile for a particular metric (for example, wall time) over the selected time frame. Then click **Compare** to compare it to the aggregated profile of another version. 
+On the Explorer view, select a service to see its aggregated profile for a particular metric (for example, wall time) over the selected time frame. Then click **Compare To** to compare it to the aggregated profile of another version.


Suggested change

On the Explorer view, select a service to see its aggregated profile for a particular metric (for example, wall time) over the selected time frame. Then click **Compare To** to compare it to the aggregated profile of another version.

On the **Explorer** view, select a service to see its aggregated profile for a particular metric (for example, wall time) over the selected time frame. Then click **Compare To** to compare it to the aggregated profile of another version.

brett0000FF · 2025-09-05T20:31:40Z

content/en/profiler/compare_profiles.md


-On the Profiler Search view, select a profile from the list. Click **Compare** to open the comparison view. By default, the selected profile is shown as Profile B. For Profile A, select an aggregation time frame and tags, or a specific profile ID. 
+Go to **APM -> Profiles -> Comparison** and select a service to view its profiles over 2 distinct time periods.


Suggested change

Go to **APM -> Profiles -> Comparison** and select a service to view its profiles over 2 distinct time periods.

Go to **[APM > Profiles > Comparison][1]** and select a service to view its profiles over two distinct time periods.

Then we need to add [1]: https://app.datadoghq.com/profiling/comparison at the very bottom of the page for this link.

brett0000FF · 2025-09-05T20:34:39Z

content/en/profiler/compare_profiles.md


-{{< img src="profiler/compare_time_frames.mp4" alt="Opening the comparison view to compare a profile with an aggregation for a time frame." video="true">}}
+Select the metric you want to compare (the list varies based on code language). This can be helpful, for example, for looking at allocation spikes while investigating CPU profiles.


Suggested change

Select the metric you want to compare (the list varies based on code language). This can be helpful, for example, for looking at allocation spikes while investigating CPU profiles.

Select the metric you want to compare (the list of available metrics depends on the programming language). This allows you to correlate different performance issues, for example, by checking for memory allocation spikes while investigating a CPU profile.

brett0000FF · 2025-09-05T20:39:30Z

content/en/profiler/compare_profiles.md

+From the single profile views, click **⇄ Compare** to open the comparison view.
+
+By default, the selected profile is shown as Profile B. For Profile A, select an aggregation time frame and tags, or a specific profile ID.
+
+Select the metric you want to compare (the list varies based on code language). This can be helpful, for example, for looking at allocation spikes while investigating CPU profiles.


Existing content is great as is, but it's a bit easier for users to follow when we put it in a numbered list like this:

Suggested change

From the single profile views, click **⇄ Compare** to open the comparison view.

By default, the selected profile is shown as Profile B. For Profile A, select an aggregation time frame and tags, or a specific profile ID.

Select the metric you want to compare (the list varies based on code language). This can be helpful, for example, for looking at allocation spikes while investigating CPU profiles.

To compare a profile you are viewing against a different time period or a specific profile:

1. From any single profile view, click **⇄ Compare** to open the comparison view.

2. The comparison view opens with your selected profile set as Profile B (the comparison target).

3. For Profile A (the baseline), select an aggregation time frame and tags, or provide a specific profile ID.

4. Select the metric you want to compare (the list of available metrics depends on the programming language). This is useful for correlating performance, for example, by checking for allocation spikes while investigating a CPU profile.

brett0000FF · 2025-09-05T20:41:04Z

static/images/profiler/compare_hover.png

Could you please un-delete all of the image and video files? We have to leave them temporarily; otherwise, the untranslated non-English docs will have the link break until they are translated. (You did update the image references for these which is great, but they will get overwritten until they are applied through our translation service).

Co-authored-by: Brett Blue <[email protected]>

brett0000FF

Looks great thank you!

github-actions bot added the Images Images are added/removed with this PR label Sep 4, 2025

c-moller force-pushed the carys.moller/profiling-compare branch 2 times, most recently from a13a634 to 32d9777 Compare September 4, 2025 14:49

c-moller marked this pull request as ready for review September 5, 2025 08:21

c-moller requested a review from a team as a code owner September 5, 2025 08:21

brett0000FF self-assigned this Sep 5, 2025

brett0000FF added the editorial review Waiting on a more in-depth review label Sep 5, 2025

brett0000FF requested changes Sep 5, 2025

View reviewed changes

c-moller and others added 4 commits September 8, 2025 09:56

feat: update compare profiles documentation

e3f2dcd

feat: update videos and text for compare profile

83bfe00

chore: rename video files

fd1f9a7

chore: revert deleted media and update text

3af67b3

Co-authored-by: Brett Blue <[email protected]>

c-moller force-pushed the carys.moller/profiling-compare branch from 6de7f67 to 3af67b3 Compare September 8, 2025 07:56

c-moller requested a review from brett0000FF September 8, 2025 07:57

brett0000FF approved these changes Sep 8, 2025

View reviewed changes

brett0000FF merged commit e2646c8 into master Sep 8, 2025
20 of 22 checks passed

brett0000FF deleted the carys.moller/profiling-compare branch September 8, 2025 15:34

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Update compare profiles documentation #31452

Update compare profiles documentation #31452

Uh oh!

c-moller commented Sep 4, 2025 •

edited

Loading

Uh oh!

github-actions bot commented Sep 4, 2025

Uh oh!

brett0000FF left a comment

Uh oh!

brett0000FF Sep 5, 2025

Uh oh!

brett0000FF Sep 5, 2025

Uh oh!

brett0000FF Sep 5, 2025

Uh oh!

brett0000FF Sep 5, 2025

Uh oh!

brett0000FF Sep 5, 2025

Uh oh!

brett0000FF left a comment

Uh oh!

Uh oh!

Uh oh!

	On the Explorer view, select a service to see its aggregated profile for a particular metric (for example, wall time) over the selected time frame. Then click Compare To to compare it to the aggregated profile of another version.
	On the Explorer view, select a service to see its aggregated profile for a particular metric (for example, wall time) over the selected time frame. Then click Compare To to compare it to the aggregated profile of another version.


		On the Profiler Search view, select a profile from the list. Click Compare to open the comparison view. By default, the selected profile is shown as Profile B. For Profile A, select an aggregation time frame and tags, or a specific profile ID.
		Go to APM -> Profiles -> Comparison and select a service to view its profiles over 2 distinct time periods.

	Go to APM -> Profiles -> Comparison and select a service to view its profiles over 2 distinct time periods.
	Go to [APM > Profiles > Comparison][1] and select a service to view its profiles over two distinct time periods.


		{{< img src="profiler/compare_time_frames.mp4" alt="Opening the comparison view to compare a profile with an aggregation for a time frame." video="true">}}
		Select the metric you want to compare (the list varies based on code language). This can be helpful, for example, for looking at allocation spikes while investigating CPU profiles.

-From the single profile views, click **⇄ Compare** to open the comparison view.
-By default, the selected profile is shown as Profile B. For Profile A, select an aggregation time frame and tags, or a specific profile ID.
-Select the metric you want to compare (the list varies based on code language). This can be helpful, for example, for looking at allocation spikes while investigating CPU profiles.
+To compare a profile you are viewing against a different time period or a specific profile:
+. From any single profile view, click **⇄ Compare** to open the comparison view.
+. The comparison view opens with your selected profile set as Profile B (the comparison target).
+. For Profile A (the baseline), select an aggregation time frame and tags, or provide a specific profile ID.
+. Select the metric you want to compare (the list of available metrics depends on the programming language). This is useful for correlating performance, for example, by checking for allocation spikes while investigating a CPU profile.

Update compare profiles documentation #31452

Update compare profiles documentation #31452

Uh oh!

Conversation

c-moller commented Sep 4, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

What does this PR do? What is the motivation?

Merge instructions

Additional notes

Uh oh!

github-actions bot commented Sep 4, 2025

Preview links (active after the build_preview check completes)

Modified Files

Uh oh!

brett0000FF left a comment

Choose a reason for hiding this comment

Uh oh!

brett0000FF Sep 5, 2025

Choose a reason for hiding this comment

Uh oh!

brett0000FF Sep 5, 2025

Choose a reason for hiding this comment

Uh oh!

brett0000FF Sep 5, 2025

Choose a reason for hiding this comment

Uh oh!

brett0000FF Sep 5, 2025

Choose a reason for hiding this comment

Uh oh!

brett0000FF Sep 5, 2025

Choose a reason for hiding this comment

Uh oh!

brett0000FF left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

c-moller commented Sep 4, 2025 •

edited

Loading

Preview links (active after the `build_preview` check completes)