From 1d0c73a8e6e367aa07f08f1de2388a3170528daa Mon Sep 17 00:00:00 2001 From: Alex Bouma Date: Wed, 9 Oct 2024 19:16:50 +0200 Subject: [PATCH 1/3] Update note about local development and testing --- docs/platforms/php/guides/laravel/index.mdx | 6 +++--- .../php/guides/laravel/other-versions/laravel5.mdx | 6 ++---- .../php/guides/laravel/other-versions/laravel6-7.mdx | 6 ++---- .../php/guides/laravel/other-versions/laravel8-10.mdx | 6 ++---- docs/platforms/php/guides/laravel/other-versions/lumen.mdx | 6 ++---- 5 files changed, 11 insertions(+), 19 deletions(-) diff --git a/docs/platforms/php/guides/laravel/index.mdx b/docs/platforms/php/guides/laravel/index.mdx index a5f7498446daa..988afcb0810dc 100644 --- a/docs/platforms/php/guides/laravel/index.mdx +++ b/docs/platforms/php/guides/laravel/index.mdx @@ -105,13 +105,13 @@ Performance data is transmitted using a new event type called "transactions", wh ## Local Development and Testing -When Sentry is installed in your application, it will also be active when you are developing or running tests. +When Sentry is installed in your application, it will also be active when you are developing or running tests. Because PHP is single-threaded, Sentry will send events synchronously, which can slow down your application or test suite. -You most likely don't want errors to be sent to Sentry when you are developing or running tests. To avoid this, set the DSN value to `null` to disable sending errors to Sentry. +You most likely don't want errors to be sent to Sentry when you are developing or running tests so they don't use up [quota](/pricing/quotas/). To avoid this, set the DSN value to `null` to disable sending errors to Sentry. You can also do this by not defining `SENTRY_LARAVEL_DSN` in your `.env` or by defining it as `SENTRY_LARAVEL_DSN=null`. -If you do leave Sentry enabled when developing or running tests, it's possible for it to have a negative effect on the performance of your application or test suite. +If you want to use Sentry in your local development environment, you can use [Spotlight](https://spotlightjs.com/) which runs locally on your machine. ## Set up Sentry through Forge diff --git a/docs/platforms/php/guides/laravel/other-versions/laravel5.mdx b/docs/platforms/php/guides/laravel/other-versions/laravel5.mdx index a3f97625d8cb6..8e751f9d31174 100644 --- a/docs/platforms/php/guides/laravel/other-versions/laravel5.mdx +++ b/docs/platforms/php/guides/laravel/other-versions/laravel5.mdx @@ -92,12 +92,10 @@ Visiting this route will trigger an exception that will be captured by Sentry. ## Local Development and Testing -When Sentry is installed in your application, it will also be active when you are developing or running tests. +When Sentry is installed in your application, it will also be active when you are developing or running tests. Because PHP is single-threaded, Sentry will send events synchronously, which can slow down your application or test suite. -You most likely don't want errors to be sent to Sentry when you are developing or running tests. To avoid this, set the DSN value to `null` to disable sending errors to Sentry. +You most likely don't want errors to be sent to Sentry when you are developing or running tests so they don't use up [quota](/pricing/quotas/). To avoid this, set the DSN value to `null` to disable sending errors to Sentry. You can also do this by not defining `SENTRY_LARAVEL_DSN` in your `.env` or by defining it as `SENTRY_LARAVEL_DSN=null`. -If you do leave Sentry enabled when developing or running tests, it's possible for it to have a negative effect on the performance of your application or test suite. - diff --git a/docs/platforms/php/guides/laravel/other-versions/laravel6-7.mdx b/docs/platforms/php/guides/laravel/other-versions/laravel6-7.mdx index 91ab4c8eaf4ba..7abaee69aaa67 100644 --- a/docs/platforms/php/guides/laravel/other-versions/laravel6-7.mdx +++ b/docs/platforms/php/guides/laravel/other-versions/laravel6-7.mdx @@ -86,12 +86,10 @@ Visiting this route will trigger an exception that will be captured by Sentry. ## Local Development and Testing -When Sentry is installed in your application, it will also be active when you are developing or running tests. +When Sentry is installed in your application, it will also be active when you are developing or running tests. Because PHP is single-threaded, Sentry will send events synchronously, which can slow down your application or test suite. -You most likely don't want errors to be sent to Sentry when you are developing or running tests. To avoid this, set the DSN value to `null` to disable sending errors to Sentry. +You most likely don't want errors to be sent to Sentry when you are developing or running tests so they don't use up [quota](/pricing/quotas/). To avoid this, set the DSN value to `null` to disable sending errors to Sentry. You can also do this by not defining `SENTRY_LARAVEL_DSN` in your `.env` or by defining it as `SENTRY_LARAVEL_DSN=null`. -If you do leave Sentry enabled when developing or running tests, it's possible for it to have a negative effect on the performance of your application or test suite. - diff --git a/docs/platforms/php/guides/laravel/other-versions/laravel8-10.mdx b/docs/platforms/php/guides/laravel/other-versions/laravel8-10.mdx index 0da3cd6ea7220..39cc53fb99711 100644 --- a/docs/platforms/php/guides/laravel/other-versions/laravel8-10.mdx +++ b/docs/platforms/php/guides/laravel/other-versions/laravel8-10.mdx @@ -94,10 +94,8 @@ Performance data is transmitted using a new event type called "transactions", wh ## Local Development and Testing -When Sentry is installed in your application, it will also be active when you are developing or running tests. +When Sentry is installed in your application, it will also be active when you are developing or running tests. Because PHP is single-threaded, Sentry will send events synchronously, which can slow down your application or test suite. -You most likely don't want errors to be sent to Sentry when you are developing or running tests. To avoid this, set the DSN value to `null` to disable sending errors to Sentry. +You most likely don't want errors to be sent to Sentry when you are developing or running tests so they don't use up [quota](/pricing/quotas/). To avoid this, set the DSN value to `null` to disable sending errors to Sentry. You can also do this by not defining `SENTRY_LARAVEL_DSN` in your `.env` or by defining it as `SENTRY_LARAVEL_DSN=null`. - -If you do leave Sentry enabled when developing or running tests, it's possible for it to have a negative effect on the performance of your application or test suite. diff --git a/docs/platforms/php/guides/laravel/other-versions/lumen.mdx b/docs/platforms/php/guides/laravel/other-versions/lumen.mdx index a2951246a575d..79d58950f945c 100644 --- a/docs/platforms/php/guides/laravel/other-versions/lumen.mdx +++ b/docs/platforms/php/guides/laravel/other-versions/lumen.mdx @@ -80,12 +80,10 @@ Visiting this route will trigger an exception that will be captured by Sentry. ## Local Development and Testing -When Sentry is installed in your application, it will also be active when you are developing or running tests. +When Sentry is installed in your application, it will also be active when you are developing or running tests. Because PHP is single-threaded, Sentry will send events synchronously, which can slow down your application or test suite. -You most likely don't want errors to be sent to Sentry when you are developing or running tests. To avoid this, set the DSN value to `null` to disable sending errors to Sentry. +You most likely don't want errors to be sent to Sentry when you are developing or running tests so they don't use up [quota](/pricing/quotas/). To avoid this, set the DSN value to `null` to disable sending errors to Sentry. You can also do this by not defining `SENTRY_LARAVEL_DSN` in your `.env` or by defining it as `SENTRY_LARAVEL_DSN=null`. -If you do leave Sentry enabled when developing or running tests, it's possible for it to have a negative effect on the performance of your application or test suite. - From c647e659a2f5887347159be54950af68f0b592cc Mon Sep 17 00:00:00 2001 From: Alex Bouma Date: Wed, 9 Oct 2024 19:20:15 +0200 Subject: [PATCH 2/3] Add note about local dev and testing to all PHP docs --- docs/platforms/php/guides/symfony/index.mdx | 10 ++++++++++ docs/platforms/php/index.mdx | 8 ++++++++ 2 files changed, 18 insertions(+) diff --git a/docs/platforms/php/guides/symfony/index.mdx b/docs/platforms/php/guides/symfony/index.mdx index f712d372373ad..380a2dc2dbbb3 100644 --- a/docs/platforms/php/guides/symfony/index.mdx +++ b/docs/platforms/php/guides/symfony/index.mdx @@ -92,3 +92,13 @@ class SentryTestController extends AbstractController ``` After you visit the `/_sentry-test` page, you can view and resolve the recorded error by logging into [sentry.io](https://sentry.io) and opening your project. Clicking on the error's title will open a page where you can see detailed information and mark it as resolved. + +## Local Development and Testing + +When Sentry is installed in your application, it will also be active when you are developing or running tests. Because PHP is single-threaded, Sentry will send events synchronously, which can slow down your application or test suite. + +You most likely don't want errors to be sent to Sentry when you are developing or running tests so they don't use up [quota](/pricing/quotas/). To avoid this, set the DSN value to `null` to disable sending errors to Sentry. + +You can also do this by not defining `SENTRY_DSN` in your `.env` or by defining it as `SENTRY_DSN=null`. + +If you want to use Sentry in your local development environment, you can use [Spotlight](https://spotlightjs.com/) which runs locally on your machine. diff --git a/docs/platforms/php/index.mdx b/docs/platforms/php/index.mdx index 5ea567e30ad53..e6478d0ded022 100644 --- a/docs/platforms/php/index.mdx +++ b/docs/platforms/php/index.mdx @@ -80,3 +80,11 @@ try { If you're using Laravel's Forge platform to provision and deploy your PHP application, you can create a Sentry organization through [Forge](https://forge.laravel.com/docs/integrations/sentry.html). ![Sentry and Forge](./img/forge-sentry.png) + +## Local Development and Testing + +When Sentry is installed in your application, it will also be active when you are developing or running tests. Because PHP is single-threaded, Sentry will send events synchronously, which can slow down your application or test suite. + +You most likely don't want errors to be sent to Sentry when you are developing or running tests so they don't use up [quota](/pricing/quotas/). To avoid this, set the DSN value to `null` to disable sending errors to Sentry. + +If you want to use Sentry in your local development environment, you can use [Spotlight](https://spotlightjs.com/) which runs locally on your machine. From f62d971808a8d0a8ff927d5f6d803b0f3a5ab986 Mon Sep 17 00:00:00 2001 From: Alex Bouma Date: Tue, 5 Nov 2024 10:37:01 +0100 Subject: [PATCH 3/3] Process feedback --- docs/platforms/php/guides/laravel/index.mdx | 2 +- docs/platforms/php/guides/laravel/other-versions/laravel5.mdx | 2 +- docs/platforms/php/guides/laravel/other-versions/laravel6-7.mdx | 2 +- .../platforms/php/guides/laravel/other-versions/laravel8-10.mdx | 2 +- docs/platforms/php/guides/laravel/other-versions/lumen.mdx | 2 +- docs/platforms/php/guides/symfony/index.mdx | 2 +- docs/platforms/php/index.mdx | 2 +- 7 files changed, 7 insertions(+), 7 deletions(-) diff --git a/docs/platforms/php/guides/laravel/index.mdx b/docs/platforms/php/guides/laravel/index.mdx index 988afcb0810dc..6b7f2b5c6bf19 100644 --- a/docs/platforms/php/guides/laravel/index.mdx +++ b/docs/platforms/php/guides/laravel/index.mdx @@ -107,7 +107,7 @@ Performance data is transmitted using a new event type called "transactions", wh When Sentry is installed in your application, it will also be active when you are developing or running tests. Because PHP is single-threaded, Sentry will send events synchronously, which can slow down your application or test suite. -You most likely don't want errors to be sent to Sentry when you are developing or running tests so they don't use up [quota](/pricing/quotas/). To avoid this, set the DSN value to `null` to disable sending errors to Sentry. +You most likely don't want errors to be sent to Sentry when you are developing or running tests so they don't use up [quota](/pricing/quotas/). To avoid this, set the DSN value to `null` to disable sending any events, check-ins, profiles or transactions to Sentry. You can also do this by not defining `SENTRY_LARAVEL_DSN` in your `.env` or by defining it as `SENTRY_LARAVEL_DSN=null`. diff --git a/docs/platforms/php/guides/laravel/other-versions/laravel5.mdx b/docs/platforms/php/guides/laravel/other-versions/laravel5.mdx index 8e751f9d31174..7fb556c04840b 100644 --- a/docs/platforms/php/guides/laravel/other-versions/laravel5.mdx +++ b/docs/platforms/php/guides/laravel/other-versions/laravel5.mdx @@ -94,7 +94,7 @@ Visiting this route will trigger an exception that will be captured by Sentry. When Sentry is installed in your application, it will also be active when you are developing or running tests. Because PHP is single-threaded, Sentry will send events synchronously, which can slow down your application or test suite. -You most likely don't want errors to be sent to Sentry when you are developing or running tests so they don't use up [quota](/pricing/quotas/). To avoid this, set the DSN value to `null` to disable sending errors to Sentry. +You most likely don't want errors to be sent to Sentry when you are developing or running tests so they don't use up [quota](/pricing/quotas/). To avoid this, set the DSN value to `null` to disable sending any events, check-ins, profiles or transactions to Sentry. You can also do this by not defining `SENTRY_LARAVEL_DSN` in your `.env` or by defining it as `SENTRY_LARAVEL_DSN=null`. diff --git a/docs/platforms/php/guides/laravel/other-versions/laravel6-7.mdx b/docs/platforms/php/guides/laravel/other-versions/laravel6-7.mdx index 7abaee69aaa67..7446040e835a5 100644 --- a/docs/platforms/php/guides/laravel/other-versions/laravel6-7.mdx +++ b/docs/platforms/php/guides/laravel/other-versions/laravel6-7.mdx @@ -88,7 +88,7 @@ Visiting this route will trigger an exception that will be captured by Sentry. When Sentry is installed in your application, it will also be active when you are developing or running tests. Because PHP is single-threaded, Sentry will send events synchronously, which can slow down your application or test suite. -You most likely don't want errors to be sent to Sentry when you are developing or running tests so they don't use up [quota](/pricing/quotas/). To avoid this, set the DSN value to `null` to disable sending errors to Sentry. +You most likely don't want errors to be sent to Sentry when you are developing or running tests so they don't use up [quota](/pricing/quotas/). To avoid this, set the DSN value to `null` to disable sending any events, check-ins, profiles or transactions to Sentry. You can also do this by not defining `SENTRY_LARAVEL_DSN` in your `.env` or by defining it as `SENTRY_LARAVEL_DSN=null`. diff --git a/docs/platforms/php/guides/laravel/other-versions/laravel8-10.mdx b/docs/platforms/php/guides/laravel/other-versions/laravel8-10.mdx index 39cc53fb99711..4b3eaf4b6f6cd 100644 --- a/docs/platforms/php/guides/laravel/other-versions/laravel8-10.mdx +++ b/docs/platforms/php/guides/laravel/other-versions/laravel8-10.mdx @@ -96,6 +96,6 @@ Performance data is transmitted using a new event type called "transactions", wh When Sentry is installed in your application, it will also be active when you are developing or running tests. Because PHP is single-threaded, Sentry will send events synchronously, which can slow down your application or test suite. -You most likely don't want errors to be sent to Sentry when you are developing or running tests so they don't use up [quota](/pricing/quotas/). To avoid this, set the DSN value to `null` to disable sending errors to Sentry. +You most likely don't want errors to be sent to Sentry when you are developing or running tests so they don't use up [quota](/pricing/quotas/). To avoid this, set the DSN value to `null` to disable sending any events, check-ins, profiles or transactions to Sentry. You can also do this by not defining `SENTRY_LARAVEL_DSN` in your `.env` or by defining it as `SENTRY_LARAVEL_DSN=null`. diff --git a/docs/platforms/php/guides/laravel/other-versions/lumen.mdx b/docs/platforms/php/guides/laravel/other-versions/lumen.mdx index 79d58950f945c..c749e1cc67fe8 100644 --- a/docs/platforms/php/guides/laravel/other-versions/lumen.mdx +++ b/docs/platforms/php/guides/laravel/other-versions/lumen.mdx @@ -82,7 +82,7 @@ Visiting this route will trigger an exception that will be captured by Sentry. When Sentry is installed in your application, it will also be active when you are developing or running tests. Because PHP is single-threaded, Sentry will send events synchronously, which can slow down your application or test suite. -You most likely don't want errors to be sent to Sentry when you are developing or running tests so they don't use up [quota](/pricing/quotas/). To avoid this, set the DSN value to `null` to disable sending errors to Sentry. +You most likely don't want errors to be sent to Sentry when you are developing or running tests so they don't use up [quota](/pricing/quotas/). To avoid this, set the DSN value to `null` to disable sending any events, check-ins, profiles or transactions to Sentry. You can also do this by not defining `SENTRY_LARAVEL_DSN` in your `.env` or by defining it as `SENTRY_LARAVEL_DSN=null`. diff --git a/docs/platforms/php/guides/symfony/index.mdx b/docs/platforms/php/guides/symfony/index.mdx index 380a2dc2dbbb3..98603e4c9d48a 100644 --- a/docs/platforms/php/guides/symfony/index.mdx +++ b/docs/platforms/php/guides/symfony/index.mdx @@ -97,7 +97,7 @@ After you visit the `/_sentry-test` page, you can view and resolve the recorded When Sentry is installed in your application, it will also be active when you are developing or running tests. Because PHP is single-threaded, Sentry will send events synchronously, which can slow down your application or test suite. -You most likely don't want errors to be sent to Sentry when you are developing or running tests so they don't use up [quota](/pricing/quotas/). To avoid this, set the DSN value to `null` to disable sending errors to Sentry. +You most likely don't want errors to be sent to Sentry when you are developing or running tests so they don't use up [quota](/pricing/quotas/). To avoid this, set the DSN value to `null` to disable sending any events, check-ins, profiles or transactions to Sentry. You can also do this by not defining `SENTRY_DSN` in your `.env` or by defining it as `SENTRY_DSN=null`. diff --git a/docs/platforms/php/index.mdx b/docs/platforms/php/index.mdx index e6478d0ded022..3abf7f36a3eb5 100644 --- a/docs/platforms/php/index.mdx +++ b/docs/platforms/php/index.mdx @@ -85,6 +85,6 @@ If you're using Laravel's Forge platform to provision and deploy your PHP applic When Sentry is installed in your application, it will also be active when you are developing or running tests. Because PHP is single-threaded, Sentry will send events synchronously, which can slow down your application or test suite. -You most likely don't want errors to be sent to Sentry when you are developing or running tests so they don't use up [quota](/pricing/quotas/). To avoid this, set the DSN value to `null` to disable sending errors to Sentry. +You most likely don't want errors to be sent to Sentry when you are developing or running tests so they don't use up [quota](/pricing/quotas/). To avoid this, set the DSN value to `null` to disable sending any events, check-ins, profiles or transactions to Sentry. If you want to use Sentry in your local development environment, you can use [Spotlight](https://spotlightjs.com/) which runs locally on your machine.