Add Sentry monitoring (#378)

* start - playground node

* add sentry client config

* add to ui-testing playground

* add sentry release notification to release and snapshot actions

* Add conditional step to create Sentry release

.github/workflows/changeset-release.yml

@@ -47,6 +47,17 @@ jobs:
           GITHUB_TOKEN: ${{ secrets.STUDIOCMS_SERVICE_TOKEN }}
           NPM_TOKEN: ${{ secrets.NPM_TOKEN }}
 
+      - name: Create Sentry release
+        if: steps.changesets.outputs.published == 'true'
+        uses: getsentry/action-release@v1
+        env:
+          SENTRY_AUTH_TOKEN: ${{ secrets.SENTRY_AUTH_TOKEN }}
+          SENTRY_ORG: studiocms
+          SENTRY_URL: https://sentry.studiocms.xyz/
+        with:
+          environment: production
+          projects: studiocms-playground studiocms-ui-testing
+
       - name: Add Label to CI PR
         if: ${{ steps.changesets.outputs.hasChangesets == 'true' }}
         run: gh pr edit "$PR_URL" --add-label "ci"

.github/workflows/changeset-snapshot.yml

@@ -134,6 +134,16 @@ jobs:
           FORCE_COLOR: 0
           NO_COLOR: 1
 
+      - name: Create Sentry release
+        uses: getsentry/action-release@v1
+        env:
+          SENTRY_AUTH_TOKEN: ${{ secrets.SENTRY_AUTH_TOKEN }}
+          SENTRY_ORG: studiocms
+          SENTRY_URL: https://sentry.studiocms.xyz/
+        with:
+          environment: production
+          projects: studiocms-playground studiocms-ui-testing
+
       - name: Pull Request Notification
         uses: actions/github-script@60a0d83039c74a4aee543508d2ffcb1c3799cdea # v7
         env:

playgrounds/node/.env.demo

@@ -28,4 +28,7 @@ CMS_AUTH0_DOMAIN=
 CMS_AUTH0_REDIRECT_URI=http://localhost:4321/studiocms_api/auth/auth0/callback
 
 ## Cloudinary Javascript SDK
-CMS_CLOUDINARY_CLOUDNAME="demo"
+CMS_CLOUDINARY_CLOUDNAME="demo"
+
+# Sentry DSN
+SENTRY_AUTH_TOKEN=

playgrounds/node/astro.config.mts

@@ -1,5 +1,6 @@
 import db from '@astrojs/db';
 import node from '@astrojs/node';
+import sentry from '@sentry/astro';
 // import webvitals from '@astrojs/web-vitals';
 import studioCMSBlog from '@studiocms/blog';
 import devapps from '@studiocms/devapps';
@@ -13,6 +14,13 @@ export default defineConfig({
 	output: 'server',
 	adapter: node({ mode: 'standalone' }),
 	integrations: [
+		sentry({
+			dsn: 'https://[email protected]/2',
+			sourceMapsUploadOptions: {
+				project: 'studiocms-playground',
+				authToken: process.env.SENTRY_AUTH_TOKEN,
+			},
+		}),
 		db(),
 		// webvitals(),
 		studioCMS(), // StudioCMS Integration options can be found in `studiocms.config.mjs`

playgrounds/node/package.json

@@ -24,6 +24,7 @@
     "studiocms": "workspace:*",
     "sharp": "catalog:",
     "@studiocms/blog": "workspace:*",
-    "@studiocms/devapps": "workspace:*"
+    "@studiocms/devapps": "workspace:*",
+    "@sentry/astro": "^8.38.0"
   }
 }

playgrounds/node/sentry.client.config.js

@@ -0,0 +1,12 @@
+import * as Sentry from '@sentry/astro';
+
+Sentry.init({
+	dsn: 'https://[email protected]/2',
+	integrations: [
+		Sentry.feedbackIntegration({
+			// Additional SDK configuration goes in here, for example:
+			colorScheme: 'system',
+			isNameRequired: true,
+		}),
+	],
+});

playgrounds/ui/astro.config.mts

@@ -1,7 +1,17 @@
+import sentry from '@sentry/astro';
 import { defineConfig } from 'astro/config';
 
 // https://astro.build/config
 export default defineConfig({
 	site: 'https://ui-testing.studiocms.xyz',
 	output: 'static',
+	integrations: [
+		sentry({
+			dsn: 'https://[email protected]/3',
+			sourceMapsUploadOptions: {
+				project: 'studiocms-ui-testing',
+				authToken: process.env.SENTRY_AUTH_TOKEN,
+			},
+		}),
+	],
 });

playgrounds/ui/package.json

@@ -18,6 +18,7 @@
     "@astrojs/node": "catalog:",
     "astro": "catalog:",
     "@studiocms/ui": "workspace:*",
-    "@fontsource-variable/onest": "catalog:studiocms-shared"
+    "@fontsource-variable/onest": "catalog:studiocms-shared",
+    "@sentry/astro": "^8.38.0"
   }
 }

playgrounds/ui/sentry.client.config.js

@@ -0,0 +1,12 @@
+import * as Sentry from '@sentry/astro';
+
+Sentry.init({
+	dsn: 'https://[email protected]/3',
+	integrations: [
+		Sentry.feedbackIntegration({
+			// Additional SDK configuration goes in here, for example:
+			colorScheme: 'system',
+			isNameRequired: true,
+		}),
+	],
+});