Setting Up Stackdriver Error Reporting for Node.js

You can send error reports to Stackdriver Error Reporting from Node.js applications by using the Stackdriver Error Reporting library for Node.js.

Stackdriver Error Reporting is integrated with some products, such as Cloud Functions and App Engine. Stackdriver Error Reporting displays the errors that are logged to Stackdriver Logging by applications running on those products. See Running on Google Cloud Platform for more information.

Before you begin

  1. Sign in to your Google account.

    If you don't already have one, sign up for a new account.

  2. Select or create a Cloud Platform project.

    Go to the Manage resources page

  3. Enable billing for your project.

    Enable billing

  4. Enable the Stackdriver Error Reporting API.

    Enable the API

Installing the library

Stackdriver Error Reporting library for Node.js lets you monitor and view errors reported by Node.js applications running nearly anywhere.

  1. Prepare your environment for Node.js development.

    Go to the Node.js setup guide

  2. Use npm to install the package:

    npm install --save @google-cloud/error-reporting
  3. Import the library and instantiate a client in order to begin reporting errors:

    // Imports the Google Cloud client library
    const ErrorReporting = require('@google-cloud/error-reporting');
    
    // Instantiates a client
    const errors = ErrorReporting();
    
    // Reports a simple error
    errors.report('Something broke!');

For more information, see the documentation. Report issues on the issue tracker.

Configuring the client

You can customize the behavior of the Stackdriver Error Reporting library for Node.js. See the library's configuration for a list of possible configuration options. These options can be passed in the options object passed to the library's constructor.

Reporting errors

Manually reporting an error is as easy as calling the report method:

// Imports the Google Cloud client library
const ErrorReporting = require('@google-cloud/error-reporting');

// Instantiates a client
const errors = ErrorReporting();

// Use the error message builder to customize all fields ...
const errorEvent = errors.event();

// Add error information
errorEvent.setMessage('My error message');
errorEvent.setUser('root@nexus');

// Report the error event
errors.report(errorEvent, () => {
  console.log('Done reporting error event!');
});

// Report an Error object
errors.report(new Error('My error message'), () => {
  console.log('Done reporting Error object!');
});

// Report an error by provided just a string
errors.report('My error message', () => {
  console.log('Done reporting error string!');
});

Reporting errors with Express.js

The Stackdriver Error Reporting library for Node.js makes it easy to integrate Stackdriver Error Reporting into popular Node.js web frameworks such as Express.js:

const express = require('express');

// Imports the Google Cloud client library
const ErrorReporting = require('@google-cloud/error-reporting');

// Instantiates a client
const errors = ErrorReporting();

const app = express();

app.get('/error', (req, res, next) => {
  res.send('Something broke!');
  next(new Error('Custom error message'));
});

app.get('/exception', () => {
  JSON.parse('{"malformedJson": true');
});

// Note that express error handling middleware should be attached after all
// the other routes and use() calls. See the Express.js docs.
app.use(errors.express);

const PORT = process.env.PORT || 8080;
app.listen(PORT, () => {
  console.log(`App listening on port ${PORT}`);
  console.log('Press Ctrl+C to quit.');
});

Other integrations

For more information on integrations between the Stackdriver Error Reporting library for Node.js and other Node.js web frameworks, see the library's repository on GitHub.

Running on Google Cloud Platform

Using Stackdriver Error Reporting library for Node.js requires the IAM role Error Reporting writer. Most GCP compute platforms provide this role by default.

App Engine

App Engine grants the Error Reporting Writer role by default.

The Stackdriver Error Reporting library for Node.js can be used without needing to explicity provide credentials.

Stackdriver Error Reporting is automatically enabled for App Engine flexible environment applications. No additional setup is required.

Container Engine

On Google Container Engine, you must add the cloud-platform access scope when creating the cluster:

gcloud container clusters create example-cluster-name --scopes https://www.googleapis.com/auth/cloud-platform

Compute Engine

When using Compute Engine VM instances, add the cloud-platform access scope to each instance. When creating a new instance through the Google Cloud Platform Console, you can do this in the Identity and API access section of the Create Instance panel. Use the Compute Engine default service account and select Allow full access to all Cloud APIs in the Identity and API access section.

Cloud Functions

Cloud Functions grants the Error Reporting Writer role by default.

The Stackdriver Error Reporting library for Node.js can be used without needing to explicity provide credentials.

Cloud Functions is configured to use Stackdriver Error Reporting automatically. Unhandled JavaScript exceptions will appear in Stackdriver Logging and be processed by Stackdriver Error Reporting without needing to use the Stackdriver Error Reporting library for Node.js.

Running locally and elsewhere

To use the Stackdriver Error Reporting library for Node.js outside of Google Cloud Platform, you must supply your GCP project ID and appropriate service account credentials directly to the Stackdriver Error Reporting library for Node.js. This applies to running the agent on your own workstation, on your datacenter's computers, or on the VM instances of another cloud provider. For more information see Obtaining and providing service account credentials manually.

Example:

// Imports the Google Cloud client library
const ErrorReporting = require('@google-cloud/error-reporting');

// Instantiates a client
const errors = ErrorReporting({
  projectId: 'your-project-id',
  keyFilename: '/path/to/key.json'
});

// Reports a simple error
errors.report('Something broke!');

Viewing error reports

After deployment, you can view error reports in the Cloud Platform Console Error Reporting dashboard.

Go to the Error Reporting dashboard

Monitor your resources on the go

Get the Google Cloud Console app to help you manage your projects.

Send feedback about...

Stackdriver Error Reporting