Server Location

HLS Analyzer Monitoring Overview

HLSAnalyzer.com is an online HLS analyzer and monitoring service.  Streams are individually added to the monitoring system (Master or Media playlists), after which they can be configured for monitoring and alerting. Alerts can be delivered via email, or HTTP callback POSTs. HLSAnalyzer.com generates both stream delivery outages alerts as well as ad-insertion (SCTE-35) cue stoppage alerts. The monitoring engine downloads every segment and playlist, and logs the primary characteristics of the stream delivery process for subsequent evaluation and processing.  Summary reports for SCTE-35 cues as measured by the system, as well as an overview of all alert events can be downloaded for up to 90 days.

There are two primary ways of interacting with our system: a browser-based UI interface that allows access to most features of the analyzer, as well as an HTTP REST-based API that facilitates integration with automated pipelines. For examples on integrating our APIs with real-world applications, refer to our sample code available on Github.

Contents

Browser Interface

Monitor All Streams

View API Status

Perform Stream Processing

Configure Alert Parameters

Batch Processing

Logs

Alert Functionality

Cloud Monitoring and Management

API Error Response Codes

Analyzer Error and Warning Codes

Browser Interface

The HLSAnalyzer.com browser-based UI can be used to add and remove streams, check the current API status, add files from a .csv file, and configure alert parameters. The interface utilizes the same API calls that are documented in the next section, ensuring a consistent experience while interacting with the HLS Analyzer monitoring server. The browser can also be used to monitor the state of all links associated with an API key in real-time.  

For the best experience, the use of Google Chrome, Firefox, or Microsoft Edge is recommended.

Monitor All Streams

/monitor-hls-playlists/monitor-api/api_key/

Description: All streams associated with the particular API key will be available for inspection, via an interface similar to the following:

Features include:

View API Status

All of the important parameters of the API can be monitored, including the current alert configuration state.

Perform Stream Processing

HLS streams can be added and removed from this interface. LinkIDs may be supplied for each stream, to make their identification easier. When not supplied, LinkIDs will automatically be assigned by the server when adding streams. Stream outage alerts as well as SCTE-35 outage alerts (disabled by default) may be individually enabled or disabled for each stream.

Configure Alert Parameters

Global alert parameters can be configured via this panel. The outage and clear settings apply globally to all streams, with delivery stream outages being specified in units of seconds and SCTE-35 outages in units of minutes. Alerts may be globally enabled or disabled from this panel as well. One or both alert types (email and HTTP Post callback) can be filled or left blank.

Batch Processing

Batch processing functions perform functions that involve a large set of streams:

http://www.example.com/playlist.m3u8, mylinkID2

https://www.example.com/playlsit2.m3u8,

http://www.example.com/playlist3.m3u8, mylinkID3

Logs

There are two types of logs: summary logs and detailed logs. Summary logs can be selected for up to 7 days, while detailed logs up to 24 hours. The following logging functions can be performed by the system:

Logs will be available for up to 90 days in the past.


Alert Functionality

The monitoring service supports two types of outage alerts: stream delivery outages, and SCTE-35 cue outages. SCTE-35 alerts are disabled by default and must be enabled via the browser-based UI or the REST-APIs. Global alerts must be enabled before either stream outage alerts or SCTE-35 cue outage alerts are monitored.

When playlists or segments are not delivered on time, then alerts may be received according to configuration parameters. Media playlists may be in any of the following states:

Media Playlist State

Description

Live

Playlist does not have an ENDLIST and is progressing by adding new segments.

Stalled

New segments are not added to the playlist (stale playlist).

HTTPError

The playlist cannot be downloaded due to HTTP errors.

LiveEnd

The steam was in Live state, but has transitioned to ENDLIST. When in this state, no segment monitoring will be performed until the playlist returns to Live state again.

VOD

The stream was never in Live state and has an ENDLIST.

Unknown

The starting state of the stream, which will transition to any of the states described above.

When either media playlist or segments arrive at a slower rate than the expected time duration, the playlist buffer will be depleted and eventually reach zero, which would indicate a rebuffering event at the player. The total time spent while the player is rebuffering is considered as the amount of outage and is reported by the analyzer. Alerts are based on the time that the player is in a rebuffering state (e.g. the hypothetical playback buffer is zero), which can help track both complete stream outages, as well as intermittent delivery issues. As a result of this, the actual outage amount (where no data was theoretically available for playback) may be smaller than the period where data experienced inconsistent delivery. For example, if 10-second segments are delivered at non real-time rates and the playback buffer was already at or near zero, both outage and inconsistent delivery durations would be incurred. However, the accumulated outages would be 2 seconds for each segment, where the inconsistent delivery period would be accounted for the entire duration of the slower than real-time delivery times, as shown in the following diagram:

A stream must be in outage condition for a minimum amount of time before an alert is generated. After the alert condition has been resolved, the clear condition must continue for a minimum amount of time before the clear condition is recognized by the system. This is shown in the next diagram:

We recommend customers evaluate the alert sensitivity settings for both stream outages and SCTE-35 outages before determining a sensitivity level suitable for their system. Alerts may be programmed to report the inconsistent delivery times, as well as when those conditions have been cleared. Alert email messages will generally have the following format:


Subject: OUTAGE: HLSAnalyzer Outage Alert for 5fa1ab24559c

This is an alert update from HLSAnalyzer.com for:

 https://example.com/example.m3u8

Alerts:

[5fa1ab24559c] Outage Time (UTC): 1610541723.00, Alert Condition Duration: 125.00 (sec), Total Accumulated Stream Outage: 128.3 (sec), Status: Stalled , Variant:  https://example.com/example.m3u8

[5fa1ab24559c] This stream experienced inconsistent delivery for 125.00 seconds.


Subject: OK: HLSAnalyzer Clear Alert for 5fa1ab24559c

This is an alert update from HLSAnalyzer.com for:

 https://example.com/example.m3u8

Alerts:

[5fa1ab24559c] Outage Time (UTC): 1610542123.00, Alert Condition Duration: 305.00 (sec), Total Accumulated Stream Outage: 386.0 (sec), Status: Live , Variant: https://example.com/example.m3u8

[5fa1ab24559c] This stream's alert condition has been cleared after a consistent delivery period of 305.00 seconds.


Cloud Monitoring and Management

The HLSAnalyzer.com service is a fully managed and monitored solution that provides high service availability for our customers. The health of our system is monitored by:

Our list of internal monitoring tools is always expanding to ensure that our service remains up and available and continuously monitors our clients’ HLS streams.


API Error Response Codes

Category

Error Code

Description

API

EC100

General Error or Warning

EC101

Link quota limit reached

EC102

Invalid API Key

EC103

This feature requires a paid subscription

EC104

API Key has expired

M3U8 Links

EC110

Error condition with a specific text message

EC111

Warning condition with a specific text message

LinkID

EC120

Invalid or missing LinkID

Alerting

EC130

Invalid alert limit value specified

EC131

Invalid alert setup value specified


Analyzer Error and Warning Codes

Error Code

Error Message

Description

EC-1000

Media playlist has become a master playlist

A URI previously associated with a media playlist has become a master playlist. This is generally an unexpected condition.

EC-1001

An unusually large jump in media playlist progression

Media sequence numbers are expected to increase by 1, per RFC 8216 Section 6.2.2.

EC-1002

Media sequence wraparound

According to RFC 8216 Section 6.2.2, media sequence numbers MUST not wrap.

EC-1003

Negatively increasing media sequence

According to RFC 8216 Section 6.2.2, media sequence numbers MUST not decrease.

EC-1004

Extra player buffer accumulation

This error indicates the arrival of new segments faster than in real-time. This condition may eventually lead to skipped segment playback.

EC-1005

Negative segment duration

Segment duration must always be greater than zero.

EC-1006

Segment duration is greater than the target duration

Segment duration is greater than the target duration by more than 150%.

EC-1007

An unusually large segment duration

Any segment duration greater than 120 seconds is considered to be an error condition.

EC-1008

Invalid target or segment duration

The server could not decipher the segment or target duration in the playlist.

EC-2000

Bandwidth parameter not specified for media Playlist

According to RFC 8216 Section 4.3.4.2: “      Every EXT-X-STREAM-INF tag MUST include the BANDWIDTH attribute.”

EC-2001

The ratio of measured Peak Bitrate exceeds the specified bitrate

The measured peak bitrate must be less than the specified bitrate from the Master playlist

EC-2002

Could not download the segment

The segment specified by the media playlist could not be downloaded

EC-2003

Playlist and stream mismatch

The parameter specified in the Master playlist does not match the stream’s characteristic

EC-2004

Could not download the playlist

An HTTP error is reported by the operating system when trying to read the link

EC-2005

Additional HLS conformance errors

A specific error was encountered; refer to the error message for details

EC-3000

Subscription required

Some operations, such as downloading high-bitrate streams, require a subscription

Warning Code

Warning Message

Description

WA-1001

Rebuffering Error

A rebuffering event was experienced by the monitoring server, due to the slow arrival of media playlist segments.

WA-1002

Slow segment download time

Downloading of the segment took longer than the specified segment duration.

WA-1003

Media sequence number increment mismatch

Media sequence number differences do not match the expected segment counts in a live playlist.

WA-2000

Master playlist feature not supported

Media playlists that change resolution or are added or removed are not yet supported.

Copyright © 2022 Task One, LLC. All Rights Reserved.