despatchcloudturkey/logging-api-laravel

Logging API 的 Laravel 桥接器。

v1.0.1 2024-08-30 22:53 UTC

This package is auto-updated.

Last update: 2024-09-30 23:08:13 UTC


README

要求

  • Laravel 7.x 或 8.x

安装

将依赖项添加到您的项目中。

composer require despatchcloudturkey/logging-api-laravel

将您的应用程序 API 凭据设置到您的 .env 文件中。

LOGGING_API_URL=http://your-logging-api-server.com
LOGGING_API_KEY=your-api-key

如果您使用与 Logging API 服务器一起的 VPC(本地网络),您可以使用私有 URL 环境。

LOGGING_API_PRIVATE_URL=http://127.0.0.1:3001

用法

存储日志

您可以在没有 ID 的情况下创建日志。Logging API 会为您的日志内容分配唯一的 ID(127 个字符)。此函数将返回此 ID 作为 string

$id = LoggingAPI::store('my log file content is here');

带 ID 存储日志

您可以使用特定的 ID 参数创建日志。

LoggingAPI::store('John want to go.', '123ABC');

上传日志文件

您可以将日志文件作为文件上传到 Logging API。

$id = LoggingAPI::upload('/path/of/my/file/'); // without ID
LoggingAPI::upload('/path/of/my/file/', 'my-id'); // with ID

获取日志内容

您可以将日志内容作为字符串获取。

$contents = LoggingAPI::get('123ABC');

响应日志文件

您可以使用记录的内容/文件创建响应。

return LoggingAPI::response('my-id);

删除日志文件

您可以在 Logging API 中删除日志文件。

LoggingAPI::delete('123ABC');

由 Despatch Cloud 创建。