Skip to main content
06 / How-to · Server · 6.4

Alerts and notifications

Read and dismiss the panel's alerts, and get them in a chat through a webhook.

Type
How-to guide
Needs
An account in the panel to read alerts · An administrator account to set the webhook up
Version
unreleased
Last verified
Unverified

An alert says that something needs attention. Alerts are in the Alerts panel, which the bell at the top right opens, and at the top of the Dashboard. The panel works them out again every five minutes and right after every event that concerns them: a task that finished, a site that changed, a service that stopped.

What raises an alert​

KindWhenLevel
CertificateA site's certificate renewal failed.error
CertificateA site's certificate expires within 14 days.warning; error under 3 days
TaskA task failed in the last 24 hours: a backup, a restore test, a release, a site creation.error
ServiceA service is stopped or failed.error
ServiceSomething is trying many wrong WordPress connector tokens.error
ConfigurationFiles the panel manages changed outside the panel.warning
ReleaseThe site serves a release other than the one recorded, or a release did not finish its check after promotion.warning

An operator sees only the alerts of its sites; the other roles see them all.

Dismiss an alert​

In the Alerts panel, press Dismiss on the alert. Administrators and operators can do it; the alert goes away for everyone. When the condition changes (a different renewal error, a certificate going from warning to error) or comes back after it cleared, the alert shows again.

An alert clears by itself when its condition ends: a service that starts again, a renewed certificate.

Changes made outside the panel​

When someone edits by hand a file the panel manages (a site's nginx configuration, its PHP pool), the Dashboard shows the Configuration changed outside the panel section, with every file. The panel has overwritten nothing. An administrator chooses, file by file:

  • Restore: the panel writes the file again as it configured it;
  • Keep: the change stays and becomes the expected one.

Get notifications in a chat​

The panel can send alerts to a webhook that takes a text field, such as the incoming webhooks of Slack, Discord or Mattermost.

  1. Create an incoming webhook in your chat and copy its https:// URL.
  2. In the panel open Settings.
  3. In the Notifications section, paste the URL into Webhook.
  4. Press Save.

Every five minutes the panel sends each undismissed alert it has not notified in the last six hours, in the administrators' language, in the form CloudGround ERROR on <site>: <text>. Until you dismiss it, an alert therefore comes back every six hours. A failed send is tried again on the next round.

The URL must be https (an http:// one is refused on save) and point to a public address: when it sends, the panel refuses local and private addresses, this server's own included, and follows no redirect. A send refused that way shows only in the API log (alert webhook failed … not a public address). The URL is a credential: other accounts see it masked, and the panel never writes it to the logs. To stop notifications, empty the field and press Save.

Next step​

Keep the panel current: update CloudGround.

Was this page useful?
Edit this page ↗