Star us on GitHub
Star
Menu

Node.js App

Learn how to set up highlight.io JS log ingestion without a logging library.
1
Set up your frontend highlight.io integration.

First, make sure you've followed the frontend getting started guide.

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
Call built-in console methods.

Logs are automatically recorded by the highlight SDK. Arguments passed as a dictionary as the second parameter will be interpreted as structured key-value pairs that logs can be easily searched by.

module.exports = function() { console.log('hey there!'); console.warn('whoa there', {'key': 'value'}); }
Copy
5
Verify your backend logs are being recorded.

Visit the highlight logs portal and check that backend logs are coming in.