Highlights
- Explicit opt-in for AWS MediaTailor, with full support for custom CDN domains.
- New
config.ad.typeAPI to choose between CSAI and SSAI (DAI,MT) ad tracking — no more URL-based guessing for SSAI. - End-to-end logging through
nrvideo.Log, with active detection mode logged at startup.
Features
MediaTailor custom CDN support
Replaced URL-based auto-detection with explicit opt-in.
- Enabled the tracker via
mediatailor: true(ormediatailor: { trackingUrl, adSegmentPrefix }), supporting both default AWS hostnames and custom CDN domains. - Added
MT_DEFAULT_AD_SEGMENT_PATH(/tm/) constant for AWS-recommended CDN ad-segment path; ad segments rewritten to a custom CDN domain under/tm/are detected automatically. - Updated
isMediaTailorSegment()to check the default AWS segments hostname, the/tm/path, and an optional customer-suppliedadSegmentPrefix. - Threaded
adSegmentPrefixthrough HLS (VHS) and DASH manifest parsing. - Added explicit session initialization via
mediatailor: { trackingUrl }forPOST /v1/session/flows.
Ad tracking configuration
Introduced config.ad.type to control ad tracker selection.
- Exposed
AD_TRACKINGconstant with CSAI (flat value covering IMA / Brightcove IMA / Freewheel / generic) and SSAI sub-types (DAI,MT). - Required an explicit sub-type for SSAI — each platform needs its own SDK and cannot be auto-detected.
- Mapped
SSAI.MTto implymediatailor: true. - Added a fallback to CSAI auto-detection with a warning when
config.ad.typeis unset (backward compatible for v4.1.2 users). - Co-located
segmentPrefixandtrackingUrlunderconfig.ad. - Added
DaiAdsTrackerto static exports.
Logging improvements
- Exposed
VideojsTracker.Logas a static so UMD callers can set log level. - Added logging of the active ad segment detection mode at tracker startup.
- Added logging of the matched ad segment detection path on the first ad break (once per session).
- Added logging of which CSAI framework was auto-detected (BrightcoveIma / IMA / Freewheel / generic).
- Replaced
console.log/warn/errorwithnrvideo.Logacross MediaTailor files.
Bug fixes
- Fixed buffer end handling in tracker.
- Fixed
register-plugin.jssilently dropping the options object and not forwarding it to theTrackerJSconstructor.
Documentation
- Updated the README and SSAI docs for custom CDN support, clarified when
trackingUrlandadSegmentPrefixoverrides are needed, and cleaned upsessionIdreferences. - Corrected
adSegmentPrefixreferences toconfig.ad.segmentPrefixin the SSAI troubleshooting docs.
Upgrade from 4.1.x
- No breaking changes for CSAI users. If
config.ad.typeis unset, the tracker still auto-detects CSAI frameworks (with a one-time warning). - MediaTailor users must opt in explicitly. Replace any URL-pattern reliance with one of:
mediatailor: true(default AWS hostnames +/tm/path)mediatailor: { trackingUrl, adSegmentPrefix }(custom CDN / explicit session init)config.ad.type: AD_TRACKING.SSAI.MT
- If you previously passed
adSegmentPrefixat the top level, move it toconfig.ad.segmentPrefix.
Points forts
- Opt-in explicite pour AWS MediaTailor, avec prise en charge complète des domaines CDN personnalisés.
- Nouvelle API
config.ad.typepour choisir entre le suivi publicitaire CSAI et SSAI (DAI,MT) — plus de déduction basée sur l’URL pour le SSAI. - End-to-end logging through
nrvideo.Log, with active detection mode logged at startup.
Caractéristiques
MediaTailor custom CDN support
Remplacement de l'auto-détection basée sur l'URL par une activation explicite.
- Enabled the tracker via
mediatailor: true(ormediatailor: { trackingUrl, adSegmentPrefix }), supporting both default AWS hostnames and custom CDN domains. - Ajout de la constante
MT_DEFAULT_AD_SEGMENT_PATH(/tm/) pour le chemin de segment publicitaire CDN recommandé par AWS ; les segments publicitaires réécrits vers un domaine CDN personnalisé sous/tm/sont détectés automatiquement. - Updated
isMediaTailorSegment()to check the default AWS segments hostname, the/tm/path, and an optional customer-suppliedadSegmentPrefix. - Transmission de
adSegmentPrefixà travers l’analyse du manifeste HLS (VHS) et DASH. - Added explicit session initialization via
mediatailor: { trackingUrl }forPOST /v1/session/flows.
Ad tracking configuration
Introduction de config.ad.type pour contrôler la sélection du tracker publicitaire.
- Exposition de la constante
AD_TRACKINGavec CSAI (valeur fixe couvrant IMA/Brightcove IMA/Freewheel/générique) et les sous-types SSAI (DAI,MT). - Required an explicit sub-type for SSAI — each platform needs its own SDK and cannot be auto-detected.
- Mapped
SSAI.MTto implymediatailor: true. - Added a fallback to CSAI auto-detection with a warning when
config.ad.typeis unset (backward compatible for v4.1.2 users). - Colocalisation de
segmentPrefixettrackingUrlsousconfig.ad. - Ajout de
DaiAdsTrackeraux exports statiques.
Logging improvements
- Exposition de
VideojsTracker.Logen tant que statique afin que les appelants UMD puissent définir le niveau de log. - Added logging of the active ad segment detection mode at tracker startup.
- Added logging of the matched ad segment detection path on the first ad break (once per session).
- Added logging of which CSAI framework was auto-detected (BrightcoveIma / IMA / Freewheel / generic).
- Remplacement de
console.log/warn/errorparnrvideo.Logdans les fichiers MediaTailor.
Débogage
- Fixed buffer end handling in tracker.
- Fixed
register-plugin.jssilently dropping the options object and not forwarding it to theTrackerJSconstructor.
Documentation
- Updated the README and SSAI docs for custom CDN support, clarified when
trackingUrlandadSegmentPrefixoverrides are needed, and cleaned upsessionIdreferences. - Corrected
adSegmentPrefixreferences toconfig.ad.segmentPrefixin the SSAI troubleshooting docs.
Upgrade from 4.1.x
Aucune modification majeure pour les utilisateurs de CSAI. Si
config.ad.typen'est pas défini, le tracker auto-détecte toujours les frameworks CSAI (avec un avertissement unique).Les utilisateurs de MediaTailor doivent accepter explicitement. Remplacer toute dépendance à un modèle d'URL par l'un des éléments suivants :
mediatailor: true(noms d’hôte AWS par défaut + chemin/tm/)mediatailor: { trackingUrl, adSegmentPrefix }(CDN personnalisé/initialisation explicite de session)config.ad.type: AD_TRACKING.SSAI.MT
Si vous passiez précédemment
adSegmentPrefixau niveau supérieur, déplacez-le versconfig.ad.segmentPrefix.
Highlights
- Added MediaTailor SSAI tracker initialization on loadstart after source load detection.
- Added DAI stream manager support through the stream-manager event.
- Improved bitrate reporting with:
- Playback bitrate (
AVERAGE-BANDWIDTH/BANDWIDTH) - Manifest max bitrate
- Segment download bitrate
- Network throughput bitrate
- Playback bitrate (
Improvements
- Refined ad and content event handling to avoid duplicate or incorrect content events while ads are active for following events:
- Pause/Resume
- Seek Start/End
- Buffer Start
- Improved end-of-content handling for ad-enabled playback paths during IMA and Freewheel scenarios.
- Added safer fallback logic for tech wrappers (
Hls.js,Shaka,contrib-hls) when bitrate data is unavailable in VHS.
Technical notes
- Tracker metadata and playback context methods remain aligned with Video.js/Brightcove integrations:
- Retrieves the title, ID, and duration from
mediainfowhen available. - Retrieves source and rendition data from the active tech component when available.
- Retrieves the title, ID, and duration from
- Updated the Listener registration and unregistration to include ad and stream manager lifecycle events.
Points forts
Ajout de l'initialisation du tracker SSAI MediaTailor lors du loadstart après la détection du chargement de la source.
Ajout de la prise en charge du gestionnaire de flux DAI via l’événement stream-manager.
Amélioration des rapports de débit binaire avec :
- Débit binaire de lecture (
AVERAGE-BANDWIDTH/BANDWIDTH) - Débit binaire max. du manifeste
- Débit binaire de téléchargement du segment
- Débit binaire du réseau
- Débit binaire de lecture (
Améliorations
Amélioration de la gestion des événements de publicité et de contenu pour éviter les événements de contenu en double ou incorrects lorsque les publicités sont actives pour les événements suivants :
- Pause/reprendre
- Début/fin de recherche
- Début du tampon
Amélioration de la gestion de la fin du contenu pour les chemins de lecture avec publicités lors des scénarios IMA et Freewheel.
Ajout d'une logique de repli plus sûre pour les wrappers techniques (
Hls.js,Shaka,contrib-hls) lorsque les données de débit binaire sont indisponibles dans VHS.
Notes techniques
Les métadonnées du tracker et les méthodes de contexte de lecture restent alignées avec Video.js/Brightcove intégrations :
- Récupère le titre, l'ID et la durée à partir de
mediainfolorsqu'ils sont disponibles. - Récupère les données sources et de rendu à partir du composant technique actif lorsqu'elles sont disponibles.
- Récupère le titre, l'ID et la durée à partir de
Mise à jour de l'enregistrement et de la désinscription du Listener pour inclure les événements de cycle de vie du gestionnaire d'annonces et de flux.
What's changed
Documentation
- README Overhaul: Restructured and expanded README with comprehensive installation guides, usage examples, best practices, configuration options, API reference, and support channels.
Improvements
- Attributes Validation: Updated validation logic for custom attributes to enforce correctness at the tracker level.
- Custom Attributes Limit: Added an enforced limit on the number of custom attributes that can be sent per event, preventing unexpected payload sizes.
Installation
$npm install @newrelic/video-html5@4.1.1This release introduces three new bitrate metrics for granular playback observability, QoE (Quality of Experience) support, and Shaka Player 5.x compatibility while maintaining backward compatibility with Shaka 4.x.
New bitrate metrics
Three new attributes are now available to provide deeper insight into streaming performance:
Attribute | Source | Description |
|---|---|---|
|
| Total variant bitrate (video + audio) as declared in the manifest (Indicated Bitrate). |
|
| Estimated network bandwidth measured by Shaka's ABR algorithm (Observed Bitrate). |
|
| Effective download throughput across all downloaded media. |
Additionally, contentBitrate uses track.videoBandwidth (video-only bitrate) to differentiate it from other metrics that report combined video and audio bandwidth.
Quality of Experience (QoE) support
QoE aggregate events are now supported via video-core. Enable them by setting qoeAggregate: true in the config:
const options = { info: { beacon: 'xxxxxxxxxx', applicationID: 'xxxxxxx', licenseKey: 'xxxxxxxxxxx', }, config: { qoeAggregate: true, qoeIntervalFactor: 2, },};
const tracker = new ShakaTracker(player, options);The following KPIs are tracked automatically:
KPI | Description |
|---|---|
| Time from content request to content start (ms). |
| Maximum |
| Weighted average bitrate across the session. |
|
|
|
|
| Total time spent rebuffering (ms). |
| Rebuffering time as a percentage of total playtime. |
| Total content playtime (ms). |
| Total number of errors during the session. |
Shaka Player 5.x compatibility
The tracker is now compatible with both Shaka Player 4.x and 5.x:
getPlayerVersion()resolves version across both major versions.onError()handles both Shaka player errors (e.detail) and HTML video element errors (e.target.error).- Sample files updated for Shaka 5.x (removed deprecated
shaka.polyfill.installAll(), updated player instantiation).
Upgrade guide
Run the following following to update:
$npm install @newrelic/video-shaka@4.0.3To enable QoE, add qoeAggregate: true to your config options as shown above.
Dependencies
Requires @newrelic/video-core v4.1.1 or later for QoE support.
Cette sortie introduit trois nouvelles métriques de débit binaire pour une observabilité granulaire de la lecture, la prise en charge de la QoE (Quality of Experience), et la compatibilité avec Shaka Player 5.x, tout en maintenant la rétrocompatibilité avec Shaka 4.x.
Nouvelles métriques de débit binaire
Trois nouveaux attributs sont désormais disponibles pour fournir des informations détaillées plus approfondies sur les performances de streaming :
Attribut | Source | Description |
|---|---|---|
|
| Débit binaire total de la variante (vidéo + audio) tel que déclaré dans le manifeste (Débit binaire indiqué). |
|
| Bande passante réseau estimée mesurée par l'algorithme ABR de Shaka (débit binaire observé). |
|
| Débit de téléchargement effectif sur tous les médias téléchargés. |
De plus, contentBitrate utilise track.videoBandwidth (débit binaire vidéo uniquement) pour le différencier des autres métriques qui indiquent la bande passante vidéo et audio combinée.
Prise en charge de la qualité d'expérience (QoE)
Les événements agrégés de QoE sont désormais pris en charge via video-core. Activez-les en définissant qoeAggregate: true dans la configuration :
const options = { info: { beacon: 'xxxxxxxxxx', applicationID: 'xxxxxxx', licenseKey: 'xxxxxxxxxxx', }, config: { qoeAggregate: true, qoeIntervalFactor: 2, },};
const tracker = new ShakaTracker(player, options);Les KPI suivants sont suivis automatiquement :
Indicateurs de performance clés | Description |
|---|---|
| Temps entre la demande de contenu et le début du contenu (ms). |
|
|
| Débit binaire moyen pondéré sur l'ensemble de la session. |
|
|
|
|
| Temps total passé en rebuffering (ms). |
| Temps de re-mise en mémoire tampon en pourcentage du temps de lecture total. |
| Temps total de lecture du contenu (ms). |
| Nombre total d'erreurs pendant la session. |
Compatibilité Shaka Player 5.x
Le tracker est désormais compatible avec Shaka Player 4.x et 5.x :
getPlayerVersion()résout la version sur les deux versions majeures.onError()gère à la fois les erreurs du lecteur Shaka (e.detail) et les erreurs de l'élément vidéo HTML (e.target.error).- Fichiers d'exemple mis à jour pour Shaka 5.x (suppression de
shaka.polyfill.installAll()obsolète, mise à jour de l'instanciation du lecteur).
Guide de mise à niveau
Exécutez ce qui suit pour mettre à jour :
$npm install @newrelic/video-shaka@4.0.3Pour activer la QoE, ajoutez qoeAggregate: true à vos options de configuration comme indiqué ci-dessus.
Dépendances
Nécessite @newrelic/video-core v4.1.1 ou une version ultérieure pour la prise en charge de la QoE.
Bug fixes
Improved contentBitrate calculation
Issue: The contentBitrate attribute reported the target bitrate from the manifest instead of the actual measured throughput during playback.
Fix: Updated the bitrate calculation method to use getAverageThroughput() from dash.js. This captures the measured average throughput, providing a more accurate, real-time representation of the content consumption rate during playback.
Implementation details
- Primary logic: Uses
player.getAverageThroughput('video')to retrieve measured throughput - Fallback logic:
- Uses manifest bitrate if throughput measurement is unavailable
- Improves accuracy of video quality monitoring and analytics
- Impact:
- More accurate bitrate reporting in New Relic video monitoring
- Better visibility into actual network conditions and video quality
- Improved debugging capabilities for playback issues
What's new
This release introduces three new bitrate metrics providing comprehensive quality analysis for MPEG-DASH streaming, along with important improvements to existing bitrate calculations and dash.js v4/v5 compatibility.
New features
New bitrate metrics
contentManifestBitrate: Maximum combined (video + audio) bitrate from the MPD manifest. Represents the highest possible stream variant available.contentMeasuredBitrate: Network estimated by the player's Adaptive BitRate (ABR) algorithm, based on measured download throughput. Use this metric to analyze ABR decision-making.contentDownloadBitrate: Effective download throughput calculated from video segment request data (bytesDownloaded × 8 / downloadTime). This Provides real-time network performance monitoring.
Changes
Updated bitrate calculations
contentBitrate: Returns the video-only bitrate from the active track and excludes audio. Previous versions included combined bitrate.contentRenditionBitrate: Returns the combined video and audio bandwidth of the active rendition to provide a complete quality picture.
Compatibility improvements
getDashBitrate(): Fixed v4 compatibility issue. Version check now occurs before calling v5-only APIs, preventing errors on dash.js v4.x installations.getManifestBitrate(): Introduced a smart version detection that usesgetRepresentationsByType()on dash.js v5+ and falls back togetBitrateInfoListFor()on v4.x.
Bug fixes
- Removed duplicate
getPlayhead()method definition - Removed
console.logstatement fromgetTrack()error handler
Bitrate metrics overview
Attribute | Type | Description |
|---|---|---|
| Video-only | Bitrate of the currently active video track |
| Combined | Video + audio bandwidth of active rendition |
| Maximum | Highest quality variant from MPD manifest |
| Estimated | ABR algorithm bandwidth estimate |
| Real-time | Effective download throughput |
Bug fixes
Fixed contentBitrate to accurately report stream bitrate
Issue: The contentBitrate attribute used estimatedBandwidth (the network capacity estimate) as its primary source, which didn't accurately represent the actual bitrate of the playing video stream.
Solution: Updated the bitrate calculation to prioritize streamBandwidth from Shaka Player statistics, which provides the actual content bitrate of the current video variant as defined in the manifest.
Impact: The contentBitrate attribute correctly reports the bitrate (in bits per second) of playing video stream rather than the estimated network bandwidth. This provides more accurate telemetry data for video quality monitoring and analytics.
Technical details
- Changed the priority order in
getContentBitratePlayback()method - Uses the
stats.streamBandwidthas the primary source for content bitrate - Updated the
DATAMODEL.mddocumentation to reflect the accurate definition