Skip to content

Commit

Permalink
docs(README): added Debugging section
Browse files Browse the repository at this point in the history
  • Loading branch information
chapati23 committed Jul 24, 2024
1 parent b22eb3c commit 04ccd00
Showing 1 changed file with 11 additions and 0 deletions.
11 changes: 11 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,8 @@ A monorepo for our governance watchdog, a system that monitors Mento Governance
- [Google Cloud Permission Requirements](#google-cloud-permission-requirements)
- [Deployment from scratch](#deployment-from-scratch)
- [Migrate Terraform State to Google Cloud](#migrate-terraform-state-to-google-cloud)
- [Debugging Problems](#debugging-problems)
- [View Logs](#view-logs)
- [Teardown](#teardown)

## Requirements for local development
Expand Down Expand Up @@ -315,6 +317,15 @@ For all team members to be able to manage the Google Cloud infrastructure, you n
rm terraform.tfstate.backup
```
## Debugging Problems
### View Logs
For most problems, you'll likely want to check the cloud function logs first.
- `npm run logs` will print the latest 50 log entries into your local terminal for quick and easy access
- `npm run logs:url` will print the URL to the function logs in the Google Cloud Console for full access
## Teardown
Before destroying the project, you'll need to migrate the terraform state from the cloud bucket backend onto your local machine.
Expand Down

0 comments on commit 04ccd00

Please sign in to comment.