diff --git a/docs/all.md b/docs/all.md index 0c9aa6af7..5f9be2a30 100644 --- a/docs/all.md +++ b/docs/all.md @@ -60,9 +60,13 @@ - [Data Storage Policies \& Procedures](#data-storage-policies--procedures) - [Potential PII Locations](#potential-pii-locations) - [Data Retention Policy](#data-retention-policy) -- [Debug messages not being sent](#debug-messages-not-being-sent) - - [Getting the file location and tracing what happens](#getting-the-file-location-and-tracing-what-happens) - - [Viewing the csv file](#viewing-the-csv-file) +- [Troubleshooting](#troubleshooting) + - [Debug messages not being sent](#debug-messages-not-being-sent) + - [Getting the file location and tracing what happens](#getting-the-file-location-and-tracing-what-happens) + - [Viewing the csv file](#viewing-the-csv-file) + - [Deployment / app push problems](#deployment--app-push-problems) + - [Routes cannot be mapped to destinations in different spaces](#routes-cannot-be-mapped-to-destinations-in-different-spaces) + - [API request failed](#api-request-failed) # Infrastructure overview @@ -449,7 +453,10 @@ If this is the first time you have used Terraform in this repository, you will f ``` cf push --vars-file deploy-config/sandbox.yml --var NEW_RELIC_LICENSE_KEY=$NEW_RELIC_LICENSE_KEY ``` - + The real `push` command has more var arguments than the single one above. Get their values from a Notify team member. +1. Visit the URL of the app you just deployed + * Admin https://notify-sandbox.app.cloud.gov/ + * API https://notify-api-sandbox.app.cloud.gov/ # Database management @@ -1327,11 +1334,12 @@ Seven (7) days by default. Each service can be set with a custom policy via `Ser Data cleanup is controlled by several tasks in the `nightly_tasks.py` file, kicked off by Celery Beat. +# Troubleshooting -# Debug messages not being sent +## Debug messages not being sent -## Getting the file location and tracing what happens +### Getting the file location and tracing what happens Ask the user to provide the csv file name. Either the csv file they uploaded, or the one that is autogenerated when they do a one-off send and is visible in the UI @@ -1340,7 +1348,7 @@ Starting with the admin logs, search for this file name. When you find it, the In the api logs, search by job_id. Either you will see evidence of the job failing and retrying over and over (in which case search for a stack trace using timestamp), or you will ultimately get to a log line that links the job_id to a message_id. In this case, now search by message_id. You should be able to find the actual result from AWS, either success or failure, with hopefully some helpful info. -## Viewing the csv file +### Viewing the csv file If you need to view the questionable csv file on production, run the following command: @@ -1355,7 +1363,7 @@ locally, just do: poetry run flask command download-csv-file-by-name -f ``` -## Debug steps +### Debug steps 1. Either send a message and capture the csv file name, or get a csv file name from a user 2. Using the log tool at logs.fr.cloud.gov, use filters to limit what you're searching on (cf.app is 'notify-admin-production' for example) and then search with the csv file name in double quotes over the relevant time period (last 5 minutes if you just sent a message, or else whatever time the user sent at) @@ -1363,3 +1371,28 @@ poetry run flask command download-csv-file-by-name -f and have the same values as used above.