Add cookbook page about sentry integration #134
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Co-authored-by: Sergei Predvoditelev <[email protected]>
Member
Author
I haven't tried this service. |
Member
|
@xepozz I did. It is 100% compatible. |
samdark
reviewed
Oct 24, 2021
samdark
added
status:under development
Member
Author
|
@samdark merge? |
Member
Author
|
Oh looks config package was modified from article writing date. I will check one more time and back. |
Member
|
@xepozz any updates? |
Member
|
This one should be updated/merged. Can do translation later. |
Member
Author
Oh sorry I meant this line |
diff --git c/cookbook/en/README.md i/cookbook/en/README.md index 7d4ad10..6e50ac3 100644 --- c/cookbook/en/README.md +++ i/cookbook/en/README.md @@ -12,10 +12,6 @@ This book conforms to the [Terms of Yii Documentation](https://www.yiiframework. --- -[Preface](preface.md) - -## Getting started - -## Organizing code - +- [Preface](preface.md) - [Structuring code by use-case with vertical slices](organizing-code/structuring-by-use-case-with-vertical-slices.md) +- [Sentry integration](sentry-integration.md) diff --git c/cookbook/en/sentry-integration.md i/cookbook/en/sentry-integration.md new file mode 100644 index 0000000..67fec61 --- /dev/null +++ i/cookbook/en/sentry-integration.md @@ -0,0 +1,117 @@ +# Sentry Integration + +## What is Sentry + +[Sentry](https://sentry.io/) is a tool for monitoring and debugging application stability and performance. +Sentry gives you access to the events that you send there from your application. + +Most often, Sentry is used for monitoring errors (exceptions). +You can enrich errors with context to better understand the problem: +- Request arguments +- Tags for grouping exceptions +- Environment state: environment variables, application state, and other global attributes + +You can find the full list of features on the official website: https://sentry.io/welcome/ + +## Installation + +### Install the package + +Install the required package `yiisoft/yii-sentry` with the following command: + +```shell +composer require yiisoft/yii-sentry --prefer-dist +``` + +### Install an HTTP driver + +The [`getsentry/sentry-php`](https://github.com/getsentry/sentry-php) library requires the `php-http/httplug` package and any HTTP driver. +In the example below we’ll use the Guzzle adapter. + +> You can find the list of all adapters on [this page](https://docs.php-http.org/en/latest/clients.html#clients-adapters). + +To install the packages, run the following command: + +```shell +composer require php-http/httplug php-http/guzzle7-adapter --prefer-dist +``` + +## Configuration + +### Get and store the token + +Next, configure the application. + +First, register at [Sentry](https://sentry.io) and create a project. + +Then, in the project settings on the “General Settings” tab, find the “Security Token” field and copy its value. + +Now put this token into the package configuration. By default, the config is located at `config/packages/yiisoft/yii-sentry/config/params.php`. +Set the copied token as the value of the array element at `yiisoft/yii-sentry` => `options` => `dsn`. Example: + +```diff +'yiisoft/yii-sentry' => [ + 'enabled' => true, + 'options' => [ +- 'dsn' => '', ++ 'dsn' => 'TOKEN', + ], +], +``` + +### Configure the HTTP client + +After installing the HTTP client, configure it. + +Create the file `config/common/sentry.php` and put the following code into it: + +```php +<?php + +declare(strict_types=1); + +return [ + \Http\Client\HttpClient::class => \GuzzleHttp\Client::class, + \Http\Client\HttpAsyncClient::class => [ + 'class' => \Http\Adapter\Guzzle7\Client::class, + '__construct()' => [ + \Yiisoft\Factory\Definition\Reference::to(\Http\Client\HttpClient::class), + ], + ], +]; +``` + +# Integration + +### Web + +Sentry support for `web` is implemented as middleware. + +That means you only need to add `SentryMiddleware` to the global middleware list in `config/web/application.php`: + +```diff +return [ + Yiisoft\Yii\Web\Application::class => [ + '__construct()' => [ + 'dispatcher' => DynamicReference::to(static function (Injector $injector) { + return ($injector->make(MiddlewareDispatcher::class)) + ->withMiddlewares( + [ + Router::class, + SubFolder::class, ++ SentryMiddleware::class, + ErrorCatcher::class, + ] + ); + }), + 'fallbackHandler' => Reference::to(NotFoundHandler::class), + ], + ], +]; +``` + +### Console + +Sentry supports `console` via a handler for the [ConsoleEvents::ERROR](https://symfony.com/doc/current/components/console/events.html#the-consoleevents-error-event) event. + +The package provides a configuration file that automatically subscribes the application to this event. diff --git c/cookbook/ru/README.md i/cookbook/ru/README.md index 87d1f5b..1a24a7d 100644 --- c/cookbook/ru/README.md +++ i/cookbook/ru/README.md @@ -9,8 +9,5 @@ --- -Оглавление ---------------- - [Вступление](preface.md) [Интеграция с Sentry](sentry-integration.md)
samdark
approved these changes
Aug 26, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Added cookbook page about integration with Sentry.
Todo: