-
Notifications
You must be signed in to change notification settings - Fork 44
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Docs on How to Troubleshoot Radius apps (#783)
* Docs on Troubleshooting Radius apps * Address feedback * Address feedback * fix spelling * Address feedback * Address feedback * Update docs/content/guides/deploy-apps/howto-troubleshootapps/index.md Co-authored-by: Aaron Crawfis <[email protected]> * Fix ref --------- Co-authored-by: Aaron Crawfis <[email protected]>
- Loading branch information
1 parent
36c55ff
commit eef2c69
Showing
7 changed files
with
58 additions
and
98 deletions.
There are no files selected for viewing
This file contains 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
This file contains 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
This file contains 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
This file contains 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
This file contains 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
43 changes: 43 additions & 0 deletions
43
docs/content/guides/deploy-apps/howto-troubleshootapps/index.md
This file contains 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,43 @@ | ||
--- | ||
type: docs | ||
title: "How-To: Troubleshoot applications" | ||
linkTitle: "Troubleshoot apps" | ||
description: "Learn how to troubleshoot issues with the Radius application" | ||
weight: 900 | ||
categories: "How-To" | ||
tags: ["troubleshooting"] | ||
--- | ||
|
||
## Pre-requisites | ||
|
||
- A [deployed application]({{< ref deploy-apps >}}) in a Radius environment. | ||
|
||
## Step 1: Port-forward container to your local machine | ||
|
||
Use the below command to port-forward the container to your local machine. This enables you to access the container from your local machine. | ||
|
||
```bash | ||
rad resource expose containers <container_name> -a <app_name> --port <port_number> | ||
``` | ||
Refer to [`rad resource expose`]({{< ref rad_resource_expose >}}) for more details on the command. | ||
|
||
## Step 2: Inspect container logs | ||
|
||
If your Radius application is unresponsive or does not connect to its dependencies, Use the below command to inspect logs from container: | ||
|
||
```bash | ||
rad resource logs containers frontend -a <app_name> | ||
``` | ||
|
||
> Also refer to the [connections section]({{< ref "guides/author-apps/containers/overview#connections" >}}) to know about the naming convention of the environment variables and inspect if your application uses the right variables. | ||
## Step 3: Inspect control-plane logs | ||
|
||
If you hit errors while deploying the application, look at the control plane logs to see if there are any errors. You can use the following command to view the logs: | ||
|
||
```bash | ||
rad debug-logs | ||
``` | ||
Inspect the UCP and DE logs to see if there are any errors | ||
|
||
>Also make sure to [open an Issue](https://github.com/radius-project/radius/issues/new/choose) if you encounter a generic `Internal server error` message or an error message that is not self-serviceable, so we can address the root error not being forwarded to the user. |
This file was deleted.
Oops, something went wrong.