@newrelic/video-shaka

v4.1.2

Published

2 months ago

New relic tracker for shaka player

Downloads

623

0High
0Medium
0Low

newrelic

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 for DASH and HLS content.

Features

🎯 Automatic Event Detection - Captures Shaka Player events automatically without manual instrumentation
📊 Comprehensive Bitrate Tracking - Four distinct bitrate metrics for complete quality analysis
🔧 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
⚡ Real-Time Performance - Network throughput and estimated bandwidth monitoring
🎬 Adaptive Streaming - Optimized for adaptive bitrate streaming with separate video/audio track analysis

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

Prerequisites

Before using the tracker, ensure you have:

New Relic Account - Active New Relic account with valid application credentials (beacon, applicationId, licenseKey)
Shaka Player - Shaka Player integrated in your application

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);

Best Practices

1. Setting `contentTitle`

The contentTitle attribute will display a value if your video metadata contains title information. If the metadata does not include a title, contentTitle will not be populated. For best results, ensure you explicitly set this attribute during initialization:

const tracker = new ShakaTracker(player, {
  info: {
    licenseKey: 'YOUR_LICENSE_KEY',
    beacon: 'YOUR_BEACON_URL',
    applicationId: 'YOUR_APP_ID',
  },
  customData: {
    contentTitle: 'My Video Title',  // Explicitly set from your metadata
  },
});

If your title changes dynamically (e.g., playlist or queue):

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

2. Setting `userId`

Set a user identifier to track video analytics per user:

// Set userId during initialization
const tracker = new ShakaTracker(player, {
  info: {
    licenseKey: 'YOUR_LICENSE_KEY',
    beacon: 'YOUR_BEACON_URL',
    applicationId: 'YOUR_APP_ID',
  },
  customData: {
    contentTitle: 'Video Title',
    userId: 'user-12345',
  },
});

// Or set userId separately using the API method
tracker.setUserId('user-12345');

3. Adding Custom Attributes for Your Deployment

Add custom attributes unique to your deployment to improve data aggregation and analysis:

const tracker = new ShakaTracker(player, {
  info: {
    licenseKey: 'YOUR_LICENSE_KEY',
    beacon: 'YOUR_BEACON_URL',
    applicationId: 'YOUR_APP_ID',
  },
  customData: {
    // Required for identification
    contentTitle: videoMetadata.title,
    userId: currentUser.id,

    // Custom attributes for your deployment
    subscriptionTier: 'premium',      // User subscription level
    contentProvider: 'studio-abc',    // Content source
    region: 'us-west-2',              // Geographic region
    cdnProvider: 'cloudflare',        // CDN being used
    deviceType: 'desktop',            // Device category
    appVersion: '2.1.0',              // Your app version
    campaign: 'spring-promo',         // Marketing campaign
  },
});

Use these attributes in New Relic queries:

-- Analyze by subscription tier
SELECT count(*) FROM VideoAction WHERE actionName = 'CONTENT_START'
FACET subscriptionTier SINCE 1 day ago

-- Monitor by region
SELECT average(contentDownloadBitrate) FROM VideoAction
FACET region SINCE 1 hour ago

4. Gradual Rollout with Feature Flags

When deploying to production, use feature flags to enable the tracker gradually. This helps you:

Validate data collection without impacting all users
Monitor performance impact at scale
Catch issues before full deployment
Control monitoring costs

// Example using a feature flag
const rolloutPercentage = 5; // Start with 5% of users

function shouldEnableTracking(userId) {
  // Simple percentage-based rollout
  const hash = userId.split('').reduce((acc, char) => acc + char.charCodeAt(0), 0);
  return (hash % 100) < rolloutPercentage;
}

const player = new shaka.Player();
await player.attach(document.querySelector('#video'));
player.version = shaka.Player.version;
await player.load(manifestUrl);

// Only initialize tracker if user is in rollout
if (shouldEnableTracking(currentUser.id)) {
  const tracker = new ShakaTracker(player, {
    info: {
      licenseKey: 'YOUR_LICENSE_KEY',
      beacon: 'YOUR_BEACON_URL',
      applicationId: 'YOUR_APP_ID',
    },
    customData: {
      contentTitle: videoMetadata.title,
      userId: currentUser.id,
      rolloutGroup: `${rolloutPercentage}%`,  // Track which rollout group
    },
  });
}

Recommended Rollout Schedule:

| Phase | Percentage | Duration | Validation | |-------|-----------|----------|------------| | Initial | 5% | 2-3 days | Verify data flowing to New Relic | | Early | 15% | 3-5 days | Check data quality and performance | | Expansion | 25% | 5-7 days | Validate across device types | | Majority | 50% | 1-2 weeks | Monitor at scale | | Full | 100% | Ongoing | Complete deployment |

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
  contentSeries: 'Season 1',           // Series information
  // Add any custom attributes you need
}

Limit: The maximum total number of custom attributes per event is 150. Any attributes beyond this limit will be dropped.

Note: There are special keywords reserved for default attributes (see DATAMODEL.md). Please do not use these as custom attributes, as they will be dropped. Examples of reserved keywords include actionName, contentId, contentTitle, playerName, playerVersion, viewSession, viewId, and others listed in the data model documentation.

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', {
    newBitrate: player.getStats().streamBandwidth,
    timestamp: Date.now(),
  });
});

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

Bitrate Metrics

The tracker captures four distinct bitrate metrics providing complete quality analysis:

| Attribute | Description | Use Case | |-----------|-------------|----------| | contentBitrate | Video-only bitrate (in bps) from the videoBandwidth of the currently active track, excluding audio | Monitor actual video quality being delivered | | contentManifestBitrate | Total variant bitrate (video + audio combined, in bps) as reported by streamBandwidth in Shaka Player statistics. Represents the indicated bitrate | Understand the stream variant quality currently playing | | contentMeasuredBitrate | Estimated network bandwidth (in bps) as measured by Shaka Player's ABR algorithm, derived from estimatedBandwidth in player statistics | Analyze ABR decision-making | | contentDownloadBitrate | Effective download throughput (in bps), calculated as (bytesDownloaded × 8) / playTime from Shaka Player statistics | Monitor real-time network performance |

Bitrate Monitoring Example

// All bitrate metrics are automatically captured and sent with each event
// Access them in New Relic Insights queries:

// NRQL Query Examples:
// SELECT average(contentDownloadBitrate) FROM VideoAction WHERE actionName = 'CONTENT_HEARTBEAT'
// SELECT contentBitrate, contentMeasuredBitrate FROM VideoAction WHERE actionName = 'CONTENT_RENDITION_CHANGE'

Data Model

The tracker captures comprehensive video analytics across four event types:

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

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

Contribute

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.

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.