README

用于在所有层中利用 sentry 进行 PHP 级别错误记录的 spryker 包

安装

通过 composer 安装

$ composer require basecom/spryker-sentry

集成

1. 将 Basecom 添加到 config_default.php 中的命名空间

$config[KernelConstants::CORE_NAMESPACES][] = 'Basecom';

1. 将相应的 SentryApplicationPlugin 添加到您想要将错误记录到 sentry 的每一层

Glue

将 SentryApplicationPlugin 添加到 Pyz\Glue\GlueApplication\GlueApplicationDependencyProvider

    protected function getApplicationPlugins(): array
    {
        return [
            ...
            new Basecom\Glue\Sentry\Plugin\Application\SentryApplicationPlugin(),
        ];
    }

Zed

将 SentryApplicationPlugin 添加到 Pyz\Zed\Application\ApplicationDependencyProvider

    protected function getApplicationPlugins(): array
    {
        return [
            ...
            new Basecom\Zed\Sentry\Communication\Plugin\Application\SentryApplicationPlugin(),
        ];
    }

Yves

将 SentryApplicationPlugin 添加到 Pyz\Yves\ShopApplication\ShopApplicationDependencyProvider

    protected function getApplicationPlugins(): array
    {
        return [
            ...
            new Basecom\Yves\Sentry\Plugin\Application\SentryApplicationPlugin(),
        ];
    }

控制台 / CLI

将 SentryConsolePlugin 添加到 Pyz\Zed\Console\ConsoleDependencyProvider

    public function getEventSubscriber(Container $container)
    {
        $eventSubscriber = parent::getEventSubscriber($container);
        ...
        $eventSubscriber[] = new SentryConsolePlugin();

        return $eventSubscriber;
    }

配置

在 config_*.php 中配置 sentry 记录器

<?php

use Basecom\Shared\Sentry\SentryConstants;

...

// full sentry DSN. if empty, sentry logging is disabled in this config / environment
$config[SentryConstants::SENTRY_DSN] = 'https://###@###.ingest.sentry.io/###';

// set alternative environment names (per Layer), defaults to $APPLICATION_ENV when not set
$config[SentryConstants::SENTRY_ENVIRONMENT_ZED] = 'stage_zed';
$config[SentryConstants::SENTRY_ENVIRONMENT_GLUE] = 'stage_glue';
$config[SentryConstants::SENTRY_ENVIRONMENT_YVES] = 'stage_yves';
$config[SentryConstants::SENTRY_ENVIRONMENT_CONSOLE] = 'stage_console';

// error types which should be logged
$config[SentryConstants::SENTRY_ERROR_TYPES] = E_ALL ^ E_DEPRECATED ^ E_USER_DEPRECATED