Skip to content

[PROF-11898] Tweak Ruby stack truncation config documentation #30552

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.

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

Merged

Conversation

ivoanjo
Copy link
Member

@ivoanjo ivoanjo commented Jul 18, 2025

What does this PR do? What is the motivation?

This PR tweaks the documentation around the "max frames" setting, used to control the stack truncation/limit config setting.

Specifically it:

  • Mentions this configuration in the enabling page, not just the troubleshooting page
  • Mentions that the grouped frames can be under Truncated Frames, as per another PR I'm preparing on the Ruby lib side
  • Uses 600 as an example for raising, as 600 is the current maximum the frontend will show, and hopefully works for even the most complex applications

Merge instructions

Merge readiness:

  • Ready for merge

Additional notes

N/A

**What does this PR do?**

This PR tweaks the documentation around the "max frames" setting,
used to control the stack truncation/limit config setting.

Specifically it:
* Mentions this configuration in the enabling page, not just the
  troubleshooting page
* Mentions that the grouped frames can be under `Truncated Frames`,
  as per another PR I'm preparing on the Ruby lib side
* Uses 600 as an example for raising, as 600 is the current maximum
  the frontend will show, and hopefully works for even the most
  complex applications

**Motivation:**

Improve documentation for this feature.
@ivoanjo ivoanjo requested a review from a team as a code owner July 18, 2025 10:55
Copy link
Contributor

github-actions bot commented Jul 18, 2025

✅ Documentation Team Review

The documentation team has approved this pull request. Thank you for your contribution!

Copy link
Contributor

@michaelcretzman michaelcretzman merged commit 99a2df0 into master Jul 18, 2025
19 of 20 checks passed
@michaelcretzman michaelcretzman deleted the ivoanjo/prof-11898-tweak-ruby-max-frames-doc branch July 18, 2025 19:44
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants