Data set parameters
Each stream type can collect different sets of data. A data set lets you define the format of the data received by your origin server, giving you the ability to choose or ignore specific parameters and their elements from log data fields.
In fields with whitespace and other non-printable or non-US ASCII characters (for example, octets outside of the range from 0x21 to 0x7E), these characters are hex-encoded as per RFC-1738 URL encoding.
If you're looking for sample logs (JSON and structured) with data, see Log format.
Data set support
Some data sets may not be available for logging depending on the product enabled for the property you want to monitor. For example, Web security and EdgeWorkers information data set fields are not supported for the Cloud Wrapper products.
Select the fields from this group to get information about the edge cache, and additional breadcrumbs data about the HTTP request-response cycle.
|Returns additional breadcrumbs data about the HTTP request-response cycle for improved visibility into the Akamai platform. This field is available only for Adaptive Media Delivery, Download Delivery, Cloud Wrapper, Object Delivery, Dynamic Site Accelerator, Ion Standard, and API Acceleration products.
a – the component IP of the node or host processing the request, such as the edge or origin host
c – the letter identifier for the Akamai network component that as involved during that phase of the request (c - cache parent, g - edge host, p - peer host, o - origin, or w - Cloud Wrapper)
j (optional) – forward list
k – the request end time (in milliseconds) between when the edge host accepts the connection and receives the request header, including initial metadata parsing time and SSL overhead
l – the turnaround time (in milliseconds) between receiving the end of the request headers and gathering the breadcrumb, including fetching the object from another server in case of a miss, or synchronous validation of cached object’s freshness, fetching the object from the disk, performing ESI processing, and computing response headers
m – the DNS lookup time (in milliseconds) as the delta between the start of the request and the completion of the DNS lookup
To log this parameter for the Dynamic Site Accelerator, Ion Standard, and API Acceleration products, you need to enable the Breadcrumbs behavior in your stream's property configuration. See Breadcrumbs in the Property Manager guide.
If you want to check the caching hierarchy for cacheable objects, use the Cache status and Breadcrumbs fields. If cache status returns
Common media client data
You can choose the CMCD data set to get standardized Common Media Client Data from media traffic for log analysis, QoS monitoring, and media delivery optimization. This field is available only for the Adaptive Media Delivery product. See the CMCD specification on the Consumer Technology Association website for details on specific fields.
|CMCD||cmcd=//1.0@V/bl=21600,br=1426,cid=%22akam-email%22,d=6006,mtp=11100,ot=m,sf=h,sid=%229f36f5c9-d6a2-497b-8c73-4b8f694eab749f36f5c9-d6a2-497b-8c73%22,tb=1426,dl=18500,nor=%22../300kbps/track.m4v%22,nrr=%2212323-48763%22,su,bs,rtp=12000,pr=1.08,sf=d,st=v%22||This field returns a Common Media Client Data payload for media traffic:|
v – CMCD version, e. g. 1.0
bl – the buffer length (in milliseconds) associated with the media object being requested rounded to the nearest 100 ms
br – encoded bitrate (in kbps) of the object
cid – an unique ID for the current content
d – the object playback duration (in milliseconds) of the requested object
mtp – the throughput (in kbps) between client and server, as measured by the client, and rounded to the nearest 100 kbps
ot – object type (audio only, video only, muxed audio & video, etc.)
sid – an unique GUID for the current streaming session
tb – the highest (top) bitrate (in kbps) rendition that the client is allowed to play
nor – the relative path of the next object to be requested
nrr – the next request object (nor) will be a partial object request, this field returns the byte range to be requested
su – the startup field returns without value if the object is needed urgently due to startup, seeking or recovery after a buffer-empty event
bs – the buffer starvation field returns without value if the buffer was starved between the prior request and this object request, resulting in the player rebuffering state and the video or audio playback stopped
rtp – the requested maximum throughput (in kbps) for the client to deliver the content, rounded to the nearest 100 kbps
sf – the streaming format, such as MPEG Dash, HLS or Smooth Streaming
st – stream type, either
pr – the playback rate field returns,
Choose from these data fields to log EdgeWorkers data, if enabled in your property. This includes adding the EdgeWorkers behavior for each of the properties you want to monitor. This data set is not supported for the Cloud Wrapper products.
|Provides information about the EdgeWorkers ID, version, event
handler, reasons for turning EdgeWorker off, returned errors and metrics
such as heap usage, CPU, and wall time. The field returns the data in
See DataStream reports in the EdgeWorkers guide for more details.
|Provides EdgeWorkers execution information, including the stage of execution, the EdgeWorker ID, process, total and total stage time (in milliseconds), used memory (in kilobytes), ghost flow, error code, HTTP status change when the response is generated using the API, CPU flits consumed during processing, tier ID for the request, indirect CPU time (in milliseconds) and ghost error code.|
See DataStream reports in the EdgeWorkers guide for more details.
Choose from these fields to get geolocation data about the requests, such as its country and city of origin.
|Billing region||8||The Akamai geographical price zone from where the request was served.|
|Country/region||US||The ISO code of the country or region where the request originated.|
|Edge IP||188.8.131.52||The IP address of the edge server that served the response to the client. This field returns data that may be useful while resolving issues with your account representative.
To monitor this parameter in your logs, you need to update your stream's property configuration to include a Log Request Details behavior that logs the Edge Server IP field. See Log custom parameters.
|Server country/region||US||The ISO code of the country or region from where the request was served.|
|State||New%20Hampshire||The URI-encoded name of the state where the request originated.|
|City||Bangalore||The city where the request originated.|
Choose from these log data fields to get customer and request identification data, including the request timestamp.
|CP code||2097150||The Content Provider code associated with the request that identifies a particular subset of traffic and content for billing, reporting, and monitoring served on the Akamai platform.|
|Request ID||2256a92||The identifier of the request assigned by the server. See Akamai Pragma headers for details.|
|Request time||1612215703.120||The Unix epoch time in seconds when the request when the edge server accepted the request from the client.|
|Stream ID||58736||The unique identifier of the stream that logged the request data. You can log this field to troubleshoot and group logs between different streams.|
Message exchange data
Choose from these fields to get log data gathered along the request-response cycle, including client information, request and response details, and bytes count.
If the origin provides an uncompressed object, but the edge server provides the object to the client as compressed, it's reported and billed as compressed. See the Bytes and Total bytes fields.
Using stream data for billing
We recommend using raw log data for basic traffic analysis and monitoring CDN health.
You should take these limitations into account before using data served on your stream for audit, compliance, or billing purposes. See DataStream use cases.
|Brotli status||baC||This field reports the status when serving a Brotli-compressed object:
a – the client accepts Brotli, and the request passes the status value in the Accept-Encoding header
|The content bytes served in the response body, excluding HTTP headers. For HTTP/2, this includes overhead bytes.|
|The IPv4 or IPv6 address of the requesting client. See IPv6 in RFC 5952.|
|Cookie||country=AU;%20sessionId=12a8f83b||This field contains cookies received in the HTTP request headers from the client.
This field is RFC-1738 escaped, replacing spaces and other special characters, and separated by the
To monitor this parameter in your logs, you need to update your stream's property configuration to include a Log Request Details behavior that logs the Set-Cookie header. See Log custom parameters.
|HTTP status codes||0|
|The HTTP status code sent in the response. Returns |
|The size of the object matching the |
|Origin Content-Length||10282||The compressible Content-Length object value (in bytes) in the response header from the origin. This field is available only for Ion Standard, Ion Premier and Ion Media Advanced products.|
|Overhead bytes||400||TCP/IP/ETH overhead in bytes for the request and response, without HTTP or UDP overhead.|
|The protocol of the response-request cycle.|
|Query string||q=foo&submit=true||The query string in the incoming URI from the client. To monitor this parameter in your logs, you need to update your stream's property configuration to set the Cache Key Query Parameters behavior to include all parameters. See Cache Key Query Parameters.|
|Request host||splat-traffic.205400.akamai.com||The value of the Host header in the request with the domain name of the server and the TCP port number on which the server is listening. If no port is included, the default port for the service requested is implied. For example, 443 for an HTTPS URL, and 80 for an HTTP URL.
|The HTTP method of the request.|
|Request path||path1/path2/file.ext||The path to a resource in the incoming URI without query parameters. See the Query string field.|
|The client TCP port number of the requested service.|
|The size of object data returned to the client without HTTP response headers.
The Akamai Edge logs the object size even if there is no |
|The value of the |
|TLS overhead time||-|
|The elapsed time in milliseconds between when the edge server accepts the connection and the completion of the TLS handshake. Returns a number for SSL connections, and |
|The protocol of the TLS handshake. Returns |
|The bytes served in the response including the content, protocol overheads, and request body bytes. Protocol overheads include HTTP headers and UDP/TCP/IP/ETH overheads.|
|Uncompressed size||46251||The size (in bytes) of the uncompressed object, if compressed before sending to the client.|
|The URI-encoded value of the |
This field is RFC-1738 escaped. See the note on hex-encoding above the table, User-Agent in RFC 7231 and RFC 2616.
To monitor this parameter in your logs, you need to update your stream's property configuration to include a User Agent behavior that logs this header. See Log custom parameters.
Request header data
Choose from these fields to extract data coming from the incoming requests' headers, such as the referrer URLs or byte ranges.
|The value of the |
To monitor this parameter in your logs, you need to update your stream's property configuration to include a Log Request Details behavior that logs the Accept-Language header. See Log custom parameters.
|Max age||300||The time in seconds that the object is valid for positive cache responses.|
|Provides a single byte range or a comma-separated list of byte ranges. Bytes are numbered from 0.
See Range in RFC 7233.
|Referer||https://example.com/search?q=jobs||The URL of the resource from which the requested URI was followed.
This field is RFC-1738 escaped.
See the note on hex-encoding above the table and Referer in RFC 7231.
To monitor this parameter in your logs, you need to update your stream's property configuration to include a Log Request Details behavior that logs the Referer header. See Log custom parameters.
|Returns the contents of the |
See Forwarded For in RFC 7239.
To monitor this parameter in your logs, you need to update your stream's property configuration to include a Log Request Details behavior that logs the X-Forwarded-For header. See Log custom parameters.
Network performance data
Choose from these fields to get data on the edge server and client performance, and error codes when serving the requests for troubleshooting.
|DNS lookup time||3||The elapsed time in milliseconds between the start of the request and the completion of the DNS lookup in a multi-domain config, if one was required. For cached IP addresses, this value is |
|Error code||ERR_ACCESS_DENIED|fwd_acl||A string describing the problem with serving the request.|
|Last byte||1||The last byte of the object that was served in this response. |
|Request end time||0|
|The elapsed time in milliseconds it takes the edge server to fully read the request.|
|Turnaround time||16||The elapsed time in milliseconds between when the last request header is received and the first byte of the reply is written to the client socket.|
|The time in milliseconds from when the edge server is ready to send the first byte of the response to when the last byte reaches the kernel.|
Select the Security rules field to log the Web Application Firewall (WAF) end user's activity data, including the security policy ID, non-deny, and deny rules. This data set is not supported for the Cloud Wrapper products.
|Security rules||ULnR_28976|3900000:3900001:3900005:3900006:BOT-ANOMALY-HEADER||This field returns data when the request triggers any configured WAF or Bot Manager rules in the |
To monitor this parameter in your logs, you need to update your stream's property configuration to include a Web Application Firewall (WAF) behavior or add the hostnames using Security Configurations.
When you Create a stream or Edit a stream, you can choose to log midgress traffic within the Akamai network, such as between two edge servers. This feature also requires enabling the Collect midgress traffic option in the DataStream behavior for your property in Property Manager. As a result, the second place in the log line contains a numeric value:
0, if the request was processed between the client device and edge server (
CLIENT_REQ), and isn't logged as midgress traffic
1, if the request was processed by an edge server within the region (
PEER_REQ), and is logged as midgress traffic
2, if the request was processed by a parent Akamai edge server in the parent-child hierarchy (
CHILD_REQ), and is logged as midgress traffic
If logging midgress traffic is not enabled on your contract, contact the Akamai support team.
If you want your stream to collect other custom data fields, specify them in the Log Request Details behavior of your property. See Log custom parameters.
Updated about 6 hours ago