Fix #4 #6 #7 - Monolog 2 and optimize for Sentry 2.2.1

Also improves the doc

Author: B-Galati

Makefile

@@ -15,7 +15,7 @@ composer.lock: composer.json
 
 .PHONY: tests-ci tests
 tests-ci: composer-validate phpstan phpunit
-tests: tests-ci cs-check
+tests: tests-ci cs-check ## Run all tests
 
 .PHONY: composer-validate
 composer-validate: vendor composer.json composer.lock ## Validate composer.json file

README.md

@@ -11,7 +11,8 @@ It is a [Monolog](https://github.com/Seldaek/monolog) handler for Sentry PHP SDK
 - Send each log record to a [Sentry](https://sentry.io) server
 - Send log records as breadcrumbs when they are handled in batch; the main reported log record is the one with the highest log level
 - Send log along with exception when one is set in the main log record context 
-- Workaround for [an issue](https://github.com/getsentry/sentry-php/issues/811) that prevents sending logs in long running process
+- Compatible with Monolog 1 and 2
+- ~~Workaround for [an issue](https://github.com/getsentry/sentry-php/issues/811) that prevents sending logs in long running process~~
 
 ## Requirements
 
@@ -46,6 +47,15 @@ $logger->error('Bar');
 
 Check out the [handler constructor](src/SentryHandler.php) to know how to control the minimum logging level and bubbling.
 
+>:information_source:
+>
+>- It is a good idea to combine this handler with a `FingersCrossedHandler` and a `BufferHandler` 
+>to leverage Sentry breadcrumbs. It gives maximum context for each Sentry event and prevents slowing down http requests.
+>- Beware of issue [getsentry/sentry-php#878](https://github.com/getsentry/sentry-php/issues/878) that can be solved by
+>using another HTTP client
+>
+>Check out the symfony guide for a complete example that address all these points
+
 ## Documentation
 
 - [Symfony guide](doc/guide-symfony.md): it gives a way to integrate this handler to your app
@@ -57,7 +67,7 @@ Check out the [handler constructor](src/SentryHandler.php) to know how to contro
 It is pretty much the same thing but this one captures Monolog records as breadcrumbs 
 when flushing in batch.
 
-It provides a workaround for [issue 811](https://github.com/getsentry/sentry-php/issues/811) which prevents sending events to Sentry in long running process.
+~~It provides a workaround for [issue getsentry/sentry-php#811](https://github.com/getsentry/sentry-php/issues/811) which prevents sending events to Sentry in long running process.~~
 
 Breadcrumbs support has been proposed in a pull request that has been refused for good reasons that
 can be checked in the [PR](https://github.com/getsentry/sentry-php/pull/844). Basically the official one aims to be as simple as possible. 

composer.json

@@ -29,10 +29,11 @@
     },
     "require": {
         "php": "^7.1.3",
-        "monolog/monolog": "^1.6",
-        "sentry/sentry": "^2.1"
+        "monolog/monolog": "^1.6 || ^2.0",
+        "sentry/sentry": "^2.2.1"
     },
     "require-dev": {
+        "coduo/php-matcher": "^3.2",
         "friendsofphp/php-cs-fixer": "^2.15",
         "jangregor/phpstan-prophecy": "^0.4.2",
         "phpstan/phpstan": "^0.11.13",

doc/guide-symfony.md

@@ -1,17 +1,18 @@
 # Symfony guide
 
->ℹ️
+>:information_source:
 >
 >- It was written for Symfony 4.
 >- Its main purpose is to give ideas of how to integrate this handler in a Symfony project
 
 This guide proposed an opinionated solution to integrate Sentry in a Symfony project.
 It uses a `FingersCrossedHandler` with a `BufferHandler` to leverage Sentry breadcrumbs 
-in order to give maximum context for each Sentry event.
+in order to give maximum context for each Sentry event. It also prevents slowing down http requests.
 
 It provides the following benefits:
 
 - Flexibility: it's your code at the end so you can customize it to fit your project needs
+- Resolve issue [getsentry/sentry-php#878](https://github.com/getsentry/sentry-php/issues/878)
 - Log Monolog records of the request lifecycle (Handled message for Messenger) in Sentry breadcrumbs
 - Configure Sentry app path and excluded paths (cache and vendor)
 - Resolve log PSR placeholders
@@ -41,16 +42,34 @@ It provides the following benefits:
 
 ## Step 1: Configure Sentry Hub
 
+Symfony http client is required:
+
+```
+composer require symfony/http-client
+```
+
 Let's configure the Sentry Hub with a factory. It gives full flexibility in terms of configuration.
 
 ```php
 <?php
 
 use App\Kernel;
+use Http\Client\Exception\NetworkException;
+use Http\Client\Exception\RequestException;
+use Http\Client\HttpAsyncClient;
+use Http\Client\Promise\HttpFulfilledPromise;
+use Http\Client\Promise\HttpRejectedPromise;
+use Nyholm\Psr7\Factory\Psr17Factory;
+use Psr\Http\Client\NetworkExceptionInterface;
+use Psr\Http\Client\RequestExceptionInterface;
+use Psr\Http\Message\RequestInterface;
 use Sentry\ClientBuilder;
 use Sentry\Integration\RequestIntegration;
+use Sentry\SentrySdk;
 use Sentry\State\Hub;
 use Sentry\State\HubInterface;
+use Symfony\Component\HttpClient\HttpClient;
+use Symfony\Component\HttpClient\Psr18Client;
 
 class SentryFactory
 {
@@ -69,6 +88,7 @@ class SentryFactory
             'prefixes'             => [$projectRoot],
             'release'              => $release,
             'default_integrations' => false,
+            'send_attempts'        => 1,
             'tags'                 => [
                 'php_uname'       => \PHP_OS,
                 'php_sapi_name'   => \PHP_SAPI,
@@ -78,14 +98,53 @@ class SentryFactory
             ],
         ]);
 
+        $clientBuilder->setHttpClient(new SentryHttpClient());
+
         // Enable Sentry RequestIntegration
         $options = $clientBuilder->getOptions();
-        $options->setIntegrations([new RequestIntegration($options)]);
+        $options->setIntegrations([new RequestIntegration()]);
 
         $client = $clientBuilder->getClient();
 
         // A global HubInterface must be set otherwise some feature provided by the SDK does not work as they rely on this global state
-        return Hub::setCurrent(new Hub($client));
+        return SentrySdk::setCurrentHub(new Hub($client));
+    }
+}
+
+/**
+ * @see https://github.com/symfony/symfony/blob/4.4/src/Symfony/Component/HttpClient/HttplugClient.php
+ *
+ * Beware of the following issue with the default HTTP that comes with the Sentry SDK
+ * @see https://github.com/getsentry/sentry-php/issues/878
+ */
+class SentryHttpClient implements HttpAsyncClient
+{
+    private $client;
+
+    public function __construct()
+    {
+        $factory = new Psr17Factory();
+
+        // DO NOT use the http client from Symfony or you could turn into an infinite loop depending on your monolog config and the if logging of HTTP request is enabled or not
+        $client = HttpClient::create(['timeout' => 2]);
+
+        $this->client = new Psr18Client($client, $factory, $factory);
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function sendAsyncRequest(RequestInterface $request)
+    {
+        try {
+            $response = $this->client->sendRequest($request);
+        } catch (RequestExceptionInterface $e) {
+            return new HttpRejectedPromise(new RequestException($e->getMessage(), $request, $e));
+        } catch (NetworkExceptionInterface $e) {
+            return new HttpRejectedPromise(new NetworkException($e->getMessage(), $request, $e));
+        }
+
+        return new HttpFulfilledPromise($response);
     }
 }
 ```

src/SentryHandler.php

@@ -8,11 +8,9 @@
 use Monolog\Handler\AbstractProcessingHandler;
 use Monolog\Logger;
 use Sentry\Breadcrumb;
-use Sentry\Client;
 use Sentry\Severity;
 use Sentry\State\HubInterface;
 use Sentry\State\Scope;
-use Sentry\Transport\HttpTransport;
 
 class SentryHandler extends AbstractProcessingHandler
 {
@@ -103,36 +101,6 @@ protected function write(array $record): void
 
             $this->hub->captureEvent($payload);
         });
-
-        $this->flushSentryEvents();
-    }
-
-    /**
-     * Block until all async events are processed for the HTTP transport.
-     *
-     * @see https://github.com/getsentry/sentry-php/issues/811
-     */
-    private function flushSentryEvents(): void
-    {
-        // Inspired by https://github.com/getsentry/sentry-laravel/blob/14e8bf07f4254f031db3e88096ed8a8959aa34c1/src/Sentry/Laravel/Integration.php#L94-L112
-        $client = $this->hub->getClient();
-
-        if (!$client instanceof Client) {
-            return;
-        }
-
-        $transportProperty = new \ReflectionProperty(Client::class, 'transport');
-        $transportProperty->setAccessible(true);
-
-        $transport = $transportProperty->getValue($client);
-
-        if ($transport instanceof HttpTransport) {
-            \Closure::bind(
-                function () {$this->cleanupPendingRequests(); },
-                $transport,
-                $transport
-            )();
-        }
     }
 
     /**