Pages Plugins

Sentry

This Sentry plugin captures and logs all exceptions which occur below it in the execution chain. It is therefore recommended that you install this plugin at the root of your application in functions/_middleware.ts as the very first plugin.

Installation

npm install --save @cfpreview/pages-plugins-sentry

Usage

// ./functions/_middleware.ts

import sentryPlugin from "@cfpreview/pages-plugins-sentry";

export const onRequest: PagesFunction = sentryPlugin({
  dsn: "https://sentry.io/xyz",
});

The plugin uses Toucan behind-the-scenes, so can take any of these following options. context/request/event is already populated, so does not need to be manually included.

If your DSN is held as an environment variable or in KV, you can access it like so:

// ./functions/_middleware.ts

import sentryPlugin from "@cfpreview/pages-plugins-sentry";

export const onRequest: PagesFunction<{
  SENTRY_DSN: string;
}> = (context) => {
  return sentryPlugin({ dsn: context.env.SENTRY_DSN })(context);
};

// ./functions/_middleware.ts

import sentryPlugin from "@cfpreview/pages-plugins-sentry";

export const onRequest: PagesFunction<{
  KV: KVNamespace;
}> = async (context) => {
  return sentryPlugin({ dsn: await context.KV.get("SENTRY_DSN") })(context);
};

Additional Context

If you need to set additional context for Sentry (e.g. user information or additional logs), you may use the data.sentry instance in any Function below the plugin in the execution chain.

For example, you can access data.sentry and set user information like so:

// ./functions/admin/_middleware.ts

import type sentryPlugin from "@cfpreview/pages-plugins-sentry";

type PagesFunctionWithSentry = ReturnType<typeof sentryPlugin>;

export const onRequest: PagesFunctionWithSentry = async ({ data, next }) => {
  // Authenticate the user from the request and extract user's email address
  const email = await getEmailFromRequest(request);

  data.sentry.setUser({ email });

  return next();
};

Again, the full list of features can be found in Toucan's documentation.