GuideReference
TrainingSupportCommunity

DataStream migration

Migrate your existing integration of the DataStream subprovider to use version 5.0 to better manage the existing features you've been using and add to them these new features:

  • Insight into your midgress.
  • New data set fields.

Summary of changes

Midgress traffic

You can now use DataStream to log midgress traffic on your properties.

  1. On creation of or as an edit to your data stream, add the collect_midgress argument and set it to true.
  2. Update your property's DataStream behavior to enable the collection of midrgress traffic.

Values returned in your logs tell you where the midgress is captured.

ValueDescription
0Request processed between a client device and an edge server and isn't logged as midgress traffic.
1Request processed by an edge server within a set region.
2Request processed by a parent Akamai edge server in the parent-child hierarchy.

Data set fields

Updates to data set fields.

IDNameTypeDescription
1066Edge IPStringThe IP address of the edge server that served the response to the client. This is useful when resolving issues with your account representative.
2019CacheableStringReturns 1 if the object is cacheable based on response headers and metadata, 0 if the object is not cacheable.
2023File size bucketStringThis field groups the response content into different buckets by size in kilobytes, megabytes and gigabytes.
2024Edge attemptsNumberThe number of attempts to download the content from the edge in a specific time interval, based on the number of total manifest requests received.
2052Server country/regionStringThe ISO 3166 code of the country or region from where the request was served.
2053Billing regionStringThe Akamai geographical price zone from where the request was served.
2060Brotli statusStringThis 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. For more information, see Brotli status.
2061Origin content-lengthintegerThe 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.
2080CMCDstringReturns a Common Media Client Data (CMCD) payload with detailed data on media traffic. This field is available only for the Adaptive Media Delivery product. For more information, see CMCD.

Update your configuration

Use the attribute change table to adjust your configuration settings.

Activation history

The required stream_id argument for the activation history data source did not change, but each of the attributes names have.

v1v2
activations TypeSetactivations TypeList
created_bymodified_by
created_datemodified_date
is_activestatus
stream_version_idstream_version

Data set fields

The optional argument for the data set fields data source name changed and is now product focused. Of all the v1 attributes, only one changed name.

Typev1v2
Argumenttemplate_nameproduct_id, possible values are:

  • CloudWrapper_MultiCDN
  • Adaptive_Media_Delivery
  • Download_Delivery
  • Object_Delivery
  • API_Acceleration
  • Ion_Standard
  • Ion_Premier
  • Dynamic_Site_Accelerator
  • Dynamic_Site_Delivery
  • Ion_Media_Advanced
  • Terra_Alta_Enterprise_Accelerator
  • Web_Application_Accelerator
  • Rich_Media_Accelerator
Attributedataset_group_namedataset_field_group

Data streams

The optional group_id argument for the data streams data source did not change, but several of the attributes names have and a few were removed.

v1v2
streamsstream_details
stream_version_idstream_version
current_version_idlatest_version
group_id TypeStringgroup_id TypeInt, returns without the grp_ prefix
activation_statusstream_status
group_nameRemoved
stream_type_nameRemoved
archivedRemoved
errorsRemoved
connectorsRemoved

Data stream

Both arguments and attributes for the data stream resource have changes.

Typev1v2
Argumentconfigdelivery_configuration
delimiterfield_delimiter
time_in_secinterval_in_secs
dataset_fields_idsdataset_fields
email_idsnotification_emails
property_idsproperties
template_nameRemoved
Not availablecollect_midgress
Attributestream_version_idstream_version
current_version_idlatest_version
property_idsproperties
dataset_fields_idsdataset_fields
configdelivery_configuration
Not availablestream_status
template_nameRemoved
stream_typeRemoved
product_nameRemoved