You are here

Home » API reference » Raven: Sentry Integration 8.2 » Raven.php

class Raven in Raven: Sentry Integration 8.2

Same name in this branch
  1. 8.2 src/Logger/Raven.php \Drupal\raven\Logger\Raven
  2. 8.2 src/Plugin/CspReportingHandler/Raven.php \Drupal\raven\Plugin\CspReportingHandler\Raven
Same name and namespace in other branches
  1. 8 src/Logger/Raven.php \Drupal\raven\Logger\Raven
  2. 3.x src/Logger/Raven.php \Drupal\raven\Logger\Raven

Logs events to Sentry.

Hierarchy

Expanded class hierarchy of Raven

2 files declare their use of Raven
ProxyConfigTest.php in tests/src/Unit/ProxyConfigTest.php
RavenCommands.php in src/Commands/RavenCommands.php
1 string reference to 'Raven'
raven.services.yml in ./raven.services.yml
raven.services.yml
1 service uses Raven
logger.raven in ./raven.services.yml
Drupal\raven\Logger\Raven

File

src/Logger/Raven.php, line 24

Namespace

Drupal\raven\Logger
View source 
class Raven implements LoggerInterface {
  use DependencySerializationTrait {
    __sleep as protected dependencySleep;
    __wakeup as protected dependencyWakeup;
  }
  use RfcLoggerTrait;

  /**
   * Raven client.
   *
   * @var \Raven_Client|null
   */
  public $client;

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

  /**
   * Config factory.
   *
   * @var \Drupal\Core\Config\ConfigFactoryInterface
   */
  protected $configFactory;

  /**
   * Current user.
   *
   * @var \Drupal\Core\Session\AccountInterface|null
   */
  protected $currentUser;

  /**
   * Environment.
   *
   * @var string
   */
  protected $environment;

  /**
   * The module handler.
   *
   * @var \Drupal\Core\Extension\ModuleHandlerInterface
   */
  protected $moduleHandler;

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

  /**
   * Request stack.
   *
   * @var \Symfony\Component\HttpFoundation\RequestStack|null
   */
  protected $requestStack;

  /**
   * The settings array.
   *
   * @var \Drupal\Core\Site\Settings
   */
  protected $settings;

  /**
   * Constructs a Raven log 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.
   * @param \Drupal\Core\Extension\ModuleHandlerInterface $module_handler
   *   The module handler.
   * @param string $environment
   *   The kernel.environment parameter.
   * @param \Drupal\Core\Session\AccountInterface|null $current_user
   *   The current user (optional).
   * @param \Symfony\Component\HttpFoundation\RequestStack|null $request_stack
   *   The request stack (optional).
   * @param \Drupal\Core\Site\Settings $settings
   *   The settings array (optional).
   */
  public function __construct(ConfigFactoryInterface $config_factory, LogMessageParserInterface $parser, ModuleHandlerInterface $module_handler, $environment, AccountInterface $current_user = NULL, RequestStack $request_stack = NULL, Settings $settings = NULL) {
    $this->configFactory = $config_factory;
    $this->config = $this->configFactory
      ->get('raven.settings');
    $this->currentUser = $current_user;
    $this->requestStack = $request_stack;
    $this->moduleHandler = $module_handler;
    $this->parser = $parser;
    $this->environment = $this->config
      ->get('environment') ?: $environment;
    $this->settings = $settings ?: Settings::getInstance();
    $this
      ->setClient();

    // Raven can catch fatal errors which are not caught by the Drupal logger.
    if ($this->client && $this->config
      ->get('fatal_error_handler')) {
      $error_handler = new \Raven_ErrorHandler($this->client);
      $error_handler
        ->registerShutdownFunction($this->config
        ->get('fatal_error_handler_memory'));
      register_shutdown_function([
        $this->client,
        'onShutdown',
      ]);
    }

    // Add Drush console error event listener.
    if (function_exists('drush_main') && $this->config
      ->get('drush_error_handler') && method_exists('Drush\\Drush', 'service')) {
      Drush::service('eventDispatcher')
        ->addListener(ConsoleEvents::ERROR, [
        $this,
        'onConsoleError',
      ]);
    }
  }

  /**
   * Creates Sentry client based on config and any alter hooks.
   */
  public function setClient() {
    if (!class_exists('Raven_Client')) {

      // Sad raven.
      return;
    }
    $options = [
      'auto_log_stacks' => $this->config
        ->get('stack'),
      'curl_method' => 'async',
      'dsn' => empty($_SERVER['SENTRY_DSN']) ? $this->config
        ->get('client_key') : $_SERVER['SENTRY_DSN'],
      'environment' => empty($_SERVER['SENTRY_ENVIRONMENT']) ? $this->environment : $_SERVER['SENTRY_ENVIRONMENT'],
      'processors' => [
        'Drupal\\raven\\Processor\\SanitizeDataProcessor',
      ],
      'timeout' => $this->config
        ->get('timeout'),
      'message_limit' => $this->config
        ->get('message_limit'),
      'trace' => $this->config
        ->get('trace'),
      'verify_ssl' => TRUE,
    ];
    $ssl = $this->config
      ->get('ssl');

    // Verify against a CA certificate.
    if ($ssl == 'ca_cert') {
      $options['ca_cert'] = realpath($this->config
        ->get('ca_cert'));
    }
    elseif ($ssl == 'no_verify_ssl') {
      $options['verify_ssl'] = FALSE;
    }
    if (!empty($_SERVER['SENTRY_RELEASE'])) {
      $options['release'] = $_SERVER['SENTRY_RELEASE'];
    }
    elseif (!empty($this->config
      ->get('release'))) {
      $options['release'] = $this->config
        ->get('release');
    }

    // Proxy configuration.
    $parsed_dsn = parse_url($options['dsn']);
    if (!empty($parsed_dsn['host']) && !empty($parsed_dsn['scheme'])) {
      $http_client_config = $this->settings
        ->get('http_client_config', []);
      if (!empty($http_client_config['proxy'][$parsed_dsn['scheme']])) {
        $no_proxy = isset($http_client_config['proxy']['no']) ? $http_client_config['proxy']['no'] : [];

        // No need to configure proxy if Sentry host is on proxy bypass list.
        if (!in_array($parsed_dsn['host'], $no_proxy, TRUE)) {
          $options['http_proxy'] = $http_client_config['proxy'][$parsed_dsn['scheme']];
        }
      }
    }

    // Disable the default breadcrumb handler because Drupal error handler
    // mistakes it for the calling code when errors are thrown.
    $options['install_default_breadcrumb_handlers'] = FALSE;
    $this->moduleHandler
      ->alter('raven_options', $options);
    try {
      $this->client = new \Raven_Client($options);
    } catch (\InvalidArgumentException $e) {

      // Raven is incorrectly configured.
      return;
    }

    // Set default user context to avoid sending session ID to Sentry.
    $this->client
      ->user_context([
      'id' => $this->currentUser ? $this->currentUser
        ->id() : 0,
    ]);
    if ($this->requestStack && ($request = $this->requestStack
      ->getCurrentRequest())) {
      $this->client
        ->user_context([
        'ip_address' => $request
          ->getClientIp(),
      ]);
    }
  }

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

      // Sad raven.
      return;
    }
    $levels = [
      RfcLogLevel::EMERGENCY => \Raven_Client::FATAL,
      RfcLogLevel::ALERT => \Raven_Client::FATAL,
      RfcLogLevel::CRITICAL => \Raven_Client::FATAL,
      RfcLogLevel::ERROR => \Raven_Client::ERROR,
      RfcLogLevel::WARNING => \Raven_Client::WARNING,
      RfcLogLevel::NOTICE => \Raven_Client::INFO,
      RfcLogLevel::INFO => \Raven_Client::INFO,
      RfcLogLevel::DEBUG => \Raven_Client::DEBUG,
    ];
    $data['level'] = $levels[$level];
    $message_placeholders = $this->parser
      ->parseMessagePlaceholders($message, $context);
    $formatted_message = empty($message_placeholders) ? $message : strtr($message, $message_placeholders);
    if ($message_limit = $this->config
      ->get('message_limit')) {
      $formatted_message = Unicode::truncate($formatted_message, $message_limit, FALSE, TRUE);
    }
    $data['sentry.interfaces.Message'] = [
      'message' => $message,
      'params' => $message_placeholders,
      'formatted' => $formatted_message,
    ];
    $data['timestamp'] = gmdate('Y-m-d\\TH:i:s\\Z', $context['timestamp']);
    $data['logger'] = $context['channel'];
    $data['extra']['link'] = (string) $context['link'];
    $data['extra']['referer'] = $context['referer'];
    $data['extra']['request_uri'] = $context['request_uri'];
    $data['user']['id'] = $context['uid'];
    $data['user']['ip_address'] = $context['ip'];
    if (!$this->client->auto_log_stacks) {
      $stack = FALSE;
    }
    elseif (isset($context['backtrace'])) {
      $stack = $context['backtrace'];
    }
    else {

      // Remove any logger stack frames.
      $stack = debug_backtrace($this->client->trace ? 0 : DEBUG_BACKTRACE_IGNORE_ARGS);
      $finder = new ClassFinder();
      if ($stack[0]['file'] === realpath($finder
        ->findFile('Drupal\\Core\\Logger\\LoggerChannel'))) {
        array_shift($stack);
        if ($stack[0]['file'] === realpath($finder
          ->findFile('Psr\\Log\\LoggerTrait'))) {
          array_shift($stack);
        }
      }
    }

    // Allow modules to alter or ignore this message.
    $filter = [
      'level' => $level,
      'message' => $message,
      'context' => $context,
      'data' => &$data,
      'stack' => &$stack,
      'client' => $this->client,
      'process' => !empty($this->config
        ->get('log_levels')[$level + 1]),
    ];
    if (in_array($context['channel'], $this->config
      ->get('ignored_channels') ?: [])) {
      $filter['process'] = FALSE;
    }
    $this->moduleHandler
      ->alter('raven_filter', $filter);
    if (!empty($filter['process'])) {
      $this->client
        ->capture($data, $stack);
    }

    // Record a breadcrumb.
    $breadcrumb = [
      'level' => $level,
      'message' => $message,
      'context' => $context,
      'process' => TRUE,
      'breadcrumb' => [
        'category' => $context['channel'],
        'message' => $formatted_message,
        'level' => $levels[$level],
      ],
    ];
    foreach ([
      '%line',
      '%file',
      '%type',
      '%function',
    ] as $key) {
      if (isset($context[$key])) {
        $breadcrumb['breadcrumb']['data'][substr($key, 1)] = $context[$key];
      }
    }
    $this->moduleHandler
      ->alter('raven_breadcrumb', $breadcrumb);
    if (!empty($breadcrumb['process'])) {
      $this->client->breadcrumbs
        ->record($breadcrumb['breadcrumb']);
    }
  }

  /**
   * {@inheritdoc}
   */
  public function __sleep() {
    return array_diff($this
      ->dependencySleep(), [
      'client',
      'config',
    ]);
  }

  /**
   * {@inheritdoc}
   */
  public function __wakeup() {
    $this
      ->dependencyWakeup();
    $this->config = $this->configFactory
      ->get('raven.settings');
    $this
      ->setClient();
  }

  /**
   * Sends all unsent events.
   *
   * Call this method periodically if you have a long-running script or are
   * processing a large set of data which may generate errors.
   */
  public function flush() {
    if ($this->client) {
      $this->client
        ->onShutdown();
    }
  }

  /**
   * Captures console error events.
   */
  public function onConsoleError(ConsoleErrorEvent $event) {
    if (!$this->client) {
      return;
    }
    $this->client
      ->captureException($event
      ->getError());
  }

}

Members

Namesort descending Modifiers Type Description Overrides
DependencySerializationTrait::$_entityStorages protected property An array of entity type IDs keyed by the property name of their storages.
DependencySerializationTrait::$_serviceIds protected property An array of service IDs keyed by property name used for serialization.
DependencySerializationTrait::__sleep public function Aliased as: dependencySleep 1
DependencySerializationTrait::__wakeup public function Aliased as: dependencyWakeup 2
Raven::$client public property Raven client.
Raven::$config protected property A configuration object containing Raven settings.
Raven::$configFactory protected property Config factory.
Raven::$currentUser protected property Current user.
Raven::$environment protected property Environment.
Raven::$moduleHandler protected property The module handler.
Raven::$parser protected property The message's placeholders parser.
Raven::$requestStack protected property Request stack.
Raven::$settings protected property The settings array.
Raven::flush public function Sends all unsent events.
Raven::log public function Logs with an arbitrary level. Overrides RfcLoggerTrait::log
Raven::onConsoleError public function Captures console error events.
Raven::setClient public function Creates Sentry client based on config and any alter hooks.
Raven::__construct public function Constructs a Raven log object.
Raven::__sleep public function
Raven::__wakeup public function
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