You are here

Home » API reference » Memcache API and Integration 8.2 » MemcacheStatisticsController.php

class MemcacheStatisticsController in Memcache API and Integration 8.2

Memcache Statistics.

Hierarchy

Expanded class hierarchy of MemcacheStatisticsController

File

memcache_admin/src/Controller/MemcacheStatisticsController.php, line 15

Namespace

Drupal\memcache_admin\Controller
View source 
class MemcacheStatisticsController extends ControllerBase {
  use MessengerTrait;
  use StringTranslationTrait;

  /**
   * Callback for the Memcache Stats page.
   *
   * @param string $bin
   *   The bin name.
   *
   * @return array
   *   The page output.
   */
  public function statsTable($bin = 'default') {
    $bin = $this
      ->getBinMapping($bin);

    /** @var $memcache \Drupal\memcache\DrupalMemcacheInterface */
    $memcache = \Drupal::service('memcache.factory')
      ->get($bin, TRUE);

    // Instantiate our event.
    $event = new MemcacheStatsEvent($memcache, $bin);

    // Get the event_dispatcher service and dispatch the event.
    $event_dispatcher = \Drupal::service('event_dispatcher');
    $event_dispatcher
      ->dispatch(MemcacheStatsEvent::BUILD_MEMCACHE_STATS, $event);

    // Report the PHP Memcache(d) driver version.
    if ($memcache
      ->getMemcache() instanceof \Memcached) {
      $raw_stats['driver_version'] = $this
        ->t('PECL Driver in Use: Memcached v@version', [
        '@version' => phpversion('Memcached'),
      ]);
    }
    elseif ($memcache
      ->getMemcache() instanceof \Memcache) {
      $raw_stats['driver_version'] = $this
        ->t('PECL Driver in Use: Memcache v@version', [
        '@version' => phpversion('Memcache'),
      ]);
    }

    // Get the event_dispatcher service and dispatch the event.
    $event_dispatcher = \Drupal::service('event_dispatcher');
    $event_dispatcher
      ->dispatch(MemcacheStatsEvent::REPORT_MEMCACHE_STATS, $event);
    $output = [
      '#markup' => '<p>' . $raw_stats['driver_version'],
    ];
    $output[] = $this
      ->statsTablesOutput($bin, $event
      ->getServers(), $event
      ->getReport());
    return $output;
  }

  /**
   * Callback for the Memcache Stats page.
   *
   * @param string $cluster
   *   The Memcache cluster name.
   * @param string $server
   *   The Memcache server name.
   * @param string $type
   *   The type of statistics to retrieve when using the Memcache extension.
   *
   * @return string
   *   The page output.
   */
  public function statsTableRaw($cluster, $server, $type = 'default') {
    $cluster = $this
      ->binMapping($cluster);
    $server = str_replace('!', '/', $server);
    $slab = \Drupal::routeMatch()
      ->getParameter('slab');
    $memcache = \Drupal::service('memcache.factory')
      ->get($cluster, TRUE);
    if ($type == 'slabs' && !empty($slab)) {
      $stats = $memcache
        ->stats($cluster, $slab, FALSE);
    }
    else {
      $stats = $memcache
        ->stats($cluster, $type, FALSE);
    }

    // @codingStandardsIgnoreStart
    // @todo - breadcrumb
    // $breadcrumbs = [
    //   l(t('Home'), NULL),
    //   l(t('Administer'), 'admin'),
    //   l(t('Reports'), 'admin/reports'),
    //   l(t('Memcache'), 'admin/reports/memcache'),
    //   l(t($bin), "admin/reports/memcache/$bin"),
    // ];
    // if ($type == 'slabs' && arg(6) == 'cachedump' && user_access('access slab cachedump')) {
    //   $breadcrumbs[] = l($server, "admin/reports/memcache/$bin/$server");
    //   $breadcrumbs[] = l(t('slabs'), "admin/reports/memcache/$bin/$server/$type");
    // }
    // drupal_set_breadcrumb($breadcrumbs);
    // @codingStandardsIgnoreEnd
    if (isset($stats[$cluster][$server]) && is_array($stats[$cluster][$server]) && count($stats[$cluster][$server])) {
      $output = $this
        ->statsTablesRawOutput($cluster, $server, $stats[$cluster][$server], $type);
    }
    elseif ($type == 'slabs' && is_array($stats[$cluster]) && count($stats[$cluster])) {
      $output = $this
        ->statsTablesRawOutput($cluster, $server, $stats[$cluster], $type);
    }
    else {
      $output = $this
        ->statsTablesRawOutput($cluster, $server, [], $type);
      $this
        ->messenger()
        ->addMessage($this
        ->t('No @type statistics for this bin.', [
        '@type' => $type,
      ]));
    }
    return $output;
  }

  /**
   * Helper function, reverse map the memcache_bins variable.
   */
  private function binMapping($bin = 'cache') {
    $memcache = \Drupal::service('memcache.factory')
      ->get(NULL, TRUE);
    $memcache_bins = $memcache
      ->getBins();
    $bins = array_flip($memcache_bins);
    if (isset($bins[$bin])) {
      return $bins[$bin];
    }
    else {
      return $this
        ->defaultBin($bin);
    }
  }

  /**
   * Statistics report: format total and open connections.
   */
  private function statsConnections($stats) {
    return $this
      ->t('@current open of @total total', [
      '@current' => number_format($stats['curr_connections']),
      '@total' => number_format($stats['total_connections']),
    ]);
  }

  /**
   * Statistics report: calculate # of increments and decrements.
   */
  private function statsCounters($stats) {
    if (!is_array($stats)) {
      $stats = [];
    }
    $stats += [
      'incr_hits' => 0,
      'incr_misses' => 0,
      'decr_hits' => 0,
      'decr_misses' => 0,
    ];
    return $this
      ->t('@incr increments, @decr decrements', [
      '@incr' => number_format($stats['incr_hits'] + $stats['incr_misses']),
      '@decr' => number_format($stats['decr_hits'] + $stats['decr_misses']),
    ]);
  }

  /**
   * Generates render array for output.
   */
  private function statsTablesOutput($bin, $servers, $stats) {
    $memcache = \Drupal::service('memcache.factory')
      ->get(NULL, TRUE);
    $memcache_bins = $memcache
      ->getBins();
    $links = [];
    if (!is_array($servers)) {
      return;
    }
    foreach ($servers as $server) {

      // Convert socket file path so it works with an argument, this should
      // have no impact on non-socket configurations. Convert / to !.
      $links[] = Link::fromTextandUrl($server, Url::fromUri('base:/admin/reports/memcache/' . $memcache_bins[$bin] . '/' . str_replace('/', '!', $server)))
        ->toString();
    }
    if (count($servers) > 1) {
      $headers = array_merge([
        '',
        $this
          ->t('Totals'),
      ], $links);
    }
    else {
      $headers = array_merge([
        '',
      ], $links);
    }
    $output = [];
    foreach ($stats as $table => $data) {
      $rows = [];
      foreach ($data as $data_row) {
        $row = [];
        $row[] = $data_row['label'];
        if (isset($data_row['total'])) {
          $row[] = $data_row['total'];
        }
        foreach ($data_row['servers'] as $server) {
          $row[] = $server;
        }
        $rows[] = $row;
      }
      $output[$table] = [
        '#theme' => 'table',
        '#header' => $headers,
        '#rows' => $rows,
      ];
    }
    return $output;
  }

  /**
   * Generates render array for output.
   */
  private function statsTablesRawOutput($cluster, $server, $stats, $type) {
    $user = \Drupal::currentUser();
    $current_type = isset($type) ? $type : 'default';
    $memcache = \Drupal::service('memcache.factory')
      ->get(NULL, TRUE);
    $memcache_bins = $memcache
      ->getBins();
    $bin = isset($memcache_bins[$cluster]) ? $memcache_bins[$cluster] : 'default';
    $slab = \Drupal::routeMatch()
      ->getParameter('slab');

    // Provide navigation for the various memcache stats types.
    $links = [];
    if (count($memcache
      ->statsTypes())) {
      foreach ($memcache
        ->statsTypes() as $type) {

        // @todo render array
        $link = Link::fromTextandUrl($type, Url::fromUri('base:/admin/reports/memcache/' . $bin . '/' . str_replace('/', '!', $server) . '/' . ($type == 'default' ? '' : $type)))
          ->toString();
        if ($current_type == $type) {
          $links[] = '<strong>' . $link . '</strong>';
        }
        else {
          $links[] = $link;
        }
      }
    }
    $build = [
      'links' => [
        '#markup' => !empty($links) ? implode(' | ', $links) : '',
      ],
    ];
    $build['table'] = [
      '#type' => 'table',
      '#header' => [
        $this
          ->t('Property'),
        $this
          ->t('Value'),
      ],
    ];
    $row = 0;

    // Items are returned as an array within an array within an array.  We step
    // in one level to properly display the contained statistics.
    if ($current_type == 'items' && isset($stats['items'])) {
      $stats = $stats['items'];
    }
    foreach ($stats as $key => $value) {

      // Add navigation for getting a cachedump of individual slabs.
      if (($current_type == 'slabs' || $current_type == 'items') && is_int($key) && $user
        ->hasPermission('access slab cachedump')) {
        $build['table'][$row]['key'] = [
          '#type' => 'link',
          '#title' => $this
            ->t('Slab @slab', [
            '@slab' => $key,
          ]),
          '#url' => Url::fromUri('base:/admin/reports/memcache/' . $bin . '/' . str_replace('/', '!', $server) . '/slabs/cachedump/' . $key),
        ];
      }
      else {
        $build['table'][$row]['key'] = [
          '#plain_text' => $key,
        ];
      }
      if (is_array($value)) {
        $subrow = 0;
        $build['table'][$row]['value'] = [
          '#type' => 'table',
        ];
        foreach ($value as $k => $v) {

          // Format timestamp when viewing cachedump of individual slabs.
          if ($current_type == 'slabs' && $user
            ->hasPermission('access slab cachedump') && !empty($slab) && $k == 0) {
            $k = $this
              ->t('Size');
            $v = format_size($v);
          }
          elseif ($current_type == 'slabs' && $user
            ->hasPermission('access slab cachedump') && !empty($slab) && $k == 1) {
            $k = $this
              ->t('Expire');
            $full_stats = $memcache
              ->stats($cluster);
            $infinite = $full_stats[$cluster][$server]['time'] - $full_stats[$cluster][$server]['uptime'];
            if ($v == $infinite) {
              $v = $this
                ->t('infinite');
            }
            else {
              $v = $this
                ->t('in @time', [
                '@time' => \Drupal::service('date.formatter')
                  ->formatInterval($v - \Drupal::time()
                  ->getRequestTime()),
              ]);
            }
          }
          $build['table'][$row]['value'][$subrow] = [
            'key' => [
              '#plain_text' => $k,
            ],
            'value' => [
              '#plain_text' => $v,
            ],
          ];
          $subrow++;
        }
      }
      else {
        $build['table'][$row]['value'] = [
          '#plain_text' => $value,
        ];
      }
      $row++;
    }
    return $build;
  }

  /**
   * Helper function, reverse map the memcache_bins variable.
   */
  protected function getBinMapping($bin = 'cache') {
    $memcache = \Drupal::service('memcache.factory')
      ->get(NULL, TRUE);
    $memcache_bins = $memcache
      ->getBins();
    $bins = array_flip($memcache_bins);
    if (isset($bins[$bin])) {
      return $bins[$bin];
    }
    else {
      return $this
        ->defaultBin($bin);
    }
  }

  /**
   * Helper function. Returns the bin name.
   */
  protected function defaultBin($bin) {
    if ($bin == 'default') {
      return 'cache';
    }
    return $bin;
  }

}

Members

Namesort descending Modifiers Type Description Overrides
ControllerBase::$configFactory protected property The configuration factory.
ControllerBase::$currentUser protected property The current user service. 1
ControllerBase::$entityFormBuilder protected property The entity form builder.
ControllerBase::$entityManager protected property The entity manager.
ControllerBase::$entityTypeManager protected property The entity type manager.
ControllerBase::$formBuilder protected property The form builder. 2
ControllerBase::$keyValue protected property The key-value storage. 1
ControllerBase::$languageManager protected property The language manager. 1
ControllerBase::$moduleHandler protected property The module handler. 2
ControllerBase::$stateService protected property The state service.
ControllerBase::cache protected function Returns the requested cache bin.
ControllerBase::config protected function Retrieves a configuration object.
ControllerBase::container private function Returns the service container.
ControllerBase::create public static function Instantiates a new instance of this class. Overrides ContainerInjectionInterface::create 40
ControllerBase::currentUser protected function Returns the current user. 1
ControllerBase::entityFormBuilder protected function Retrieves the entity form builder.
ControllerBase::entityManager Deprecated protected function Retrieves the entity manager service.
ControllerBase::entityTypeManager protected function Retrieves the entity type manager.
ControllerBase::formBuilder protected function Returns the form builder service. 2
ControllerBase::keyValue protected function Returns a key/value storage collection. 1
ControllerBase::languageManager protected function Returns the language manager service. 1
ControllerBase::moduleHandler protected function Returns the module handler. 2
ControllerBase::redirect protected function Returns a redirect response object for the specified route. Overrides UrlGeneratorTrait::redirect
ControllerBase::state protected function Returns the state storage service.
LinkGeneratorTrait::$linkGenerator protected property The link generator. 1
LinkGeneratorTrait::getLinkGenerator Deprecated protected function Returns the link generator.
LinkGeneratorTrait::l Deprecated protected function Renders a link to a route given a route name and its parameters.
LinkGeneratorTrait::setLinkGenerator Deprecated public function Sets the link generator service.
LoggerChannelTrait::$loggerFactory protected property The logger channel factory service.
LoggerChannelTrait::getLogger protected function Gets the logger for a specific channel.
LoggerChannelTrait::setLoggerFactory public function Injects the logger channel factory.
MemcacheStatisticsController::binMapping private function Helper function, reverse map the memcache_bins variable.
MemcacheStatisticsController::defaultBin protected function Helper function. Returns the bin name.
MemcacheStatisticsController::getBinMapping protected function Helper function, reverse map the memcache_bins variable.
MemcacheStatisticsController::statsConnections private function Statistics report: format total and open connections.
MemcacheStatisticsController::statsCounters private function Statistics report: calculate # of increments and decrements.
MemcacheStatisticsController::statsTable public function Callback for the Memcache Stats page.
MemcacheStatisticsController::statsTableRaw public function Callback for the Memcache Stats page.
MemcacheStatisticsController::statsTablesOutput private function Generates render array for output.
MemcacheStatisticsController::statsTablesRawOutput private function Generates render array for output.
MessengerTrait::$messenger protected property The messenger. 29
MessengerTrait::messenger public function Gets the messenger. 29
MessengerTrait::setMessenger public function Sets the messenger.
RedirectDestinationTrait::$redirectDestination protected property The redirect destination service. 1
RedirectDestinationTrait::getDestinationArray protected function Prepares a 'destination' URL query parameter for use with \Drupal\Core\Url.
RedirectDestinationTrait::getRedirectDestination protected function Returns the redirect destination service.
RedirectDestinationTrait::setRedirectDestination public function Sets the redirect destination service.
StringTranslationTrait::$stringTranslation protected property The string translation service. 1
StringTranslationTrait::formatPlural protected function Formats a string containing a count of items.
StringTranslationTrait::getNumberOfPlurals protected function Returns the number of plurals supported by a given language.
StringTranslationTrait::getStringTranslation protected function Gets the string translation service.
StringTranslationTrait::setStringTranslation public function Sets the string translation service to use. 2
StringTranslationTrait::t protected function Translates a string to the current language or to a given language.
UrlGeneratorTrait::$urlGenerator protected property The url generator.
UrlGeneratorTrait::getUrlGenerator Deprecated protected function Returns the URL generator service.
UrlGeneratorTrait::setUrlGenerator Deprecated public function Sets the URL generator service.
UrlGeneratorTrait::url Deprecated protected function Generates a URL or path for a specific route based on the given parameters.