PHP Airbrake 项目技术文档
1. 安装指南
使用 Composer 安装
推荐使用 Composer 来安装 PHP Airbrake 库。在项目的根目录下,编辑 composer.json 文件,添加以下内容:
{
"require": {
"dbtlr/php-airbrake": "~1.1"
}
}
然后在命令行中执行以下命令:
curl -s http://getcomposer.org/installer | php
php composer.phar install
安装完成后,使用生成的 vendor/autoload.php 文件来自动加载库类。
2. 项目的使用说明
通过异常处理器使用
推荐通过错误和异常处理器来使用 PHP Airbrake,这样可以避免每次手动调用配置和客户端类。只需调用内置的错误处理器,并将 API 密钥传递给 start() 方法,如下所示:
<?php
require_once 'vendor/autoload.php';
Airbrake\EventHandler::start('[your api key]');
可选地,您可以将第二个参数设置为 TRUE,以启用警告级别消息的日志记录。默认情况下,此功能是禁用的,因为它可能会被认为过于冗长,具体取决于代码库的质量。还可以传递一个选项数组作为第三个参数,该数组将加载许多常见的配置选项。
直接调用使用
如果直接调用类而不是通过异常处理器,可以按如下方式进行:
<?php
require_once 'vendor/autoload.php';
$apiKey = '[your api key]'; // 这是必需的
$options = array(); // 这是可选的
$config = new Airbrake\Configuration($apiKey, $options);
$client = new Airbrake\Client($config);
// 发送错误消息
$client->notifyOnError('My error message');
// 发送捕获的异常
try {
throw new Exception('This is my exception');
} catch (Exception $exception) {
$client->notifyOnException($exception);
}
选项数组可以包含配置选项部分的数据,如果您想覆盖一些默认选项,可以填充该数组。否则,可以忽略它。
3. 项目API使用文档
配置选项
- timeout:默认值为 2,表示服务在放弃之前等待的时间。应设置为一个合理的限制,以避免在失败时页面加载时间过长。
- environmentName:默认值为 'production'。可以更改为与您正在工作的环境匹配,以帮助防止日志中充满非生产环境的问题。
- serverData:默认值为
$_SERVER数组,但可以用任何数据数组覆盖。 - getData:默认值为
$_GET数组。 - postData:默认值为
$_POST数组。 - sessionData:默认值为
$_SESSION数组。 - component:运行的组件或控制器的名称。
- action:调用的操作的名称。
- projectRoot:默认值为文档根目录。可能需要根据应用程序的上下文进行更改。
- url:请求的主 URL。
- hostname:请求的主机名。
- secure:可选 - 布尔值,允许您定义是否要使用安全的 Airbrake 端点。
- errorReportingLevel:可选 - 与
error_reportingphp.ini 设置功能相同(此设置应用于EventHandler::start方法上的show warnings参数之上)。 - proxyHost:可选的 HTTP 代理主机,所有连接将通过该主机发送。
- proxyPort:HTTP 代理端口(仅在提供
proxyHost时需要)。默认值为 80。 - proxyUser:HTTP 代理用户名(即使提供了
proxyHost,也可以选择)。 - proxyPass:HTTP 代理密码(仅在提供
proxyUser时需要)。
过滤器
您可以通过调用 addFilter 或 addFilters 方法向发送到 Airbrake 服务器的请求数据添加过滤器。默认情况下,过滤器通过表单的 name 属性定义。例如,如果您有一个表单如下:
<form method="post" action="/login">
<label for="username">Username</label>
<input id="username" name="user[email]" type="text" />
<label for="password">Password</label>
<input id="password" name="user[password]" type="password" />
</form>
您可以使用以下代码过滤掉所有用户详细信息:
<?php
$config = Airbrake\EventHandler::getClient()->getConfiguration();
$config->addFilter('user');
或者只过滤密码:
<?php
$config = Airbrake\EventHandler::getClient()->getConfiguration();
$config->addFilter('user[password]');
您还可以通过实现 Airbrake\Filter\FilterInterface 接口来定义自己的过滤器类。
4. 项目安装方式
通过 Composer 安装
如前所述,推荐使用 Composer 来安装 PHP Airbrake 库。编辑 composer.json 文件并执行安装命令即可完成安装。
手动安装
如果您不使用 Composer,也可以手动下载库文件并将其包含在项目中。不过,这种方式不推荐,因为手动管理依赖关系较为繁琐。
通过以上文档,您应该能够顺利安装和使用 PHP Airbrake 项目,并了解如何配置和使用其 API。
PaddleOCR-VLPaddleOCR-VL 是一款顶尖且资源高效的文档解析专用模型。其核心组件为 PaddleOCR-VL-0.9B,这是一款精简却功能强大的视觉语言模型(VLM)。该模型融合了 NaViT 风格的动态分辨率视觉编码器与 ERNIE-4.5-0.3B 语言模型,可实现精准的元素识别。Python00- DDeepSeek-OCR暂无简介Python00
openPangu-Ultra-MoE-718B-V1.1昇腾原生的开源盘古 Ultra-MoE-718B-V1.1 语言模型Python00
HunyuanWorld-Mirror混元3D世界重建模型,支持多模态先验注入和多任务统一输出Python00
AI内容魔方AI内容专区,汇集全球AI开源项目,集结模块、可组合的内容,致力于分享、交流。03
Spark-Scilit-X1-13BFLYTEK Spark Scilit-X1-13B is based on the latest generation of iFLYTEK Foundation Model, and has been trained on multiple core tasks derived from scientific literature. As a large language model tailored for academic research scenarios, it has shown excellent performance in Paper Assisted Reading, Academic Translation, English Polishing, and Review Generation, aiming to provide efficient and accurate intelligent assistance for researchers, faculty members, and students.Python00
GOT-OCR-2.0-hf阶跃星辰StepFun推出的GOT-OCR-2.0-hf是一款强大的多语言OCR开源模型,支持从普通文档到复杂场景的文字识别。它能精准处理表格、图表、数学公式、几何图形甚至乐谱等特殊内容,输出结果可通过第三方工具渲染成多种格式。模型支持1024×1024高分辨率输入,具备多页批量处理、动态分块识别和交互式区域选择等创新功能,用户可通过坐标或颜色指定识别区域。基于Apache 2.0协议开源,提供Hugging Face演示和完整代码,适用于学术研究到工业应用的广泛场景,为OCR领域带来突破性解决方案。00- HHowToCook程序员在家做饭方法指南。Programmer's guide about how to cook at home (Chinese only).Dockerfile013
Spark-Chemistry-X1-13B科大讯飞星火化学-X1-13B (iFLYTEK Spark Chemistry-X1-13B) 是一款专为化学领域优化的大语言模型。它由星火-X1 (Spark-X1) 基础模型微调而来,在化学知识问答、分子性质预测、化学名称转换和科学推理方面展现出强大的能力,同时保持了强大的通用语言理解与生成能力。Python00- PpathwayPathway is an open framework for high-throughput and low-latency real-time data processing.Python00