@sentry/vue

What is @sentry/vue?

@sentry/vue is an official Sentry SDK for Vue.js applications. It allows developers to monitor and track errors, performance issues, and other events in their Vue.js applications. The package provides seamless integration with Vue.js, enabling automatic error tracking and performance monitoring.

What are @sentry/vue's main functionalities?

Error Tracking

This feature allows you to initialize Sentry in your Vue.js application to automatically capture and report errors. The `dsn` is your Sentry Data Source Name, which uniquely identifies your project.

import * as Sentry from '@sentry/vue';
import { Integrations } from '@sentry/tracing';
import Vue from 'vue';

Sentry.init({
  Vue: Vue,
  dsn: 'https://[e-mail]/0',
  integrations: [new Integrations.BrowserTracing()],
  tracesSampleRate: 1.0,
});

Performance Monitoring

This feature allows you to monitor the performance of your Vue.js application. You can track custom transactions and measure the performance of specific parts of your application.

import * as Sentry from '@sentry/vue';
import { Integrations } from '@sentry/tracing';
import Vue from 'vue';

Sentry.init({
  Vue: Vue,
  dsn: 'https://[e-mail]/0',
  integrations: [new Integrations.BrowserTracing()],
  tracesSampleRate: 1.0,
});

// Example of a custom transaction
const transaction = Sentry.startTransaction({
  op: 'test',
  name: 'My Custom Transaction',
});

setTimeout(() => {
  transaction.finish();
}, 99);

Manual Error Reporting

This feature allows you to manually capture and report exceptions in your Vue.js application. This is useful for capturing errors that are not automatically caught by Sentry.

import * as Sentry from '@sentry/vue';
import Vue from 'vue';

Sentry.init({
  Vue: Vue,
  dsn: 'https://[e-mail]/0',
});

// Manually capture an exception
try {
  throw new Error('This is a test error');
} catch (error) {
  Sentry.captureException(error);
}

Other packages similar to @sentry/vue

bugsnag-js

Bugsnag provides error monitoring and crash reporting for web and mobile applications. It offers similar functionalities to @sentry/vue, such as automatic error tracking and performance monitoring. Bugsnag also provides detailed error reports and supports various platforms, including Vue.js.

rollbar

Rollbar is an error tracking and monitoring service that supports multiple languages and frameworks, including Vue.js. It offers real-time error reporting, automatic error grouping, and detailed error insights. Rollbar is comparable to @sentry/vue in terms of functionality and ease of integration.

airbrake-js

Airbrake provides error monitoring and performance management for web applications. It supports Vue.js and offers features like real-time error tracking, detailed error reports, and performance monitoring. Airbrake is similar to @sentry/vue in its capabilities and integration process.

README

Official Sentry SDK for Vue.js

Links

• Official SDK Docs
• TypeDoc

General

This package is a wrapper around @sentry/browser, with added functionality related to Vue.js. All methods available in @sentry/browser can be imported from @sentry/vue.

To use this SDK, call Sentry.init(options) as early in your application as possible.

Vue 3

const app = createApp({
  // ...
});

Sentry.init({
  app,
  dsn: '__PUBLIC_DSN__',
  integrations: [
    // Or omit `router` if you're not using vue-router
    Sentry.browserTracingIntegration({ router }),
  ],
});

Vue 2

import Vue from 'vue';
import App from './App';
import router from './router';
import * as Sentry from '@sentry/vue';

Sentry.init({
  Vue: Vue,
  dsn: '__PUBLIC_DSN__',
  integrations: [
    // Or omit `router` if you're not using vue-router
    Sentry.browserTracingIntegration({ router }),
  ],
});

new Vue({
  el: '#app',
  router,
  components: { App },
  template: '<App/>',
});

Changelog

8.29.0

Important Changes

• Beta releases of official Solid and SolidStart Sentry SDKs

This release marks the beta releases of the @sentry/solid and @sentry/solidstart Sentry SDKs. For details on how to use them, check out the Sentry Solid SDK README and the Sentry SolidStart SDK README respectively. Please reach out on GitHub if you have any feedback or concerns.

• feat(node): Option to only wrap instrumented modules (#13139)

Adds the SDK option to only wrap ES modules with import-in-the-middle that specifically need to be instrumented.

import * as Sentry from '@sentry/node';

Sentry.init({
  dsn: '__PUBLIC_DSN__',
  registerEsmLoaderHooks: { onlyIncludeInstrumentedModules: true },
});

• feat(node): Update OpenTelemetry packages to instrumentation v0.53.0 (#13587)

All internal OpenTelemetry instrumentation was updated to their latest version. This adds support for Mongoose v7 and v8 and fixes various bugs related to ESM mode.

Other Changes

• feat(nextjs): Emit warning when using turbopack (#13566)
• feat(nextjs): Future-proof Next.js config options overriding (#13586)
• feat(node): Add generic-pool integration (#13465)
• feat(nuxt): Upload sourcemaps generated by Nitro (#13382)
• feat(solidstart): Add browserTracingIntegration by default (#13561)
• feat(solidstart): Add sentrySolidStartVite plugin to simplify source maps upload (#13493)
• feat(vue): Only start UI spans if parent is available (#13568)
• fix(cloudflare): Guard context.waitUntil call in request handler (#13549)
• fix(gatsby): Fix assets path for sourcemaps upload (#13592)
• fix(nextjs): Use posix paths for sourcemap uploads (#13603)
• fix(node-fetch): Use stringified origin url (#13581)
• fix(node): Replace dashes in generic-pool span origins with underscores (#13579)
• fix(replay): Fix types in WebVitalData (#13573)
• fix(replay): Improve replay web vital types (#13602)
• fix(utils): Keep logger on carrier (#13570)

Work in this release was contributed by @Zen-cronic. Thank you for your contribution!