Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions .github/workflows/build-upload-deploy-prod.yml
Original file line number Diff line number Diff line change
Expand Up @@ -50,6 +50,8 @@ jobs:
AWS_RUM_REGION: ${{ secrets.AWS_RUM_REGION }}
AWS_RUM_SAMPLE_RATE: ${{ secrets.AWS_RUM_SAMPLE_RATE }}
ASSETS_FROM_S3: ${{ env.ASSETS_FROM_S3 }}
SENTRY_AUTH_TOKEN: ${{ secrets.SENTRY_AUTH_TOKEN }}
SENTRY_DSN: ${{ secrets.SENTRY_DSN }}
run: npm run build

- name: Build Target
Expand Down
3 changes: 3 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -92,3 +92,6 @@ test.html
/config/env.schema.runtime.cjs
.githooks/
scripts/lint-to-json.js

# Sentry Config File
.env.sentry-build-plugin
14 changes: 14 additions & 0 deletions app/api/sentry-example-api/route.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
import { NextResponse } from "next/server";

export const dynamic = "force-dynamic";
class SentryExampleAPIError extends Error {
constructor(message: string | undefined) {
super(message);
this.name = "SentryExampleAPIError";
}
}
// A faulty API route to test Sentry's error monitoring
export function GET() {
throw new SentryExampleAPIError("This error is raised on the backend called by the example page.");
return NextResponse.json({ data: "Testing Sentry Error..." });
Comment thread
GelatoGenesis marked this conversation as resolved.
}
Comment thread
GelatoGenesis marked this conversation as resolved.
8 changes: 8 additions & 0 deletions app/error.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -3,13 +3,21 @@
import ErrorComponent from "@/components/error/Error";
import styles from "@/styles/Home.module.scss";
import { extractErrorDetails } from "@/utils/error-extractor";
import * as Sentry from "@sentry/nextjs";
import { useEffect } from "react";
import {publicEnv} from "@/config/env";

type ErrorProps = {
readonly error: Error & { digest?: string };
readonly reset: () => void;
};

export default function ErrorPage({ error, reset }: ErrorProps) {
useEffect(() => {
if (!publicEnv.SENTRY_DSN) return;
Sentry.captureException(error);
}, [error]);

const errorDetails = extractErrorDetails(error, "ROUTE_ERROR");

return (
Expand Down
7 changes: 7 additions & 0 deletions app/global-error.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -3,13 +3,20 @@
import ErrorComponent from "@/components/error/Error";
import styles from "@/styles/Home.module.scss";
import { extractErrorDetails } from "@/utils/error-extractor";
import * as Sentry from "@sentry/nextjs";
import { useEffect } from "react";
import {publicEnv} from "@/config/env";

type GlobalErrorProps = {
readonly error: Error & { digest?: string };
readonly reset: () => void;
};

export default function GlobalError({ error, reset }: GlobalErrorProps) {
useEffect(() => {
if (!publicEnv.SENTRY_DSN) return;
Sentry.captureException(error);
}, [error]);
Comment thread
coderabbitai[bot] marked this conversation as resolved.
const errorDetails = extractErrorDetails(error, "GLOBAL_ERROR");

return (
Expand Down
209 changes: 209 additions & 0 deletions app/sentry-example-page/page.tsx
Original file line number Diff line number Diff line change
@@ -0,0 +1,209 @@
"use client";

import Head from "next/head";
import * as Sentry from "@sentry/nextjs";
import { useState, useEffect } from "react";

class SentryExampleFrontendError extends Error {
constructor(message: string | undefined) {
super(message);
this.name = "SentryExampleFrontendError";
}
}

export default function Page() {
const [hasSentError, setHasSentError] = useState(false);
const [isConnected, setIsConnected] = useState(true);

useEffect(() => {
async function checkConnectivity() {
const result = await Sentry.diagnoseSdkConnectivity();
setIsConnected(result !== 'sentry-unreachable');
}
checkConnectivity();
}, []);
Comment thread
GelatoGenesis marked this conversation as resolved.

return (
<div>
<Head>
<title>sentry-example-page</title>
<meta name="description" content="Test Sentry for your Next.js app!" />
</Head>

<main>
<div className="flex-spacer" />
<svg height="40" width="40" fill="none" xmlns="http://www.w3.org/2000/svg">
<path d="M21.85 2.995a3.698 3.698 0 0 1 1.353 1.354l16.303 28.278a3.703 3.703 0 0 1-1.354 5.053 3.694 3.694 0 0 1-1.848.496h-3.828a31.149 31.149 0 0 0 0-3.09h3.815a.61.61 0 0 0 .537-.917L20.523 5.893a.61.61 0 0 0-1.057 0l-3.739 6.494a28.948 28.948 0 0 1 9.63 10.453 28.988 28.988 0 0 1 3.499 13.78v1.542h-9.852v-1.544a19.106 19.106 0 0 0-2.182-8.85 19.08 19.08 0 0 0-6.032-6.829l-1.85 3.208a15.377 15.377 0 0 1 6.382 12.484v1.542H3.696A3.694 3.694 0 0 1 0 34.473c0-.648.17-1.286.494-1.849l2.33-4.074a8.562 8.562 0 0 1 2.689 1.536L3.158 34.17a.611.611 0 0 0 .538.917h8.448a12.481 12.481 0 0 0-6.037-9.09l-1.344-.772 4.908-8.545 1.344.77a22.16 22.16 0 0 1 7.705 7.444 22.193 22.193 0 0 1 3.316 10.193h3.699a25.892 25.892 0 0 0-3.811-12.033 25.856 25.856 0 0 0-9.046-8.796l-1.344-.772 5.269-9.136a3.698 3.698 0 0 1 3.2-1.849c.648 0 1.285.17 1.847.495Z" fill="currentcolor"/>
</svg>
<h1>
sentry-example-page
</h1>

<p className="description">
Click the button below, and view the sample error on the Sentry <a target="_blank" href="https://seize-ff.sentry.io/issues/?project=4510442439573504">Issues Page</a>.
For more details about setting up Sentry, <a target="_blank"
href="https://docs.sentry.io/platforms/javascript/guides/nextjs/">read our docs</a>.
</p>
Comment thread
GelatoGenesis marked this conversation as resolved.

<button
type="button"
onClick={async () => {
await Sentry.startSpan({
name: 'Example Frontend/Backend Span',
op: 'test'
}, async () => {
const res = await fetch("/api/sentry-example-api");
if (!res.ok) {
setHasSentError(true);
}
});
throw new SentryExampleFrontendError("This error is raised on the frontend of the example page.");
}}
disabled={!isConnected}
>
<span>
Throw Sample Error
</span>
</button>

{hasSentError ? (
<p className="success">
Error sent to Sentry.
</p>
) : !isConnected ? (
<div className="connectivity-error">
<p>It looks like network requests to Sentry are being blocked, which will prevent errors from being captured. Try disabling your ad-blocker to complete the test.</p>
</div>
) : (
<div className="success_placeholder" />
)}

<div className="flex-spacer" />

</main>

<style>{`
main {
display: flex;
min-height: 100vh;
flex-direction: column;
justify-content: center;
align-items: center;
gap: 16px;
padding: 16px;
font-family: system-ui, -apple-system, BlinkMacSystemFont, "Segoe UI", Roboto, "Helvetica Neue", sans-serif;
}

h1 {
padding: 0px 4px;
border-radius: 4px;
background-color: rgba(24, 20, 35, 0.03);
font-family: monospace;
font-size: 20px;
line-height: 1.2;
}

p {
margin: 0;
font-size: 20px;
}

a {
color: #6341F0;
text-decoration: underline;
cursor: pointer;

@media (prefers-color-scheme: dark) {
color: #B3A1FF;
}
}

button {
border-radius: 8px;
color: white;
cursor: pointer;
background-color: #553DB8;
border: none;
padding: 0;
margin-top: 4px;

& > span {
display: inline-block;
padding: 12px 16px;
border-radius: inherit;
font-size: 20px;
font-weight: bold;
line-height: 1;
background-color: #7553FF;
border: 1px solid #553DB8;
transform: translateY(-4px);
}

&:hover > span {
transform: translateY(-8px);
}

&:active > span {
transform: translateY(0);
}

&:disabled {
cursor: not-allowed;
opacity: 0.6;

& > span {
transform: translateY(0);
border: none
}
}
}

.description {
text-align: center;
color: #6E6C75;
max-width: 500px;
line-height: 1.5;
font-size: 20px;

@media (prefers-color-scheme: dark) {
color: #A49FB5;
}
}

.flex-spacer {
flex: 1;
}

.success {
padding: 12px 16px;
border-radius: 8px;
font-size: 20px;
line-height: 1;
background-color: #00F261;
border: 1px solid #00BF4D;
color: #181423;
}

.success_placeholder {
height: 46px;
}

.connectivity-error {
padding: 12px 16px;
background-color: #E50045;
border-radius: 8px;
width: 500px;
color: #FFFFFF;
border: 1px solid #A80033;
text-align: center;
margin: 0;
}

.connectivity-error a {
color: #FFFFFF;
text-decoration: underline;
}
`}</style>
</div>
);
}
4 changes: 3 additions & 1 deletion config/env.schema.ts
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,7 @@ export const publicEnvSchema = z.object({
* ────────────────
*/
NODE_ENV: z.enum(["development", "production", "test", "local"]).optional(),
NEXT_RUNTIME: z.string().optional(),
VERSION: z.string().optional(),
ASSETS_FROM_S3: z.enum(["true", "false"]).optional(),

Expand Down Expand Up @@ -118,8 +119,9 @@ export const publicEnvSchema = z.object({
AWS_RUM_APP_ID: z.string().optional(),
AWS_RUM_REGION: z.string().optional(),
AWS_RUM_SAMPLE_RATE: z.string().optional(),
SENTRY_DSN: z.string().optional(),

/**
/**
* ────────────────
* PORTS / RUNTIME (all optional)
* ────────────────
Expand Down
39 changes: 39 additions & 0 deletions instrumentation-client.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@
// This file configures the initialization of Sentry on the client.
// The added config 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 {publicEnv} from "@/config/env";

const sentryEnabled = !!publicEnv.SENTRY_DSN;
const isProduction = publicEnv.NODE_ENV === "production";
const dsn = publicEnv.SENTRY_DSN;

Sentry.init({
dsn: sentryEnabled ? dsn : undefined,
enabled: sentryEnabled,

// Add optional integrations for additional features
integrations: [
Sentry.replayIntegration(),
],

// Define how likely traces are sampled. Adjust this value in production, or use tracesSampler for greater control.
tracesSampleRate: 1,
// Enable logs to be sent to Sentry
enableLogs: true,

// Define how likely Replay events are sampled.
// This sets the sample rate to be 10%. You may want this to be 100% while
// in development and sample at a lower rate in production
replaysSessionSampleRate: sentryEnabled && isProduction ? 0.1 : 0,

// Define how likely Replay events are sampled when an error occurs.
replaysOnErrorSampleRate: sentryEnabled && isProduction ? 1.0 : 0,

// Enable sending user PII (Personally Identifiable Information)
// https://docs.sentry.io/platforms/javascript/guides/nextjs/configuration/options/#sendDefaultPii
sendDefaultPii: true,
});
Comment thread
GelatoGenesis marked this conversation as resolved.

export const onRouterTransitionStart = Sentry.captureRouterTransitionStart;
19 changes: 19 additions & 0 deletions instrumentation.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
import * as Sentry from "@sentry/nextjs";
import {publicEnv} from "@/config/env";

const sentryEnabled = !!publicEnv.SENTRY_DSN;

export async function register() {
if (!sentryEnabled) return;
if (publicEnv.NEXT_RUNTIME === 'nodejs') {
await import('./sentry.server.config');
}

if (publicEnv.NEXT_RUNTIME === 'edge') {
await import('./sentry.edge.config');
}
}

export const onRequestError = sentryEnabled
? Sentry.captureRequestError
: undefined;
Loading