joppedc/logsnag-php-sdk

Logsnag API的PHP集成

v1.0.2 2023-04-09 10:42 UTC

This package is auto-updated.

Last update: 2024-09-15 13:46:42 UTC


README

LogSnag

实时监控,覆盖整个业务。一个LogSnag PHP SDK。

Latest Stable Version Test License

非官方PHP SDK

入门

安装

要安装SDK,您需要在项目中使用Composer。有关安装说明,请参阅Composer文档

这是一个“核心”SDK,这意味着所有核心逻辑和模型都包含在其中。如果您愿意使用自己的HTTP客户端,可以像这样安装SDK:joppedc/logsnag-php-sdk

composer require joppedc/logsnag-php-sdk

此包(joppedc/logsnag-php-sdk)不依赖于任何特定的发送HTTP消息的库。相反,它使用Httplug,允许用户选择他们想要使用的任何PSR-7实现和HTTP客户端。

如果您想快速开始,应运行以下命令

composer require joppedc/logsnag-php-sdk php-http/curl-client

这将安装库本身以及一个使用cURL作为传输方法的HTTP客户端适配器(由Httplug提供)。如果您不想使用这些包,可以不使用。SDK不关心您想使用哪种传输方法,因为这只是您应用程序的实现细节。

配置

new JoppeDc\LogsnagPhpSdk\Client("your_secret_key");

用法

创建新的日志事件

$payload = new JoppeDc\LogsnagPhpSdk\Contracts\LogPayload(
    'project_name',
    'channel_name',
    'event_name'
);

$payload->setDescription('test-description');
$payload->setTags(['tag' => 'tag value']);
$payload->setIcon('😀');

$log = $this->client->createLog($payload);

创建新的洞察事件

$payload = new JoppeDc\LogsnagPhpSdk\Contracts\InsightPayload(
    'project_name',
    'title',
    5
);

$payload->setIcon('😀');

$insight = $this->client->createInsight($payload);

修改洞察事件

$payload = new JoppeDc\LogsnagPhpSdk\Contracts\MutateInsightPayload(
    'project_name',
    'title',
    -5
);

$payload->setIcon('😀');

$insight = $this->client->mutateInsight($payload);

特别感谢