Set Up
Do you need to set up?
The Getting Started page includes code samples that both enable and configure Performance Monitoring, so you don’t need to set up anything further. You can proceed straight to our content about instrumentation.
If you're adding tracing, enable and configure it as documented here. If you’re on a legacy plan, you'll also need to add transaction events to your subscription.
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.
Enable Tracing
Install the tracing package:
# Using yarn
yarn add @sentry/tracing
# Using npm
npm install @sentry/tracing
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.
// If you're using one of our integration packages, like `@sentry/react` or
// `@sentry/angular`, substitute its name for `@sentry/browser` here
import * as Sentry from "@sentry/browser";
// If taking advantage of included instrumentation (highly recommended)
import { Integrations as TracingIntegrations } from "@sentry/tracing";
// Or, if only manually tracing
// import * as _ from "@sentry/tracing"
// Note: You MUST import the package in some way for tracing to work
Sentry.init({
dsn: "https://examplePublicKey@o0.ingest.sentry.io/0",
// This enables included instrumentation (highly recommended), but is not
// necessary for purely manual usage
integrations: [new TracingIntegrations.BrowserTracing()],
// 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 setting 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.
Without setting a sample rate, included 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 representative data without overwhelming either your system or your Sentry transaction quota.
Next Steps:
- Package:
- npm:@sentry/browser
- Version:
- 6.2.1
- Repository:
- https://github.com/getsentry/sentry-javascript