Performance tracking

Helper/Data.php

@@ -233,6 +233,14 @@ public function isPhpTrackingEnabled()
         return $this->scopeConfig->isSetFlag(static::XML_PATH_SRS.'enable_php_tracking');
     }
 
+    /**
+     * @return bool
+     */
+    public function isPerformanceTrackingEnabled()
+    {
+        return $this->scopeConfig->isSetFlag(static::XML_PATH_SRS.'enable_performance_tracking');
+    }
+
     /**
      * @return bool
      */

Model/SentryPerformance.php

@@ -0,0 +1,98 @@
+<?php
+
+declare(strict_types=1);
+
+namespace JustBetter\Sentry\Model;
+
+// phpcs:disable Magento2.Functions.DiscouragedFunction
+
+use Magento\Framework\App\Request\Http as HttpRequest;
+use Magento\Framework\App\Response\Http as HttpResponse;
+use Magento\Framework\App\ResponseInterface;
+use Sentry\SentrySdk;
+use Sentry\Tracing\SpanContext;
+use Sentry\Tracing\Transaction;
+use Sentry\Tracing\TransactionContext;
+use Sentry\Tracing\TransactionSource;
+
+class SentryPerformance
+{
+    /** @var Transaction|null */
+    private $transaction;
+
+    /** @var \Magento\Framework\App\ResourceConnection */
+    private $resourceConnection;
+
+    public function __construct(\Magento\Framework\App\ResourceConnection $resourceConnection)
+    {
+        $this->resourceConnection = $resourceConnection;
+    }
+
+    public function startTransaction(HttpRequest $request)
+    {
+        $requestStartTime = $request->getServer('REQUEST_TIME_FLOAT', microtime(true));
+
+        $context = TransactionContext::fromHeaders(
+            $request->getHeader('sentry-trace') ?: '',
+            $request->getHeader('baggage') ?: ''
+        );
+
+        $requestPath = '/'.ltrim($request->getRequestUri(), '/');
+
+        $context->setOp('http.server');
+        $context->setName($requestPath);
+        $context->setSource(TransactionSource::url());
+        $context->setStartTimestamp($requestStartTime);
+
+        $context->setData([
+            'url'    => $requestPath,
+            'method' => strtoupper($request->getMethod()),
+        ]);
+
+        // Start the transaction
+        $transaction = \Sentry\startTransaction($context);
+
+        // If this transaction is not sampled, don't set it either and stop doing work from this point on
+        if (!$transaction->getSampled()) {
+            return;
+        }
+
+        $this->transaction = $transaction;
+
+        // Set the current transaction as the current span so we can retrieve it later
+        \Sentry\SentrySdk::getCurrentHub()->setSpan($transaction);
+    }
+
+    /**
+     * @param ResponseInterface|Response $response
+     */
+    public function finishTransaction(ResponseInterface $response)
+    {
+        if ($this->transaction) {
+            if ($response instanceof HttpResponse) {
+                $this->transaction->setHttpStatus($response->getStatusCode());
+            }
+
+            // Finish the transaction, this submits the transaction and it's span to Sentry
+            $this->transaction->finish();
+
+            $this->transaction = null;
+        }
+    }
+
+    public function addSqlQuery($sql, $startTime, $endTime = null)
+    {
+        $parentSpan = SentrySdk::getCurrentHub()->getSpan();
+        if (!$parentSpan) {
+            return;
+        }
+
+        $context = new SpanContext();
+        $context->setOp('db.sql.query');
+        $context->setDescription($sql);
+        $context->setStartTimestamp($startTime);
+        $context->setEndTimestamp($endTime ?: microtime(true));
+
+        $parentSpan->startChild($context);
+    }
+}

Observer/ControllerActionPredispatchObserver.php

@@ -0,0 +1,27 @@
+<?php
+
+namespace JustBetter\Sentry\Observer;
+
+use JustBetter\Sentry\Model\SentryPerformance;
+use Magento\Framework\App\Request\Http;
+use Magento\Framework\Event\ObserverInterface;
+
+class ControllerActionPredispatchObserver implements ObserverInterface
+{
+    /** @var SentryPerformance */
+    private $sentryPerformance;
+
+    /** @var Http */
+    private $request;
+
+    public function __construct(SentryPerformance $sentryPerformance, Http $request)
+    {
+        $this->sentryPerformance = $sentryPerformance;
+        $this->request = $request;
+    }
+
+    public function execute(\Magento\Framework\Event\Observer $observer)
+    {
+        $this->sentryPerformance->startTransaction($this->request);
+    }
+}

Plugin/GlobalExceptionCatcher.php

@@ -68,6 +68,10 @@ public function aroundLaunch(AppInterface $subject, callable $proceed)
             $config->setEnvironment($environment);
         }
 
+        if ($this->sentryHelper->isTracingEnabled() && $this->sentryHelper->isPerformanceTrackingEnabled()) {
+            $config->setTracesSampleRate($this->sentryHelper->getTracingSampleRate());
+        }
+
         $this->eventManager->dispatch('sentry_before_init', [
             'config' => $config,
         ]);

Plugin/LoggerProxyPlugin.php

@@ -0,0 +1,44 @@
+<?php
+
+namespace JustBetter\Sentry\Plugin;
+
+use JustBetter\Sentry\Model\SentryPerformance;
+use Magento\Framework\DB\Logger\LoggerProxy;
+
+/**
+ * Plugin to add DB Queries from the ProxyLogger to Sentry
+ */
+class LoggerProxyPlugin
+{
+    /** @var SentryPerformance */
+    private $sentryPerformance;
+
+    /** @var float|null */
+    private $timer;
+
+    public function __construct(SentryPerformance $sentryPerformance)
+    {
+        $this->sentryPerformance = $sentryPerformance;
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function beforeStartTimer()
+    {
+        $this->timer = microtime(true);
+    }
+
+    /**
+     * @param LoggerProxy $subject
+     * @param string $type
+     * @param string $sql
+     * @param array $bind
+     * @param \Zend_Db_Statement_Pdo|null $result
+     * @return void
+     */
+    public function beforeLogStats(LoggerProxy $subject, $type, $sql, $bind = [], $result = null)
+    {
+        $this->sentryPerformance->addSqlQuery($sql, $this->timer);
+    }
+}

Plugin/SampleRequest.php

@@ -0,0 +1,35 @@
+<?php
+
+namespace JustBetter\Sentry\Plugin;
+
+use JustBetter\Sentry\Model\SentryPerformance;
+use Magento\Framework\App\Request\Http;
+use Magento\Framework\App\ResponseInterface;
+
+/**
+ * Plugin to sample request and send them to Sentry
+ */
+class SampleRequest
+{
+    /** @var SentryPerformance */
+    private $sentryPerformance;
+
+    /** @var Http */
+    private $request;
+
+    public function __construct(SentryPerformance $sentryPerformance, Http $request)
+    {
+        $this->sentryPerformance = $sentryPerformance;
+        $this->request = $request;
+    }
+
+    /**
+     * Add our toolbar to the response.
+     *
+     * @param ResponseInterface $response
+     */
+    public function beforeSendResponse(ResponseInterface $response)
+    {
+        $this->sentryPerformance->finishTransaction($response);
+    }
+}

etc/adminhtml/system.xml

@@ -19,6 +19,10 @@
                     <label>Enable PHP Tracking</label>
                     <source_model>Magento\Config\Model\Config\Source\Yesno</source_model>
                 </field>
+                <field id="enable_performance_tracking" translate="label" type="select" sortOrder="20" showInDefault="1" showInWebsite="0" showInStore="0">
+                    <label>Enable Performance Tracking</label>
+                    <source_model>Magento\Config\Model\Config\Source\Yesno</source_model>
+                </field>
                 <field id="enable_script_tag" translate="label" type="select" sortOrder="20" showInDefault="1" showInWebsite="0" showInStore="0">
                     <label>Enable Javascript Tracking</label>
                     <source_model>Magento\Config\Model\Config\Source\Yesno</source_model>

etc/config.xml

@@ -4,6 +4,7 @@
         <sentry>
             <general>
                 <enable_php_tracking>1</enable_php_tracking>
+                <enable_performance_tracking>0</enable_performance_tracking>
                 <enable_script_tag>0</enable_script_tag>
                 <script_tag_placement>before.body.end</script_tag_placement>
                 <use_logrocket>0</use_logrocket>

etc/frontend/di.xml

@@ -0,0 +1,18 @@
+<?xml version="1.0"?>
+<config xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="urn:magento:framework:ObjectManager/etc/config.xsd">
+
+    <type name="Magento\Framework\App\ResponseInterface">
+        <plugin name="JustBetter\Sentry\Plugin\SampleRequest"
+                type="JustBetter\Sentry\Plugin\SampleRequest"
+                sortOrder="99"
+        />
+    </type>
+
+    <type name="Magento\Framework\DB\Logger\LoggerProxy">
+        <plugin name="JustBetter\Sentry\Plugin\LoggerProxyPlugin"
+                type="JustBetter\Sentry\Plugin\LoggerProxyPlugin"
+                sortOrder="99"
+        />
+    </type>
+
+</config>

etc/frontend/events.xml

@@ -0,0 +1,6 @@
+<?xml version="1.0"?>
+<config xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="urn:magento:framework:Event/etc/events.xsd">
+    <event name="controller_action_predispatch">
+        <observer name="SentryPredispatch" instance="JustBetter\Sentry\Observer\ControllerActionPredispatchObserver" />
+    </event>
+</config>