View Source Alerting

Note: This page is being updated for OSS release. Please be patient.

  • When error logs are reported via YourGear.Logger.error/1 function, the errors are sent to developers as alerts.
  • It is also possible to send alerts without logging, by calling YourGear.AlertManager.notify/1 function from any part of your gear code.
  • Currently, only email alerting interface is defined as a behaviour AntikytheraEal.AlertMailer.
    • Slack and Twillio are candidates for alternative notification channels to support. Requests and contributions are welcomed.

Alert behavior and configurations

  • To prevent excessive number of alerts from being sent, alert handlers have a built-in buffering mechanism.
  • Occasional errors will be sent in shorter period of buffering (called fast_interval, 1 minute by default).
  • If errors keep occurring beyond fast_interval, they will be buffered for longer period (called delayed_interval, 30 minutes by default) before sent.
  • These intervals are configured per alert methods.
  • Required and optional settings (such as addresses for email alert), along with intervals above, can be configured in :alerts field of gear config.