👋 Welcome!

Let's get you up and running with Highlight. We should be done in less than 2 minutes.

Installing the SDK

Install highlight.run using your package manager.

# with npm
npm install highlight.run

# with yarn
yarn add highlight.run

Initialize

Initialize Highlight where your application starts, likely in the Angular main.ts file.

import { H } from 'highlight.run';

H.init(
    "<YOUR_PROJECT_ID>", // Get your project ID from https://app.highlight.run/setup
    networkRecording: {
        enabled: true,
        recordHeadersAndBody: true,
    },
    tracingOrigins: true // Optional configuration of Highlight features
);

Check out H.init() docs for more details about the options to configure.

If you prefer a full-fledged example, you can also reference our sample Angular Repo with Highlight Configured.

Verify

Start your app, go to it in the browser, then click around. Highlight will be recording your session and it will show up on https://app.highlight.run/sessions a few seconds after recording has started.

Configuration

Integration with Angular ErrorHandler coming soon!