Set Up
If you’re on a legacy plan, you'll need to add transaction events to your subscription to use performance monitoring.
With performance monitoring, Sentry tracks your software performance, measuring metrics like throughput and latency, and displaying the impact of errors across multiple systems. Sentry captures distributed traces consisting of transactions and spans, which measure individual services and individual operations within those services. Learn more about our model in Distributed Tracing.
If you’re adopting Performance in a high-throughput environment, we recommend testing prior to deployment to ensure that your service’s performance characteristics maintain expectations.
Enable Tracing
@sentry/nextjs
comes with performance monitoring included. To enable it, you just need to configure your sample rate as detailed below.
Configure the Sample Rate
Once you configure the sample rate, tracing will be enabled in your app. Set the sample rate for your transactions by either:
- Setting a uniform sample rate for all transactions using the
tracesSampleRate
option in your SDK config to a number between0
and1
. (For example, to send 20% of transactions, settracesSampleRate
to0.2
.) - Controlling the sample rate based on the transaction itself and the context in which it's captured, by providing a function to the
tracesSampler
config option.
The two options are meant to be mutually exclusive. If you set both, tracesSampler
will take precedence.
In both sentry.server.config.js
and sentry.client.config.js
:
import * as Sentry from "@sentry/nextjs";
Sentry.init({
dsn: "https://examplePublicKey@o0.ingest.sentry.io/0",
// To set a uniform sample rate
tracesSampleRate: 0.2,
// Alternatively, to control sampling dynamically
tracesSampler: samplingContext => { ... }
});
Learn more about how the options work in Sampling Transactions.
Verify
Verify that performance monitoring is working correctly by using our automatic instrumentation or by starting and finishing a transaction using custom instrumentation.
While you're testing, set tracesSampleRate
to 1.0
, as that ensures that every transaction will be sent to Sentry.
Once testing is complete, we recommend lowering this value in production by either lowering your tracesSampleRate
value, or switching to using tracesSampler
to dynamically sample and filter your transactions.
Leaving the sample rate at 1.0
means that automatic instrumentation will send a transaction each time a user loads any page or navigates anywhere in your app, which is a lot of transactions. Sampling enables you to collect representative data without overwhelming either your system or your Sentry transaction quota.
Next Steps:
- Package:
- npm:@sentry/nextjs
- Version:
- 8.24.0
- Repository:
- https://github.com/getsentry/sentry-javascript