From 908cb0ea768aacde6e97d4aa997a4ce4706676ef Mon Sep 17 00:00:00 2001 From: Oh My Felix Date: Mon, 6 Jul 2026 10:58:49 +0000 Subject: [PATCH 1/2] Docs: move documentation to README Co-authored-by: Felix --- .docs/README.md | 295 ---------------------------------------------- README.md | 304 ++++++++++++++++++++++++++++++++++++++++++++++-- 2 files changed, 295 insertions(+), 304 deletions(-) delete mode 100644 .docs/README.md diff --git a/.docs/README.md b/.docs/README.md deleted file mode 100644 index d5af8a9..0000000 --- a/.docs/README.md +++ /dev/null @@ -1,295 +0,0 @@ -# Contributte Sentry - -## Content - -- [Setup](#setup) -- [Configuration](#configuration) -- [Extra](#extra) -- [Usage](#usage) -- [Examples](#examples) - -## Setup - -Install composer package. - -```bash -composer require contributte/sentry -``` - -Register Nette extension. - -``` -extensions: - sentry: Contributte\Sentry\DI\SentryExtension -``` - -## Configuration - -Minimal configuration could look like this: - -```neon -sentry: - # Enabled only on production - enable: %productionMode% - - # Client configuration - client: - dsn: "https://{KEY1}@{KEY2}.ingest.sentry.io/{KEY3}" -``` - -Full configuration could look like this: - -```neon -sentry: - # Enable / disable on local or producation - enable: %productionMode% - - # Enable / disable build-in and Nette integrations - integrations: true - - # Sentry logger configuration - logger: - # Capture messages [Debugger::log("this is error")] - captureMessages: true - - # Capture levels [Debugger::log("this is error", "error")] - captureLevels: - # - debug - # - info - - warning - - error - - exception - - critical - - # Sentry client configuration - client: - - # Disable integrations in sentry.integrations if you want to override this list - integrations: [ - # Sentry - Sentry\Integration\EnvironmentIntegration() - Sentry\Integration\ErrorListenerIntegration() - Sentry\Integration\ExceptionListenerIntegration() - Sentry\Integration\FatalErrorListenerIntegration() - Sentry\Integration\FrameContextifierIntegration(null) - Sentry\Integration\ModulesIntegration() - Sentry\Integration\RequestIntegration(null) - Sentry\Integration\TransactionIntegration() - # Nette - Contributte\Sentry\Integration\NetteApplicationIntegration() - Contributte\Sentry\Integration\NetteSecurityIntegration() - Contributte\Sentry\Integration\NetteSessionIntegration() - Contributte\Sentry\Integration\ExtraIntegration([ - # version: %appVersion% - ]) - ] - default_integrations: false - send_attempts: 3 - prefixes: [%appDir%] - sample_rate: 1 - attach_stacktrace: true - context_lines: 6 - enable_compression: true - environment: local - logger: php - release: latest - dsn: "https://{KEY1}@{KEY2}.ingest.sentry.io/{KEY3}" - server_name: ::gethostname() - # before_send: () - tags: - # version: %appVersion% - error_types: 32767 # E_ALL - max_breadcrumbs: 100 - # before_breadcrumb: () - in_app_exclude: [] - send_default_pii: true - max_value_length: 1024 - http_proxy: null - capture_silenced_errors: false - max_request_body_size: always - class_serializers: [] - traces_sample_rate: 1 - - # The only way to customize client builder: - clientBuilder: - representationSerializer: @representationSerializer - logger: @representationSerializer - sdkIdentifier: foo - sdkVersion: 1.0 - transport: @transport -``` - -See more about configuration under key `sentry` in [official documentation](https://docs.sentry.io/platforms/php/). - -## Extra - -### Integrations - -> Read about integrations in [official Sentry documentation](https://docs.sentry.io/platforms/php/integrations/). - -Integrations are some kind of plugins for Sentry SDK. This package brings several integrations. - -**NetteApplicationIntegration** - -Add information about `nette/application` to Sentry event. - -```neon -sentry: - client: - integrations: - - Contributte\Sentry\Integration\NetteApplicationIntegration() -``` - -**NetteHttpIntegration** - -Add information about `nette/http` to Sentry event. It's preferred to use default integration (https://github.com/getsentry/sentry-php/blob/master/src/Integration/RequestIntegration.php). - -```neon -sentry: - client: - integrations: - - Contributte\Sentry\Integration\NetteHttpIntegration() -``` - -**NetteSecurityIntegration** - -Add information about `nette/security` to Sentry event. - -```neon -sentry: - client: - integrations: - - Contributte\Sentry\Integration\NetteSecurityIntegration() -``` - -**NetteSessionIntegration** - -Add information about `nette/session` to Sentry event. - -```neon -sentry: - client: - integrations: - - Contributte\Sentry\Integration\NetteSessionIntegration() -``` - -**ExtraIntegration** - -Add extra data to Sentry event. - -```neon -sentry: - client: - integrations: - - Contributte\Sentry\Integration\ExtraIntegration([ - version: %appVersion% - ]) -``` - -**IgnoreErrorIntegration** - -Allow to ignore exceptions or event message. - -```neon -sentry: - client: - integrations: - - Contributte\Sentry\Integration\IgnoreErrorIntegration([ - ignore_exception_instance: [ - FooException::class, - BarException::class, - ], - ignore_exception_regex: [ - '/Deprecated (.*)/' - ], - ignore_message_regex: [ - '/PHP Deprecated (.*)/' - ], - ]) -``` - -Be careful with `"` and `'`. It does matter. - -**S3UploadIntegration** - -Upload **ladenka** (error file) to S3. URL is stored as tag in Sentry. - -```neon -sentry: - client: - integrations: - - Contributte\Sentry\Integration\S3UploadIntegration() - -services: - - Contributte\Sentry\Upload\S3Uploader( - Contributte\Sentry\Upload\S3Signer( - accessKeyId: secret - secretKey: secret - url: myorg.r2.cloudflarestorage.com / s3.eu-central-1.amazonaws.com - bucket: mybucket - region: auto - prefix: null - ) - ) -``` - -### Performance - -> Read about performance tracking in [official Sentry documentation](https://docs.sentry.io/platforms/php/performance/). - -Performance monitors help you measure application spans. - -**NetteApplicationMonitor** - -Measure Nette Application lifecycle from request to shutdown. - -```neon -services: - - Contributte\Sentry\Performance\NetteApplicationMonitor - - application.application: - setup: - - @Contributte\Sentry\Performance\NetteApplicationMonitor::hook(@self, 'onRequest') - - @Contributte\Sentry\Performance\NetteApplicationMonitor::hook(@self, 'onShutdown') - # or - - "$onRequest[]" = [@Contributte\Sentry\Performance\NetteApplicationMonitor, onRequest] - - "$onShutdown[]" = [@Contributte\Sentry\Performance\NetteApplicationMonitor, onShutdown] -``` - -Don't forget to specify `traces_sample_rate` parameter, which means uniform sample rate for all transactions to a number between 0 and 1. -For example, to send 20% of transactions, set `traces_sample_rate` to `0.2`. - -```neon -sentry: - client: - # Trace every transaction, recommended for testing/dev - traces_sample_rate: 1 -``` - -## Usage - -Sentry is successfully integrated to your [Nette](https://nette.org) application and listen for any errors using [Tracy](https://tracy.nette.org). - -Let's test it using this smelling code. - -```php -contributte.org | Contact 👨🏻‍💻 f3l1x.io | Twitter 🐦 @contributte

-## Usage +# Contributte Sentry + +Sentry integration for Nette applications with Tracy logging, Nette context integrations, and performance monitoring helpers. + +## Versions + +| State | Version | Branch | Nette | PHP | +|-------------|---------|----------|-------|---------| +| dev | `^0.5` | `master` | 3.2+ | `>=8.2` | +| stable | `^0.4` | `master` | 3.2+ | `>=8.2` | + +## Contents + +- [Setup](#setup) +- [Configuration](#configuration) +- [Extra](#extra) +- [Usage](#usage) +- [Examples](#examples) + +## Setup -To install latest version of `contributte/sentry` use [Composer](https://getcomposer.org). +Install composer package. ```bash composer require contributte/sentry ``` -## Documentation +Register Nette extension. -For details on how to use this package, check out our [documentation](.docs). +``` +extensions: + sentry: Contributte\Sentry\DI\SentryExtension +``` -## Versions +## Configuration -| State | Version | Branch | Nette | PHP | -|-------------|---------|----------|-------|---------| -| dev | `^0.5` | `master` | 3.2+ | `>=8.2` | -| stable | `^0.4` | `master` | 3.2+ | `>=8.2` | +Minimal configuration could look like this: + +```neon +sentry: + # Enabled only on production + enable: %productionMode% + + # Client configuration + client: + dsn: "https://{KEY1}@{KEY2}.ingest.sentry.io/{KEY3}" +``` + +Full configuration could look like this: + +```neon +sentry: + # Enable / disable on local or producation + enable: %productionMode% + + # Enable / disable build-in and Nette integrations + integrations: true + + # Sentry logger configuration + logger: + # Capture messages [Debugger::log("this is error")] + captureMessages: true + + # Capture levels [Debugger::log("this is error", "error")] + captureLevels: + # - debug + # - info + - warning + - error + - exception + - critical + + # Sentry client configuration + client: + + # Disable integrations in sentry.integrations if you want to override this list + integrations: [ + # Sentry + Sentry\Integration\EnvironmentIntegration() + Sentry\Integration\ErrorListenerIntegration() + Sentry\Integration\ExceptionListenerIntegration() + Sentry\Integration\FatalErrorListenerIntegration() + Sentry\Integration\FrameContextifierIntegration(null) + Sentry\Integration\ModulesIntegration() + Sentry\Integration\RequestIntegration(null) + Sentry\Integration\TransactionIntegration() + # Nette + Contributte\Sentry\Integration\NetteApplicationIntegration() + Contributte\Sentry\Integration\NetteSecurityIntegration() + Contributte\Sentry\Integration\NetteSessionIntegration() + Contributte\Sentry\Integration\ExtraIntegration([ + # version: %appVersion% + ]) + ] + default_integrations: false + send_attempts: 3 + prefixes: [%appDir%] + sample_rate: 1 + attach_stacktrace: true + context_lines: 6 + enable_compression: true + environment: local + logger: php + release: latest + dsn: "https://{KEY1}@{KEY2}.ingest.sentry.io/{KEY3}" + server_name: ::gethostname() + # before_send: () + tags: + # version: %appVersion% + error_types: 32767 # E_ALL + max_breadcrumbs: 100 + # before_breadcrumb: () + in_app_exclude: [] + send_default_pii: true + max_value_length: 1024 + http_proxy: null + capture_silenced_errors: false + max_request_body_size: always + class_serializers: [] + traces_sample_rate: 1 + + # The only way to customize client builder: + clientBuilder: + representationSerializer: @representationSerializer + logger: @representationSerializer + sdkIdentifier: foo + sdkVersion: 1.0 + transport: @transport +``` + +See more about configuration under key `sentry` in [official documentation](https://docs.sentry.io/platforms/php/). + +## Extra + +### Integrations + +> Read about integrations in [official Sentry documentation](https://docs.sentry.io/platforms/php/integrations/). + +Integrations are some kind of plugins for Sentry SDK. This package brings several integrations. + +**NetteApplicationIntegration** + +Add information about `nette/application` to Sentry event. + +```neon +sentry: + client: + integrations: + - Contributte\Sentry\Integration\NetteApplicationIntegration() +``` + +**NetteHttpIntegration** + +Add information about `nette/http` to Sentry event. It's preferred to use default integration (https://github.com/getsentry/sentry-php/blob/master/src/Integration/RequestIntegration.php). + +```neon +sentry: + client: + integrations: + - Contributte\Sentry\Integration\NetteHttpIntegration() +``` + +**NetteSecurityIntegration** + +Add information about `nette/security` to Sentry event. + +```neon +sentry: + client: + integrations: + - Contributte\Sentry\Integration\NetteSecurityIntegration() +``` + +**NetteSessionIntegration** + +Add information about `nette/session` to Sentry event. + +```neon +sentry: + client: + integrations: + - Contributte\Sentry\Integration\NetteSessionIntegration() +``` + +**ExtraIntegration** + +Add extra data to Sentry event. + +```neon +sentry: + client: + integrations: + - Contributte\Sentry\Integration\ExtraIntegration([ + version: %appVersion% + ]) +``` + +**IgnoreErrorIntegration** + +Allow to ignore exceptions or event message. + +```neon +sentry: + client: + integrations: + - Contributte\Sentry\Integration\IgnoreErrorIntegration([ + ignore_exception_instance: [ + FooException::class, + BarException::class, + ], + ignore_exception_regex: [ + '/Deprecated (.*)/' + ], + ignore_message_regex: [ + '/PHP Deprecated (.*)/' + ], + ]) +``` + +Be careful with `"` and `'`. It does matter. + +**S3UploadIntegration** + +Upload **ladenka** (error file) to S3. URL is stored as tag in Sentry. + +```neon +sentry: + client: + integrations: + - Contributte\Sentry\Integration\S3UploadIntegration() + +services: + - Contributte\Sentry\Upload\S3Uploader( + Contributte\Sentry\Upload\S3Signer( + accessKeyId: secret + secretKey: secret + url: myorg.r2.cloudflarestorage.com / s3.eu-central-1.amazonaws.com + bucket: mybucket + region: auto + prefix: null + ) + ) +``` + +### Performance + +> Read about performance tracking in [official Sentry documentation](https://docs.sentry.io/platforms/php/performance/). + +Performance monitors help you measure application spans. + +**NetteApplicationMonitor** + +Measure Nette Application lifecycle from request to shutdown. + +```neon +services: + - Contributte\Sentry\Performance\NetteApplicationMonitor + + application.application: + setup: + - @Contributte\Sentry\Performance\NetteApplicationMonitor::hook(@self, 'onRequest') + - @Contributte\Sentry\Performance\NetteApplicationMonitor::hook(@self, 'onShutdown') + # or + - "$onRequest[]" = [@Contributte\Sentry\Performance\NetteApplicationMonitor, onRequest] + - "$onShutdown[]" = [@Contributte\Sentry\Performance\NetteApplicationMonitor, onShutdown] +``` + +Don't forget to specify `traces_sample_rate` parameter, which means uniform sample rate for all transactions to a number between 0 and 1. +For example, to send 20% of transactions, set `traces_sample_rate` to `0.2`. + +```neon +sentry: + client: + # Trace every transaction, recommended for testing/dev + traces_sample_rate: 1 +``` + +## Usage + +Sentry is successfully integrated to your [Nette](https://nette.org) application and listen for any errors using [Tracy](https://tracy.nette.org). + +Let's test it using this smelling code. + +```php + Date: Tue, 7 Jul 2026 17:04:15 +0000 Subject: [PATCH 2/2] Docs: polish README migration --- README.md | 48 +++++++++++++++++++++++------------------------- 1 file changed, 23 insertions(+), 25 deletions(-) diff --git a/README.md b/README.md index 0b5e6a8..25f94d6 100644 --- a/README.md +++ b/README.md @@ -18,8 +18,6 @@ Website 🚀 contributte.org | Contact 👨🏻‍💻 f3l1x.io | Twitter 🐦 @contributte

-# Contributte Sentry - Sentry integration for Nette applications with Tracy logging, Nette context integrations, and performance monitoring helpers. ## Versions @@ -31,13 +29,13 @@ Sentry integration for Nette applications with Tracy logging, Nette context inte ## Contents -- [Setup](#setup) +- [Installation](#installation) - [Configuration](#configuration) - [Extra](#extra) - [Usage](#usage) - [Examples](#examples) -## Setup +## Installation Install composer package. @@ -70,10 +68,10 @@ Full configuration could look like this: ```neon sentry: - # Enable / disable on local or producation + # Enable / disable on local or production enable: %productionMode% - # Enable / disable build-in and Nette integrations + # Enable / disable built-in and Nette integrations integrations: true # Sentry logger configuration @@ -252,12 +250,12 @@ sentry: services: - Contributte\Sentry\Upload\S3Uploader( Contributte\Sentry\Upload\S3Signer( - accessKeyId: secret - secretKey: secret - url: myorg.r2.cloudflarestorage.com / s3.eu-central-1.amazonaws.com - bucket: mybucket - region: auto - prefix: null + accessKeyId: secret + secretKey: secret + url: myorg.r2.cloudflarestorage.com / s3.eu-central-1.amazonaws.com + bucket: mybucket + region: auto + prefix: null ) ) ``` @@ -274,15 +272,15 @@ Measure Nette Application lifecycle from request to shutdown. ```neon services: - - Contributte\Sentry\Performance\NetteApplicationMonitor - - application.application: - setup: - - @Contributte\Sentry\Performance\NetteApplicationMonitor::hook(@self, 'onRequest') - - @Contributte\Sentry\Performance\NetteApplicationMonitor::hook(@self, 'onShutdown') - # or - - "$onRequest[]" = [@Contributte\Sentry\Performance\NetteApplicationMonitor, onRequest] - - "$onShutdown[]" = [@Contributte\Sentry\Performance\NetteApplicationMonitor, onShutdown] + - Contributte\Sentry\Performance\NetteApplicationMonitor + + application.application: + setup: + - @Contributte\Sentry\Performance\NetteApplicationMonitor::hook(@self, 'onRequest') + - @Contributte\Sentry\Performance\NetteApplicationMonitor::hook(@self, 'onShutdown') + # or + - "$onRequest[]" = [@Contributte\Sentry\Performance\NetteApplicationMonitor, onRequest] + - "$onShutdown[]" = [@Contributte\Sentry\Performance\NetteApplicationMonitor, onShutdown] ``` Don't forget to specify `traces_sample_rate` parameter, which means uniform sample rate for all transactions to a number between 0 and 1. @@ -290,16 +288,16 @@ For example, to send 20% of transactions, set `traces_sample_rate` to `0.2`. ```neon sentry: - client: - # Trace every transaction, recommended for testing/dev - traces_sample_rate: 1 + client: + # Trace every transaction, recommended for testing/dev + traces_sample_rate: 1 ``` ## Usage Sentry is successfully integrated to your [Nette](https://nette.org) application and listen for any errors using [Tracy](https://tracy.nette.org). -Let's test it using this smelling code. +Let's test it using this sample code. ```php