You can configure a data stream to collect these parameters. To get a list of available parameters, you can run the List data set fields operation.
Edge DNS and GTM logs
With the recent limited availability (LA) release of DataStream 2.1, you can now create streams for Edge DNS and Global Traffic Management as data sources.
For fields you can log in these streams, see Data set parameters in the DataStream 2 API v3 guide.
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.
In JSON logs, fields reported as - or null are omitted by default. If you're looking for sample logs (JSON and structured) with data, see Log format.
| Data set field ID | Field name | Data type | Description |
|---|---|---|---|
| 999 | Stream ID | string | The unique identifier of the stream that handled the request. |
| 1000 | CP code | string | The Content Provider code associated with the request. |
| 1002 | Request ID | string | The identifier of the request. |
| 1005 | Bytes | integer | The content bytes served in the response body. For HTTP/2, this includes framing overhead bytes used when multiplexing multiple responses on one connection. |
| 1006 | Client IP | string | The IPv4 or IPv6 address of the requesting client. |
| 1008 | HTTP status code | integer | The HTTP status code of the response. |
| 1009 | Protocol type | string | The scheme of the request-response cycle, either HTTP or HTTPS. |
| 1011 | Request host | string | The value of the Host header in the request. |
| 1012 | Request method | string | The HTTP method of the request. |
| 1013 | Request path | string | The path to a resource in the request, excluding query parameters. |
| 1014 | Request port | integer | The client TCP port number of the requested service. |
| 1015 | Response Content-Length | integer | The size of the entity-body in bytes returned to the client. |
| 1016 | Response Content-Type | string | The type of the content returned to the client. |
| 1017 | User-Agent | string | The URI-encoded user agent making the request. |
| 1019 | Accept-Language | string | The list of languages acceptable in the response. |
| 1023 | Cookie | string | A list of HTTP cookies previously sent by the server with the Set-Cookie header. |
| 1031 | Range | string | The part of an entity that the server is requested to return. |
| 1032 | Referer | string | The address of the resource from which the requested URL was followed. |
| 1037 | X-Forwarded-For | string | The originating IP address of a client connecting to a web server through an HTTP proxy or load balancer. |
| 1033 | Request end time | integer | The time in milliseconds it takes the edge server to fully read the request. |
| 1066 | Edge IP | string | The IP address of the edge server that served the response to the client. This is useful when resolving issues with your account representative. |
| 1068 | Error code | string | A string describing the problem with serving the request. |
| 1100 | Request time | float | The time when the edge server accepted the request from the client. |
| 1102 | Turn around time | integer | The time in milliseconds from when the edge server receives the last byte of the request to when it sends the first bytes of the response. |
| 1103 | Transfer time | integer | 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. |
| 2001 | TLS overhead time | integer | The time in milliseconds between when the edge server accepts the connection and the completion of the SSL handshake. |
| 2002 | TLS version | integer | The protocol of the TLS handshake, either TLSv1.2 or TLSv1.3. |
| 2003 | Object size | integer | The size of the object, excluding HTTP response headers. |
| 2004 | Uncompressed size | integer | The size of the uncompressed object, if zipped before sending to the client. |
| 2005 | Max-Age | integer | The time in seconds that the object is valid for positive cache responses. |
| 2006 | Overhead bytes | integer | TCP overhead in bytes for the request and response, without HTTP or UDP overhead. |
| 2007 | DNS lookup time | integer | The time in seconds between the start of the request and the completion of the DNS lookup, if one was required. |
| 2008 | Total bytes | integer | The total bytes served in the HTTP response (headers and content) including any protocol framing (HTTP2/TCP/UDP/IP/Ethernet) overhead, plus the HTTP request bytes for PUT and POST requests if those HTTP methods were used. When Akamai compresses customer content, the equivalent uncompressed bytes are used for the content bytes. |
| 2009 | Query string | string | The query string in the incoming URL from the client. To monitor this parameter in your logs, you need to update your property configuration to set the Cache Key Query Parameters behavior to include all parameters. |
| 2010 | Cache status | integer | Returns 0 if there was no object in the cache, and 1 if the object was present in the cache. In the event of negatively cached errors or stale content, the object is served from upstream even if cached. |
| 2012 | Country/Region | string | The ISO code of the country or region where the request originated. |
| 2013 | State | string | The state where the request originated. |
| 2014 | City | string | The city where the request originated. |
| 2019 | Cacheable | string | Returns 1 if the object is cacheable based on response headers and metadata, 0 if the object is not cacheable. |
| 2020 | Breadcrumbs | string | Returns additional breadcrumbs data about the HTTP request-response cycle for improved visibility into the Akamai platform, such as the IP of the node or host, component (cache parent, edge host, peer host, origin, or Cloud Wrapper), request end, turnaround and DNS lookup time. This field is available only for Adaptive Media Delivery, Download Delivery, Object Delivery, Dynamic Site Accelerator, Ion Standard, Ion Premier, and API Acceleration products. To log this parameter for Dynamic Site Accelerator, Ion Standard, and API Acceleration, you need to enable the breadcrumbs behavior in your stream's property configuration. See Breadcrumbs in the Property Manager guide. |
| 2021 | Last byte | integer | The last byte of the object that was served in this response. 0 indicates a part of a byte-range response. This field is available for all products supported by DataStream 2. |
| 2022 | Asnum | string | Returns a string with a single Autonomous System Number (ASN) or a colon-separated list of integers, if multiple ASNs are returned for the request's IP address. |
| 2023 | File size bucket | string | This field groups the response content into different buckets by size in kilobytes, megabytes and gigabytes. |
| 2024 | Edge attempts | integer | The number of attempts to download the content from the edge in a specific time interval, based on the number of total manifest requests received. |
| 2025 | Time to first byte | integer | The time taken to download the first byte of the received content in milliseconds. |
| 2026 | Startup errors | integer | The number of download initiation failures in a specific time interval. |
| 2027 | Download time | integer | The time taken to download the object in milliseconds. |
| 2028 | Throughput | integer | The byte transfer rate for the selected time interval in kilobits per second. |
| 2050 | Security rules | string | Returns data on security policy ID, non-deny and deny rules when the request triggers any configured WAF or Bot Manager rules. Requires configuring the Web Application Firewall (WAF) behavior in Property Manager or adding hostnames in Security Configurations. |
| 2052 | Server country/region | string | The ISO code of the country or region from where the request was served. |
| 2053 | Billing region | string | The Akamai geographical price zone from where the request was served. |
| 2060 | Brotli status | string | This field reports the status when serving a Brotli-compressed object. This field is available only for Ion Standard, Ion Premier and Ion Media Advanced products. See Brotli status in the DataStream user guide for details. |
| 2061 | Origin Content-Length | integer | 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. |
| 2062 | Download Initiated | integer | The number of successful download initiations in a specific time interval. |
| 2063 | Download Completed | integer | The number of complete successful downloads. |
| 2080 | CMCD | string | Returns a Common Media Client Data (CMCD) payload with detailed data on media traffic. This field is available only for the Adaptive Media Delivery product. See Common Media Client Data in the DataStream user guide for details. |
| 2081 | Delivery type | integer | Limits logged data to a specific media delivery type, such as live, VOD (video on demand), or default:3 - Download Delivery2 - Adaptive Media Delivery VOD1 - Adaptive Media Delivery Live0 - default type |
| 2082 | Delivery format | integer | Reports the logged data's media delivery format, such as HDS and HLS fragmentation, HDS and HLS stream packaging, Dynamic Adaptive Streaming over HTTP (DASH), Microsoft Smooth streaming etc., including the default format:4 - DASH3 - SILVERLIGHT2 - ZERI1 - IPHONE0 - default format |
| 2083 | Media encryption | integer | Returns 1 if media encryption is enabled for the content delivered from the edge to the client. |
| 2084 | Prefetch midgress hits | integer | Returns 1 if an edge server prefetched the content from a parent edge server other than the origin. |
| 2085 | Early hints | string | Returns the Early Hints response details in sub-fields delimited with the | character, in the Number of user-configured URLs or hints | Size of user-configured hints in bytes | Number of Akamai-generated URLs or hints | Size of Akamai-generated hints in bytes format. |
| 2086 | Edge IP binding status | integer | Returns 1 for Edge IP Binding (EIPB) requests received through an Anycast IP, or 0 for non-EIPB requests served directly from the edge server. |
| 3000 | EdgeWorkers usage | string | Returns EdgeWorkers data for client requests and responses if EdgeWorkers is enabled. The field format is: //[EdgeWorkers-Id]/[Version]/[Event Handler]/[Off Reason]/[Logic Executed]/[Status]/#[Metrics]. |
| 3001 | EdgeWorkers execution | string | Returns EdgeWorkers execution information if enabled, 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. |
| 3011 | Content protection information | string | Returns Enhanced Proxy Detection data, including the GeoGuard category, and the action EPD performed on the request. See Reporting metrics and dimensions for details. |
| 1082 | Custom field | N/A | The data specified in the Custom Log Field of the Log Requests Details that you want to receive in the stream. See Custom log field. |
Midgress traffic
You can use DataStream 2 to log midgress traffic on your property, such as between two Akamai edge servers. Using the Create a stream or Edit a stream operations, set the collectMidgress member to true, and go to Property Manager to enable the Collect midgress traffic option in the DataStream behavior for your property. 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 traffic1, if the request was processed by an edge server within the region (PEER_REQ), and is logged as midgress traffic2, if the request was processed by a parent Akamai edge server in the parent-child hierarchy (CHILD_REQ), and is logged as midgress traffic
When you enable logging midgress traffic from your stream, the Get a stream operation returns the collectMidgress member as true and lists the isMidgress data set field together with other data set fields you log in the stream. If the logging midgress traffic feature is not enabled on your contract, contact the Akamai support team.