Init commit

Author: AlexeyShchetkin

.editorconfig

@@ -0,0 +1,15 @@
+root = true
+
+[*]
+charset = utf-8
+end_of_line = lf
+insert_final_newline = true
+indent_style = space
+indent_size = 4
+trim_trailing_whitespace = true
+
+[*.md]
+trim_trailing_whitespace = false
+
+[*.{yml,yaml,json}]
+indent_size = 2

.gitattributes

@@ -0,0 +1,10 @@
+* text=auto
+
+*.md diff=markdown
+*.php diff=php
+
+/tests export-ignore
+.editorconfig export-ignore
+.gitattributes export-ignore
+.gitignore export-ignore
+phpunit.xml export-ignore

.gitignore

@@ -0,0 +1,2 @@
+/.idea
+/vendor/

LICENSE

@@ -0,0 +1,54 @@
+# Laravel Http Client Logger
+
+Laravel Http Client Logger - library for logging connection/request/response actions for Laravel HTTP Client
+
+## Installation
+
+You can install the package via composer:
+
+```bash
+composer require alexeyshchetkin/laravel-http-client-logger
+```
+
+You can publish the config file with:
+
+```bash
+php artisan vendor:publish --provider="AlexeyShchetkin\LaravelHttpClientLogger\Providers\HttpClientLoggerServiceProvider" --tag="laravel-http-client-logger"
+```
+
+The contents of the published config file:
+
+```php
+return [
+    /*
+     * Channel name for logging
+     */
+    'channel_name' => 'external_requests',
+    /*
+     * Channel log level
+     */
+    'log_level' => 'info',
+    /*
+     * Channel configuration in Laravel style
+     */
+    'channel_configuration' => [
+        'driver' => 'daily',
+        'path' => storage_path('logs/external_requests.log'),
+        'formatter' => JsonFormatter::class,
+        'level' => env('LOG_LEVEL', 'info'),
+        'days' => 7,
+    ],
+    /*
+     * Http client events for logging (comment not needed, add own if needed)
+     */
+    'events' => [
+        ConnectionFailed::class => ConnectionFailedListener::class,
+        RequestSending::class => RequestSendingListener::class,
+        ResponseReceived::class => ResponseReceivedListener::class,
+    ],
+];
+```
+
+## License
+
+The MIT License (MIT).

README.md

@@ -0,0 +1,33 @@
+{
+  "name": "alexeyshchetkin/laravel-http-client-logger",
+  "version": "1.0",
+  "type": "library",
+  "require": {
+    "php": "^7|^8",
+    "illuminate/support": ">=8"
+  },
+  "license": "MIT",
+  "autoload": {
+    "psr-4": {
+      "AlexeyShchetkin\\LaravelHttpClientLogger\\": "src/"
+    }
+  },
+  "autoload-dev": {
+    "psr-4": {
+      "AlexeyShchetkin\\LaravelHttpClientLogger\\": "tests/"
+    }
+  },
+  "authors": [
+    {
+      "name": "Alexey Shchetkin",
+      "email": "[email protected]"
+    }
+  ],
+  "extra": {
+    "laravel": {
+      "providers": [
+        "AlexeyShchetkin\\LaravelHttpClientLogger\\Providers\\HttpClientLoggerServiceProvider"
+      ]
+    }
+  }
+}

composer.json

@@ -0,0 +1,38 @@
+<?php
+
+use AlexeyShchetkin\LaravelHttpClientLogger\Listeners\ConnectionFailedListener;
+use AlexeyShchetkin\LaravelHttpClientLogger\Listeners\RequestSendingListener;
+use AlexeyShchetkin\LaravelHttpClientLogger\Listeners\ResponseReceivedListener;
+use Illuminate\Http\Client\Events\ConnectionFailed;
+use Illuminate\Http\Client\Events\RequestSending;
+use Illuminate\Http\Client\Events\ResponseReceived;
+use Monolog\Formatter\JsonFormatter;
+
+return [
+    /*
+     * Channel name for logging
+     */
+    'channel_name' => 'external_requests',
+    /*
+     * Channel log level
+     */
+    'log_level' => 'info',
+    /*
+     * Channel configuration in Laravel style
+     */
+    'channel_configuration' => [
+        'driver' => 'daily',
+        'path' => storage_path('logs/external_requests.log'),
+        'formatter' => JsonFormatter::class,
+        'level' => env('LOG_LEVEL', 'info'),
+        'days' => 7,
+    ],
+    /*
+     * Http client events for logging (comment not needed, add own if needed)
+     */
+    'events' => [
+        ConnectionFailed::class => ConnectionFailedListener::class,
+        RequestSending::class => RequestSendingListener::class,
+        ResponseReceived::class => ResponseReceivedListener::class,
+    ],
+];

config/laravel_http_client_logger.php

@@ -0,0 +1,44 @@
+<?php
+
+declare(strict_types=1);
+
+namespace AlexeyShchetkin\LaravelHttpClientLogger\Listeners;
+
+use Illuminate\Http\Client\Events\ConnectionFailed;
+use Illuminate\Http\Client\Request;
+use Illuminate\Support\Facades\Log;
+use AlexeyShchetkin\LaravelHttpClientLogger\ValueObjects\HttpClientLoggerConfiguration;
+
+class ConnectionFailedListener
+{
+    private HttpClientLoggerConfiguration $configuration;
+
+    public function __construct(HttpClientLoggerConfiguration $configuration)
+    {
+        $this->configuration = $configuration;
+    }
+
+    public function handle(ConnectionFailed $event)
+    {
+        $request = $event->request;
+        rescue(
+            fn() => Log::channel($this->configuration->getChannelName())->log(
+                $this->configuration->getLogLevel(),
+                'Connection failed for url: ' . $request->url(),
+                $this->generateLogMessage($request),
+            )
+        );
+    }
+
+    private function generateLogMessage(Request $request): array
+    {
+        return [
+            'url' => $request->url(),
+            'method' => $request->method(),
+            'request' => [
+                'headers' => $request->headers(),
+                'payload' => $request->data(),
+            ],
+        ];
+    }
+}

src/Listeners/ConnectionFailedListener.php

@@ -0,0 +1,45 @@
+<?php
+
+declare(strict_types=1);
+
+namespace AlexeyShchetkin\LaravelHttpClientLogger\Listeners;
+
+use Illuminate\Http\Client\Events\RequestSending;
+use Illuminate\Http\Client\Request;
+use Illuminate\Support\Facades\Log;
+use AlexeyShchetkin\LaravelHttpClientLogger\ValueObjects\HttpClientLoggerConfiguration;
+
+class RequestSendingListener
+{
+    private HttpClientLoggerConfiguration $configuration;
+
+    public function __construct(HttpClientLoggerConfiguration $configuration)
+    {
+        $this->configuration = $configuration;
+    }
+
+    public function handle(RequestSending $event)
+    {
+        $request = $event->request;
+
+        rescue(
+            fn() => Log::channel($this->configuration->getChannelName())->log(
+                $this->configuration->getLogLevel(),
+                'Request for url: ' . $request->url(),
+                $this->generateLogMessage($request),
+            )
+        );
+    }
+
+    private function generateLogMessage(Request $request): array
+    {
+        return [
+            'url' => $request->url(),
+            'method' => $request->method(),
+            'request' => [
+                'headers' => $request->headers(),
+                'payload' => $request->data(),
+            ],
+        ];
+    }
+}

src/Listeners/RequestSendingListener.php

@@ -0,0 +1,59 @@
+<?php
+
+declare(strict_types=1);
+
+namespace AlexeyShchetkin\LaravelHttpClientLogger\Listeners;
+
+use Illuminate\Http\Client\Events\ResponseReceived;
+use Illuminate\Http\Client\Request;
+use Illuminate\Http\Client\Response;
+use Illuminate\Support\Facades\Log;
+use AlexeyShchetkin\LaravelHttpClientLogger\ValueObjects\HttpClientLoggerConfiguration;
+
+class ResponseReceivedListener
+{
+    private HttpClientLoggerConfiguration $configuration;
+
+    public function __construct(HttpClientLoggerConfiguration $configuration)
+    {
+        $this->configuration = $configuration;
+    }
+
+    public function handle(ResponseReceived $event)
+    {
+        $request = $event->request;
+        $response = $event->response;
+
+        rescue(
+            fn() => Log::channel($this->configuration->getChannelName())->log(
+                $this->configuration->getLogLevel(),
+                'Response for url: ' . $request->url(),
+                $this->generateLogMessage($request, $response),
+            )
+        );
+    }
+
+    private function generateLogMessage(Request $request, Response $response): array
+    {
+        return [
+            'url' => $request->url(),
+            'method' => $request->method(),
+            'status' => $response->status(),
+            'request' => [
+                'headers' => $request->headers(),
+                'payload' => $request->data(),
+            ],
+            'response' => [
+                'headers' => $response->headers(),
+                'namelookup_time' => $response->handlerStats()['namelookup_time'],
+                'pretransfer_time' => $response->handlerStats()['pretransfer_time'],
+                'starttransfer_time' => $response->handlerStats()['starttransfer_time'],
+                'connect_time' => $response->handlerStats()['connect_time'],
+                'total_time' => $response->handlerStats()['total_time'],
+                'redirect_time' => $response->handlerStats()['redirect_time'],
+                'redirect_count' => $response->handlerStats()['redirect_count'],
+                'size_download' => $response->handlerStats()['size_download'],
+            ],
+        ];
+    }
+}