smoopins/laravel-stackdriver

该软件包已被废弃且不再维护。未建议替代软件包。

为Laravel框架启用对Google Stackdriver的日志记录、跟踪和错误报告,由GlueDev/laravel-stackdriver分支而来

v0.5.0 2022-03-29 01:37 UTC

README

从原始 GlueDev/laravel-stackdriver 分支而来

为Laravel启用对Google Stackdriver的日志记录、跟踪和错误报告。需要PHP >= 7.1

截图

Tracing Error reporting

安装

通过Composer

composer require smoopins/laravel-stackdriver

并发布配置文件

php artisan vendor:publish --provider="Smoopins\Laravel\Stackdriver\StackdriverServiceProvider"

使用

首先,您需要打开 config/stackdriver.php 文件。在这里,您可以看到有四个环境设置可供启用和禁用该软件包的不同功能

STACKDRIVER_ENABLED=false  
STACKDRIVER_LOGGING_ENABLED=true  
STACKDRIVER_TRACING_ENABLED=true
STACKDRIVER_ERROR_REPORTING_ENABLED=true

列出的第一个变量具有优先级。

身份验证

在撰写本文时,Google更喜欢您使用服务帐户进行身份验证。否则将抛出警告,您可以通过设置 SUPPRESS_GCLOUD_CREDS_WARNING=true 来禁用此警告(但可能不应该)

创建一个带有适当角色附加的服务帐户并将其添加到您的项目中。请确保不要将此文件提交到git,因为安全问题。然后,您可以在 keyFilePath 或在 STACKDRIVER_KEY_FILE_PATH 环境变量中指定服务帐户JSON文件的路径。

跟踪

跟踪需要安装OpenCencus模块。由于我们使用docker,这是我们的安装方式

RUN pecl install opencensus-alpha
RUN docker-php-ext-enable opencensus

请注意:如果您在安装OpenCencus扩展后遇到 opencensus.so: undefined symbol: ZVAL_DESTRUCTOR 错误,建议您按照 这些说明 自己构建扩展。

日志记录

除了更改配置文件中的值外,日志记录不需要额外的设置。

错误报告

错误报告需要您将以下内容添加到您的 Exceptions/handler.php 文件中的 report 函数

use Smoopins\Laravel\Stackdriver\StackdriverExceptionHandler;

/**  
 * Report or log an exception.
 *
 * @param \Exception  $exception  
 * @return void  
 */
public function report(Exception $exception)  
{  
    StackdriverExceptionHandler::report($exception);  
    parent::report($exception);  
}

登录到Google Cloud控制台,您应该开始看到日志、跟踪和错误出现。

批处理守护进程

Google还提供批处理守护进程,建议使用。我们没有看到在守护进程未运行时请求的响应时间慢的问题。运行守护进程的最简单方法是使用Supervisor。以下是一个供您编辑的示例配置

[program:google-batch-daemon]
command = php -d auto_prepend_file='' -d disable_functions='' /app/vendor/bin/google-cloud-batch daemon
process_name = %(program_name)s
user = application
numprocs = 1
autostart = true
autorestart = true
stdout_logfile = /dev/stdout
stdout_logfile_maxbytes = 0
stderr_logfile = /dev/stderr
stderr_logfile_maxbytes = 0

您还需要通知Google守护进程正在运行。这通过设置 IS_BATCH_DAEMON_RUNNING=true 来完成。

就是这样!

变更日志

有关最近更改的更多信息,请参阅 变更日志

鸣谢

  • [Diederik van den Burger][link-author]
  • [所有贡献者][link-contributors]

许可

请参阅许可文件获取更多信息。