public function CapacityDiagnosticCheck::run in Purge 8.3

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

src/Plugin/Purge/DiagnosticCheck/CapacityDiagnosticCheck.php, line 60

Class

CapacityDiagnosticCheck: Checks if there is purging capacity available.

Namespace

Drupal\purge\Plugin\Purge\DiagnosticCheck

Code

public function run() {
  $tracker = $this->purgePurgers
    ->capacityTracker();
  $this->value = $tracker
    ->getRemainingInvalidationsLimit();
  $ideal_limit = $tracker
    ->getIdealConditionsLimit();
  $placeholders = [
    '@limit' => $this->value,
    '@ideallimit' => $ideal_limit,
  ];
  if ($this->value === 0) {
    $this->recommendation = $this
      ->t("There is no purging capacity available.");
    return self::SEVERITY_WARNING;
  }
  elseif ($this->value < 5) {
    $this->recommendation = $this
      ->t("Your system invalidates just @limit items through webserver-initiated processing. If you notice that purge cannot keep up with its queue, reconsider your configuration.", $placeholders);
    return self::SEVERITY_WARNING;
  }
  else {
    $this->recommendation = $this
      ->t("Your system can invalidate @limit items when you're processing through webserver-initiated requests. Under ideal conditions - for example via Drush - the capacity would be @ideallimit.", $placeholders);
    return self::SEVERITY_OK;
  }
}

You are here