-
Notifications
You must be signed in to change notification settings - Fork 80
feat(docs): add troubleshooting guide for common application issues #3485
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
Open
sc-zenokerr
wants to merge
1
commit into
master
Choose a base branch
from
fix/3100/troubleshooting-page
base: master
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,42 @@ | ||
| --- | ||
| title: Troubleshooting Your Application | ||
| modified_at: 2025-12-31 00:00:00 | ||
| tags: troubleshooting errors crash deployment | ||
| index: 15 | ||
| --- | ||
|
|
||
| This page provides a summary of common issues you might encounter while deploying or running your application on Scalingo, along with links to more detailed guides. | ||
|
|
||
| ## Deployment Issues | ||
|
|
||
| Deployment issues usually happen during the build phase, before your application is even started. | ||
|
|
||
| * **Unknown Technology**: Occurs when Scalingo cannot detect the programming language or framework of your application. | ||
| * **Image Too Large**: Your application image exceeds the 1.5 GiB limit. | ||
| * **Archive Too Large**: The source code archive (uncompressed) exceeds the 300 MB limit. | ||
|
|
||
| For more details on how to fix these, see our [Common Deployment Errors]({% post_url platform/getting-started/2000-01-01-common-deployment-errors %}) page. | ||
|
|
||
| ## Boot and Startup Errors | ||
|
|
||
| These errors occur when the platform tries to start your application's containers. | ||
|
|
||
| * **Start Errors**: Generic errors during the startup process, often due to misconfiguration. | ||
| * **Timeout Errors**: Your application failed to bind to the assigned `PORT` within 60 seconds. | ||
| * **Hook Errors**: Failure of a `postdeploy` hook script. | ||
|
|
||
| Detailed information and fixes can be found in the [Application Crash]({% post_url platform/app/2000-01-01-crash %}#understanding-boot-errors) documentation. | ||
|
|
||
| ## Runtime Issues | ||
|
|
||
| Runtime issues happen while your application is already running. | ||
|
|
||
| * **Application Crashes**: Unexpected termination of your application process. | ||
| * **5xx Errors**: Server-side errors that might be related to application crashes or timeouts. | ||
|
|
||
| Learn how to diagnose and recover from these in the [Application Crash]({% post_url platform/app/2000-01-01-crash %}#understanding-runtime-errors) section. | ||
|
|
||
| ## Other Common Problems | ||
|
|
||
| * **SSH Connectivity**: Issues when trying to access your containers via SSH or pushing code. See [Troubleshooting SSH]({% post_url platform/getting-started/2000-01-01-troubleshooting-ssh %}). | ||
| * **Custom Error Pages**: If you want to customize the 502, 503, or 504 error pages displayed to your users, refer to [Custom Error and Maintenance Pages]({% post_url platform/app/2000-01-01-custom-error-page %}). |
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I'm a bit puzzled with this PR because we already have this page: https://doc.scalingo.com/platform/app/crash and they seem to overlap a lot.
Maybe we should rather edit the existing one with missing information (if any)?
Maybe we should rename the existing one for it to be more discoverable?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think this new page is quite useful. It is common troubleshooting with links to other appropriate places. The motivation for the PR is provided in the issue, which is to help our customers find the information and reduce the load on support. @mickael-plassard @CalianasJ WDYT?