Use correlation id from butler-audit when logging to Graylog.

Use the correlation-id published by butler-audit when logging
to graylog to allow for grouping all graylog entries originating
from the same request.

This change is made to be able to trace requests between systems.

CHANGELOG.md

@@ -7,6 +7,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## Changed
+- Use the correlation id from butler-audit when logging to graylog to enable tracing requests/executions into graylog.
 
 ## [0.6.1] - 2021-02-18
 

src/Logging/GraylogLoggerFactory.php

@@ -2,10 +2,10 @@
 
 namespace Butler\Service\Logging;
 
+use Butler\Audit\Facades\Auditor;
 use Gelf\Publisher;
 use Gelf\Transport\IgnoreErrorTransportWrapper;
 use Gelf\Transport\UdpTransport;
-use Illuminate\Support\Str;
 use Monolog\Formatter\GelfMessageFormatter;
 use Monolog\Handler\GelfHandler;
 use Monolog\Logger;
@@ -18,7 +18,7 @@ class GraylogLoggerFactory
     public function __invoke(array $config): Logger
     {
         $transport = new IgnoreErrorTransportWrapper(
-            new UdpTransport($config['host'], $config['port'])
+            app()->makeWith(UdpTransport::class, ['host' => $config['host'], 'port' => $config['port']])
         );
 
         $handler = new GelfHandler(new Publisher($transport));
@@ -27,7 +27,7 @@ public function __invoke(array $config): Logger
             ->setFormatter(new GelfMessageFormatter())
             ->pushProcessor(function ($record) use ($config) {
                 $record['extra'][$config['name_key']] = $config['name'];
-                $record['extra']['trace_id'] = (string) Str::uuid(12);
+                $record['extra']['trace_id'] = Auditor::correlationId();
                 return $record;
             });
 

tests/Unit/GraylogLoggerFactoryTest.php

@@ -0,0 +1,41 @@
+<?php
+
+namespace Butler\Service\Tests\Unit;
+
+use Butler\Audit\Facades\Auditor;
+use Butler\Service\Logging\GraylogLoggerFactory;
+use Butler\Service\Tests\TestCase;
+use Gelf\Message;
+use Gelf\Transport\UdpTransport;
+use Mockery;
+
+class GraylogLoggerFactoryTest extends TestCase
+{
+    public function test_correctly_uses_configuration_and_correlation_id_from_container()
+    {
+        Auditor::correlationId('example-correlation-id');
+
+        app()->bind(UdpTransport::class, function () {
+            $transport = Mockery::mock(UdpTransport::class);
+            $transport->expects()->send(
+                Mockery::on(function (Message $message) {
+                    return $message->getShortMessage() === 'Testing'
+                        && $message->getAdditional('trace_id') === 'example-correlation-id'
+                        && $message->getAdditional('service') === 'butler-service';
+                })
+            );
+            return $transport;
+        });
+
+        $config = [
+            'name' => 'butler-service',
+            'name_key' => 'service',
+            'host' => '127.0.0.1',
+            'port' => 12201,
+        ];
+
+        $factory = new GraylogLoggerFactory($config);
+        $logger = $factory($config);
+        $logger->info('Testing');
+    }
+}