Testplan for storage node email notification

littleskunk · December 23, 2022, 12:49pm

storj/storj/blob/ad9fbe2953cc191554cacf3e1343440ddd9bb790/docs/testplan/storagenode-email-notification.md

# Storagenode Email Notification Testplan

&nbsp;

## Background
This testplan is going to cover the changes to storagenode email notifications. It will go over the design doc seen here - [Storagenode Email Notification Design Doc](https://review.dev.storj.io/c/storj/storj/+/8353)

&nbsp;

| Test Scenario | Test Case                                                     | Description                                                                                                                                                                                                                                                                                                                                                  | Comments                                                                                                                                      |
|---------------|---------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------|
| Email Alerts  | Node Suspension Error Alert Email                             | If user node experiences too many errors in response to audits then the user should be sent an email alert (following the email shown in the PRD) warning the user that their node was suspended because of too many errors                                                                                                                                  |                                                                                                                                               |
|               | Node Suspension Offline Alert Email                           | If user node goes offline during a set percentage of audits the user should be sent an email alert (following the email shown in the PRD) warning the user that their node was suspended because it was offline                                                                                                                                              |                                                                                                                                               |
|               | Node Disqualified Alert Email                                 | If user node gets disqualified then user should be sent an email detailing the process which their node was disqualified (following the email shown in the PRD), also node can only be disqualified after several consecutive failed audits or with a high audit failure rate                                                                                |                                                                                                                                               |
|               | Node Software Update Alert Email                              | If user node can be upgraded to the most recent storage node software, then the user should receive an email alert (following the email shown in the PRD) detailing this; user should also be able to see options on how to update their storage node software and possible                                                                                  |                                                                                                                                               |
|               | Node Offline Alert Email                                      | If a node goes offline for four hours, then node owner should receive an email alert (following the email shown in the PRD) stating that their node was offline for the past four hours. Alert should also detail user how to check status of their node to take appropriate action & show a link to download and enable more frequent offline notifications |                                                                                                                                               |
|               | Node Online Alert Email                                       | If a node goes back online after being offline and previously given an alert for being offline, then the user should receive an email alert (following the email shown in the PRD) stating that their node went back online                                                                                                                                  |                                                                                                                                               |
|               | Send Alerts from Satellite Service                            | Alerts shoul

This file has been truncated. show original

Anon22 · March 23, 2023, 6:04am

Hi,

I just got to experience the offline E-Mail from Storj Labs hello@storj.io which was extremely helpful thanks for that.

Suggestion:
Concerning failed audits it seems there is only a plan to send a mail for a suspension. Could it be possible to handle this similarily to a online alert Email?

I had a error yesterday that caused files to not be available for the storagenode and this caused failed audits. I only noticed because other files where not available that I needed. In a worst case scenario I would have only noticed once it was already too late.
Once I was aware of the issue I was able to shut down the node and do some repairs and get the disk running again. Due to that the node is now healthy again and passing audits.