Star us on GitHub
Star
Welcome to highlight.io
Company
Mission & Values
Compliance & Security
Open Source
Getting Started
Overview
Fullstack Mapping
Backend / Server
Frontend / Client
Fullstack Frameworks
Product Features
Session Replay
Error Monitoring
General Features
Logging
Integrations
Integrations Overview
Amplitude Integration
ClickUp Integration
Discord Integration
Electron Support
Front Integration
Height Integration
Intercom Integration
Linear Integration
Mixpanel Integration
Segment Integration
Slack Integration
Vercel Integration
Tips
Content-Security-Policy
Local Development
Monkey Patches
Performance Impact
Proxying Highlight
Session Search Deep Linking
Troubleshooting
Upgrading Highlight
Highlight.io Changelog
Changelog 12 (02/17)
Menu
Docs / Highlight Docs / Tips / Local Development

Local Development

Disable Highlight

Highlight will not run if H.init() is not called or projectId is undefined. For most people, you don't want to record sessions from localhost

Here's an example of disabling Highlight while developing locally with H.init():

if (process.env.ENVIRONMENT !== 'dev') { H.init('<YOUR_PROJECT_ID') }
Copy

Here's an example of disabling Highlight while developing locally with environment variables:

H.init(process.env.HIGHLIGHT_PROJECT_ID) // process.env.HIGHLIGHT_PROJECT_ID is undefined.
Copy
Console Log Messages

Highlight monkey patches the browser's console methods in order to record console messages. A side effect of this is that all the console messages' initiators will point to Highlight. This can make debugging hard because you can't see where console messages are coming from.

To prevent this from happening, you can:

  1. Don't run Highlight locally

  2. Disable console message recording locally

Here's an example of how you disable console message recording locally.

H.init('<YOUR_PROJECT_ID', { disableConsoleRecording: process.env.ENVIRONMENT === 'dev', })
Copy