API Monitoring & Alerts

This is an introduction on using monitoring and alerts in Moesif.

Overview of alert rules

About alerting

Alert rules enable you to monitor your APIs for issues impacting customers. These can be functional or performance issues with your API that is impacting customers. You can also leverage alerting to get notified of changes in customer usage. For example, customer success may want to get notified when a new pilot has a large drop in usage. You can even leverage Moesif’s alerting architecture to trigger wehooks and flows such as to properly invoice a customer that’s on consumption-based billing.

If you’re not already familiar with API Analytics, you should first What does API Monitoring Mean for API Product Managers

You can create a trigger on any Time Series chart in Moesif. This is done with the Create Alert button. See Creating Alerts to read more. If you set any filter criteria for the chart, this will also be carried over into the alert rule.

Since alert rules are scoped to the Moesif application, so you can have different rules for a Development vs a Production app.

Before you create an alert rule, you’ll want to create a channel in Moesif. Both alert rules and channels are described below.

Notification Channels

Channel

A channel is a communication method to receive notifications. Moesif supports the following channel types:

  • Email
  • SMS
  • Slack
  • PagerDuty
  • Webhook

You can create any number of channels in Moesif and may even have multiple channels with the same type. For example, you may have a Slack channel #support-issues used by customer success and another Slack channel #backend-alerts used by engineering.

Alert Rules

Alert Rule

An Alert Rules contains the trigger conditions such as any filters and thresholds. Alerts triggered from an alert rule can be routed to any number of channels. This makes it easy to ensure the right people are notified of the right issues. Moesif supports both static alerts where you set a predefined threshold and _dynamic alerts which leverages Moesif’s anomaly detection to automatically detect issues.

FAQ

I am not receiving any alerts

Answer: If you set the threshold to Dynamic, Moesif needs a couple days of data before a historical model of your API behavior is built. If you recently deployed Moesif or have low traffic volume (such as for develop environments), then we recommend static alerts. You can also reduce the sensitivity within the alert rule. Email us or adjust the detection sensitivity in dynamic alerts. Also, ensure you have an active channel under Alert Settings.

I am receiving too many alerts

Answer: Your metric may be varying too much. This can happen when you have non-customer traffic such as health probes and bots that cause spikes in traffic. You can add more filters to your alert rule to focus only on the metrics that matter. If you are using dynamic alerts, you can also decrease the Abrupt spike detector if your time series is naturally varies a lot.

Updated: