sentry-sails 0.0.1 → 1.0.0

package/README.md

@@ -1,29 +1,104 @@
-# Sails Sentry
+# sentry-sails
 
-A Sails hook for to easily setup up Application Monitoring and Error Tracking with Sentry in Sails applications
+Sails hook for [Sentry](https://sentry.io) error tracking and performance monitoring.
 
 ## Installation
 
 ```bash
-npm install sails-sentry
+npm install sentry-sails
 ```
 
-## Usage
+## Quick Start
 
-To use the Sentry hook in your Sails.js application, add the following configuration to your `config/sentry.js` file:
+1. Install the hook:
+
+```bash
+npm install sentry-sails
+```
+
+2. Set your Sentry DSN via environment variable:
+
+```bash
+SENTRY_DSN=https://your-dsn@sentry.io/project
+```
+
+Or create `config/sentry.js`:
 
 ```javascript
 module.exports.sentry = {
-  dsn: 'your-sentry-dsn',
-  environment: process.env.NODE_ENV || 'development',
-};
+  dsn: process.env.SENTRY_DSN
+}
 ```
 
+That's it! The hook will automatically capture errors and set up performance tracing.
+
 ## Configuration
 
-- `dsn`: Your Sentry Data Source Name (DSN).
-- `environment`: The environment in which your application is running (e.g., development, production).
+All configuration options can be set in `config/sentry.js`:
+
+```javascript
+module.exports.sentry = {
+  dsn: process.env.SENTRY_DSN,
+  environment: process.env.NODE_ENV || 'development',
+  tracesSampleRate: 1.0,
+  profilesSampleRate: 1.0,
+  sendDefaultPii: true
+}
+```
+
+### Options
+
+| Option | Type | Default | Description |
+|--------|------|---------|-------------|
+| `dsn` | string | `process.env.SENTRY_DSN` | Your Sentry Data Source Name |
+| `environment` | string | `process.env.NODE_ENV` | Environment name (e.g., 'production') |
+| `tracesSampleRate` | number | `1.0` | Sample rate for performance tracing (0.0 to 1.0) |
+| `profilesSampleRate` | number | `1.0` | Sample rate for profiling (0.0 to 1.0) |
+| `sendDefaultPii` | boolean | `true` | Capture request headers and IP |
+
+## Manual Error Capture
+
+Access the Sentry instance via `sails.sentry`:
+
+```javascript
+// In any controller or action
+try {
+  await riskyOperation()
+} catch (error) {
+  sails.sentry.captureException(error)
+  throw error
+}
+```
+
+## Adding Context
+
+```javascript
+// Set user context
+sails.sentry.setUser({
+  id: req.session.userId,
+  email: req.session.userEmail
+})
+
+// Add breadcrumb
+sails.sentry.addBreadcrumb({
+  category: 'auth',
+  message: 'User logged in',
+  level: 'info'
+})
+
+// Set tags
+sails.sentry.setTag('feature', 'checkout')
+```
+
+## Requirements
+
+- Node.js >= 18.0.0
+- Sails.js >= 1.0.0
+
+## Documentation
+
+Full documentation available at [docs.sailscasts.com/sentry-sails](https://docs.sailscasts.com/sentry-sails)
 
 ## License
 
-This project is licensed under the MIT License.
+MIT

package/index.js

@@ -1,46 +1,64 @@
 /**
- * sentry hook
+ * sentry-sails hook
  *
- * @description :: A hook definition.  Extends Sails by adding shadow routes, implicit actions, and/or initialization logic.
- * @docs        :: https://sailsjs.com/docs/concepts/extending-sails/hooks
+ * @description :: A Sails hook for Sentry error tracking and performance monitoring.
+ * @docs        :: https://docs.sailscasts.com/sentry-sails
  */
 const Sentry = require('@sentry/node')
+
 module.exports = function defineSentryHook(sails) {
   return {
-    /**
-     * Runs when this Sails app loads/lifts.
-     */
     defaults: {
-      tracesSampleRate: 1.0,
-      // Set sampling rate for profiling - this is relative to tracesSampleRate
-      profilesSampleRate: 1.0,
-      tracing: true,
-      spotlight: true
+      sentry: {
+        tracesSampleRate: 1.0,
+        profilesSampleRate: 1.0,
+        environment: process.env.NODE_ENV || 'development',
+        release: process.env.SENTRY_RELEASE,
+        sendDefaultPii: true
+      }
+    },
+
+    configure: function () {
+      const dsn = sails.config.sentry.dsn || process.env.SENTRY_DSN
+
+      if (!dsn) {
+        sails.log.warn(
+          'sentry-sails: No DSN configured. Sentry will not capture errors.'
+        )
+        sails.log.warn(
+          'sentry-sails: Set SENTRY_DSN environment variable or configure dsn in config/sentry.js'
+        )
+      }
     },
-    initialize: async function () {
+
+    initialize: function (done) {
       sails.after('hook:http:loaded', () => {
-        const sentryInitOptions = {
-          ...sails.config.sentry,
-          integrations: [
-            // enable HTTP calls tracing
-            new Sentry.Integrations.Http({
-              tracing: sails.config.sentry.tracing
-            }),
-            // enable Express.js middleware tracing
-            new Sentry.Integrations.Express({ app: sails.hooks.http.app })
-          ]
+        const config = sails.config.sentry
+        const dsn = config.dsn || process.env.SENTRY_DSN
+
+        if (!dsn) {
+          sails.log.verbose('sentry-sails: Skipping initialization (no DSN)')
+          return done()
         }
-        Sentry.init(sentryInitOptions)
-        // The request handler must be the first middleware on the app
-        sails.hooks.http.app.use(Sentry.Handlers.requestHandler())
 
-        // TracingHandler creates a trace for every incoming request
-        sails.hooks.http.app.use(Sentry.Handlers.tracingHandler())
+        Sentry.init({
+          dsn,
+          environment: config.environment,
+          tracesSampleRate: config.tracesSampleRate,
+          profilesSampleRate: config.profilesSampleRate,
+          sendDefaultPii: config.sendDefaultPii,
+          ...config
+        })
+
+        sails.after('ready', () => {
+          Sentry.setupExpressErrorHandler(sails.hooks.http.app)
+          sails.log.verbose('sentry-sails: Express error handler attached')
+        })
 
-        // The error handler must be registered before any other error middleware and after all controllers
-        sails.hooks.http.app.use(Sentry.Handlers.errorHandler())
+        sails.sentry = Sentry
 
-        sails.log.info('Initializing custom hook (`sentry`)')
+        sails.log.info('sentry-sails: Initialized successfully')
+        return done()
       })
     }
   }

package/package.json

@@ -1,29 +1,38 @@
 {
   "name": "sentry-sails",
-  "version": "0.0.1",
-  "description": "Sails SDK/hook for Sentry (https://sentry.io)",
+  "version": "1.0.0",
+  "description": "Sails hook for Sentry error tracking and performance monitoring",
   "main": "index.js",
   "scripts": {},
   "keywords": [
     "sails",
     "sentry",
     "error",
-    "monitoring"
+    "monitoring",
+    "apm",
+    "tracing",
+    "performance"
   ],
   "author": "Kelvin Omereshone<kelvin@sailscasts.com>",
   "license": "MIT",
   "repository": {
     "type": "git",
-    "url": "git+https://github.com/sailscastshq/sails-hook-sentry.git"
+    "url": "git+https://github.com/sailscastshq/sentry-sails.git"
   },
   "bugs": {
-    "url": "https://github.com/sailscastshq/sails-hook-sentry/issues"
+    "url": "https://github.com/sailscastshq/sentry-sails/issues"
   },
-  "homepage": "https://github.com/sailscastshq/sails-hook-sentry#readme",
+  "homepage": "https://docs.sailscasts.com/sentry-sails",
   "sails": {
     "isHook": true,
     "hookName": "sentry"
   },
+  "engines": {
+    "node": ">=18.0.0"
+  },
+  "peerDependencies": {
+    "sails": ">=1.0.0"
+  },
   "devDependencies": {
     "@commitlint/cli": "^19.6.1",
     "@commitlint/config-conventional": "^19.6.0",
@@ -35,6 +44,6 @@
     "**/*": "prettier --write --ignore-unknown"
   },
   "dependencies": {
-    "@sentry/node": "^8.52.1"
+    "@sentry/node": "^9.0.0"
   }
 }