docs: add oom/ood to notifications (#16582)

- [x] add section or to another section: where the notifications show
up/how to access

previews:
- [Notifications - Configure OOM/OOD
notifications](https://coder.com/docs/@16581-oom-ood-notif/admin/monitoring/notifications#configure-oomood-notifications)
- [Resource
monitoring](https://coder.com/docs/@16581-oom-ood-notif/admin/templates/extending-templates/resource-monitoring)

---------

Co-authored-by: EdwardAngert <17991901+EdwardAngert@users.noreply.github.com>
This commit is contained in:
Edward Angert
2025-03-05 03:43:08 -06:00
committed by GitHub
parent edf28895c7
commit 9251e0d642
3 changed files with 67 additions and 3 deletions

View File

@ -29,14 +29,14 @@ These notifications are sent to the workspace owner:
### User Events
These notifications sent to users with **owner** and **user admin** roles:
These notifications are sent to users with **owner** and **user admin** roles:
- User account created
- User account deleted
- User account suspended
- User account activated
These notifications sent to users themselves:
These notifications are sent to users themselves:
- User account suspended
- User account activated
@ -48,6 +48,8 @@ These notifications are sent to users with **template admin** roles:
- Template deleted
- Template deprecated
- Out of memory (OOM) / Out of disk (OOD)
- [Configure](#configure-oomood-notifications) in the template `main.tf`.
- Report: Workspace builds failed for template
- This notification is delivered as part of a weekly cron job and summarizes
the failed builds for a given template.
@ -63,6 +65,16 @@ flags.
| ✔️ | `--notifications-method` | `CODER_NOTIFICATIONS_METHOD` | `string` | Which delivery method to use (available options: 'smtp', 'webhook'). See [Delivery Methods](#delivery-methods) below. | smtp |
| - | `--notifications-max-send-attempts` | `CODER_NOTIFICATIONS_MAX_SEND_ATTEMPTS` | `int` | The upper limit of attempts to send a notification. | 5 |
### Configure OOM/OOD notifications
You can monitor out of memory (OOM) and out of disk (OOD) errors and alert users
when they overutilize memory and disk.
This can help prevent agent disconnects due to OOM/OOD issues.
To enable OOM/OOD notifications on a template, follow the steps in the
[resource monitoring guide](../../templates/extending-templates/resource-monitoring.md).
## Delivery Methods
Notifications can currently be delivered by either SMTP or webhook. Each message
@ -135,7 +147,7 @@ for more options.
After setting the required fields above:
1. Setup an account on Microsoft 365 or outlook.com
1. Set up an account on Microsoft 365 or outlook.com
1. Set the following configuration options:
```text