Firebase Error Monitoring

H.init("<YOUR_PROJECT_ID>", {
  tracingOrigins: ['localhost', 'example.myapp.com/backend'],
  networkRecording: {
    enabled: true,
    recordHeadersAndBody: true,
  },
});

Install the relevant Highlight SDK(s).

Install @highlight-run/node with your package manager.

npm install --save @highlight-run/node

Initialize the Highlight JS SDK.

Initialize the Highlight JS SDK with your project ID.

import { H } from '@highlight-run/node'

H.init({
	projectID: '<YOUR_PROJECT_ID>',
	serviceName: '<YOUR_SERVICE_NAME>',
	environment: 'production',
})

Add the Firebase Highlight integration.

Use the Node Highlight SDK in your response handler.

const highlightNode = require('@highlight-run/node')

// Callable function wrapper
exports.exampleCallable = functions.https.onCall(
  highlightNode.Handlers.firebaseCallableFunctionHandler(
    (data, context) => {
      // ... your handler code here
      return { result: 'useful result!' }
    },
    {
			projectID: '<YOUR_PROJECT_ID>',
			serviceName: 'my-firebase-app',
			serviceVersion: 'git-sha',
			environment: 'production'
		},
  ),
)

// Http function wrapper
exports.exampleHttp = functions.https.onRequest(
  highlightNode.Handlers.firebaseHttpFunctionHandler(
    (req, res) => {
      // ... your handler code here
      res.json({ result: 'useful result!' })
    },
    { projectID: '<YOUR_PROJECT_ID>' },
  ),
)

Verify that your SDK is reporting errors.

You'll want to throw an exception in one of your Firebase handlers. Access the API handler and make sure the error shows up in Highlight.

exports.exampleCallable = functions.https.onCall(
  highlightNode.Handlers.firebaseCallableFunctionHandler(
    (data, context) => {
      throw new Error('example error!')
      return { result: 'useful result!' }
    },
    {
			projectID: '<YOUR_PROJECT_ID>',
			serviceName: 'my-firebase-app',
			serviceVersion: 'git-sha',
			environment: 'production'
		},
  ),
)

Set up logging.

With the JS SDKs, your logs are reported automatically from console methods. See the JS logging setup guide for more details.

Express.js Error Monitoring Nest.js Error Monitoring