public function ApiRateLimitCheck::run in CloudFlare 8

Perform the check and determine the severity level.

Diagnostic checks determine whether something you are checking for is in shape, for instance CMI settings on which your plugin depends. Any check reporting self::SEVERITY_ERROR in their run() methods, will cause purge to stop working. Any other severity level will let the purgers proceed operating but you may report any warning through getRecommendation() to be shown on Drupal's status report, purge_ui or any other diagnostic listing.


public function run() {
  if (...check..) {
    return self::SEVERITY_OK;
  }
  return self::SEVERITY_WARNING;
}

@warning As diagnostic checks can be expensive, this method is called as rarely as possible. Checks derived from DiagnosticCheckBase will only see the check getting executed when any of the getter methods are called.

Return value

int Integer, matching either of the following constants:

Throws

\Drupal\purge\Plugin\Purge\DiagnosticCheck\Exception\CheckNotImplementedCorrectly Thrown when the return value is incorrect.

Overrides DiagnosticCheckInterface::run

File

modules/cloudflarepurger/src/Plugin/Purge/DiagnosticCheck/ApiRateLimitCheck.php, line 79

Class

ApiRateLimitCheck: Checks that the site is within CloudFlare's API rate limits.

Namespace

Drupal\cloudflarepurger\Plugin\Purge\DiagnosticCheck

Code

public function run() {
  if (!$this->cloudFlareComposerDependenciesCheck
    ->check()) {
    $this->recommendation = $this
      ->t("Composer dependencies unmet.  Unable to assess API rate limits.");
    return SELF::SEVERITY_ERROR;
  }

  // Current number of purges today.
  $rate_count = $this->state
    ->getApiRateCount();
  $this->value = $rate_count;

  // Warn at 75% of capacity.
  $daily_warning_level = 0.75 * CloudFlareAPI::API_RATE_LIMIT;
  $message_variables = [
    ':rate_limit' => CloudFlareAPI::API_RATE_LIMIT,
    ':$rate_count' => $rate_count,
  ];
  if ($rate_count >= CloudFlareAPI::API_RATE_LIMIT) {
    $this->recommendation = $this
      ->t('Exceeded Api limit of :$rate_count/:rate_limit limit purges/day.', $message_variables);
    return SELF::SEVERITY_ERROR;
  }
  elseif ($rate_count >= $daily_warning_level) {
    $this->recommendation = $this
      ->t('Approaching Api limit of :$rate_count/:rate_limit limit purges/day.', $message_variables);
    return SELF::SEVERITY_WARNING;
  }
  elseif ($rate_count < $daily_warning_level) {
    $this->recommendation = $this
      ->t('Site is safely below the rate limit of :rate_limit every 5 minutes.', $message_variables);
    return SELF::SEVERITY_OK;
  }
}

You are here