bugsnag-plugin-google-cloud-functions v0.3.0

bugsnag-plugin-google-cloud-functions

A @bugsnag/js plugin for capturing errors in Google Cloud Functions.

Quickstart

Install and configure @bugsnag/js, then install the Google Cloud Functions plugin using npm or yarn:

npm install @bugsnag/js bugsnag-plugin-google-cloud-functions

yarn add @bugsnag/js bugsnag-plugin-google-cloud-functions

To start Bugsnag with the Google Cloud Functions, pass the plugin to Bugsnag.start:

const Bugsnag = require('@bugsnag/js')
const BugsnagPluginGoogleCloudFunctions = require('bugsnag-plugin-google-cloud-functions')

Bugsnag.start({
  apiKey: 'YOUR_API_KEY',
  plugins: [BugsnagPluginGoogleCloudFunctions],
  otherOptions: value
})

Start handling errors in your Google Cloud Functions function by wrapping your handler with Bugsnag handler identical by signature type.

HTTP function:

const functions = require('@google-cloud/functions-framework')

const bugsnagHandler = Bugsnag.getPlugin('googleCloudFunctions').createHttpHandler()
functions.http('httpFunction', bugsnagHandler((req, res) => {}))

HTTP function with express app handler:

const express = require('express')
const functions = require('@google-cloud/functions-framework')

const app = express()
app.use((req, res, next) => {})

const bugsnagHandler = Bugsnag.getPlugin('googleCloudFunctions').createHttpHandler()
functions.http('httpFunction', bugsnagHandler(app))

Background function:

const bugsnagHandler = Bugsnag.getPlugin('googleCloudFunctions').createEventHandler()
exports.backgroundFunction = bugsnagHandler((data, context) => {})
exports.backgroundFunction = bugsnagHandler((data, context, callback) => {})

CloudEvent function:

const functions = require('@google-cloud/functions-framework')

const bugsnagHandler = Bugsnag.getPlugin('googleCloudFunctions').createCloudEventHandler()
functions.cloudEvent('cloudEventFunction', bugsnagHandler((cloudEvent) => {}))
functions.cloudEvent('cloudEventFunction', bugsnagHandler((cloudEvent, callback) => {}))

Data capture

The Bugsnag Google Cloud Functions plugin will automatically capture the function request in the "Request" tab for HTTP function and the function event metadata in the "Cloud Functions event metadata" tab for Event-driven function on every error.

Session tracking

A session will be reported automatically each time your Google Cloud Functions function is called. This behavior can be disabled using the autoTrackSessions configuration option.

Configuration

The Bugsnag Google Cloud Functions plugin can be configured by passing options to createHandler.

flushTimeoutMs

Bugsnag will wait for events and sessions to be delivered before allowing the Google Cloud Functions function to exit.

This option can be used to control the maximum amount of time to wait before timing out.

By default, Bugsnag will timeout after 2000 milliseconds.

const bugsnagHandler = Bugsnag.getPlugin('googleCloudFunctions').createHttpHandler({
  flushTimeoutMs: 5000
})

If a timeout does occur, Bugsnag will log a warning and events & sessions may not be delivered.

License

The Unlicense