https://github.com/punktde/sentry-flow
Sentry client package for the Flow framework
https://github.com/punktde/sentry-flow
flowframework sentry
Last synced: 7 months ago
JSON representation
Sentry client package for the Flow framework
- Host: GitHub
- URL: https://github.com/punktde/sentry-flow
- Owner: punktDe
- License: other
- Created: 2018-01-15T11:04:47.000Z (about 8 years ago)
- Default Branch: master
- Last Pushed: 2024-06-05T10:17:09.000Z (over 1 year ago)
- Last Synced: 2024-10-12T05:13:29.740Z (over 1 year ago)
- Topics: flowframework, sentry
- Language: PHP
- Homepage:
- Size: 50.8 KB
- Stars: 4
- Watchers: 8
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# [PunktDe.Sentry.Flow](https://github.com/punktDe/sentry-flow)
[](https://packagist.org/packages/punktDe/sentry-flow) [](https://packagist.org/packages/punktDe/sentry-flow) [](https://packagist.org/packages/punktDe/sentry-flow)
This is a Sentry client package for the Flow framework.
Have a look at https://sentry.io for more information about Sentry.
## Installation
```
$ composer require punktde/sentry-flow
```
### Compatibilty matrix
| Flow Sentry Client | Flow | Sentry SDK | Sentry Server |
|--------------------|------------------|------------|---------------|
| ^1.0 | ^4.0 | ^1.0 | * |
| ^2.0 | ^5.0 | ^1.0 | * |
| ^3.0 | ^5.0, ^6.0 | ^2.0 | * |
| ^4.0 | ^5.0 - ^8.0 | ^3.0 | >= v20.6.0 |
| ^5.0 | ^5.0 - ^9.0 | ^4.0 | >= v20.6.0 |
## Configuration
Add the following to your `Settings.yaml` and replace the `dsn` setting with your project DSN (API Keys in your Sentry project):
```yaml
PunktDe:
Sentry:
Flow:
dsn: 'https://public_key@your-sentry-server.com/project-id'
```
You can also set the Sentry Environment to filter your exceptions by e.g. dev-/staging-/live-system.
Set the env variable `SENTRY_ENVIRONMENT` or add your value to your `Settings.yaml`:
```yaml
PunktDe:
Sentry:
Flow:
environment: 'live'
```
Furthermore you can set the Sentry Release version to help to identifiy with which release an error occurred the first time.
By default, a file which is starting with the name `RELEASE_` is searched and the values after `RELEASE_` is used for Sentry.
Alternatively you can override the filebased release number and set an environment variable `SENTRY_RELEASE` or add your value to your `Settings.yaml`:
```yaml
PunktDe:
Sentry:
Flow:
release: '5.0.3'
```
If you need to use a custom transport e.g. to write the sentry reports to a file, you must implement the `Sentry\TransportInterface`:
```php
getId();
}
return null;
}
}
```
Then you configure the class to be used:
```yaml
PunktDe:
Sentry:
Flow:
transportClass: '\Vendor\Package\Sentry\Transport\FileWriterTransport'
```
## Usage
Sentry will log all exceptions that have the rendering option `logException` enabled. This can be enabled or disabled
by status code or exception class according to the Flow configuration.