Merge pull request #2 from philkra/dedot-labels-key

sanitize labels issue #1

Author: philkra

src/Elastic/Monolog/Formatter/ElasticCommonSchemaFormatter.php

@@ -87,7 +87,10 @@ public function format(array $record): string
 
         // Add ECS Labels
         if (empty($record['context']) === false) {
-            $message['labels'] = $record['context'];
+            $message['labels'] = [];
+            foreach ($record['context'] as $key => $val) {
+                $message['labels'][str_replace(['.', ' '], '_', trim($key))] = $val;
+            }
         }
 
         // Add ECS Tags

tests/Elastic/BaseTestCase.php

@@ -41,5 +41,4 @@ protected function generateException() : Throwable
     {
         return new InvalidArgumentException('This is a InvalidArgumentException', 42);
     }
-
 }

tests/Elastic/Monolog/Formatter/ElasticCommonSchemaFormatterTest.php

@@ -246,4 +246,40 @@ public function testNormalizeException()
         $this->assertArrayNotHasKey('labels', $decoded);
     }
 
+    /**
+     * @depends testFormat
+     *
+     * @covers Elastic\Monolog\Formatter\ElasticCommonSchemaFormatter::__construct
+     * @covers Elastic\Monolog\Formatter\ElasticCommonSchemaFormatter::format
+     */
+    public function testSanitizeOfLabelKeys()
+    {
+        $msg = [
+            'level'      => Logger::NOTICE,
+            'level_name' => 'NOTICE',
+            'channel'    => 'ecs',
+            'datetime'   => new \DateTimeImmutable("@0"),
+            'message'    => md5(uniqid()),
+            'context'    => [
+                'sim ple' => 'sim_ple',
+                ' lpad'   => 'lpad',
+                'rpad '   => 'rpad',
+                'foo.bar' => 'foo_bar',
+                'a.b.c'   => 'a_b_c',
+                '.hello'  => '_hello',
+                'lorem.'  => 'lorem_',
+            ],
+            'extra'      => [],
+        ];
+
+        $formatter = new ElasticCommonSchemaFormatter();
+        $doc = $formatter->format($msg);
+        $decoded = json_decode($doc, true);
+
+        $this->assertArrayHasKey('labels', $decoded);
+        foreach ($msg['context'] as $keyPrevious => $keySanitized) {
+            $this->assertArrayNotHasKey($keyPrevious, $decoded['labels'], $keyPrevious);
+            $this->assertArrayHasKey($keySanitized, $decoded['labels'], $keySanitized);
+        }
+    }
 }