Measures
Bytes Served
measure
Size of full Response (Bytes) sent, includes Header and Body.
Applicable for: Ad, Content, Live, VOD
Field Type: number
Node Location: event.metrics.bytes_served
Permitted Values: any
Unit: bytes
Max Decimals: 0
Round Trip Time
measure
The round trip time (RTT) in microseconds from when a request is submitted from a client to a CDN server and back again to the starting point.
Applicable for: Ad, Content, Live, VOD
Field Type: number
Node Location: event.metrics.round_trip_time_mu
Permitted Values: any
Unit: microseconds
Max Decimals: 0
Time To First Byte
measure
The number of microseconds between receiving the request and writing the first byte of the response, as measured on the server.
Applicable for: Ad, Content, Live, VOD
Field Type: number
Node Location: event.metrics.time_to_first_byte_ms
Permitted Values: any
Unit: milliseconds
Max Decimals: 0
Time To Last Byte
measure
Time-Taken since the first byte read to the last byte sent.
Applicable for: Ad, Content, Live, VOD
Field Type: number
Node Location: event.metrics.time_to_last_byte_ms
Permitted Values: any
Unit: milliseconds
Max Decimals: 3
Message Metadata
Request Headers
dimension
List of the headers sent in the request to the CDN.
Applicable for: Ad, Live, Content, VOD
Field Type: string
Node Location: event.request_headers
Permitted Values: any
Request Params
dimension
List of the query parameters included in the request sent to the CDN.
Applicable for: Ad, Content, Live, VOD
Field Type: string
Node Location: event.request_params
Permitted Values: any
CDN Data
Cache Hit
dimension
Boolean value indicating if the response pulled from server's local cache.
Use Case
If the result of a CDN request is a MISS that indicates the content was not readily available in the CDN cache & had to be retrieved from another location. Depending on the CDN this may result delays delivering content or require the player to re-request the content.
Applicable for: Ad, Content, Live, VOD
Field Type: bool
Node Location: cdn.cache_hit
Permitted Values: value list
Value List: true, false
Cache Result
dimension
Additional information that expands on the cacheHit data point describing the result or actions taken if the cache is unavailable.
Use Case
If the result of a CDN request is a MISS that indicates the content was not readily available in the CDN cache & had to be retrieved from another location. Depending on the CDN this may result delays delivering content or require the player to re-request the content.
Applicable for: Ad, Content, Live, VOD
Field Type: string
Node Location: cdn.cache_result
Permitted Values: any
Content Type
dimension
The value of the HTTP Content-Type header of the response.
Applicable for: Ad, Content, Live, VOD
Field Type: string
Node Location: cdn.content_type
Permitted Values: any
HTTP Status
dimension
HTTP Status Code returned by the server.
Applicable for: Ad, Live, Content, VOD
Field Type: string
Node Location: cdn.http_status
Permitted Values: any
Referrer
dimension
The name of the domain that originated the request. Common referrers include search engines, other websites that link directly to your objects, and your own website.
Applicable for: Ad, Content, Live, VOD
Field Type: string
Node Location: page.referrer
Permitted Values: URL
UUID
dimension
Unique identifier of the log file.
Applicable for: Content, Ad, Live, VOD
Field Type: string
Node Location: root.uuid
Permitted Values: any
Event ID
dimension
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.
Use Case
Provides a UUID that can be used for de-dupping records in the data platform or Connector.
Applicable for: Ad, Content, Live, VOD
Field Type: string
Node Location: root.event_id
Permitted Values: any
CDN
dimension
Content Distribution Network name
Applicable for: Ad, Content, Live, VOD
Field Type: string
Node Location: cdn.cdn
Permitted Values: any
Host
dimension
Host of the client's request.
Applicable for: Ad, Content, Live, VOD
Field Type: string
Node Location: cdn.host
Permitted Values: any
User Details
App Session ID
dimension
Unique identifier for the user's current Datazoom session. Session will persist as long as the user is viewing content uninterrupted. A 20 minute pause in activity will close the session.
Use Case
This is the primary identifier for grouping events generated by Datazoom for analysis and unique user counts.
Applicable for: Ad, Content, Live, VOD
Field Type: string
Node Location: user_details.app_session_id
Permitted Values: any
Client IP Address
dimension
IP address of the user's device
Applicable for: Ad, Content, Live, VOD
Field Type: string
Node Location: user_details.client_ip
Permitted Values: IP address
Content Session ID
dimension
A unique id for the current video playback session.
Applicable for: Ad, Content, Live, VOD
Field Type: string
Node Location: user_details.content_session_id
Permitted Values: UUID
User Agent
dimension
Contains a number of tokens that refer to aspects of the user device, including the user's browser name and version, rendering engine, device’s model number, operating system and its version, etc.
Applicable for: Ad, Content, Live, VOD
Field Type: string
Node Location: user_details.user_agent
Permitted Values: any
Location
City
dimension
The city or town where the user is located
Applicable for: Ad, Content, Live, VOD
Field Type: string
Node Location: geo_location.city
Permitted Values: any
Country Code
dimension
The country from which the browser initiated the event. For a list of country codes, see ISO 3166-1 alpha-2 .
Applicable for: Ad, Content, Live, VOD
Field Type: string
Node Location: geo_location.country_code
Permitted Values: 2 letter code
Region
dimension
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.
Applicable for: Ad, Content, Live, VOD
Field Type: string
Node Location: geo_location.region
Permitted Values: any
Region Code
dimension
The specific administrative division within a country where the event occurred. In the United States, regions correspond to state codes ; for example, WA or NY.
Applicable for: Ad, Content, Live, VOD
Field Type: string
Node Location: geo_location.region_code
Permitted Values: 2 letter code
Network
ASN
dimension
Autonomous System Number: a unique number identifying a group of IP networks that serves the content to the end-user. Client ASN as determined from a lookup of the client IP
Use Case
ASN is a proxy for the customer's ISP which can be used for analyzing usage by ISP to identify problems that might be related a specific part of the ISP infrastructure.
Applicable for: Ad, Content, Live, VOD
Field Type: string
Node Location: network.asn
Permitted Values: any
ASN Org
dimension
The organization that owns the Autonomous System Number. Often an ISP, sometimes a private company or institution.
Use Case
ASN is a proxy for the customer's ISP which can be used for analyzing usage by ISP to identify problems that might be related to the ISP
Applicable for: Ad, Content, Live, VOD
Field Type: string
Node Location: network.asn_org
Permitted Values: any
cmcd
Startup (CMCD)
dimension
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.
Applicable for: Ad, Content, Live, VOD
Field Type: bool
Node Location: cmcd.su
Permitted Values: value list
Value List: true, false
Buffer Length (CMCD)
dimension
The buffer length associated with the media object being requested.
Applicable for: Ad, Content, Live, VOD
Field Type: number
Node Location: cmcd.bl
Permitted Values: any
Unit: milliseconds
Max Decimals: 0
Buffer Starvation (CMCD)
dimension
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.
Applicable for: Ad, Content, Live, VOD
Field Type: bool
Node Location: cmcd.bs
Permitted Values: value list
Value List: true, false
Content ID (CMCD)
dimension
A unique string identifying the current content.
Applicable for: Ad, Content, Live, VOD
Field Type: string
Node Location: cmcd.cid
Permitted Values: any
Deadline (CMCD)
dimension
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.
Applicable for: Ad, Content, Live, VOD
Field Type: number
Node Location: cmcd.dl
Permitted Values: any
Unit: milliseconds
Max Decimals: 0
Encoded Bitrate (CMCD)
dimension
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.
Applicable for: Ad, Content, Live, VOD
Field Type: number
Node Location: cmcd.br
Permitted Values: any
Unit: kbps
Max Decimals: 0
Measured throughput (CMCD)
dimension
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.
Applicable for: Ad, Content, Live, VOD
Field Type: number
Node Location: cmcd.mtp
Permitted Values: any
Unit: kbps
Max Decimals: 0
Next Object Request (CMCD)
dimension
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.
Applicable for: Ad, Content, Live, VOD
Field Type: string
Node Location: cmcd.nor
Permitted Values: any
Next Range Request (CMCD)
dimension
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:
"<range-start>-" "<range-start>-<range-end>" "-<suffix-length>"
Applicable for: Ad, Content, Live, VOD
Field Type: string
Node Location: cmcd.nrr
Permitted Values: any
Object Duration (CMCD)
dimension
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.
Applicable for: Ad, Content, Live, VOD
Field Type: number
Node Location: cmcd.d
Permitted Values: any
Unit: milliseconds
Max Decimals: 0
Object Type (CMCD)
dimension
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.
Applicable for: Ad, Content, Live, VOD
Field Type: string
Node Location: cmcd.ot
Permitted Values: value list
Value List: m, a, v, av, i, c, tt, k, o
Playback Rate (CMCD)
dimension
1 if real-time, 2 if double speed, 0 if not playing. SHOULD only be sent if not equal to 1.
Applicable for: Ad, Content, Live, VOD
Field Type: number
Node Location: cmcd.pr
Permitted Values: any
Max Decimals: 2
Request ID (CMCD)
dimension
A unique identifier that is established to track an individual media object request made from the client to a CDN.
Use Case
This is key in establishing trace visualization and joining specific CDN logs to a Media Object Request event.
Applicable for: Ad, Content, Live, VOD
Field Type: string
Node Location: cmcd.rid
Permitted Values: any
Requested Maximum Throughput (CMCD)
dimension
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.
Applicable for: Ad, Content, Live, VOD
Field Type: number
Node Location: cmcd.rtp
Permitted Values: any
Unit: kbps
Max Decimals: 0
Session ID (CMCD)
dimension
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].
Applicable for: Ad, Content, Live, VOD
Field Type: string
Node Location: cmcd.sid
Permitted Values: any
Stream Type (CMCD)
dimension
Describes if the content being streamed is Live or On Demand.
Use Case
v = all segments are available – e.g., VOD
l = segments become available over time – e.g., LIVE
Applicable for: Ad, Content, Live, VOD
Field Type: string
Node Location: cmcd.st
Permitted Values: value list
Value List: v, l
Streaming Format (CMCD)
dimension
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.
Applicable for: Ad, Content, Live, VOD
Field Type: string
Node Location: cmcd.sf
Permitted Values: value list
Value List: d, h, s, o
Sub-Request ID (CMCD)
dimension
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.
Applicable for: Ad, Content, Live, VOD
Field Type: string
Node Location: cmcd.srid
Permitted Values: any
Top Bitrate (CMCD)
dimension
The highest bitrate rendition in the manifest or playlist that the client is allowed to play, given current codec, licensing and sizing constraints.
Applicable for: Ad, Content, Live, VOD
Field Type: number
Node Location: cmcd.tb
Permitted Values: any
Unit: kbps
Max Decimals: 0
Version (CMCD)
dimension
The version of the CMCD specification used for interpreting the defined key names and values.
Applicable for: Ad, Content, Live, VOD
Field Type: number
Node Location: cmcd.v
Permitted Values: any
Max Decimals: 0
|
Comments
0 comments
Article is closed for comments.