@convivainc/conviva-js-appanalytics
Version:
Conviva ECO Sensor library
487 lines (362 loc) • 24 kB
Markdown
# Conviva JavaScript ECO SDK
Use Conviva JavaScript ECO SDK to auto-collect events and track application-specific events and state changes.
**Table of Contents**
- [Quick Start](#quick-start)
- [More Features](#more-features)
- [Auto-collected Events](#auto-collected-events)
- [FAQ](#faq)
## Quick Start
### 1. Installation
<!--self-serve[NPM/Yarn]-->
- Install the Conviva JavaScript ECO SDK using either **npm** or **yarn**:
<!-- :::code-tabs[NPM,Yarn] -->
```NPM
npm install /conviva-js-appanalytics
```
```Yarn
yarn add /conviva-js-appanalytics
```
<!-- ::: -->
**Note**: For script-based integrations, refer [Conviva JS Script ECO SDK](https://github.com/Conviva/conviva-js-script-appanalytics) for guidelines.
<!--eof-self-serve-->
### 2. Initialization
- Import the required packages into your project:
```js
import {
convivaAppTracker,
setUserId,
trackPageView,
} from '/conviva-js-appanalytics';
```
- Initialize the Conviva JavaScript ECO SDK:
**Note**: It is recommended to initialize the tracker as early **as possible** during the DOM load sequence, such as in `App.js`.
```js
convivaAppTracker({
appId: 'YOUR_APP_NAME',
convivaCustomerKey: 'YOUR_CUSTOMER_KEY',
appVersion: '1.1.0',
});
```
**YOUR_APP_NAME** - A string value that uniquely identifies your app across platforms. For example: `"WEB App"`, `"LGTV App"`.
**YOUR_CUSTOMER_KEY** - A string to identify a specific customer account. Use different keys for dev and prod. Find them in [Pulse](https://pulse.conviva.com/app/profile/applications) under My Profile (_Conviva login required_).
**appVersion** - Set app version in string format.
### 3. Set the User ID
User ID is a unique string identifier to distinguish individual viewers. If using [Conviva Video Sensor](https://github.com/Conviva/conviva-js-coresdk), match it with the **Viewer ID**.
Note: Set the User ID as soon as Conviva sensor is initialized so that none of the events are missed from User's timeline.
```js
setUserId('replace_me_by_the_userId');
```
### 4. Report Page View
trackPageView() should be called after the page is considered "loaded" by your application—that is, when content is rendered and ready for user interaction. Avoid calling it too early (e.g., before the main content or layout is visible), as this may result in incomplete timing data.
What defines a "page change"?
This depends on your app type:
For MPAs: Every full page reload is a new page.
For SPAs: A new page is usually identified by URL path or route changes.
Developers should trigger pageview() based on what they define as a meaningful navigation or view transition in their application.
By default, when `trackPageView()` is called, the _Page Title_ is set using `document.title`. However, you can override this by passing a custom title in the `trackPageView()` API:
```js
// Uses document.title as the Page Title
trackPageView();
// Pass a custom Page Title
trackPageView({ title: 'Custom Page Title' });
```
**Note**: The Web (JS/React) SDK does not collect page views if the trackPageView() API is not explicitly called during a navigation event. As a result, corresponding metrics (such as Page Views, Avg Perceived Page Load Time, Avg Largest Contentful Paint Time) will be missing from the Pulse dashboard. Conviva does not support auto-collection of missing page views.
## More Features
<details>
<!--self-serve-custom-event-->
<summary><b>Track Custom Event</b></summary>
Use the **trackCustomEvent()** API to track all kinds of events. This API provides 2 fields to describe the tracked events:
**name** - Name of the custom event
**data** - Any type of data in JSON format.
```js
import { trackCustomEvent } from '/conviva-js-appanalytics';
let customData = {
identifier1: 'test',
identifier2: 1,
identifier3: true,
};
trackCustomEvent({
name: 'Custom Event Name',
data: customData,
});
```
<!--eof-self-serve-custom-event-->
</details>
<details>
<!--self-serve-custom-event-->
<summary><b>Set Custom Tags</b></summary>
Custom Tags are global tags applied to all events and persist throughout the application lifespan, or until they are removed.
**Set the custom tags:**
```js
import { setCustomTags } from '/conviva-js-appanalytics';
let customTagsData = { tagKey1: 'tagValue1', tagKey2: 1, tagKey3: true };
setCustomTags(customTagsData);
```
**Clear previously set custom tags:**
```js
import { unsetCustomTags } from '/conviva-js-appanalytics';
// Remove custom tags tagKey2 & tagKey3
let customTagsData = ['tagKey2', 'tagKey3'];
unsetCustomTags(customTagsData);
```
<!--eof-self-serve-custom-event-->
</details>
<details>
<summary><b>Error Reporting</b></summary>
Uncaught exceptions and unhandled rejections are automatically collected and enabled by default. To report caught exceptions or other errors, use the following API:
```js
import { trackError } from '/conviva-js-appanalytics';
try {
//...
} catch (error) {
trackError({
message: 'Cannot get user object',
filename: 'shop.js',
error: error, // Passing the caught error object.
});
}
```
</details>
<details>
<summary><b>Client ID Synchronization</b></summary>
When using multiple Conviva JavaScript ECO SDK instances across different environments (e.g., subdomains of the same customer or mobile apps embedding webviews), the Client ID may not be shared automatically. To ensure consistency, the SDK provides the following advanced APIs for manual synchronization. These APIs are intended for developers who require fine-grained control over Client ID management across multiple instances.
Use Cases:
- Synchronizing Client ID between a mobile app and WebView.
- Synchronizing Client ID across subdomains.
**Note**: The Conviva JavaScript ECO SDK utilizes **local storage** to cache some data.
- `getClientId()` – Retrieves the current Client ID
- `setClientId(clientId)` – Sets a specific Client ID
**Retrieve the Client ID**
```js
import {
convivaAppTracker,
getClientId,
} from '/conviva-js-appanalytics';
convivaAppTracker({
appId: 'YOUR_APP_NAME_AS_STRING',
convivaCustomerKey: 'CONVIVA_ACCOUNT_CUSTOMER_KEY',
appVersion: '1.1.0',
});
// Always call getClientId() after initializing convivaAppTracker()
clientId = getClientId();
```
**Set the Client ID**
```js
import {
convivaAppTracker,
getClientId,
} from '/conviva-js-appanalytics';
// Always call setClientId() before initializing convivaAppTracker() to set a specific clientId
setClientId(clientId);
convivaAppTracker({
appId: 'YOUR_APP_NAME_AS_STRING',
convivaCustomerKey: 'CONVIVA_ACCOUNT_CUSTOMER_KEY',
appVersion: '1.1.0',
});
```
**Auto sync Client ID using cookie**
Syncs clientId within subdomains by storing it in cookie with key name `Conviva_sdkConfig`.
***Configure sharing clientId using cookie***
To share clientId using cookie, you need to set the `enableClIdInCookies` configuration as true during SDK initialization.
```js
import {
convivaAppTracker,
} from '/conviva-js-appanalytics';
convivaAppTracker({
appId: 'YOUR_APP_NAME_AS_STRING',
convivaCustomerKey: 'CONVIVA_ACCOUNT_CUSTOMER_KEY',
appVersion: '1.1.0',
configs: {
enableClIdInCookies: true
},
});
```
</details>
<details>
<summary><b>Meta Tags Collection </b></summary>
This feature enables tracking of meta tags from the `<head>` section of an HTML page based on the provided configuration.
Example meta tags in an HTML Page:
```js
<html>
<head>
<meta name="keywords" content="HTML, CSS, JavaScript">
<meta name="description" content="Free Web tutorials for HTML and CSS">
<meta name="author" content="John Doe">
<meta http-equiv="refresh" content="30">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<meta property="site_name" content="goole.com">
<meta property="title" content="Sample app">
<meta property="description" content="TV series content">
<meta property="locale" content="es_ES">
<meta property="type" content="video">
</head>
</html>
```
**Configure Meta Tags Tracking**
To collect meta tag data, you need to define the `metaTagsTracking` configuration during SDK initialization.
Example Configuration:
```js
convivaAppTracker({
appId: 'YOUR_APP_NAME_AS_STRING',
convivaCustomerKey: 'CONVIVA_ACCOUNT_CUSTOMER_KEY',
appVersion: '1.1.0',
configs: {
metaTagsTracking: {
tags: [
{
key: 'name', // Target meta tags with "name" attributes
value: 'content', // Extract their "content" values
},
{
key: 'property', // Target meta tags with "property" attributes
value: 'content', // Extract their "content" values
condition: ['title', 'locale'], // Optional: Filter by specific property values
},
],
},
},
});
```
</details>
<details>
<summary><b>Set Device Metadata</b></summary>
`deviceMetadata` is an object containing key-value pairs for predefined values, such as DeviceType and DeviceCategory, as well as additional properties like DeviceBrand, DeviceManufacturer, and DeviceModel.
Conviva automatically collects deviceMetadata for Web apps and mobile browsers. However, for devices like set-top boxes, smart TVs, gaming consoles, and others, you will need to manually set the `deviceMetadata`.
**Example of setting deviceMetadata:**
```js
import {
convivaAppTracker,
ConvivaDeviceMetadata,
} from '/conviva-js-appanalytics';
const deviceMetadata: ConvivaDeviceMetadata = {
DeviceBrand: 'Samsung',
DeviceManufacturer: 'Samsung',
DeviceModel: 'UTU7000',
DeviceType: 'SmartTV',
OperatingSystemName: 'Tizen',
OperatingSystemVersion: '8.0',
DeviceCategory: 'SAMSUNGTV',
FrameworkName: 'Angular',
FrameworkVersion: '8.0.0',
};
convivaAppTracker({
appId: 'YOUR_APP_NAME_AS_STRING',
convivaCustomerKey: 'CONVIVA_ACCOUNT_CUSTOMER_KEY',
appVersion: '1.1.0',
deviceMetadata: deviceMetadata,
});
```
<details>
<summary><b>The table of predefined metadata keys for deviceMetadata</b></summary>
| **Key** | **Type** | **Description** | **Example Values** |
| ---------------------- | ----------------------------------- | ------------------------------------------------------------------------------------------------------------------------ | --------------------------------------------------------------------------------------- |
| DeviceBrand | string | Brand of the device | `"Comcast"`, `"LG"`, `"Google"`, `"Vizio"` |
| DeviceManufacturer | string | Manufacturer of the device | `"Sony"`, `"Comcast"`, `"Google"`, `"Microsoft"` |
| DeviceModel | string | Model of the device | `"Comcast Flex"`, `"UTU7000_KA"`, `"Xbox One"` |
| DeviceType | Prescribed values of DeviceType | Type of the device. Only allows the DeviceType values and discards any other string values | DESKTOP, Console, Mobile (see [table below](#devicecategory-pre-defined-string-values)) |
| DeviceVersion | string | Device firmware version | `"10"`, `"9"` |
| OperatingSystemName | string | Name of the operating system used by the device, in uppercase | `"Tizen"`, `"webOS"`, `"Vizio`", `"Linux`", `"Xbox OS"`, `"Chrome OS"` |
| OperatingSystemVersion | string | Version of the operating system used by the device | `"10.10.1"`, `"8.1"`, `"T-INFOLINK2012-1012"`, `"1.56.500000"` |
| DeviceCategory | Prescribed values of DeviceCategory | Device category to which the used device belongs. Only allows DeviceCategory values and discards any other string values | WEB, AND, PS (see [table below](#devicetype-pre-defined-string-values)) |
| FrameworkName | string | Application framework name | `"React TV"`, `"LightningJS"`, `"Angular"` |
| FrameworkVersion | string | Application framework version | `"1.2.3"` | |
#### DeviceCategory Pre-defined String Values:
| Value | Description |
| --------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| AND | The device is an Android device like Samsung Galaxy, Amazon Fire TV, Android TV, or Android Tablet. |
| APL | The device is an Apple device like iPhone or Apple TV. |
| CHR | The device is a Google Chromecast STB or Android TV with built-in Chromecast. |
| DSKAPP | The device is a desktop computer (including notebooks) where video is played in an installed app, as opposed to a browser. |
| SIMULATOR | The device is a simulated video session used for testing. |
| KAIOS | The device is a phone or other device based on KaiOS OS, such as the Lyf Jio F30C. |
| LGTV | The device is an LG smart TV, including NetCast and webOS. |
| LNX | This mostly covers various Set-Top Boxes and Smart TVs that use custom Linux-based SDKs. |
| NINTENDO | The device is a Nintendo games console, including Wii and Switch. |
| PS | The device is a PlayStation console, including PS3 and PS4. |
| RK | The device is a Roku device. |
| SAMSUNGTV | The device is a Samsung Smart TV, including Orsay and Tizen. |
| VIDAA | Vidaa-based devices, using an operating system developed by Hisense. |
| VIZIOTV | Category for native app integrations on Vizio TVs using the SmartCast platform (from 2016 onwards). |
| WEB | The device can be any device with an in-browser HTML5-based player. Video is played in the browser using HTML5 technology, in browsers like Chrome, Edge, Firefox, Internet Explorer, Opera, or Safari. |
| WIN | The device is a Windows OS-based handheld device, like a Windows Phone or Windows Tablet. |
| XB | The device is an Xbox console, including Xbox 360 and Xbox One. |
#### DeviceType Pre-defined String Values:
| Value | Description |
| ------- | -------------------------------------------- |
| DESKTOP | The device is a desktop or laptop computer. |
| Console | The device is a gaming console. |
| Settop | The device is a set-top box. |
| Mobile | The device is a mobile phone. |
| Tablet | The device is a tablet. |
| SmartTV | The device is a smart TV. |
| Vehicle | The device is a vehicle infotainment system. |
| Other | Other device types. |
</details>
</details>
## Auto-collected Events
Conviva automatically collects rich set of app performance metrics through app events after completing the [Quick Start](#quick-start).
<details>
<summary><b>Auto-collected events table</b></summary>
| Event | Occurrence |
| ------------------------ | --------------------------------------------------------------------------------------------------------------------------------------- |
| network_request | After receiving the network request response. [Refer limitations](#limitations). |
| application_error | When an error occurrs in the application. |
| button_click | On the button click callback. [Refer limitations](#limitations). |
| link_click | On the link click callback. [Refer limitations](#limitations). |
| application_background | When visibility state change to `hidden`. |
| application_foreground | When visibility state change to `visible`. |
| Largest Contentful Paint | Timing information about the largest image or text paint before user input on a web page. |
| First App Launch | First time launch in the browser. Custom Tag Context. |
| page_loaded | On `"load"` event listener.Used to compute Page Loads, Avg Document Load Time, Avg DNS Lookup Time, Avg Document Response Time metrics. |
| Server-Sent Events | Supports Server-Sent Event (SSE) via Fetch eventstream. |
| WebSocket message stream | When WebSocket events occur (open, close, send, receive, error) for real-time communication tracking. |
| Event source message stream | When Event source events occur (open, send, receive, error) for real-time communication tracking. |
To learn about the default metrics for analyzing the native and web applications performance, such as App Crashes, Avg Screen Load Time, and Page Loads, refer to the [App Experience Metrics](https://pulse.conviva.com/learning-center/content/eco/eco_metrics.html) page in the Learning Center.
</details>
### Limitations
<details>
<summary><b>Clicks</b></summary>
The collection of all types of clicks is automatically supported, including those from standard HTML elements as well as elements created using React, Angular, and Vue frameworks. We also offer an experimental remote configuration specifically for click events, aiming to dynamically add support for non-standard or unsupported frameworks. For further assistance, please contact the Conviva support team.
**Note:** `preventDefault` and `stopPropagation` will prevent the auto-collection of button and link click events.
**Migration of Pulse dimensions for clicks**
Starting with version [v1.1.2](https://github.com/Conviva/conviva-js-appanalytics/releases/tag/v1.1.2) of the SDK, the attribute keys for click events have been updated.
If you are using v1.1.1 or earlier and currently mapping `elementText`, you must update your configuration when upgrading to v1.1.2 or later. Specifically, update the mapping in [ECO Activation](https://pulse.conviva.com/app/activation/home) by mapping `elementText` to `text`, then redeploy to apply the changes.
To ensure metrics reflect the updates, please review and update your event/metric mappings in [ECO Activation](https://pulse.conviva.com/app/activation/home) if you are using any of the following attributes:
| <=v1.1.1 | >=v1.1.2 |
|--------------------------------|--------------------------------|
| elementType | elementType |
| elementText | text |
| elementName | elementName |
| elementValue | value |
| elementId | id |
| elementClasses | class |
</details>
<details>
<summary><b>network_request</b></summary>
This feature supports tracking network requests triggered within the application using `XMLHttpRequest` and the Fetch API.
**Request and Response Body Collection:**
Collected only when:
- Size is < Size limit
- Default Size Limit is 10 KB.
- Configurable via Remote configuration.
- Response body is type JSON.
- Content-type contains `"json"` or equals any of `"text/plain"`, `"text/javascript"`, `"application/javascript"`, `"text/html"`
- Response Type is not "opaque"
**Request and Response Header Collection:**
Collected only when:
- The server is provisioned with `"Access-Control-Expose-Headers:"`.
- Response Type is not "opaque"
</details>
<details>
<summary><b>Clean up</summary>
"cleanup" api support is not available in older browsers(Chrome: < 66, Mozila: < 57, Safari: < 12.1)
</details>
<details>
<summary><b>SSE, Websocket and Event source</summary>
Only supports json payload for SSE and Event source.
Supports json and Array Buffer for websocket.
</details>
### Validation
After steps 1–4, verify [auto-collected events](#auto-collected-events) in the [validation dashboard](https://pulse.conviva.com/app/appmanager/ecoIntegration/validation) . (_Conviva login required_)
## FAQ
[ECO Integration FAQ](https://pulse.conviva.com/learning-center/content/sensor_developer_center/tools/eco_integration/eco_integration_faq.htm)