Gatsby Book Launch

“The missing guide to the modern web” launches on Thursday, Sep 29th: Modular: The Web’s New Architecture

ContactSign Up for Free
Community Plugin
View plugin on GitHub

@honeybadger-io/gatsby-plugin-honeybadger

Gatsby plugin to add Honeybadger error tracking to your site.

Install

npm install --save @honeybadger-io/gatsby-plugin-honeybadger

How to use

Add your API key in the plugin options in gatsby-config.js:

// gatsby-config.js
module.exports = {
  plugins: [
    {
      resolve: `@honeybadger-io/gatsby-plugin-honeybadger`,
      options: {
        apiKey: 'YOUR_API_KEY',
        revision: `${Date.now()}`,
        assetsUrl: 'https://foobar.com/assets',
        environment: process.env.NODE_ENV
      }
    }
  ]
}

Options

  • [apiKey] (String): the API key of your Honeybadger project.
  • [revision] (String): gatsby-plugin-honeybadger uses honeybadger-webpack to upload source maps to Honeybadger. options.revision needs to be unique as it is the identifier that connects your errors to your source maps.
  • [assetsURL] (String): The base URL to production assets (scheme://host/path). Used to grab source maps.
  • [environment] (String): Current environment. Used to indicate the environment where the error occurred. Optional, defaults to process.env.NODE_ENV.

Releasing

To release a new version:

  1. npm version [version]
  2. npm publish
© 2022 Gatsby, Inc.