@strapi/plugin-sentry 4.6.0-beta.1 → 4.6.0-beta.2

package/README.md

@@ -68,10 +68,7 @@ try {
   // Your code here
 } catch (error) {
   // Either send a simple error
-  strapi
-    .plugin('sentry')
-    .service('sentry')
-    .sendError(error);
+  strapi.plugin('sentry').service('sentry').sendError(error);
 
   // Or send an error with a customized Sentry scope
   strapi
@@ -92,15 +89,39 @@ Use it if you need direct access to the Sentry instance, which should already al
 **Example**
 
 ```js
-const sentryInstance = strapi
-  .plugin('sentry')
-  .service('sentry')
-  .getInstance();
+const sentryInstance = strapi.plugin('sentry').service('sentry').getInstance();
+```
+
+## Disabling for non-production environments
+
+If the `dsn` property is set to a nil value (`null` or `undefined`) while `enabled` is true, the Sentry plugin will be available to use in the running Strapi instance, but the service will not actually send errors to Sentry. That allows you to write code that runs on every environment without additional checks, but only send errors to Sentry in production.
+
+When you start Strapi with a nil `dsn` config property, the plugin will print a warning:  
+`info: @strapi/plugin-sentry is disabled because no Sentry DSN was provided`
+
+You can make use of that by using the `env` utility to set the `dsn` config property depending on the environment.
+
+**Example**
+
+`./config/plugins.js`
+
+```js
+module.exports = ({ env }) => ({
+  // ...
+  sentry: {
+    enabled: true,
+    config: {
+      // Only set `dsn` property in production
+      dsn: env('NODE_ENV') === 'production' ? env('SENTRY_DSN') : null,
+    },
+  },
+  // ...
+});
 ```
 
-## Disabling
+## Disabling altogether
 
-This plugin can be disabled in the plugins configuration file. With the `env` utility, it is also possible to disable it depending on the environment.
+Like every other plugin, you can also disable this plugin in the plugins configuration file. This will cause `strapi.plugins('sentry')` to return undefined.
 
 **Example**
 
@@ -110,8 +131,7 @@ This plugin can be disabled in the plugins configuration file. With the `env` ut
 module.exports = ({ env }) => ({
   // ...
   sentry: {
-    // Only enable Sentry in production
-    enabled: env('NODE_ENV') === 'production',
+    enabled: false,
   },
   // ...
 });

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@strapi/plugin-sentry",
-  "version": "4.6.0-beta.1",
+  "version": "4.6.0-beta.2",
   "description": "Send Strapi error events to Sentry",
   "repository": {
     "type": "git",
@@ -39,5 +39,5 @@
     "description": "Send Strapi error events to Sentry.",
     "kind": "plugin"
   },
-  "gitHead": "2c0bcabdf0bf2a269fed50c6f23ba777845968a0"
+  "gitHead": "b852090f931cd21868c4016f24db2f9fdfc7a7ab"
 }