Setting Monitoring in Makerkit | Next.js SaaS Boilerplate

Introducing how Makerkit handles monitoring of performance metrics and exceptions in the Next.js Supabase SaaS kit

Makerkit provides first-class support for Sentry (and Signoz, if you prefer, as a plugin).

Makerkit will set up a few things for you out of the box:

  1. Performance Metrics - Instrumentation using Next.js's instrumentation hook
  2. Client exceptions - Automatically capturing uncaught exceptions on the client
  3. Server exceptions - Automatically capturing server-side exceptions when using the functions enhanceAction and enhanceRouteHandler

Additionally, it provides you with the tools to manually capturing exceptions, should you want to.

Configuring Monitoring in Makerkit

To set up monitoring in your application, you need to define the two variables below:

# sentry
NEXT_PUBLIC_MONITORING_PROVIDER=
  1. Monitoring Provider - the monitoring provider to use. Based on this variable, Makerkit will provide the relative implementation.
  2. Enable Instrumentation - if enabled, we report performance metrics to the provider using Next.js

For the provider's specific settings, please check the relative documentation.

Performance Monitoring

Performance monitoring uses Next.js' experimental instrumentation for reporting performance metrics using OpenTelemetry.

Note: Performance monitoring is only enabled for Node.js runtimes.