Star us on GitHub
Star
Menu

Firebase

Learn how to set up highlight.io in Firebase Cloud Functions.
1
Set up your frontend Highlight snippet.

This backend SDK requires one of the Highlight frontend SDKs to be installed, so please make sure you've followed the fullstack mapping guide first.

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

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

# with yarn yarn add @highlight-run/node # with pnpm pnpm add @highlight-run/node # with npm npm install @highlight-run/node
Copy
3
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'})
Copy
4
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' }, ), ) // 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' }, ), )
Copy
5
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' }, ), )
Copy
6
Verify your backend logs are being recorded.

With the JS SDKs, your logs are reported automatically from console methods. Visit the highlight logs portal and check that backend logs are coming in.