class LogsHttpLogger in Logs HTTP 8

Implements a Logs Http Logger instance.

Hierarchy

class \Drupal\logs_http\Logger\LogsHttpLogger implements LogsHttpLoggerInterface uses RfcLoggerTrait

Expanded class hierarchy of LogsHttpLogger

1 file declares its use of LogsHttpLogger

LogsHttpLoggerTest.php in tests/src/Unit/LogsHttpLoggerTest.php

1 string reference to 'LogsHttpLogger'

logs_http.services.yml in ./logs_http.services.yml: logs_http.services.yml

1 service uses LogsHttpLogger

logs_http.logs_http_logger in ./logs_http.services.yml: Drupal\logs_http\Logger\LogsHttpLogger

File

src/Logger/LogsHttpLogger.php, line 13

Namespace

Drupal\logs_http\Logger

View source

class LogsHttpLogger implements LogsHttpLoggerInterface {
  use RfcLoggerTrait;

  /**
   * A configuration object containing Logs http settings.
   *
   * @var \Drupal\Core\Config\Config
   */
  protected $config;

  /**
   * The message's placeholders parser.
   *
   * @var \Drupal\Core\Logger\LogMessageParserInterface
   */
  protected $logMessageParser;

  /**
   * The severity levels array.
   *
   * @var array
   */
  protected $severityLevels;

  /**
   * The cache of the events.
   *
   * @var array
   */
  protected $cache = [];

  /**
   * Clear the events by setting a new array to the variable.
   */
  public function reset() {
    $this->cache = [];
  }

  /**
   * Constructs a LogsHttpLogger object.
   *
   * @param \Drupal\Core\Config\ConfigFactoryInterface $config_factory
   *   The configuration factory object.
   * @param \Drupal\Core\Logger\LogMessageParserInterface $parser
   *   The parser to use when extracting message variables.
   */
  public function __construct(ConfigFactoryInterface $config_factory, LogMessageParserInterface $parser) {
    $this->config = $config_factory
      ->get('logs_http.settings');
    $this->logMessageParser = $parser;
    $this->severityLevels = RfcLogLevel::getLevels();
  }

  /**
   * {@inheritdoc}
   */
  public function log($level, $message, array $context = []) {
    if (!$this
      ->isEnabled()) {

      // Service is disabled.
      return;
    }
    if ($level > $this->config
      ->get('severity_level')) {

      // Severity level is above the ones we want to log.
      return;
    }
    $event = $this
      ->registerEvent($level, $message, $context);
    if (!$event) {

      // No event created.
      return;
    }
    $this
      ->addEventToCache($event);
  }

  /**
   * {@inheritdoc}
   *
   * To prevent multiple registration of the same error, we check that identical
   * events are not captured twice, thus reducing the final HTTP requests
   * needed.
   */
  public function registerEvent($level, string $message, array $context = []) {

    // Populate the message placeholders and then replace them in the message.
    $message_placeholders = $this->logMessageParser
      ->parseMessagePlaceholders($message, $context);
    $message = empty($message_placeholders) ? $message : strtr($message, $message_placeholders);
    $event = [
      'timestamp' => $context['timestamp'],
      'type' => $this->severityLevels[$level]
        ->getUntranslatedString(),
      'ip' => $context['ip'],
      'request_uri' => $context['request_uri'],
      'referer' => $context['referer'],
      'uid' => $context['uid'],
      'link' => strip_tags($context['link']),
      'message' => $message,
      'severity' => $level,
    ];
    if (!empty($context['@backtrace_string'])) {
      $event['exception_trace'] = $context['@backtrace_string'];
    }
    if ($environment_uuid = $this->config
      ->get('environment_uuid')) {
      $event['uuid'] = $environment_uuid;
    }
    return $event;
  }

  /**
   * Add an event to static cache.
   *
   * Prevent adding the same event, occurred in the same request, twice.
   *
   * @param array $event
   *   The event to register in the static cache.
   *
   * @return bool
   *   TRUE if added to cache, otherwise FALSE, indicating is was already added
   *   previously.
   */
  protected function addEventToCache(array $event) {

    // Remove empty values, to prevent errors in the indexing of the JSON.
    $event = $this
      ->arrayRemoveEmpty($event);

    // Prevent identical events.
    $event_clone = $event;
    unset($event_clone['timestamp']);
    $key = md5(serialize($event_clone));
    $is_unique = !empty($this->cache[$key]);
    $this->cache[$key] = $event;
    return $is_unique;
  }

  /**
   * Deep array filter; Remove empty values.
   *
   * @param array $haystack
   *   The variable to filter.
   *
   * @return array
   *   The filtered array.
   */
  protected function arrayRemoveEmpty(array $haystack) {
    foreach ($haystack as $key => $value) {
      if (is_array($value)) {
        $haystack[$key] = $this
          ->arrayRemoveEmpty($haystack[$key]);
      }
      if (empty($haystack[$key])) {
        unset($haystack[$key]);
      }
    }
    return $haystack;
  }

  /**
   * A getter for the current events.
   *
   * @return array
   *   Returns the current events.
   */
  public function getEvents() {
    return $this->cache;
  }

  /**
   * Check weather we should use Logs http module or not.
   *
   * Determine by checking the 'enabled' configuration, plus the 'url' must not
   * be empty.
   *
   * @return bool
   *   Returns TRUE if currently we should POST the data, otherwise returns
   *   FALSE.
   */
  public function isEnabled() {
    return $this->config
      ->get('enabled') && !empty($this
      ->getUrl());
  }

  /**
   * A getter for the url of the endpoint we should send the data to.
   *
   * @return array|mixed|null
   *   Returns the endpoint URL to POST data to.
   */
  public function getUrl() {
    return $this->config
      ->get('url');
  }

  /**
   * A getter for the HTTP headers for the logging request.
   */
  public function getHttpHeaders() {
    return [
      'Content-Type' => 'application/json',
    ];
  }

}

Members

Name	Modifiers	Type	Description
LogsHttpLogger::$cache	protected	property	The cache of the events.
LogsHttpLogger::$config	protected	property	A configuration object containing Logs http settings.
LogsHttpLogger::$logMessageParser	protected	property	The message's placeholders parser.
LogsHttpLogger::$severityLevels	protected	property	The severity levels array.
LogsHttpLogger::addEventToCache	protected	function	Add an event to static cache.
LogsHttpLogger::arrayRemoveEmpty	protected	function	Deep array filter; Remove empty values.
LogsHttpLogger::getEvents	public	function	A getter for the current events. Overrides LogsHttpLoggerInterface::getEvents
LogsHttpLogger::getHttpHeaders	public	function	A getter for the HTTP headers for the logging request. Overrides LogsHttpLoggerInterface::getHttpHeaders
LogsHttpLogger::getUrl	public	function	A getter for the url of the endpoint we should send the data to. Overrides LogsHttpLoggerInterface::getUrl
LogsHttpLogger::isEnabled	public	function	Check weather we should use Logs http module or not. Overrides LogsHttpLoggerInterface::isEnabled
LogsHttpLogger::log	public	function	Overrides RfcLoggerTrait::log
LogsHttpLogger::registerEvent	public	function	To prevent multiple registration of the same error, we check that identical events are not captured twice, thus reducing the final HTTP requests needed. Overrides LogsHttpLoggerInterface::registerEvent
LogsHttpLogger::reset	public	function	Clear the events by setting a new array to the variable. Overrides LogsHttpLoggerInterface::reset
LogsHttpLogger::__construct	public	function	Constructs a LogsHttpLogger object.
RfcLoggerTrait::alert	public	function
RfcLoggerTrait::critical	public	function
RfcLoggerTrait::debug	public	function
RfcLoggerTrait::emergency	public	function
RfcLoggerTrait::error	public	function
RfcLoggerTrait::info	public	function
RfcLoggerTrait::notice	public	function
RfcLoggerTrait::warning	public	function

You are here

class LogsHttpLogger in Logs HTTP 8

Hierarchy

File

Namespace

Members

API Navigation