Deploys · Guides
Name each release in Errors
Optional. With an app's Errors key set, each good deploy tells Errors which release is live in its environment, so issues say which release brought them.
What it does
After a deploy succeeds, Deploys tells Errors that its release is live in the deploy's environment, as php artisan mybeast:errors-release does from the Errors SDK for Laravel. Errors then says which release each issue came in, and its “it's fixed” notices go out once the fix is live.
A rollback, a failed deploy and a stopped one tell Errors nothing: going back is not a fix.
Give the app its Errors key
- In Errors, open the project's Settings and make a key of the kind Server secret under Errors keys. Copy it: it's shown once.
- In Deploys, open the app's Settings, paste it under Errors and choose Keep the key.
Each app takes its own, so apps of one project can report to Errors or not. Deploys keeps the key encrypted and never shows it again, only its first part beside On. Setting it is for the project's admins. The setup guide in Deploys says which apps have none.
The release name
Errors hears the deploy's release, found as The line that names the release says: --release, else the app's pattern in the log, else the commit's first 12 characters.
It helps only when your app reports the same name to Errors. The Errors SDK for Laravel reads MYBEAST_ERRORS_RELEASE, else the first 12 characters of the commit in the app's .git. So either deploy with the .git folder and leave the release line empty, or have your deploy script write the same name into MYBEAST_ERRORS_RELEASE.
See that it worked
The deploy's page has an Errors row once the app has a key, with a note beside it:
| Errors | Meaning |
|---|---|
| Waiting | Queued, or being tried again while Errors is down or busy. |
| Marked | Errors knows the release is live in the environment, and says how many people it will tell an issue is fixed. |
| Not marked | Errors refused, or the tries ran out. The note says why, such as a key Errors no longer takes. |
| Skipped | The deploy had no release name: the log did not show one, and there was no commit. |
While Errors is down or busy, Deploys asks again after 10 seconds, 1 minute, 5 minutes and 15 minutes. It never asks again after a refusal: when Errors refuses the key, set it again.
Stop it
Remove, beside the key in the app's settings, stops naming its releases in Errors. The deploys already named stay as they are in Errors.