@newrelic/video-shaka

v4.1.1

Published

7 hours ago

New relic tracker for shaka player

0High
0Medium
0Low

New Relic Shaka Player Tracker

The New Relic Shaka Player Tracker provides comprehensive video analytics for applications using Shaka Player. Track video events, monitor playback quality, identify errors, and gain deep insights into user engagement and streaming performance.

Features

🎯 Automatic Event Detection - Captures Shaka Player events automatically without manual instrumentation
📊 Comprehensive Bitrate Tracking - Three distinct bitrate metrics for complete quality analysis
🎬 Adaptive Streaming Support - Full support for DASH and HLS with adaptive bitrate tracking
🔧 Multi-Format Support - Works with DASH, HLS, and other formats supported by Shaka Player
📈 QoE Metrics - Quality of Experience aggregation for startup time, buffering, and playback quality
🎨 Event Segregation - Organized event types: VideoAction, VideoAdAction, VideoErrorAction, VideoCustomAction
🚀 Easy Integration - NPM package or direct script include

Installation

Option 1: Install via NPM/Yarn

Install the package using your preferred package manager:

NPM:

npm install @newrelic/video-shaka

Yarn:

yarn add @newrelic/video-shaka

Option 2: Direct Script Include (Without NPM)

For quick integration without a build system, include the tracker directly in your HTML:

<!DOCTYPE html>
<html>
  <head>
    <!-- Shaka Player -->
    <script src="https://cdnjs.cloudflare.com/ajax/libs/shaka-player/4.3.0/shaka-player.compiled.js"></script>

    <!-- New Relic Shaka Tracker -->
    <script src="path/to/newrelic-video-shaka.min.js"></script>
  </head>
  <body>
    <video id="myVideo" controls width="640" height="480"></video>

    <script>
      // Initialize Shaka Player
      var player = new shaka.Player();
      await player.attach(document.getElementById('myVideo'));

      // Set player version
      player.version = shaka.Player.version;

      // Configure New Relic tracker with info from one.newrelic.com
      const options = {
        info: {
          licenseKey: 'YOUR_LICENSE_KEY',
          beacon: 'YOUR_BEACON_URL',
          applicationId: 'YOUR_APP_ID',
        },
      };

      // Initialize tracker
      const tracker = new ShakaTracker(player, options);

      // Load content
      await player.load('https://your-content.mpd');
    </script>
  </body>
</html>

Setup Steps:

Get Configuration - Visit one.newrelic.com and follow the Streaming Video & Ads onboarding flow to get your licenseKey, beacon, applicationID, and integration code snippet.
Integrate - Include the script in your HTML and initialize with your configuration

Usage

Getting Your Configuration

Before initializing the tracker, obtain your New Relic configuration:

Log in to one.newrelic.com
Navigate to the video agent onboarding flow
Copy your credentials: licenseKey, beacon, and applicationId

Basic Setup

import ShakaTracker from '@newrelic/video-shaka';

// Initialize Shaka Player
const player = new shaka.Player();
await player.attach(videoElement);

// Set player version (required)
player.version = shaka.Player.version;

// Configure tracker with credentials from one.newrelic.com
const options = {
  info: {
    licenseKey: 'YOUR_LICENSE_KEY',
    beacon: 'YOUR_BEACON_URL',
    applicationId: 'YOUR_APP_ID',
  },
};

// Initialize tracker
const tracker = new ShakaTracker(player, options);

// Load and play content
await player.load('https://your-content.mpd');

Advanced Configuration

const options = {
  info: {
    licenseKey: 'YOUR_LICENSE_KEY',
    beacon: 'YOUR_BEACON_URL',
    applicationId: 'YOUR_APP_ID',
  },
  config: {
    qoeAggregate: true, // Enable QoE event aggregation
    qoeIntervalFactor: 2, // Send QoE events every 2 harvest cycles
  },
  customData: {
    contentTitle: 'My Video Title',
    customPlayerName: 'MyCustomPlayer',
    customAttribute: 'customValue',
  },
};

const tracker = new ShakaTracker(player, options);

Configuration Options

QoE (Quality of Experience) Settings

| Option | Type | Default | Description | | ------------------- | ------- | ------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | qoeAggregate | boolean | false | Enable Quality of Experience event aggregation. Set to true to collect QoE metrics like startup time, buffering, and average bitrate. | | qoeIntervalFactor | number | 1 | Controls QoE event frequency. A value of N sends QoE events once every N harvest cycles. Must be a positive integer. QoE events are always included on first and final harvest cycles. |

Custom Data

Add custom attributes to all events:

customData: {
  contentTitle: 'My Video Title',      // Override video title
  customPlayerName: 'MyPlayer',        // Custom player identifier
  customPlayerVersion: '1.0.0',        // Custom player version
  userId: '12345',                     // User identifier
  // Add any custom attributes you need
}

QoE KPIs

When QoE is enabled, the following KPIs are automatically tracked and sent as part of QOE_AGGREGATE events:

| KPI | Description | | ---------------------- | ------------------------------------------------------------- | | startupTime | Time from content request to content start, in milliseconds. | | peakBitrate | Maximum contentBitrate observed during playback. | | averageBitrate | Weighted average bitrate across the playback session. | | hadStartupFailure | true if a content error occurred before content started. | | hadPlaybackFailure | true if a content error occurred during playback. | | totalRebufferingTime | Total time spent rebuffering, in milliseconds. | | rebufferingRatio | Rebuffering time as a percentage of total playtime. | | totalPlaytime | Total content playtime, in milliseconds. | | numberOfErrors | Total number of errors during the session. |

API Reference

Core Methods

`tracker.setUserId(userId)`

Set a unique identifier for the current user.

tracker.setUserId('user-12345');

`tracker.setHarvestInterval(milliseconds)`

Configure how frequently data is sent to New Relic. Accepts values between 1000ms (1 second) and 300000ms (5 minutes).

tracker.setHarvestInterval(30000); // Send data every 30 seconds

`tracker.sendCustom(actionName, attributes)`

Send custom events with arbitrary attributes.

tracker.sendCustom('VideoBookmarked', {
  timestamp: Date.now(),
  position: player.getMediaElement().currentTime,
  userId: 'user-12345',
  bookmarkId: 'bookmark-789',
});

`tracker.setOptions(options)`

Update tracker configuration after initialization.

tracker.setOptions({
  customData: {
    contentTitle: 'New Video Title',
    season: '1',
    episode: '3',
  },
});

Example: Complete Integration

import ShakaTracker from '@newrelic/video-shaka';

// Initialize Shaka Player
const player = new shaka.Player();
await player.attach(videoElement);
player.version = shaka.Player.version;

// Initialize tracker
const tracker = new ShakaTracker(player, {
  info: {
    licenseKey: 'YOUR_LICENSE_KEY',
    beacon: 'YOUR_BEACON_URL',
    applicationId: 'YOUR_APP_ID',
  },
  config: {
    qoeAggregate: true,
  },
});

// Set user context
tracker.setUserId('user-12345');

// Configure reporting interval
tracker.setHarvestInterval(30000);

// Send custom events
player.addEventListener('adaptation', () => {
  tracker.sendCustom('QualityChanged', {
    timestamp: Date.now(),
    newBitrate: player.getStats().streamBandwidth,
  });
});

// Load content
await player.load('https://your-content.mpd');

Data Model

The tracker captures comprehensive video analytics across four event types:

VideoAction - Playback events (play, pause, buffer, seek, quality changes)
VideoAdAction - Ad events (ad start, quartiles, completions, clicks)
VideoErrorAction - Error events (playback failures, network errors)
VideoCustomAction - Custom events defined by your application

Bitrate Metrics

Three distinct bitrate metrics provide complete quality analysis:

contentBitrate - Current rendition encoding bitrate from manifest (streamBandwidth)
contentManifestBitrate - Maximum available quality from all variants
contentNetworkDownloadBitrate - Calculated network throughput based on bytes downloaded and elapsed time

Full Documentation: See DATAMODEL.md for complete event and attribute reference.

Support

Should you need assistance with New Relic products, you are in good hands with several support channels.

If the issue has been confirmed as a bug or is a feature request, please file a GitHub issue.

Support Channels

New Relic Documentation: Comprehensive guidance for using our platform
New Relic Community: The best place to engage in troubleshooting questions
New Relic University: A range of online training for New Relic users of every level
New Relic Technical Support: 24/7/365 ticketed support. Read more about our Technical Support Offerings

Additional Resources

DATAMODEL.md - Complete event and attribute reference
DEVELOPING.md - Building and testing instructions

Contributing

We encourage your contributions to improve the Shaka Player Tracker! Keep in mind that when you submit your pull request, you'll need to sign the CLA via the click-through using CLA-Assistant. You only have to sign the CLA one time per project.

If you have any questions, or to execute our corporate CLA (which is required if your contribution is on behalf of a company), drop us an email at [email protected].

For more details on how best to contribute, see CONTRIBUTING.md.

A Note About Vulnerabilities

As noted in our security policy, New Relic is committed to the privacy and security of our customers and their data. We believe that providing coordinated disclosure by security researchers and engaging with the security community are important means to achieve our security goals.

If you believe you have found a security vulnerability in this project or any of New Relic's products or websites, we welcome and greatly appreciate you reporting it to New Relic through our bug bounty program.

Acknowledgments

If you would like to contribute to this project, review these guidelines.

To all contributors, we thank you! Without your contribution, this project would not be what it is today.

License

The Shaka Player Tracker is licensed under the Apache 2.0 License.

The Shaka Player Tracker also uses source code from third-party libraries. Full details on which libraries are used and the terms under which they are licensed can be found in the third-party notices document.