Flare error count

On this page

  1. Usage
  2. Customizing the amount of errors

This check will monitor the amount of errors and exceptions your application throws. For this check you'll need to have an account on Flare.

By default, this check will send:

  • a warning when there were more than 500 errors reported to Flare in the past 60 minutes
  • a failure when there were more than 1000 errors reported to Flare in the past 60 minutes

To start using this check, you should have a Flare API Token and Flare project id. Check the Flare docs on how to get these values.

Here's how you can register the check.

use Spatie\Health\Facades\Health;
use Spatie\Health\Checks\Checks\FlareErrorOccurrenceCountCheck;

Health::checks([
    FlareErrorOccurrenceCountCheck::new()
        ->apiToken($flareApiToken)
        ->projectId($flareProjectId),
]);

To customize the amount of errors that triggers a warning/failure, you can call warnWhenMoreErrorsReceivedThan, and failWhenMoreErrorsReceivedThan.

FlareErrorOccurrenceCountCheck::new()
    ->warnWhenMoreErrorsReceivedThan(20)
    ->failWhenMoreErrorsReceivedThan(50),