Browser SDK

This SDK is for instrumenting web sites and applications to send data for the GitLab product analytics functionality.

How to use the Browser SDK

Using the NPM package

Add the NPM package to your package JSON using your preferred package manager:

yarn add @gitlab/application-sdk-browser
npm i @gitlab/application-sdk-browser

Then, for browser usage import the client SDK:

import { glClientSDK } from '@gitlab/application-sdk-browser';

this.glClient = glClientSDK({ appId, host });

Using the script directly

Add the script to the page and assign the client SDK to window:

<script src=""></script>
  window.glClient = window.glSDK.glClientSDK({
    appId: 'YOUR_APP_ID',
    host: 'YOUR_HOST',

You can use a specific version of the SDK like this:

<script src=""></script>

Browser SDK initialization options

Apart from appId and host, you can configure the Browser SDK with the following options:

interface GitLabClientSDKOptions {
  appId: string;
  host: string;
  hasCookieConsent?: boolean;
  trackerId?: string;
    | boolean
    | {
        minimumVisitLength?: number;
        heartbeatDelay?: number;
  plugins?: AllowedPlugins;
Option Description
appId The ID provided by the GitLab Project Analytics setup guide. This ID ensures your data is sent to your analytics instance.
host The GitLab Project Analytics instance provided by the setup guide.
hasCookieConsent Whether to use cookies to identify unique users. Set to false by default. When false, users are considered anonymous users. No cookies or other storage mechanisms are used to identify users.
trackerId Used to differentiate between multiple trackers running on the same page or application, because each tracker instance can be configured differently to capture different sets of data. This identifier helps ensure that the data sent to the collector is correctly associated with the correct tracker configuration. Default value is gitlab.
pagePingTracking Option to track user engagement on your website or application by sending periodic events while a user is actively browsing a page. Page pings provide valuable insight into how users interact with your content, such as how long they spend on a page, which sections they are viewing, and whether they are scrolling. pagePingTracking can be boolean or an object. As a boolean, set to true it enables page ping with default options, and set to false it disables page ping tracking. As an object, it has two options: minimumVisitLength (the minimum time that must have elapsed before the first heartbeat) and heartbeatDelay (the interval at which the callback is fired).
plugins Specify which plugins to enable or disable. By default all plugins are enabled.


  • Client Hints: An alternative to tracking the User Agent, which is particularly useful in browsers that are freezing the User Agent string. Enabling this plugin will automatically capture the following context:

    For example, iglu:org.ietf/http_client_hints/jsonschema/1-0-0 has the following configuration:

             "brand":"Google Chrome",
  • Link Click Tracking: With this plugin, the tracker adds click event listeners to all link elements. Link clicks are tracked as self-describing events. Each link-click event captures the link’s href attribute. The event also has fields for the link’s ID, classes, and target (where the linked document is opened, such as a new tab or new window).

  • Performance Timing: It collects performance-related data from a user’s browser using the Navigation Timing API. This API provides detailed information about the various stages of loading a web page, such as domain lookup, connection time, content download, and rendering times. This plugin helps to gather insights into how well a website performs for users, identify potential performance bottlenecks, and improve the overall user experience.

  • Error Tracking: It helps to capture and track errors that occur on a website or application. By monitoring these errors, you can gain insights into potential issues with code or third-party libraries, which can help to improve the overall user experience, and maintain the quality of the website or application.

By default all plugins are enabled. You can disable or enable these plugins through the plugins object:

const tracker = glClientSDK({
  plugins: {
    clientHints: true,
    linkTracking: true,
    performanceTiming: true,
    errorTracking: true,



Used to associate a user and their attributes with the session and tracking events.

glClient.identify(userId, userAttributes);
Property Type Description
userId String The user identifier your application uses to identify individual users.
userAttributes Object/Null/undefined The user attributes that need to be added to the session and tracking events.


Used to trigger a pageview event.;
Property Type Description
eventAttributes Object/Null/undefined The event attributes that need to be added to the pageview event.

The eventAttributes object supports the following optional properties:

Property Type Description
title String Override the default page title.
contextCallback Function A callback that fires on the page view.
context Object Add context (additional information) on the page view.
timestamp timestamp Set the true timestamp or overwrite the device-sent timestamp on an event.


Used to trigger a custom event.

glClient.track(eventName, eventAttributes);
Property Type Description
eventName String The name of the custom event.
eventAttributes Object/Null/undefined The event attributes that need to be added to the tracked event.


enableLinkClickTracking tracks only clicks on links that exist when the page has loaded. To track new links added to the page after it has been loaded, use refreshLinkClickTracking.



trackError is supported on the Browser SDK, but the resulting events are not used or available.

Used to capture errors. This works only when the errorTracking plugin is enabled. The plugin is enabled by default.


For example, trackError can be used in try...catch like below:

try {
  // Call the function that throws an error
} catch (error) {
    message: error.message, // "This is a custom error"
    filename: error.fileName || 'unknown', // The file in which the error occurred (e.g., "index.html")
    lineno: error.lineNumber || 0, // The line number where the error occurred (e.g., 2)
    colno: error.columnNumber || 0, // The column number where the error occurred (e.g., 6)
    error: error, // The Error object itself
Property Type Description
eventAttributes Object The event attributes that need to be added to the tracked event. message is a mandatory key in eventAttributes.


addCookieConsent is used to allow tracking of user identifiers via cookies. By default hasCookieConsent is false, and no user identifiers are passed. To enable tracking of user identifiers, call the addCookieConsent method. This step is not needed if you intialized the Browser SDK with hasCookieConsent set to true.



Used to set a custom URL for tracking.

Property Type Description
url String The custom URL that you want to set for tracking.


Used to set a referrer URL for tracking.

Property Type Description
url String The referrer URL that you want to set for tracking.


Used to override the document title.

Property Type Description
title String The document title you want to set.


If you would like to contribute to Browser SDK, follow the contributing guide.


If the Browser SDK is not sending events, or behaving in an unexpected way, take the following actions:

  1. Verify that the appId and host values in the options object are correct.
  2. Check if any browser privacy settings, extensions, or ad blockers are interfering with the Browser SDK.

For more information and assistance, see the Snowplow documentation or contact the Analytics Instrumentation team.