Skip to content

Improve Application Memory Documentation#3739

Open
benjaminach wants to merge 18 commits into
masterfrom
feat/oom-crash
Open

Improve Application Memory Documentation#3739
benjaminach wants to merge 18 commits into
masterfrom
feat/oom-crash

Conversation

@benjaminach
Copy link
Copy Markdown
Contributor

@benjaminach benjaminach commented May 5, 2026

This PR improves the documentation around application memory usage on Scalingo.

It clarifies how memory, swap, container sizes, metrics, and runtime crashes relate to each other, and moves the OOM crash explanation to the Runtime Issues page where it better fits troubleshooting workflows.

It also adds language-specific memory management pointers for Go, Java, Node.js, PHP, Python, and Ruby, so users can find the main runtime settings that influence memory usage.

Changes

  • Add memory management guidance to supported language introduction pages.
  • Move OOM crash details from Application Metrics to Runtime Issues.
  • Clarify memory and swap interpretation in Application Metrics.
  • Refresh the Container Sizes page with a cleaner table and explicit container limits.
  • Update related links and references around alerts, metrics, and container sizes.

@benjaminach benjaminach requested review from Frzk and leo-scalingo May 5, 2026 16:38
@benjaminach benjaminach changed the title Document OOM Crashes Improve Application Memory Documentation May 11, 2026
@benjaminach benjaminach marked this pull request as ready for review May 11, 2026 21:20
Copy link
Copy Markdown
Member

@leo-scalingo leo-scalingo left a comment

Choose a reason for hiding this comment

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

Small changes

Comment thread src/_posts/platform/app/troubleshooting/2000-01-01-runtime-issues.md Outdated
Comment thread src/_posts/platform/app/troubleshooting/2000-01-01-runtime-issues.md Outdated
Co-authored-by: Léo Unbekandt <159253935+leo-scalingo@users.noreply.github.com>
@benjaminach benjaminach requested a review from leo-scalingo May 12, 2026 07:49
Copy link
Copy Markdown
Member

@leo-scalingo leo-scalingo left a comment

Choose a reason for hiding this comment

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

LGTM

Comment thread src/_posts/languages/php/2000-01-01-start.md Outdated
Comment thread src/_posts/languages/php/2000-01-01-start.md Outdated
Comment thread src/_posts/languages/python/2000-01-01-start.md Outdated
Comment thread src/_posts/languages/python/2000-01-01-start.md Outdated
Comment thread src/_posts/languages/ruby/2000-01-01-start.md Outdated
Comment thread src/_posts/platform/app/2000-01-01-metrics.md
@benjaminach benjaminach marked this pull request as draft May 12, 2026 14:21
Copy link
Copy Markdown
Contributor

@Frzk Frzk left a comment

Choose a reason for hiding this comment

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

non-blocking: While I understand the need for a "Memory Management" section in each language section, I feel like there's also some duplicated content. I think these should be revised and completed when we'll rework the languages pages.

non-blocking: The OOM error description is quite developed compared to the others. IMHO, this creates a gap and a lack of homogeneity that should ideally be filled (in a way or another) at some point.

praise: Thanks for moving the "OOM Crash" section to a more appropriate one 👍

praise: Thanks for caring about the little things (spelling, etc).

Comment thread src/_posts/platform/app/scaling/2000-01-01-scaling.md
Comment thread src/_posts/languages/java/2000-01-01-start.md Outdated
Comment thread src/_posts/languages/java/2000-01-01-start.md Outdated
Comment thread src/_posts/languages/java/2000-01-01-start.md
Comment thread src/_posts/languages/nodejs/2000-01-01-start.md Outdated
@benjaminach benjaminach marked this pull request as ready for review May 18, 2026 14:57
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.

4 participants