Logo

CDN collectors

Akamai CDN Collector

The Akamai cdn collector by Datazoom makes the following data points automatically collectable in real time and correlatable to data collected from Datazoom application collectors configured with a media player extension.

Data Points

Events

Discrete occurrences driven by user interactions or system actions

Fluxdata

Metrics measuring changing parameters over time

Events

CDN Log

Represents a single log line from the CDN's logging service

Metadata

User Details

App Session ID

Datazoom generated UUID for the user's Datazoom session.

Data type
string
Number Type
Not set
Required
true

Client IP Address

Public IP address of the end user's device

Data type
string
Number Type
Not set
Permitted Values
IP address

Content Session ID

A unique id for the current video playback session.

Data type
string
Number Type
Not set
Required
true
Permitted Values
UUID

User Agent

For web collectors, this is the browser's defined string for user agent. For application collectors, Datazoom composes a psuedo-user agent that contains a number of tokens that refer to aspects of the user device.

Data type
string
Number Type
Not set

CMCD

Buffer Length (CMCD)

The buffer length associated with the media object being requested.

Data type
number
Number Type
Int
Unit
milliseconds

Buffer Starvation (CMCD)

Key is included without a value if the buffer was starved at some point between the prior request and this object request, resulting in the player being in a rebuffering state and the video or audio playback being stalled. This key MUST NOT be sent if the buffer was not starved since the prior request. If the object type ‘ot’ key is sent along with this key, then the ‘bs’ key refers to the buffer associated with the particular object type. If no object type is communicated, then the buffer state applies to the current session.

Data type
bool
Number Type
Not set
Permitted Values
value list

Content ID (CMCD)

A unique string identifying the current content.

Data type
string
Number Type
Not set

Deadline (CMCD)

Deadline from the request time until the first sample of this Segment/Object needs to be available in order to not create a buffer underrun or any other playback problems.

Data type
number
Number Type
Int
Unit
milliseconds

Encoded Bitrate (CMCD)

The encoded bitrate of the audio or video object being requested. This may not be known precisely by the player; however, it MAY be estimated based upon playlist/manifest declarations. If the playlist declares both peak and average bitrate values, the peak value should be transmitted.

Data type
number
Number Type
Int
Unit
kbps

Measured throughput (CMCD)

The throughput between client and server, as measured by the client and MUST be rounded to the nearest 100 kbps. This value, however derived, SHOULD be the value that the client is using to make its next Adaptive Bitrate switching decision. If the client is connected to multiple servers concurrently, it must take care to report only the throughput measured against the receiving server. If the client has multiple concurrent connections to the server, then the intent is that this value communicates the aggregate throughput the client sees across all those connections.

Data type
number
Number Type
Int
Unit
kbps

Next Object Request (CMCD)

Relative path of the next object to be requested. This can be used to trigger pre-fetching by the CDN. This MUST be a path relative to the current request. This string MUST be URLEncoded [5]. The client SHOULD NOT depend upon any pre-fetch action being taken - it is merely a request for such a pre-fetch to take place.

Data type
string
Number Type
Not set

Next Range Request (CMCD)

If the next request will be a partial object request, then this string denotes the byte range to be requested. If the ‘nor’ field is not set, then the object is assumed to match the object currently being requested. The client SHOULD NOT depend upon any pre-fetch action being taken – it is merely a request for such a pre-fetch to take place. Formatting is similar to the HTTP Range header, except that the unit MUST be ‘byte’, the ‘Range:’ prefix is NOT required and specifying multiple ranges is NOT allowed. Valid combinations are: "-" "-" "-"

Data type
string
Number Type
Not set

Object Duration (CMCD)

The playback duration in milliseconds of the object being requested. If a partial segment is being requested, then this value MUST indicate the playback duration of that part and not that of its parent segment. This value can be an approximation of the estimated duration if the explicit value is not known.

Data type
number
Number Type
Int
Unit
milliseconds

Object Type (CMCD)

The media type of the current object being requested: m = text file, such as a manifest or playlist a = audio only v = video only av = muxed audio and video i = init segment c = caption or subtitle tt = ISOBMFF timed text track k = cryptographic key, license or certificate. o = other If the object type being requested is unknown, then this key MUST NOT be used.

Data type
string
Number Type
Not set
Permitted Values
value list

Playback Rate (CMCD)

1 if real-time, 2 if double speed, 0 if not playing. SHOULD only be sent if not equal to 1.

Data type
number
Number Type
Short

Request ID (CMCD)

A unique identifier that is established to track an individual media object request made from the client to a CDN.

Data type
string
Number Type
Not set

Requested Maximum Throughput (CMCD)

The requested maximum throughput that the client considers sufficient for delivery of the asset. Values MUST be rounded to the nearest 100kbps. For example, a client would indicate that the current segment, encoded at 2Mbps, is to be delivered at no more than 10Mbps, by using rtp=10000. Note: This can benefit clients by preventing buffer saturation through over-delivery and can also deliver a community benefit through fair-share delivery. The concept is that each client receives the throughput necessary for great performance, but no more. The CDN may not support the rtp feature.

Data type
number
Number Type
Int
Unit
kbps

Session ID (CMCD)

A GUID identifying the current playback session. A playback session typically ties together segments belonging to a single media asset. Maximum length is 64 characters. It is RECOMMENDED to conform to the UUID specification [7].

Data type
string
Number Type
Not set

Startup (CMCD)

Key is included without a value if the object is needed urgently due to startup, seeking or recovery after a buffer-empty event. The media SHOULD not be rendering when this request is made. This key MUST not be sent if it is FALSE.

Data type
bool
Number Type
Not set
Permitted Values
value list

Stream Type (CMCD)

Describes if the content being streamed is Live or On Demand.

Data type
string
Number Type
Not set
Permitted Values
value list

Streaming Format (CMCD)

The streaming format that defines the current request. d = MPEG DASH h = HTTP Live Streaming (HLS) s = Smooth Streaming o = other If the streaming format being requested is unknown, then this key MUST NOT be used.

Data type
string
Number Type
Not set
Permitted Values
value list

Sub-Request ID (CMCD)

A unique identifier that is established to track an internal CDN request where a media object cannot be fulfilled by the initial service receiving the request and gets passed to another node for fulfillment.

Data type
string
Number Type
Not set

Top Bitrate (CMCD)

The highest bitrate rendition in the manifest or playlist that the client is allowed to play, given current codec, licensing and sizing constraints.

Data type
number
Number Type
Int
Unit
kbps

Version (CMCD)

The version of the CMCD specification used for interpreting the defined key names and values.

Data type
number
Number Type
Short

CDN

Cache Hit

Boolean value indicating if the response pulled from server's local cache.

Data type
bool
Number Type
Not set
Permitted Values
value list

Cache Result

Additional information that expands on the cacheHit data point describing the result or actions taken if the cache is unavailable.

Data type
string
Number Type
Not set

CDN

Content Distribution Network name

Data type
string
Number Type
Not set

Content Type

The value of the HTTP Content-Type header of the response.

Data type
string
Number Type
Not set

Host

Host of the client's request.

Data type
string
Number Type
Not set

HTTP Status

HTTP Status Code returned by the server.

Data type
string
Number Type
Not set

Location

City

The city or town where the user is located

Data type
string
Number Type
Not set
Notes
When aggregated with other player sessions, this can provide a definitive number of viewers within a city. This can be helpful when targeting local advertising.

Country Code

The country from which the browser initiated the event. For a list of country codes, see ISO 3166-1 alpha-2 .

Data type
string
Number Type
Not set
Notes
This value is ideal to utilize when enforcing content rights: any player identified within a specific country can be blocked from accessing the content. Note that proxy servers can be used by viewers to make their request appear to be originating from an approved country. Matching the countryCode received during a request to the country specified in the subscriber's profile information can help mitigate proxy use.
Permitted Values
2 letter code

Region

The specific administrative division within a country where the event occurred. In the United States, regions correspond to state names ; for example, Washington or New York.

Data type
string
Number Type
Not set
Notes
This is the full form of the regionCode (i.e., Florida instead of FL). As a result, this value is often used for display purposes, rather than programmatically. If the fullname of a country region is needed, pulling this field is more efficient than employing memory or CPU to programmatically match the regionCode to a region name.

Message

Configuration ID

Datazoom generated identifier for the collector configuration

Data type
string
Number Type
Not set
Notes
Allows customers to differentiate data on the Connector from different Collectors (e.g., could be useful for separating test content from production data).
Required
true
Permitted Values
UUID

Event ID

Unique identifier for each event message fired by a Collector or log file received by Datazoom. The string includes an incremental counter at the end to allow for sequencing the events from a user session.

Data type
string
Number Type
Not set
Required
true

Custom Data

Custom Metadata

Customers can add any user or system data to the Datazoom data stream. Requires custom coding on the page or in the app by customer developer.

Number Type
Not set

Page

Referrer

The name of the domain that originated the request.

Data type
string
Number Type
Not set
Permitted Values
URL

Events

Timestamp

When the event is received by the Datazoom server in Epoch UTC milliseconds.

Data type
number
Number Type
Not set
Unit
milliseconds
Notes
In cases where two or more events have the same timestamp, please use the event count to determine the sequence in which the events occurred.
Required
true

FluxData

Bytes Served

Size of full Response (Bytes) sent, includes Header and Body.

Device Platforms
Server API

Time To First Byte

The number of microseconds between receiving the request and writing the first byte of the response, as measured on the server.

Device Platforms
Server API

Time To Last Byte

Time-Taken since the first byte read to the last byte sent.

Device Platforms
Server API

SET UP

Follow the directions provided by Akamai to setup and configure DataStream 2 for your property.

Datazoom will map a subset of the available data points in DataStream 2 to our equivalent CDN Data Dictionary key names.

When configuring the data set parameters, select JSON as the log format

Image below from Akamai DataStream setup

Use the following settings when selecting a destination for your logs:

  • Destination: Custom HTTPS

  • Display Name: Descriptive Name

  • Endpoint URL: https://streaming.datazoom.io/cdn/v1/logs/API_KEY_HERE

  • Authentication: NONE

Image below from Akamai DataStream setup

Continue to follow the steps outlined in the Akamai documentation to add your DataStream 2 configuration to your property. Once complete, you will need to add this new Collector to a Data Pipe. If you’re new to this, please review How to configure a Data Pipe.

Previous
Native Roku Media Player
Next
Amazon CloudFront CDN Collector