Dashboard Alerts

Guide on setting up dashboard alerts to monitor your app behavior and catch issues early.

What Alerts can I set up?

Alchemy currently offers one type of alert:

Error rate alerts: get alerted when your error rates reach a specified threshold across all your apps. For example, receive an alert if 5% of your requests in the past 10 minutes are errors.

ℹ️

Alerts are currently not available on the free tier.

How to set up alerts

Setting up alerts in the dashboard is easy.

📘

Alerts are created at the team level.

All members of your Alchemy team will have the same alerts configuration and alerts hub page. To manage your own alert settings, you can add and remove yourself as a subscriber to active team alerts.

  1. Visit the configure alerts page in the dashboard

    Untitled
  2. Click “Create new alert”

    Untitled
  3. Set your error alert configurations

    Depending on the type of alert you choose, you can specify the configurations.

    • Trigger: define the specific event type to trigger the alert
    • Threshold and Interval: unique settings to the error rate alert type
    • Alert frequency: how often you want to receive the alert
    • Recipients: who the alert should be sent to (you can edit this at any time)
    Untitled
  4. Save your alert

    Once your alert is saved, you should see it appear in your alerts list.

    Untitled
  5. When your alert gets triggered, you’ll also be able to see it in the notification panel and the Alert Hub!

    Untitled
  6. Dismiss alerts manually or by clicking on the relevant action item.

    Alerts will automatically be dismissed if you click on them directly.

    Manually dismiss alerts by clicking on the X button next to the alert or by clicking “Dismiss All”

    Untitled
  7. Dismissed alerts will be moved into “past alerts”

    Past alerts are available for you to view at any time.

    Untitled
  8. Edit, deactivate, and delete alerts at any time by visiting your Alert configuration page.

How do I unsubscribe myself from an Alert?

You can unsubscribe yourself from an alert by editing the alert and removing your name from the recipient list. Note that deactivating or deleting alerts will do so for your entire team so if you’re just looking to remove yourself, you should edit the alert instead.

Editing Alerts

You can edit any alert by visiting the Alerts Configuration page. Alert edits will apply to the entire team so make sure to communicate with the alert subscribers or create a new alert if you want to keep multiple versions.

Deactivating Alerts

Deactivating alerts will disable them from being sent to all the specified subscribers. If you’d like to remove yourself from receiving the alert you can do so by editing the alert instead of deactivating it for everyone. We recommend deactivating alerts if your team no longer wants to receive them but may want to use them again in the future. You can also edit your alert settings to change the thresholds and frequencies.

Deleting Alerts

Deleting an alert will remove and unsubscribe it for everyone in addition to removing all alert settings. We only recommend deleting alerts if you know you will never want to reactivate them again.

Error Rate Alerts

Error rate alerts are used to monitor errors across all your Alchemy apps. Depending on what your expected error rates are, you can define specific thresholds and time intervals to monitor.

How to set up an error rate alert:

Untitled
  • Error threshold: the % of errors out of your total requests that you want to be alerted for. We recommend setting this high enough so that it’s not noisy, but low enough to catch abnormalities. This range will change depending on your expected error rates but we typically recommend anywhere from 1-5% depending on your error tolerance.
  • Sample interval: the time interval to measure total requests over. A good rule of thumb here is 5-15mins.
  • Alert frequency: how often you want to receive the alert. Depending on what your threshold is set at, you don’t want this to be spammy.
  • Email recipients: define who the alert will be sent to. If there are specific teammates who want to subscribe to these alerts you can add their emails here. Only emails with active alchemy accounts on your team will be able to receive alerts.

How we define “Errors”

To understand how we define error requests, it’s helpful to know what our definition is for successful requests:

  • Success: HTTP == 2xx && JSON-RPC== 0 && error_message == null
  • Failure: !success

For more details and context on error codes, check out Error Reference.

What should I do if I receive an error rate alert?

If you’ve received an error rate alert your apps may be experiencing higher than normal error rates and you may way to investigate the root cause. We recommend viewing your request logs to see if any abnormal requests are driving the increased errors.