- Property Manager name: DataStream
- Behavior version: The
v2024-10-21rule format supports thedatastreambehavior v1.8. - Rule format status: GA, stable
- Access: Read/Write
- Allowed in includes: No (temporarily)
The DataStream 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 DataStream API to aggregate the data.
In the latest rule format, logStreamName 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.
| Option | Type | Description | Requires | |
|---|---|---|---|---|
streamType | enum | Specify the DataStream type. | {"displayType":"enum","options":["BEACON","LOG","BEACON_AND_LOG"],"tag":"select"}{"if":{"attribute":"modulesOnContract","op":"contains","scope":"global","value":"DataStreamLogs"}} | |
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 | boolean | Enables DataStream reporting. | {"displayType":"boolean","tag":"input","type":"checkbox"}{"if":{"expression":{"attribute":"streamType","op":"in","value":["LOG"]},"op":"not"}} | |
datastreamIds | string | A set of dash-separated DataStream ID values to limit the scope of reported data. By default, all active streams report. Use the DataStream 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. | {"displayType":"string","tag":"input","type":"text"}{"if":{"attribute":"enabled","op":"eq","value":true}} | |
logEnabled | boolean | Enables log collection for the property by associating it with DataStream configurations. | streamType is either: LOG, BEACON_AND_LOG | {"displayType":"boolean","tag":"input","type":"checkbox"}{"if":{"attribute":"streamType","op":"in","value":["LOG","BEACON_AND_LOG"]}} |
logStreamName | string | 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. | logEnabled is true | {"displayType":"string","tag":"input","type":"text"}{"if":{"attribute":"logEnabled","op":"eq","value":true}} |
samplingPercentage | number | Specifies the percentage of log data you want to collect for this property. | logEnabled is true | {"displayType":"number","tag":"input","type":"number"}{"if":{"attribute":"logEnabled","op":"eq","value":true}} |
collectMidgressTraffic | boolean | If enabled, gathers midgress traffic data within the Akamai platform, such as between two edge servers, for all streams configured. | logEnabled is true | {"displayType":"boolean","tag":"input","type":"checkbox"}{"if":{"op":"and","params":[{"attribute":"logEnabled","op":"eq","value":true},{"attribute":"modulesOnContract","op":"contains","scope":"global","value":"DataStreamMidgress"}]}} |