New Relic VideoJS Tracker

The New Relic VideoJS tracker instruments the VideoJS player and Brightcove player. It also instruments Ads for FreeWheel and IMA. Makes use of newrelic-video-core, extending the VideoTracker class.

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 the dist folder to your page.

If the dist folder is not included, run npm i && npm run build to build it.

Standard way

// var player = videojs('my-player')
nrvideo.Core.addTracker(new nrvideo.VideojsTracker(player))

VideoJS Plugin Ecosystem

You can use the built-in Videojs plugin system.

// var player = videojs('my-player')
player.newrelic()

Custom Attributes

You can add custom attributes in the following ways. You can override OOTB attributes or create your own.

Using the standard way

    const tracker = new nrvideo.VideojsTracker(player,{ customData: { 
      contentTitle: "Override Existing Title",
      customPlayerName: "myGreatPlayer", 
      customPlayerVersion: "9.4.2"
    } })
    
   nrvideo.Core.addTracker(tracker)
   tracker.customData.myGreeting = "hello from vjs"

Using the plugin System

    var player = videojs('my-video')
    const tracker = player.newrelic()
    tracker.customData.myGreeting = "hello from vjs"

Verify instrumentation

On the page you've instrumented...

   Is Browser Agent loaded? → Type newrelic in the console.

   Is Video Script Loaded? → Type nrvideo in the console.

   Turn on debug → add ?nrvideo-debug=true or &nrvideo-debug=true in the URL.

   Is Video Tracker correctly instantiated? → filter console by [nrvideo] and look for logs.

   Search for Tracker or nrvideo.

    

Examples

Check out the samples folder for complete usage examples.

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/videojs-tracker/100305

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].