datastream

Behavior name: DataStream

Version: v2024-04-29Includes use: No

Behavior name: DataStream

The Data​Stream reporting service provides real-time logs on application activity, including aggregated metrics on complete request and response cycles and origin response times. Apply this behavior to report on this set of traffic. Use the Data​Stream API to aggregate the data.

Note: In the latest rule format, log is an array of string values, such as ["1234", "5678"] instead of a single 1234 integer value. Make sure your property accepts the single integer for the previous rule format, otherwise use an array to prevent errors.

Default behavior

These samples reflect the behavior's default settings. You can use these as is in your configurations or make adjustments based on the behavior's available options.

data "akamai_property_rules_builder" "datastream" {
  rules_v2025_02_18 {
    name     = "DataStream"
    comments = "Provides real-time logs on application activity."
    behavior {
      datastream {
        enabled = true
        datastream_ids = ""
  }
}
  }
}
"behaviors": [
  {
  "name": "datastream",
  "options": {
    "enabled": true,
    "datastreamIds": ""
  }
}
]

Options

Option Description
stream_​type
Specify the Data​Stream type. Value is one of:
  • BEACON. Low latency streaming of raw or aggregated data for push delivery or through the pull API.
  • LOG. Scalable, low latency streaming of raw data for push delivery.
  • BEACON_​AND_​LOG. Specify both.
enabled
Enables Data​Stream reporting.
datastream_​ids
A set of dash-separated Data​Stream ID values to limit the scope of reported data. By default, all active streams report. Use the Data​Stream application to gather stream ID values that apply to this property configuration. Specifying IDs for any streams that don't apply to this property has no effect, and results in no data reported.
log_​enabled
Enables log collection for the property by associating it with Data​Stream configurations.
log_​stream_​name
Specifies the unique IDs of streams configured for the property. For properties created with the previous version of the rule format, this option contains a string instead of an array of strings. You can use the List streams operation to get stream IDs.
sampling_​percentage
Specifies the percentage of log data you want to collect for this property.
collect_​midgress_​traffic
If enabled, gathers midgress traffic data within the Akamai platform, such as between two edge servers, for all streams configured.