Alerts and Notifications

Notifications make the RI Platform much more useful for data scientists. Below, you may learn the different kinds of supported notifications and how you can easily set them up.

Types of Notifications

All the following types of notifications are configured at the Project level. You can opt into any subset.

Job Action Notifications

• Triggered during key status changes in the life cycle of a testing job, such as completion or failure.

• Useful for long-running jobs with large datasets / complex models.

Daily Digest Notifications

• Include a summary of all Stress Test runs for the day.

• Will NOT be sent if there are no Stress Tests for the day.

• Sent out every day at 8am in the timezone configured by the default workspace (initialized to UTC).

Configuring Notifications

How to Configure Email Notifications

• Email notifications depend on the RIME instance having a properly configured SMTP server.

• Email addresses can be added by clicking on the alerts icon for a particular project in the web app or calling a method in the SDK.

  project = rime_client.get_project("<your_project_id_here")
  # Strings for the type of the notification to sign up for are:
  # ["Job_Action", "Monitoring", "Daily_Digest"]
  project.add_email("<your_email_here>", "Monitoring")
  

• Currently, Gmail and Outlook are the only officially supported email clients.

• Email notifications are supported for Enterprise customers and Cloud Trial customers.

  • Enterprise customers will need to configure SMTP with their own server. SMTP settings live under workspace settings.

  • Cloud Trial customers will receive emails from “dev@robustintelligence.com”. Add this email address to your safe senders list to prevent it from going to spam.

• Emails can be removed from a project in the web app or the SDK.

  project = rime_client.get_project("<your_project_id_here")
  project.remove_email("<your_email_here>")
  

How to Configure Webhooks

• Arbitrary webhook URLs may be added by clicking the alerts icon for a particular project on the web app or by calling a method in the SDK.

  project = rime_client.get_project("<your_project_id_here")
  # Strings for the type of the notification to sign up for are:
  # ["Job_Action", "Monitoring", "Daily_Digest"]
  project.add_webhook("<your_webhook_url_here", "Job_Action")
  

• Webhook URLs should be preauthenticated (i.e. include a security token as a URL parameter). After you create a webhook from another application to copy-paste into the RI Platform, ensure that you do not share that webhook publicly.

• Webhooks can be removed from a project in the web app or the SDK.

  project = rime_client.get_project("<your_project_id_here")
  project.remove_webhook("<your_webhook_url_here")
  

How to Configure Slack Notifications

• Incoming webhooks are the preferred way to integrate Slack and the RI Platform.

• Create an Incoming Webhook Slack App using the instructions here.

• Use the instructions for configuring webhooks above to add your created webhook to your project of choice.

• Thresholds can also be modified in the SDK.

  project = rime_client.get_project("<your_project_id_here")
  firewall = project.get_firewall()
  
  # Get a pd.DataFrame with the current thresholds.
  df = firewall.get_metric_thresholds()
  
  # Disable the threshold for "Abnormality Rate"
  firewall.update_metric_thresholds("Abnormality Rate", disabled=True)