Merge pull request #176 from lsst-sqre/tickets/DM-48618/sentry

DM-48618: Sentry

.changeset/big-beds-travel.md

@@ -0,0 +1,5 @@
+---
+'squareone': patch
+---
+
+Instrument with Sentry

.github/workflows/ci.yaml

@@ -78,6 +78,8 @@ jobs:
           image: lsst-sqre/squareone
           github_token: ${{ secrets.GITHUB_TOKEN }}
           dockerfile: apps/squareone/Dockerfile
+          secrets: |
+            SENTRY_AUTH_TOKEN=${{ secrets.SENTRY_AUTH_TOKEN }}
 
   docs:
     needs: [changes]

apps/squareone/.gitignore

@@ -47,3 +47,6 @@ docs/_build
 .pnp.*
 
 .nova
+
+# Sentry Config File
+.env.sentry-build-plugin

apps/squareone/Dockerfile

@@ -36,7 +36,7 @@ COPY turbo.json turbo.json
 # ARG TURBO_TOKEN
 # ENV TURBO_TOKEN=$TURBO_TOKEN
 
-RUN turbo run build --filter=squareone...
+RUN --mount=type=secret,id=SENTRY_AUTH_TOKEN,env=SENTRY_AUTH_TOKEN turbo run build --filter=squareone...
 
 FROM base AS runner
 

apps/squareone/next.config.js

@@ -45,11 +45,12 @@ const readServerYamlConfig = () => {
 module.exports = (phase, { defaultConfig }) => {
   const publicYamlConfig = readPublicYamlConfig();
   const serverYamlConfig = readServerYamlConfig();
+  const sentryDsn = process.env.SENTRY_DSN || null;
 
   const config = {
     ...defaultConfig,
-    publicRuntimeConfig: { ...publicYamlConfig },
-    serverRuntimeConfig: { ...serverYamlConfig },
+    publicRuntimeConfig: { sentryDsn, ...publicYamlConfig },
+    serverRuntimeConfig: { sentryDsn, ...serverYamlConfig },
     async rewrites() {
       return [
         // Mock Gafaelfawr (this is never triggered by a production ingress)
@@ -87,3 +88,47 @@ module.exports = (phase, { defaultConfig }) => {
   };
   return config;
 };
+
+// Injected content via Sentry wizard below
+
+const { withSentryConfig } = require('@sentry/nextjs');
+
+module.exports = withSentryConfig(module.exports, {
+  // For all available options, see:
+  // https://github.com/getsentry/sentry-webpack-plugin#options
+
+  org: 'rubin-observatory',
+  project: 'squareone',
+
+  // Only print logs for uploading source maps in CI
+  silent: !process.env.CI,
+
+  // For all available options, see:
+  // https://docs.sentry.io/platforms/javascript/guides/nextjs/manual-setup/
+
+  // Upload a larger set of source maps for prettier stack traces (increases build time)
+  widenClientFileUpload: true,
+
+  // Automatically annotate React components to show their full name in breadcrumbs and session replay
+  reactComponentAnnotation: {
+    enabled: true,
+  },
+
+  // Route browser requests to Sentry through a Next.js rewrite to circumvent ad-blockers.
+  // This can increase your server load as well as your hosting bill.
+  // Note: Check that the configured route will not match with your Next.js middleware, otherwise reporting of client-
+  // side errors will fail.
+  tunnelRoute: '/monitoring',
+
+  // Hides source maps from generated client bundles
+  hideSourceMaps: true,
+
+  // Automatically tree-shake Sentry logger statements to reduce bundle size
+  disableLogger: true,
+
+  // Enables automatic instrumentation of Vercel Cron Monitors. (Does not yet work with App Router route handlers.)
+  // See the following for more information:
+  // https://docs.sentry.io/product/crons/
+  // https://vercel.com/docs/cron-jobs
+  automaticVercelMonitors: false,
+});

apps/squareone/package.json

@@ -44,6 +44,7 @@
     "@lsst-sqre/rubin-style-dictionary": "workspace:*",
     "@lsst-sqre/squared": "workspace:*",
     "@microsoft/fetch-event-source": "^2.0.1",
+    "@sentry/nextjs": "^8",
     "ajv": "^8.11.0",
     "date-fns": "^3.6.0",
     "formik": "^2.2.9",

apps/squareone/sentry.client.config.js

@@ -0,0 +1,38 @@
+// This file configures the initialization of Sentry on the client.
+// The config you add here will be used whenever a users loads a page in their browser.
+// https://docs.sentry.io/platforms/javascript/guides/nextjs/
+
+import * as Sentry from '@sentry/nextjs';
+import getConfig from 'next/config';
+
+const { publicRuntimeConfig } = getConfig();
+
+Sentry.init({
+  dsn: publicRuntimeConfig.sentryDsn,
+
+  environment: publicRuntimeConfig.environmentName,
+
+  // Add optional integrations for additional features
+  integrations: [Sentry.replayIntegration()],
+
+  // Trace requests through any other Sentry-enabled service in the same
+  // environment. By default, only requests to 'localhost' and requests that
+  // start with '/' have trace headers added. Many of our requests to external
+  // services use the fully qualified URL.
+  // https://docs.sentry.io/platforms/javascript/tracing/instrumentation/automatic-instrumentation/#tracepropagationtargets
+  tracePropagationTargets: [publicRuntimeConfig.baseUrl],
+
+  // Define how likely traces are sampled. Adjust this value in production, or
+  // use tracesSampler for greater control.
+  tracesSampleRate: publicRuntimeConfig.sentryTracesSampleRate,
+
+  // Define how likely Replay events are sampled.
+  replaysSessionSampleRate: publicRuntimeConfig.sentryReplaysSessionSampleRate,
+
+  // Define how likely Replay events are sampled when an error occurs.
+  replaysOnErrorSampleRate: publicRuntimeConfig.sentryReplaysOnErrorSampleRate,
+
+  // Setting this option to true will print useful information to the console
+  // while you're setting up Sentry.
+  debug: false,
+});

apps/squareone/sentry.server.config.js

@@ -0,0 +1,20 @@
+// This file configures the initialization of Sentry on the server.
+// The config you add here will be used whenever the server handles a request.
+// https://docs.sentry.io/platforms/javascript/guides/nextjs/
+
+import * as Sentry from '@sentry/nextjs';
+import getConfig from 'next/config';
+
+const { publicRuntimeConfig } = getConfig();
+
+Sentry.init({
+  dsn: publicRuntimeConfig.sentryDsn,
+
+  environment: publicRuntimeConfig.environmentName,
+
+  // Define how likely traces are sampled.
+  tracesSampleRate: publicRuntimeConfig.sentryTracesSampleRate,
+
+  // Setting this option to true will print useful information to the console while you're setting up Sentry.
+  debug: false,
+});

apps/squareone/squareone.config.schema.json

@@ -24,6 +24,12 @@
       "title": "Base URL for the public ingress",
       "description": "Used for computing absolute URLs"
     },
+    "environmentName": {
+      "type": "string",
+      "default": "development",
+      "title": "Phalanx environment name",
+      "description": "Used in telemetry"
+    },
     "docsBaseUrl": {
       "type": "string",
       "default": "https://rsp.lsst.io",
@@ -76,6 +82,29 @@
     "pendingVerificationPageMdx": {
       "type": "string",
       "title": "/enrollment/pending-confirmation content (MDX)."
+    },
+    "sentryTracesSampleRate": {
+      "type": "number",
+      "title": "Sentry traces sample rate",
+      "description": "The percentage of traces to send to sentry. A number between 0 and 1 inclusive, where zero means don't send any traces, and 1 means send all traces."
+    },
+    "sentryReplaysSessionSampleRate": {
+      "type": "number",
+      "title": "Sentry replay session sample rate",
+      "description": "The percentage of replay sessions to send to Sentry. A number between 0 and 1 inclusive, where zero means don't send any sessions, and 1 means send all sessions.",
+      "default": 0.0
+    },
+    "sentryReplaysOnErrorSampleRate": {
+      "type": "number",
+      "title": "Sentry error replay session sample rate",
+      "description": "The percentage of replay sessions to send to Sentry when an error occurs. A number between 0 and 1 inclusive, where zero means don't send any sessions, and 1 means send all sessions.",
+      "default": 1.0
+    },
+    "sentryDebug": {
+      "type": "boolean",
+      "title": "Sentry debug",
+      "description": "Setting this option to true will print useful information to the console while you're setting up Sentry.",
+      "default": false
     }
   }
 }

apps/squareone/squareone.config.yaml

@@ -1,5 +1,6 @@
 siteName: 'Squareone Development Site'
 baseUrl: 'http://localhost:3000'
+environmentName: 'development'
 siteDescription: |
   The site description.
 docsBaseUrl: 'https://rsp.lsst.io'
@@ -168,6 +169,11 @@ pendingVerificationPageMdx: |
 
   If you have not received the confirmation email please check your SPAM folder.
 
-  If you still cannot find the confirmation email please 
+  If you still cannot find the confirmation email please
   <Link href="../support"><a>contact us</a></Link> to have the confirmation
   email resent.
+
+sentryTracesSampleRate: 0
+sentryReplaysSessionSampleRate: 0
+sentryReplaysOnErrorSampleRate: 1.0
+sentryDebug: false

apps/squareone/src/instrumentation.js

@@ -0,0 +1,9 @@
+import * as Sentry from '@sentry/nextjs';
+
+export async function register() {
+  if (process.env.NEXT_RUNTIME === 'nodejs') {
+    await import('../sentry.server.config');
+  }
+}
+
+export const onRequestError = Sentry.captureRequestError;

apps/squareone/src/pages/_error.jsx

@@ -0,0 +1,17 @@
+import * as Sentry from '@sentry/nextjs';
+import Error from 'next/error';
+
+const CustomErrorComponent = (props) => {
+  return <Error statusCode={props.statusCode} />;
+};
+
+CustomErrorComponent.getInitialProps = async (contextData) => {
+  // In case this is running in a serverless function, await this in order to give Sentry
+  // time to send the error before the lambda exits
+  await Sentry.captureUnderscoreErrorException(contextData);
+
+  // This will contain the status code of the response
+  return Error.getInitialProps(contextData);
+};
+
+export default CustomErrorComponent;

apps/squareone/src/pages/api/sentry-example-api.js

@@ -0,0 +1,5 @@
+// A faulty API route to test Sentry's error monitoring
+export default function handler(_req, res) {
+  throw new Error('Sentry Example API Route Error');
+  res.status(200).json({ name: 'John Doe' });
+}

apps/squareone/src/pages/sentry-example-page.jsx

@@ -0,0 +1,83 @@
+import Head from 'next/head';
+import * as Sentry from '@sentry/nextjs';
+
+export default function Page() {
+  return (
+    <div>
+      <Head>
+        <title>Sentry Onboarding</title>
+        <meta name="description" content="Test Sentry for your Next.js app!" />
+      </Head>
+
+      <main
+        style={{
+          minHeight: '100vh',
+          display: 'flex',
+          flexDirection: 'column',
+          justifyContent: 'center',
+          alignItems: 'center',
+        }}
+      >
+        <h1 style={{ fontSize: '4rem', margin: '14px 0' }}>
+          <svg
+            style={{
+              height: '1em',
+            }}
+            xmlns="http://www.w3.org/2000/svg"
+            viewBox="0 0 200 44"
+          >
+            <path
+              fill="currentColor"
+              d="M124.32,28.28,109.56,9.22h-3.68V34.77h3.73V15.19l15.18,19.58h3.26V9.22h-3.73ZM87.15,23.54h13.23V20.22H87.14V12.53h14.93V9.21H83.34V34.77h18.92V31.45H87.14ZM71.59,20.3h0C66.44,19.06,65,18.08,65,15.7c0-2.14,1.89-3.59,4.71-3.59a12.06,12.06,0,0,1,7.07,2.55l2-2.83a14.1,14.1,0,0,0-9-3c-5.06,0-8.59,3-8.59,7.27,0,4.6,3,6.19,8.46,7.52C74.51,24.74,76,25.78,76,28.11s-2,3.77-5.09,3.77a12.34,12.34,0,0,1-8.3-3.26l-2.25,2.69a15.94,15.94,0,0,0,10.42,3.85c5.48,0,9-2.95,9-7.51C79.75,23.79,77.47,21.72,71.59,20.3ZM195.7,9.22l-7.69,12-7.64-12h-4.46L186,24.67V34.78h3.84V24.55L200,9.22Zm-64.63,3.46h8.37v22.1h3.84V12.68h8.37V9.22H131.08ZM169.41,24.8c3.86-1.07,6-3.77,6-7.63,0-4.91-3.59-8-9.38-8H154.67V34.76h3.8V25.58h6.45l6.48,9.2h4.44l-7-9.82Zm-10.95-2.5V12.6h7.17c3.74,0,5.88,1.77,5.88,4.84s-2.29,4.86-5.84,4.86Z M29,2.26a4.67,4.67,0,0,0-8,0L14.42,13.53A32.21,32.21,0,0,1,32.17,40.19H27.55A27.68,27.68,0,0,0,12.09,17.47L6,28a15.92,15.92,0,0,1,9.23,12.17H4.62A.76.76,0,0,1,4,39.06l2.94-5a10.74,10.74,0,0,0-3.36-1.9l-2.91,5a4.54,4.54,0,0,0,1.69,6.24A4.66,4.66,0,0,0,4.62,44H19.15a19.4,19.4,0,0,0-8-17.31l2.31-4A23.87,23.87,0,0,1,23.76,44H36.07a35.88,35.88,0,0,0-16.41-31.8l4.67-8a.77.77,0,0,1,1.05-.27c.53.29,20.29,34.77,20.66,35.17a.76.76,0,0,1-.68,1.13H40.6q.09,1.91,0,3.81h4.78A4.59,4.59,0,0,0,50,39.43a4.49,4.49,0,0,0-.62-2.28Z"
+            ></path>
+          </svg>
+        </h1>
+
+        <p>Get started by sending us a sample error:</p>
+        <button
+          type="button"
+          style={{
+            padding: '12px',
+            cursor: 'pointer',
+            backgroundColor: '#AD6CAA',
+            borderRadius: '4px',
+            border: 'none',
+            color: 'white',
+            fontSize: '14px',
+            margin: '18px',
+          }}
+          onClick={async () => {
+            await Sentry.startSpan(
+              {
+                name: 'Example Frontend Span',
+                op: 'test',
+              },
+              async () => {
+                const res = await fetch('/api/sentry-example-api');
+                if (!res.ok) {
+                  throw new Error('Sentry Example Frontend Error');
+                }
+              }
+            );
+          }}
+        >
+          Throw error!
+        </button>
+
+        <p>
+          Next, look for the error on the{' '}
+          <a href="https://rubin-observatory.sentry.io/issues/?project=4508718184988672">
+            Issues Page
+          </a>
+          .
+        </p>
+        <p style={{ marginTop: '24px' }}>
+          For more information, see{' '}
+          <a href="https://docs.sentry.io/platforms/javascript/guides/nextjs/">
+            https://docs.sentry.io/platforms/javascript/guides/nextjs/
+          </a>
+        </p>
+      </main>
+    </div>
+  );
+}