emargareten/client-logger-laravel

在 Laravel 中记录 HTTP 客户端请求和响应

v0.0.4 2024-03-12 11:54 UTC

This package is auto-updated.

Last update: 2024-09-08 15:35:25 UTC


README

Latest Version on Packagist GitHub Tests Action Status GitHub Code Style Action Status Total Downloads

客户端日志记录器是一个为 Laravel 设计的日志 HTTP 客户端请求和响应的包。它易于使用,并提供高度的自定义化。

安装

要安装此包,请使用 composer

composer require emargareten/client-logger-laravel

用法

安装包后,您可以使用以下命令发布配置文件(可选)

php artisan vendor:publish --provider="Emargareten\ClientLogger\ClientLoggerServiceProvider"

该包向 PendingRequest 类添加了一个 log 方法。此方法可用于记录 HTTP 请求的请求和响应

use Illuminate\Support\Facades\Http;

$response = Http::log('Example message...')->get('https://example.com');

这将创建一个包含以下信息的日志条目(在上下文中)

  • method:请求的 HTTP 方法。
  • uri:请求的 URI。
  • headers:请求的头部。
  • payload:请求的有效负载。
  • response_status:响应的状态码。
  • response_headers:响应的头部。
  • response:响应的主体。

您还可以通过传递数组作为第二个参数来更改特定日志的配置

Http::log('Example message...', [
    'hidden_request_headers' => ['x-api-key'],
])->get('https://example.com');

以下是一些可用的配置选项

  • channel:用于日志的通道。
  • level:用于日志的级别(可以为每个状态码单独设置,或为特定状态码完全禁用)。
  • hidden_request_headers:应遮蔽在日志中的头部数组。
  • hidden_request_params:应遮蔽在日志中的请求参数数组。
  • hidden_response_headers:应遮蔽在日志中的头部数组。
  • hidden_response_params:应遮蔽在日志中的响应参数数组。

有关所有可用选项,请参阅 配置文件

测试

要运行测试,请使用以下命令

composer test

代码分析

要分析代码,请使用以下命令

composer analyse

代码格式化

要格式化代码,请使用以下命令

composer format

变更日志

请参阅 CHANGELOG 以获取有关最近更改的更多信息。

许可证

MIT 许可证 (MIT)。请参阅 许可证文件 以获取更多信息。