- Property Manager name: DataStream
- Behavior version: The
v2023-01-05rule format supports thedatastreambehavior v1.6. - 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.
| Option | Type | Description | Requires | |
|---|---|---|---|---|
stream_type | 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"}} | |
datastream_ids | 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}} | |
log_enabled | boolean | Enables log collection for the property by associating it with DataStream configurations. | stream_type is either: LOG, BEACON_AND_LOG | {"displayType":"boolean","tag":"input","type":"checkbox"}{"if":{"attribute":"streamType","op":"in","value":["LOG","BEACON_AND_LOG"]}} |
log_stream_name | string | Specifies the name of the active stream monitoring the property that you want to receive log data from. | log_enabled is true | {"displayType":"string","tag":"input","type":"text"}{"if":{"attribute":"logEnabled","op":"eq","value":true}} |
sampling_percentage | number | Specifies the percentage of log data you want to collect for this property. | log_enabled is true | {"displayType":"number","tag":"input","type":"number"}{"if":{"attribute":"logEnabled","op":"eq","value":true}} |
collect_midgress_traffic | boolean | Whether to collect traffic data from within the Akamai platform, such as between two edge servers. | log_enabled 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"}]}} |