Sentry Laravel SDK 使用教程

1. 项目的目录结构及介绍

Sentry Laravel SDK 的目录结构如下：

sentry-laravel/
├── src/
│   ├── Integration.php
│   ├── LaravelIntegration.php
│   ├── SentryServiceProvider.php
│   └── ...
├── tests/
│   ├── IntegrationTest.php
│   ├── LaravelIntegrationTest.php
│   └── ...
├── composer.json
├── LICENSE
├── README.md
└── ...

目录结构介绍

• src/：包含 SDK 的主要源代码文件。
  • Integration.php：定义了 Sentry 集成的基础类。
  • LaravelIntegration.php：专门为 Laravel 框架定制的集成类。
  • SentryServiceProvider.php：Sentry 服务提供者，用于注册和配置 Sentry。
• tests/：包含 SDK 的测试文件。
  • IntegrationTest.php：集成测试文件。
  • LaravelIntegrationTest.php：针对 Laravel 集成的测试文件。
• composer.json：Composer 依赖管理文件。
• LICENSE：项目许可证文件。
• README.md：项目说明文档。

2. 项目的启动文件介绍

Sentry Laravel SDK 的启动文件主要涉及 SentryServiceProvider.php 文件。

SentryServiceProvider.php

该文件位于 src/ 目录下，主要负责在 Laravel 应用中注册和配置 Sentry。以下是关键代码片段：

namespace Sentry\Laravel;

use Illuminate\Support\ServiceProvider;
use Sentry\SentrySdk;
use Sentry\State\HubInterface;

class SentryServiceProvider extends ServiceProvider
{
    public function register()
    {
        $this->app->singleton(HubInterface::class, function ($app) {
            return SentrySdk::getCurrentHub();
        });
    }

    public function boot()
    {
        $this->publishes([
            __DIR__ . '/../config/sentry.php' => config_path('sentry.php'),
        ]);

        if ($this->app->runningInConsole()) {
            $this->commands([
                \Sentry\Laravel\Commands\Publish::class,
            ]);
        }
    }
}

功能介绍

• register() 方法：注册 Sentry 的单例实例。
• boot() 方法：发布配置文件并注册命令。

3. 项目的配置文件介绍

Sentry Laravel SDK 的配置文件为 config/sentry.php。

config/sentry.php

该文件包含了 Sentry 的所有配置选项。以下是部分配置示例：

return [
    'dsn' => env('SENTRY_LARAVEL_DSN', ''),
    'release' => env('SENTRY_RELEASE', null),
    'environment' => env('SENTRY_ENVIRONMENT', env('APP_ENV', 'production')),
    'breadcrumbs' => [
        'logs' => true,
        'sql_queries' => true,
        'sql_bindings' => true,
        'queue_info' => true,
        'command_info' => true,
    ],
    'tracing' => [
        'enabled' => true,
        'traces_sample_rate' => 1.0,
    ],
];

配置项介绍

• dsn：Sentry 的 DSN 地址，从环境变量中读取。
• release：应用的版本号。
• environment：应用的环境，如 production、staging 等。
• breadcrumbs：面包屑功能配置。
• tracing：追踪功能配置。

通过以上配置，可以灵活地调整 Sentry 在 Laravel 应用中的行为。