Skip to content

Profiling - Refactor java documentation#34317

Open
r1viollet wants to merge 10 commits intomasterfrom
r1viollet/profiling-java-refactor
Open

Profiling - Refactor java documentation#34317
r1viollet wants to merge 10 commits intomasterfrom
r1viollet/profiling-java-refactor

Conversation

@r1viollet
Copy link
Contributor

@r1viollet r1viollet commented Feb 3, 2026

What does this PR do? What is the motivation?

  • Simplify documentation to only include onboarding steps
  • Move internal details to the troubleshooting section
  • Move GraalVM specifics to a dedicated page

Merge instructions

Discussions are ongoing with @anandreshmi46

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

- Simplify documentation to only include onboarding steps
- Move internal details to the troubleshooting section
- Move GraalVM specifics to a dedicated page
@github-actions github-actions bot added the Architecture Everything related to the Doc backend label Feb 3, 2026
@github-actions
Copy link
Contributor

github-actions bot commented Feb 3, 2026

@r1viollet r1viollet marked this pull request as ready for review February 3, 2026 11:06
@r1viollet r1viollet requested review from a team as code owners February 3, 2026 11:06
@r1viollet r1viollet marked this pull request as draft February 3, 2026 11:06
@r1viollet
Copy link
Contributor Author

build-preview is not running for some reason so we do not get a preview

 - Move back requirements from Java Troubleshooting page to enablement page
 - Update the JDK details
@anandreshmi46 anandreshmi46 force-pushed the r1viollet/profiling-java-refactor branch from 9d697c2 to 653aea3 Compare February 4, 2026 17:30

| Engine | Platforms | Description |
|--------|-----------|-------------|
| **Datadog Profiler** | Linux | A native profiler based on async-profiler. Uses the `AsyncGetCallTrace` JVM API and perf events for accurate CPU sampling. Provides the full set of profile types including wallclock profiling for latency analysis. Default since dd-trace-java v1.7.0. |
Copy link
Contributor Author

Choose a reason for hiding this comment

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

This is no longer true... We have VM unwinding in most cases.

</a>
</div>
<div class="col">
<a class="card h-100" href="{{ "profiler/enabling/graalvm" | absLangURL }}">
Copy link
Contributor Author

Choose a reason for hiding this comment

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

we would need some work here to make this look good

 - Add profiling engine configuration to troubleshooting documentation
 - Format all configuration in tables for improved readability
 - Remove OpenJ9 from JFR support
 - Remove redundant and Obsolete data
 - Update Allocation profiler section
@bholemansi24 bholemansi24 marked this pull request as ready for review February 18, 2026 14:45
@git-thuerk-done git-thuerk-done added the editorial review Waiting on a more in-depth review label Feb 18, 2026
@git-thuerk-done
Copy link
Contributor

git-thuerk-done commented Feb 18, 2026

Editorial review: DOCS-13438

@anandreshmi46 anandreshmi46 marked this pull request as draft February 18, 2026 19:30
 - Update troubleshooting section
 - Update params.yaml
- Remove ddprof mention
@anandreshmi46 anandreshmi46 marked this pull request as ready for review February 20, 2026 15:34
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Architecture Everything related to the Doc backend editorial review Waiting on a more in-depth review

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants

Comments