README

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

截图

安装

通过 Composer

composer require gluedev/laravel-stackdriver

并发布配置文件

php artisan vendor:publish --provider="GlueDev\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 GlueDev\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 Console，您应该开始看到日志、跟踪和错误出现。

批处理守护进程

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 来实现的。

就这样！

变更日志

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

致谢

许可

有关更多信息，请参阅许可文件。

gluedev / laravel-stackdriver

维护者

详细信息