New Relic Video Core - JavaScript

The New Relic video tracking core library is the base for all video trackers in the browser platform. It contains the classes and core mechanisms used by the player specific trackers. It segregates the events into different event types based on action, such as video-related events going to VideoAction, ad-related events to VideoAdAction, errors to VideoErrorAction, and custom actions to VideoCustomAction.

Build

Install dependencies:

$ npm install

And build:

$ npm run build:dev

Or if you need a production build:

$ npm run build

Usage

Add scripts inside dist folder to your page.

If you want to know how to generate dist folder, refer to npm commands section.

Registering Trackers

nrvideo provides a class called VideoTracker that will serve as an interface with Browser Agent, allowing you to manage and send events to New Relic.

First of all, you have to add a tracker in the core class:

// var nrvideo = require('newrelic-video-core')
var tracker = new nrvideo.VideoTracker();
nrvideo.Core.addTracker(tracker);

Once the tracker is added, any event it emits will be sent to New Relic and processed by the following functions:

tracker.sendVideoAction("VideoEvent", { data: 1 });
tracker.sendVideoAdAction("AdEvent", { data: "test-1" });
tracker.sendVideoErrorAction("ErrorEvent", { data: "error-test" });
tracker.sendVideoCustomAction("CustomEvent", { data: "custom-test" });

Of course, you may want to use built-in events for video. Luckily for you, this core library provides an easy way of sending video-related content, using tracker.sendXXXXX methods.

tracker.sendRequest(); // Will send CONTENT_REQUEST

Search for Tracker#sendXXXX events in the documentation to read more about it.

Data Model

To understand which actions and attributes are captured and emitted by the tracker under different event types, see DataModel.md.

Documentation

All classes are documented using autodocs. The documents, generated with jsdoc, can be found in the documentation directory of the current repo.

Open source license

This project is distributed under the Apache 2 license.

Support

New Relic has open-sourced this project. This project is provided AS-IS WITHOUT WARRANTY OR DEDICATED SUPPORT. Issues and contributions should be reported to the project here on GitHub.

We encourage you to bring your experiences and questions to the Explorers Hub where our community members collaborate on solutions and new ideas.

Community

New Relic hosts and moderates an online forum where customers can interact with New Relic employees as well as other customers to get help and share best practices. Like all official New Relic open source projects, there's a related Community topic in the New Relic Explorers Hub. You can find this project's topic/threads here:

https://discuss.newrelic.com/t/video-core-js-tracker/100303

Issues / enhancement requests

Issues and enhancement requests can be submitted in the Issues tab of this repository. Please search for and review the existing open issues before submitting a new issue.

Contributing

Contributions are encouraged! If you submit an enhancement request, we'll invite you to contribute the change yourself. Please review our Contributors Guide.

Keep in mind that when you submit your pull request, you'll need to sign the CLA via the click-through using CLA-Assistant. If you'd like to execute our corporate CLA, or if you have any questions, please drop us an email at [email protected].