Skip to content
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

Docs on How to Troubleshoot Radius apps #783

Merged
merged 13 commits into from
Sep 26, 2023
12 changes: 11 additions & 1 deletion docs/content/community/contributing/github.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,4 +18,14 @@ The source code for Radius is available on GitHub within the [radius repo](https

Documentation is housed at https://github.com/radius-project/docs.

Samples are location at https://github.com/radius-project/samples.
Samples are located at https://github.com/radius-project/samples.

## Troubleshooting common issues

### Visual Studio not authorized for single sign-on

If you receive an error saying Visual Studio Code or another application is not authorized to clone any of the Radius repositories you may need to re-authorize the GitHub app:

1. Open a browser to https://github.com/settings/applications
1. Find the applicable app and select Revoke
1. Reopen app on local machine and re-auth
Original file line number Diff line number Diff line change
Expand Up @@ -120,7 +120,7 @@ If you have issues with the sample application, where the container doesn't conn
```bash
rad resource logs containers frontend -a s3app
```
Also please make sure to [open an Issue](https://github.com/radius-project/radius/issues/new?assignees=&labels=kind%2Fbug&template=bug.md&title=%3CBUG+TITLE%3E) 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.
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.

## Further Reading

Expand Down
2 changes: 1 addition & 1 deletion docs/content/guides/deploy-apps/howto-delete/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ tags: ["delete"]

## Pre-requisites

A [deployed application]({{< ref deploy-apps >}}) in a Radius environment.
- A [deployed application]({{< ref deploy-apps >}}) in a Radius environment.

## Step 1: Delete the Radius application from the environment

Expand Down
43 changes: 43 additions & 0 deletions docs/content/guides/deploy-apps/howto-troubleshootapps/index.md
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 4: Inspect control-plane logs
Reshrahim marked this conversation as resolved.
Show resolved Hide resolved

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.
93 changes: 0 additions & 93 deletions docs/content/reference/troubleshooting-radius.md

This file was deleted.

Loading