Remediations

Learn more about the Remediations section of the Bearer Dashboard

Remediations are actions that the Bearer Agent has taken to recover from an API event. Much like Anomalies, remediations can be configured to match the criteria of certain types of API calls.

Like anomalies, Bearer includes some built-in remediation rules. Unlike anomalies, these rules are disabled by default to ensure that you have full control over how and when a remediation is performed within your application. To enable a remediation, select the ellipsis (...) and toggle the "Activated" switch.

View all Remediations

To see all remediations that the Bearer agent has performed in the selected app, select the View all remediations link from the Remediations screen.

The All Remediations view provides a filterable list of all remediations that have been performed in the current data retention period. Selecting an entry that includes a more information arrow will display details about the API call that triggered the remediation. Here you can create a shared link to the log entry, and even create a new anomaly or remediation based on the details of this log entry.

Add a Custom Remediation Rule

To create a new custom remediation rule, select the Add a Custom Rule button.

Anomalies and remediations are created the same way, but remediations include one additional section. The remediation type.

General

Each remediation can have a name and a description. In addition, you can assign remediations to apply to all APIs, or a specific API. Remediations fall into two detection types:

  • Call by Call Filter Match: This detection type monitors all API calls and checks them against a set of filters that you define.

  • Sliding Time Window: This detection type allows you to define a trigger condition such as Error Rate, Consumption, or Average Latency. When the condition occurs within the time-window you define, the anomaly will trigger.

Finally, each remediation can be enabled or disabled whenever you like. Depending on your current plan, you may be limited in the number of remediations that can be active at a given time.

Call Filtering

Both detection types offer the ability to further narrow down the criteria required to trigger a remediation. Call filters allow you to match against various aspects of an API call including:

  • HTTP Methods

  • Status Codes

  • Connection Errors

  • Paths

  • Request Parameters

  • Headers

Each rule can have a maximum of 5 filters, and you can require that all or any filters are met in order for the rule to trigger.

Remediation Type

The Bearer Agent currently supports three remediation types:

  • Block Calls: Immediately stop and block all API calls matching the defined filters.

  • Timeout: Automatically close any ongoing API calls after the specified delay, giving your app a faster response than the default timeout duration.

  • Retry: Retry unsuccessful API calls automatically. You can set the retry pattern as uniform or exponential, as well as define an interval and total attempt count.

The uniform retry pattern retry at the same interval each time. The exponential retry pattern increases the interval duration with each subsequent unsuccessful API call.

Notification Settings

When a remediation occurs, it is automatically logged in the remediations list, as well as the remediations log collection. You can also choose to receive notifications for specific rules by configuring your preferred notification methods. Notifications can be configured in the Notifications section of the dashboard Settings. Currently, Bearer supports being notified by Email, Slack, or through a custom webhook.