bug #33241 [Monolog] Fixed ElasticsearchLogstashHandler with monolog …

…2+ (lyrixx)

This PR was merged into the 4.4 branch.

Discussion
----------

[Monolog] Fixed ElasticsearchLogstashHandler with monolog 2+

| Q             | A
| ------------- | ---
| Branch?       | master
| Bug fix?      | yes
| New feature?  | no
| BC breaks?    | no
| Deprecations? | no
| Tests pass?   | yes
| Fixed tickets | -
| License       | MIT
| Doc PR        | -

Commits
-------

1f4ca61 [Monolog] Fixed ElasticsearchLogstashHandler with monolog 2+

src/Symfony/Bridge/Monolog/Handler/ElasticsearchLogstashHandler.php

@@ -39,6 +39,9 @@
  */
 class ElasticsearchLogstashHandler extends AbstractHandler
 {
+    use ProcessableHandlerTrait;
+    use FormattableHandlerTrait;
+
     private $endpoint;
     private $index;
     private $client;
@@ -79,7 +82,13 @@ public function handleBatch(array $records): void
 
     protected function getDefaultFormatter(): FormatterInterface
     {
-        return new LogstashFormatter('application', null, null, 'ctxt_', LogstashFormatter::V1);
+        // Monolog 1.X
+        if (\defined(LogstashFormatter::class.'::V1')) {
+            return new LogstashFormatter('application', null, null, 'ctxt_', LogstashFormatter::V1);
+        }
+
+        // Monolog 2.X
+        return new LogstashFormatter('application');
     }
 
     private function sendToElasticsearch(array $records)

src/Symfony/Bridge/Monolog/Handler/FormattableHandlerTrait.php

@@ -0,0 +1,73 @@
+<?php
+
+/*
+ * This file is part of the Symfony package.
+ *
+ * (c) Fabien Potencier <fabien@symfony.com>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+/*
+ * This file is part of the Monolog package.
+ *
+ * (c) Jordi Boggiano <j.boggiano@seld.be>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Symfony\Bridge\Monolog\Handler;
+
+use Monolog\Formatter\FormatterInterface;
+use Monolog\Formatter\LineFormatter;
+
+/**
+ * Helper trait for implementing FormattableInterface.
+ *
+ * @author Jordi Boggiano <j.boggiano@seld.be>
+ *
+ * @internal
+ */
+trait FormattableHandlerTrait
+{
+    /**
+     * @var FormatterInterface
+     */
+    protected $formatter;
+
+    /**
+     * {@inheritdoc}
+     *
+     * @suppress PhanTypeMismatchReturn
+     */
+    public function setFormatter(FormatterInterface $formatter): HandlerInterface
+    {
+        $this->formatter = $formatter;
+
+        return $this;
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function getFormatter(): FormatterInterface
+    {
+        if (!$this->formatter) {
+            $this->formatter = $this->getDefaultFormatter();
+        }
+
+        return $this->formatter;
+    }
+
+    /**
+     * Gets the default formatter.
+     *
+     * Overwrite this if the LineFormatter is not a good default for your handler.
+     */
+    protected function getDefaultFormatter(): FormatterInterface
+    {
+        return new LineFormatter();
+    }
+}

src/Symfony/Bridge/Monolog/Handler/ProcessableHandlerTrait.php

@@ -0,0 +1,74 @@
+<?php
+
+/*
+ * This file is part of the Symfony package.
+ *
+ * (c) Fabien Potencier <fabien@symfony.com>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Symfony\Bridge\Monolog\Handler;
+
+use Monolog\ResettableInterface;
+
+/**
+ * Helper trait for implementing ProcessableInterface.
+ *
+ * @author Jordi Boggiano <j.boggiano@seld.be>
+ *
+ * @internal
+ */
+trait ProcessableHandlerTrait
+{
+    /**
+     * @var callable[]
+     */
+    protected $processors = [];
+
+    /**
+     * {@inheritdoc}
+     *
+     * @suppress PhanTypeMismatchReturn
+     */
+    public function pushProcessor($callback): HandlerInterface
+    {
+        array_unshift($this->processors, $callback);
+
+        return $this;
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function popProcessor(): callable
+    {
+        if (!$this->processors) {
+            throw new \LogicException('You tried to pop from an empty processor stack.');
+        }
+
+        return array_shift($this->processors);
+    }
+
+    /**
+     * Processes a record.
+     */
+    protected function processRecord(array $record): array
+    {
+        foreach ($this->processors as $processor) {
+            $record = $processor($record);
+        }
+
+        return $record;
+    }
+
+    protected function resetProcessors()
+    {
+        foreach ($this->processors as $processor) {
+            if ($processor instanceof ResettableInterface) {
+                $processor->reset();
+            }
+        }
+    }
+}

src/Symfony/Bridge/Monolog/Tests/Handler/ElasticsearchLogstashHandlerTest.php

@@ -27,11 +27,17 @@ public function testHandle()
         $responseFactory = function ($method, $url, $options) use (&$callCount) {
             $body = <<<EOBODY
 {"index":{"_index":"log","_type":"_doc"}}
-{"@timestamp":"2020-01-01T00:00:00.000000+01:00","@version":1,"host":"my hostname","message":"My info message","type":"application","channel":"app","level":"INFO"}
+{"@timestamp":"2020-01-01T00:00:00.000000+01:00","@version":1,"host":"my hostname","message":"My info message","type":"application","channel":"app","level":"INFO","monolog_level":200}
 
 
 EOBODY;
 
+            // Monolog 1X
+            if (\defined(LogstashFormatter::class.'::V1')) {
+                $body = str_replace(',"monolog_level":200', '', $body);
+                $body = str_replace(',"monolog_level":300', '', $body);
+            }
+
             $this->assertSame('POST', $method);
             $this->assertSame('http://es:9200/_bulk', $url);
             $this->assertSame($body, $options['body']);
@@ -64,14 +70,20 @@ public function testBandleBatch()
         $responseFactory = function ($method, $url, $options) use (&$callCount) {
             $body = <<<EOBODY
 {"index":{"_index":"log","_type":"_doc"}}
-{"@timestamp":"2020-01-01T00:00:00.000000+01:00","@version":1,"host":"my hostname","message":"My info message","type":"application","channel":"app","level":"INFO"}
+{"@timestamp":"2020-01-01T00:00:00.000000+01:00","@version":1,"host":"my hostname","message":"My info message","type":"application","channel":"app","level":"INFO","monolog_level":200}
 
 {"index":{"_index":"log","_type":"_doc"}}
-{"@timestamp":"2020-01-01T00:00:01.000000+01:00","@version":1,"host":"my hostname","message":"My second message","type":"application","channel":"php","level":"WARNING"}
+{"@timestamp":"2020-01-01T00:00:01.000000+01:00","@version":1,"host":"my hostname","message":"My second message","type":"application","channel":"php","level":"WARNING","monolog_level":300}
 
 
 EOBODY;
 
+            // Monolog 1X
+            if (\defined(LogstashFormatter::class.'::V1')) {
+                $body = str_replace(',"monolog_level":200', '', $body);
+                $body = str_replace(',"monolog_level":300', '', $body);
+            }
+
             $this->assertSame('POST', $method);
             $this->assertSame('http://es:9200/_bulk', $url);
             $this->assertSame($body, $options['body']);
@@ -114,6 +126,12 @@ class ElasticsearchLogstashHandlerWithHardCodedHostname extends ElasticsearchLog
 {
     protected function getDefaultFormatter(): FormatterInterface
     {
-        return new LogstashFormatter('application', 'my hostname', null, 'ctxt_', LogstashFormatter::V1);
+        // Monolog 1.X
+        if (\defined(LogstashFormatter::class.'::V1')) {
+            return new LogstashFormatter('application', 'my hostname', null, 'ctxt_', LogstashFormatter::V1);
+        }
+
+        // Monolog 2.X
+        return new LogstashFormatter('application', 'my hostname');
     }
 }