API

Stream migration

The DataStream 2 API allows you to migrate your streams from DataStream 1 to DataStream 2 individually or in bulk using the automated migration feature in the DataStream API. Consider migrating the streams to DataStream 2 before the upcoming decommissioning of DataStream 1.

Key differences

Before you migrate any streams to DataStream 2, you can compare DataStream 1 with DataStream 2, and learn about the enhancements in DataStream 2 to make sure that it meets your data delivery requirements. Main differences include available destinations, supported products and data set fields. See DataStream 1 and DataStream 2 for details.

How to migrate to DataStream 2

When you are ready to proceed with the migration, reach out to your account team to get DataStream 2 enabled in the Akamai Marketplace. If you don’t have access to the Marketplace, reach out to your Akamai sales representative.

Once you have DataStream 2 added to your account, you can migrate the stream by following the steps listed in Migration workflow.

Migration workflow

  1. Make sure your account has the DataStream 1, DataStream 2, and Property Manager scope. See Get started for details.

  2. Check if the properties you want to migrate the streams for are active on the production or staging network. Activate your property in Property Manager if necessary.

  3. Run the Prepare migration payload operation for the streams you want to migrate. Since DataStream 2 allows to monitor only properties that belong to the same product in one stream, in case of a DataStream 1 stream monitoring different products, the payload in the response will split the existing stream into two or more new streams depending on the number of different products.

Prepare migration payload
Open Recipe

  1. Solve all validation errors and issues listed by the migration payload in the response. See Migration errors for details.

  2. Run the Migrate streams operation to migrate up to 10 streams from DataStream 1 to DataStream 2.

Migrate streams
Open Recipe

  1. When you decide the configuration is ready for activation, run the Activate a stream operation.

  2. Enable the DataStream behavior in Property Manager to start collecting and streaming logs.

  3. Optionally, set the sample rate in the DataStream behavior to control the percentage of data you want to collect and send to the destination of your choice.

Next, you can configure these optional behaviors and criteria to have better control over your stream:

  • Custom log fields. Enable to log any of these data set fields: User-Agent, Accept-Language, Cookie, Referer, X-Forwarded-For or Custom field. See Custom log field.

  • Criteria. In each property that's part of the stream, you can configure the DataStream behavior in a custom rule to log requests matching your criteria. This lets you filter by hostnames, paths, IP addresses, or other criteria. See Criteria in the Property Manager API.