Tracking Vue Errors With Honeybadger in Laravel

Published on by

Tracking Vue Errors With Honeybadger in Laravel image

I feel like Vue and Laravel were almost made to go together and I’ve been using Vue for quite a while. I’m super stoked that Honeybadger recently shipped an official Vue.js integration. Let’s walk through setting everything up so you so if your Vue app catches fire, you can get it handled!

Set up Vue Error Reporting

Install the Honeybadger Vue package

# npm
npm add @honeybadger-io/vue --save
 
# yarn
yarn add @honeybadger-io/vue

Configure Honeybadger

To set this up, hop on over to assets/js/app.js and import Honeybadger’s Vue library.

import HoneybadgerVue from '@honeybadger-io/vue'

Next, we need to add it to Vue.

Vue.use(HoneybadgerVue, {
apiKey: process.env.MIX_HONEYBADGER_API_KEY,
environment: process.env.MIX_HONEYBADGER_ENVIRONMENT,
revision: 'master'
});

I’m sure you’ve noticed all the references to local environment variables. Laravel mix will pass environment variables that are prefixed with MIX_. This helps us make this integration super smooth. So we’ll have to go update the .env file. Laravel Mix Docs

If you are using honeybadger-io/honeybadger-laravel you’ll want to set up a new project for your Vue app.

MIX_HONEYBADGER_API_KEY="GCDWEMt9vhhpDsUT"
MIX_HONEYBADGER_ENVIRONMENT="${APP_ENV}"

All unhandled exceptions will now be reported to Honeybadger. Take a look at the official Vue Integration Guide for more detailed instructions and documentation.

Don’t Forget Your Source Maps!

Getting good stack traces for front-end errors can be tricky. A good stack trace points to the line number in the original source file where the error occurred in your Vue project.

Unfortunately, modern build processes have multiple stages where your original source code gets chopped up, optimized, and compressed to squeeze the best performance from it. This is great for performance, but bad for debugging (read: error reporting). Source maps are the answer.

Honeybadger provides a pretty slick Webpack plugin that will push your source maps to Honeybadger and make tracking errors a breeze.

Install the Honeybadger Webpack package

# npm
npm add @honeybadger-io/webpack --save-dev
 
# yarn
yarn add @honeybadger-io/webpack

Add the plugin to your Webpack config:

Inside webpack.mix.js we’ll start by importing the source map library.

const HoneybadgerSourceMapPlugin = require('@honeybadger-io/webpack')

Next, we need to enable source maps for Laravel Mix.

mix.js('resources/js/app.js', 'public/js')
.sass('resources/sass/app.scss', 'public/css')
.sourceMaps()

We also have to extend Laravel Mix’s Webpack config to use the Honeybadger source map plugin.

mix.webpackConfig({
plugins: [new HoneybadgerSourceMapPlugin({
apiKey: process.env.MIX_HONEYBADGER_API_KEY,
assetsUrl: process.env.MIX_HONEYBADGER_ASSET_URL,
revision: 'master'
})]
})

We’ve added a new variable MIX_HONEYBADGER_ASSET_URL , so lets update the .env file.

MIX_HONEYBADGER_ASSET_URL=https://cdn.example.com/assets

Every time you build your project with npm run prod or yarn prod, the source map will be uploaded to Honeybadger. Check out the Honeybadger Webpack Plugin on GitHub for additional documentation.

Versioning Your Project

Notice that in the above examples, we set the revision: 'master' option in both the Vue and Webpack config. In Honeybadger, the revision is a unique version for your project; it’s what is used to match up the correct source map with the correct error. While master will technically work for your first build, you’ll want to come up with a better way to version your project in Honeybadger—every build should be unique.

Personally, I prefer Git commit SHAs, since they are always unique for the current build. According to Stack Overflow, here’s a quick way to snag your project’s current commit SHA.

In your webpack.mix.js let’s add the following environment variable.

process.env.MIX_HONEYBADGER_REVISION = require('child_process')
.execSync('git rev-parse HEAD')
.toString().trim()

Now we can update the Webpack config to use the new variable.

mix.webpackConfig({
plugins: [new HoneybadgerSourceMapPlugin({
apiKey: process.env.MIX_HONEYBADGER_API_KEY,
assetsUrl: process.env.MIX_HONEYBADGER_ASSET_URL,
revision: process.env.MIX_HONEYBADGER_REVISION
})]
})

We can also circle back and update the Vue integration to use this new revision variable.

Vue.use(HoneybadgerVue, {
...
revision: process.env.MIX_HONEYBADGER_REVISION
...
})

Wrapping Up

I’m stoked to see official Vue support for Honeybadger. It’s their mission to make Honeybadger the best way to monitor your production Vue applications. To unlock the full power of Honeybadger, use it to monitor Laravel, Vue, scheduled tasks, and external uptime.

Be the Honeybadger on Your Team — Start Your 15-day Free Trial


Many thanks to Honeybadger for sponsoring Laravel News

TJ Miller photo

I work primarily with Laravel and Vue. Much of my focus is centered around APIs, and API development.

Cube

Laravel Newsletter

Join 40k+ other developers and never miss out on new tips, tutorials, and more.

Laravel Forge logo

Laravel Forge

Easily create and manage your servers and deploy your Laravel applications in seconds.

Laravel Forge
Tinkerwell logo

Tinkerwell

The must-have code runner for Laravel developers. Tinker with AI, autocompletion and instant feedback on local and production environments.

Tinkerwell
No Compromises logo

No Compromises

Joel and Aaron, the two seasoned devs from the No Compromises podcast, are now available to hire for your Laravel project. ⬧ Flat rate of $7500/mo. ⬧ No lengthy sales process. ⬧ No contracts. ⬧ 100% money back guarantee.

No Compromises
Kirschbaum logo

Kirschbaum

Providing innovation and stability to ensure your web application succeeds.

Kirschbaum
Shift logo

Shift

Running an old Laravel version? Instant, automated Laravel upgrades and code modernization to keep your applications fresh.

Shift
Bacancy logo

Bacancy

Supercharge your project with a seasoned Laravel developer with 4-6 years of experience for just $2500/month. Get 160 hours of dedicated expertise & a risk-free 15-day trial. Schedule a call now!

Bacancy
Lucky Media logo

Lucky Media

Get Lucky Now - the ideal choice for Laravel Development, with over a decade of experience!

Lucky Media
Lunar: Laravel E-Commerce logo

Lunar: Laravel E-Commerce

E-Commerce for Laravel. An open-source package that brings the power of modern headless e-commerce functionality to Laravel.

Lunar: Laravel E-Commerce
LaraJobs logo

LaraJobs

The official Laravel job board

LaraJobs
SaaSykit: Laravel SaaS Starter Kit logo

SaaSykit: Laravel SaaS Starter Kit

SaaSykit is a Multi-tenant Laravel SaaS Starter Kit that comes with all features required to run a modern SaaS. Payments, Beautiful Checkout, Admin Panel, User dashboard, Auth, Ready Components, Stats, Blog, Docs and more.

SaaSykit: Laravel SaaS Starter Kit
Rector logo

Rector

Your partner for seamless Laravel upgrades, cutting costs, and accelerating innovation for successful companies

Rector
MongoDB logo

MongoDB

Enhance your PHP applications with the powerful integration of MongoDB and Laravel, empowering developers to build applications with ease and efficiency. Support transactional, search, analytics and mobile use cases while using the familiar Eloquent APIs. Discover how MongoDB's flexible, modern database can transform your Laravel applications.

MongoDB

The latest

View all →
The Inertia.js v2 Beta is Here image

The Inertia.js v2 Beta is Here

Read article
Mastering Laravel, No Compromises, and SourceDive with Joel Clermont image

Mastering Laravel, No Compromises, and SourceDive with Joel Clermont

Read article
Now you can install PHP and the Laravel installer with a single command image

Now you can install PHP and the Laravel installer with a single command

Read article
WireSpy is a Sleek New Debug Bar for Laravel Livewire image

WireSpy is a Sleek New Debug Bar for Laravel Livewire

Read article
The Laracon AU schedule is now live image

The Laracon AU schedule is now live

Read article
Supercharge PhpStorm with Laravel Idea image

Supercharge PhpStorm with Laravel Idea

Read article