Set Up Performance
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
# Using yarn
yarn add @sentry/tracing
# Using npm
npm install --save @sentry/tracing
Configure the Sample Rate
Sampling for transactions must also be configured before
- 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.
import Vue from "vue";
import * as Sentry from "@sentry/vue";
// If taking advantage of automatic instrumentation (highly recommended)
import { BrowserTracing } 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({
// Passing in `Vue` is optional, if you do not pass it `window.Vue` must be present.
Vue: Vue,
dsn: "https://examplePublicKey@o0.ingest.sentry.io/0",
// This enables automatic instrumentation (highly recommended), but is not
// necessary for purely manual usage
integrations: [new BrowserTracing()],
// We recommend adjusting this value in production, or using tracesSampler
// for finer control
tracesSampleRate: 1.0,
});
Configure Tracing Instrumentation
If you want to track child components, you can configure the SDK using additional options as shown below. Captured data will be then stored as spans and attached to the currently active transaction:
Sentry.init({
Vue,
tracesSampleRate: 0.1,
trackComponents: ["Header", "Navigation", "Footer"],
hooks: ["create", "mount"],
});
Learn more about Vue component tracking.
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
Next Steps:
Our documentation is open source and available on GitHub. Your contributions are welcome, whether fixing a typo (drat!) to suggesting an update ("yeah, this would be better").
- Package:
- npm:@sentry/vue
- Version:
- 7.45.0
- Repository:
- https://github.com/getsentry/sentry-javascript