Implementation of optional sentry tracing with twig

.github/workflows/tests.yaml

@@ -104,7 +104,7 @@ jobs:
           restore-keys: ${{ runner.os }}-${{ matrix.php }}-composer-${{ matrix.dependencies }}-
 
       - name: Remove optional packages
-        run: composer remove doctrine/dbal doctrine/doctrine-bundle symfony/messenger --dev --no-update
+        run: composer remove doctrine/dbal doctrine/doctrine-bundle symfony/messenger symfony/twig-bundle --dev --no-update
 
       - name: Install highest dependencies
         run: composer update --no-progress --no-interaction --prefer-dist

CHANGELOG.md

@@ -2,6 +2,7 @@
 
 ## Unreleased
 
+- Add support for distributed tracing of Twig template rendering (#430)
 - Add support for distributed tracing of SQL queries while using Doctrine DBAL (#426)
 - Added missing `capture-soft-fails` config schema option (#417)
 - Deprecate the `Sentry\SentryBundle\EventListener\ConsoleCommandListener` class in favor of its parent class `Sentry\SentryBundle\EventListener\ConsoleListener` (#429)

Makefile

@@ -15,7 +15,7 @@ psalm:
 test:
 	vendor/bin/phpunit
 
-pre-commit-check: cs phpstan test
+pre-commit-check: cs phpstan psalm test
 
 setup-git:
 	git config branch.autosetuprebase always

composer.json

@@ -23,13 +23,13 @@
         "jean85/pretty-package-versions": "^1.5 || ^2.0",
         "php-http/discovery": "^1.11",
         "sentry/sdk": "^3.1",
-        "symfony/config": "^3.4.44||^4.4.11||^5.0.11",
-        "symfony/console": "^3.4.44||^4.4.11||^5.0.11",
-        "symfony/dependency-injection": "^3.4.44||^4.4.11||^5.0.11",
-        "symfony/event-dispatcher": "^3.4.44||^4.4.11||^5.0.11",
-        "symfony/http-kernel": "^3.4.44||^4.4.11||^5.0.11",
+        "symfony/config": "^3.4.44||^4.4.12||^5.0.11",
+        "symfony/console": "^3.4.44||^4.4.12||^5.0.11",
+        "symfony/dependency-injection": "^3.4.44||^4.4.12||^5.0.11",
+        "symfony/event-dispatcher": "^3.4.44||^4.4.12||^5.0.11",
+        "symfony/http-kernel": "^3.4.44||^4.4.12||^5.0.11",
         "symfony/psr-http-message-bridge": "^2.0",
-        "symfony/security-core": "^3.4.44||^4.4.11||^5.0.11"
+        "symfony/security-core": "^3.4.44||^4.4.12||^5.0.11"
     },
     "require-dev": {
         "doctrine/dbal": "^2.10||^3.0",
@@ -46,16 +46,18 @@
         "symfony/browser-kit": "^3.4.44||^4.4.12||^5.0.11",
         "symfony/dom-crawler": "^3.4.44||^4.4.12||^5.0.11",
         "symfony/framework-bundle": "^3.4.44||^4.4.12||^5.0.11",
-        "symfony/messenger": "^4.4.11||^5.0.11",
+        "symfony/messenger": "^4.4.12||^5.0.11",
         "symfony/monolog-bundle": "^3.4",
         "symfony/phpunit-bridge": "^5.0",
         "symfony/polyfill-php80": "^1.22",
-        "symfony/yaml": "^3.4.44||^4.4.11||^5.0.11",
+        "symfony/twig-bundle": "^3.4.44||^4.4.12||^5.0.11",
+        "symfony/yaml": "^3.4.44||^4.4.12||^5.0.11",
         "vimeo/psalm": "^4.3"
     },
     "suggest": {
         "monolog/monolog": "Allow sending log messages to Sentry by using the included Monolog handler.",
-        "doctrine/doctrine-bundle": "Allow distributed tracing of database queries using Sentry."
+        "doctrine/doctrine-bundle": "Allow distributed tracing of database queries using Sentry.",
+        "symfony/twig-bundle": "Allow distributed tracing of Twig template rendering using Sentry."
     },
     "autoload": {
         "files": [

phpstan-baseline.neon

@@ -219,4 +219,3 @@ parameters:
 			message: "#^Trying to mock an undefined method convertException\\(\\) on class Sentry\\\\SentryBundle\\\\Tests\\\\Tracing\\\\Doctrine\\\\DBAL\\\\StubExceptionConverterDriverInterface\\.$#"
 			count: 1
 			path: tests/Tracing/Doctrine/DBAL/TracingDriverTest.php
-

phpstan.neon

@@ -11,3 +11,5 @@ parameters:
     dynamicConstantNames:
         - Symfony\Component\HttpKernel\Kernel::VERSION
         - Doctrine\DBAL\Version::VERSION
+    stubFiles:
+        - tests/Stubs/Profile.phpstub

psalm.xml

@@ -13,4 +13,8 @@
             <directory name="vendor" />
         </ignoreFiles>
     </projectFiles>
+
+    <stubs>
+        <file name="tests/Stubs/Profile.phpstub"/>
+    </stubs>
 </psalm>

src/DependencyInjection/Configuration.php

@@ -163,6 +163,9 @@ private function addDistributedTracingSection(ArrayNodeDefinition $rootNode): vo
                                 ->end()
                             ->end()
                         ->end()
+                        ->arrayNode('twig')
+                            ->canBeEnabled()
+                        ->end()
                     ->end()
                 ->end()
             ->end();

src/DependencyInjection/SentryExtension.php

@@ -19,6 +19,7 @@
 use Sentry\SentryBundle\SentryBundle;
 use Sentry\SentryBundle\Tracing\Doctrine\DBAL\ConnectionConfigurator;
 use Sentry\SentryBundle\Tracing\Doctrine\DBAL\TracingDriverMiddleware;
+use Sentry\SentryBundle\Tracing\Twig\TwigTracingExtension;
 use Sentry\Serializer\RepresentationSerializer;
 use Sentry\Serializer\Serializer;
 use Sentry\Transport\TransportFactoryInterface;
@@ -62,6 +63,7 @@ protected function loadInternal(array $mergedConfig, ContainerBuilder $container
         $this->registerErrorListenerConfiguration($container, $mergedConfig);
         $this->registerMessengerListenerConfiguration($container, $mergedConfig['messenger']);
         $this->registerTracingConfiguration($container, $mergedConfig['tracing']);
+        $this->registerTracingTwigExtensionConfiguration($container, $mergedConfig['tracing']);
     }
 
     /**
@@ -173,6 +175,18 @@ private function registerTracingConfiguration(ContainerBuilder $container, array
         }
     }
 
+    /**
+     * @param array<string, mixed> $config
+     */
+    private function registerTracingTwigExtensionConfiguration(ContainerBuilder $container, array $config): void
+    {
+        $isConfigEnabled = $this->isConfigEnabled($container, $config['twig']);
+
+        if (!$isConfigEnabled) {
+            $container->removeDefinition(TwigTracingExtension::class);
+        }
+    }
+
     /**
      * @param string[]             $integrations
      * @param array<string, mixed> $config

src/Resources/config/schema/sentry-1.0.xsd

@@ -84,6 +84,7 @@
     <xsd:complexType name="tracing">
         <xsd:choice maxOccurs="unbounded">
             <xsd:element name="dbal" type="tracing-dbal" minOccurs="0" maxOccurs="1" />
+            <xsd:element name="twig" type="tracing-twig" minOccurs="0" maxOccurs="1" />
         </xsd:choice>
     </xsd:complexType>
 
@@ -94,4 +95,8 @@
 
         <xsd:attribute name="enabled" type="xsd:boolean" />
     </xsd:complexType>
+
+    <xsd:complexType name="tracing-twig">
+        <xsd:attribute name="enabled" type="xsd:boolean" />
+    </xsd:complexType>
 </xsd:schema>

src/Resources/config/services.xml

@@ -73,6 +73,12 @@
             <argument type="service" id="Sentry\SentryBundle\Tracing\Doctrine\DBAL\TracingDriverMiddleware" />
         </service>
 
+        <service id="Sentry\SentryBundle\Tracing\Twig\TwigTracingExtension" class="Sentry\SentryBundle\Tracing\Twig\TwigTracingExtension">
+            <argument type="service" id="Sentry\State\HubInterface" />
+
+            <tag name="twig.extension" />
+        </service>
+
         <service id="Sentry\Integration\RequestFetcherInterface" class="Sentry\SentryBundle\Integration\RequestFetcher">
             <argument type="service" id="Symfony\Component\HttpFoundation\RequestStack" />
             <argument type="service" id="Symfony\Bridge\PsrHttpMessage\HttpMessageFactoryInterface" on-invalid="null" />

src/Tracing/Twig/TwigTracingExtension.php

@@ -0,0 +1,102 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Sentry\SentryBundle\Tracing\Twig;
+
+use Sentry\State\HubInterface;
+use Sentry\Tracing\Span;
+use Sentry\Tracing\SpanContext;
+use SplObjectStorage;
+use Twig\Extension\AbstractExtension;
+use Twig\Profiler\NodeVisitor\ProfilerNodeVisitor;
+use Twig\Profiler\Profile;
+
+final class TwigTracingExtension extends AbstractExtension
+{
+    /**
+     * @var HubInterface The current hub
+     */
+    private $hub;
+
+    /**
+     * @var SplObjectStorage<object, Span> The currently active spans
+     */
+    private $spans;
+
+    /**
+     * @param HubInterface $hub The current hub
+     */
+    public function __construct(HubInterface $hub)
+    {
+        $this->hub = $hub;
+        $this->spans = new SplObjectStorage();
+    }
+
+    /**
+     * This method is called before the execution of a block, a macro or a
+     * template.
+     *
+     * @param Profile $profile The profiling data
+     */
+    public function enter(Profile $profile): void
+    {
+        $transaction = $this->hub->getTransaction();
+
+        if (null === $transaction) {
+            return;
+        }
+
+        $spanContext = new SpanContext();
+        $spanContext->setOp('view.render');
+        $spanContext->setDescription($this->getSpanDescription($profile));
+
+        $this->spans[$profile] = $transaction->startChild($spanContext);
+    }
+
+    /**
+     * This method is called when the execution of a block, a macro or a
+     * template is finished.
+     *
+     * @param Profile $profile The profiling data
+     */
+    public function leave(Profile $profile): void
+    {
+        if (!isset($this->spans[$profile])) {
+            return;
+        }
+
+        $this->spans[$profile]->finish();
+
+        unset($this->spans[$profile]);
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function getNodeVisitors(): array
+    {
+        return [
+            new ProfilerNodeVisitor(self::class),
+        ];
+    }
+
+    /**
+     * Gets a short description for the span.
+     *
+     * @param Profile $profile The profiling data
+     */
+    private function getSpanDescription(Profile $profile): string
+    {
+        switch (true) {
+            case $profile->isRoot():
+                return $profile->getName();
+
+            case $profile->isTemplate():
+                return $profile->getTemplate();
+
+            default:
+                return sprintf('%s::%s(%s)', $profile->getTemplate(), $profile->getType(), $profile->getName());
+        }
+    }
+}

tests/DependencyInjection/ConfigurationTest.php

@@ -41,6 +41,9 @@ public function testProcessConfigurationWithDefaultConfiguration(): void
                     'enabled' => false,
                     'connections' => class_exists(DoctrineBundle::class) ? ['%doctrine.default_connection%'] : [],
                 ],
+                'twig' => [
+                    'enabled' => false,
+                ],
             ],
         ];
 

tests/DependencyInjection/Fixtures/php/full.php

@@ -47,5 +47,8 @@
             'enabled' => false,
             'connections' => ['default'],
         ],
+        'twig' => [
+            'enabled' => false,
+        ],
     ],
 ]);

tests/DependencyInjection/Fixtures/php/twig_tracing_enabled.php

@@ -0,0 +1,14 @@
+<?php
+
+declare(strict_types=1);
+
+use Symfony\Component\DependencyInjection\ContainerBuilder;
+
+/** @var ContainerBuilder $container */
+$container->loadFromExtension('sentry', [
+    'tracing' => [
+        'twig' => [
+            'enabled' => true,
+        ],
+    ],
+]);

tests/DependencyInjection/Fixtures/xml/full.xml

@@ -41,6 +41,7 @@
             <sentry:dbal enabled="false">
                 <sentry:connection>default</sentry:connection>
             </sentry:dbal>
+            <sentry:twig enabled="false" />
         </sentry:tracing>
     </sentry:config>
 </container>

tests/DependencyInjection/Fixtures/xml/twig_tracing_enabled.xml

@@ -0,0 +1,14 @@
+<?xml version="1.0" ?>
+
+<container xmlns="http://symfony.com/schema/dic/services"
+           xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+           xmlns:sentry="https://sentry.io/schema/dic/sentry-symfony"
+           xsi:schemaLocation="http://symfony.com/schema/dic/services https://symfony.com/schema/dic/services/services-1.0.xsd
+                               https://sentry.io/schema/dic/sentry-symfony https://sentry.io/schema/dic/sentry-symfony/sentry-1.0.xsd">
+
+    <sentry:config>
+        <sentry:tracing>
+            <sentry:twig enabled="true" />
+        </sentry:tracing>
+    </sentry:config>
+</container>

tests/DependencyInjection/Fixtures/yml/full.yml

@@ -42,3 +42,5 @@ sentry:
             enabled: false
             connections:
                 - enabled
+        twig:
+            enabled: false

tests/DependencyInjection/Fixtures/yml/twig_tracing_enabled.yml

@@ -0,0 +1,4 @@
+sentry:
+    tracing:
+        twig:
+            enabled: true

tests/DependencyInjection/SentryExtensionTest.php

@@ -19,6 +19,7 @@
 use Sentry\SentryBundle\SentryBundle;
 use Sentry\SentryBundle\Tracing\Doctrine\DBAL\ConnectionConfigurator;
 use Sentry\SentryBundle\Tracing\Doctrine\DBAL\TracingDriverMiddleware;
+use Sentry\SentryBundle\Tracing\Twig\TwigTracingExtension;
 use Sentry\Serializer\RepresentationSerializer;
 use Sentry\Serializer\Serializer;
 use Sentry\Transport\TransportFactoryInterface;
@@ -286,6 +287,20 @@ public function testTracingDriverMiddlewareIsRemovedWhenDbalTracingIsDisabled():
         $this->assertEmpty($container->getParameter('sentry.tracing.dbal.connections'));
     }
 
+    public function testTwigTracingExtensionIsConfiguredWhenTwigTracingIsEnabled(): void
+    {
+        $container = $this->createContainerFromFixture('twig_tracing_enabled');
+
+        $this->assertTrue($container->hasDefinition(TwigTracingExtension::class));
+    }
+
+    public function testTwigTracingExtensionIsRemovedWhenTwigTracingIsDisabled(): void
+    {
+        $container = $this->createContainerFromFixture('full');
+
+        $this->assertFalse($container->hasDefinition(TwigTracingExtension::class));
+    }
+
     private function createContainerFromFixture(string $fixtureFile): ContainerBuilder
     {
         $container = new ContainerBuilder(new EnvPlaceholderParameterBag([

tests/Stubs/Profile.phpstub

@@ -0,0 +1,10 @@
+<?php
+
+namespace Twig\Profiler;
+
+/**
+ * @template-implements \IteratorAggregate<Profile, Profile>
+ */
+final class Profile implements \IteratorAggregate, \Serializable
+{
+}