rapid7/r7insight_php

与Insight平台一起使用的日志库

1.0.1 2020-07-13 09:38 UTC

This package is not auto-updated.

Last update: 2024-10-01 06:21:54 UTC


README

按照以下简单步骤,您可以将PHP应用程序日志发送到Insight平台。

Insight平台设置

在Insight平台上创建账户后,登录并使用“添加数据”页面中的“快速添加”选项添加新的日志,使用Token TCP选项。

将显示日志令牌和数据端点。
日志令牌是日志的唯一标识符,允许只写访问。请注意这些信息。

Composer安装

此软件包也可在Composer上找到。

您可以通过以下步骤安装此软件包

$ composer require rapid7/r7insight_php

参数设置

r7insight_php 文件夹内,打开 r7insight.php 并填写 LOG_TOKEN 参数。

LOG_TOKEN 是您之前从Insight平台UI复制的令牌,并将该记录器与Insight平台中的日志相关联。

REGION 字段中,输入区域代码 - 例如 useucaau 等。

您也可以使用具有相同名称的环境变量提供这两个参数 -- LOG_TOKENREGION

在您的PHP日志事件中添加自定义主机名和主机ID

为了设置一个自定义主机名,该主机名将作为键/值对出现在您的PHP日志事件中

r7insight_php 文件夹内,打开 r7insight.php 并按照以下方式填写参数

$HOST_NAME_ENABLED = true;

$HOST_NAME = "Custom_host_name_here";

$HOST_ID = "Custom_ID_here_12345";

$HOST_NAME 常量可以留为空字符串,库将自动尝试从您的本地主机机分配主机名并将其用作自定义主机名。

为了设置一个自定义主机ID,该主机ID将作为键/值对出现在您的PHP日志事件中:在 $HOST_ID = ""; 中输入一个值而不是空字符串。
如果没有设置 $HOST_ID 并且未更改空字符串,则PHP日志中不会出现主机ID或键/值对。

如果您想以JSON格式发送日志事件,则将 $USE_JSON 字段设置为 true。如果您将其设置为 false,则日志将以KVP(键值对)格式发送。

代码设置

现在您需要从GitHub下载/克隆库,并将其文件夹放置在您的应用程序目录中。

要在您的代码中使用它,请输入以下行,并根据需要更改放置位置。

require dirname(__FILE__) . './r7insight_php/r7insight.php';

// The following levels are available
$log->debug("Isn't that the fault of the voters?");
$log->info("That's because sometimes I go by my maiden name.");
$log->notice("Give me the strongest thing you got.");
$log->crit("Awfully big moustache.");
$log->error("Yeah, and when I find the guy that did it...");
$log->alert("That's ok. I sometimes go by my maiden name.");
$log->emerg("Every time I order out.");