-
Notifications
You must be signed in to change notification settings - Fork 27
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
[WSO2-Release] [Release 5.0.1] update documentation for release 5.0.1
- Loading branch information
1 parent
cadfc81
commit bd92765
Showing
5 changed files
with
220 additions
and
7 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,212 @@ | ||
| # API Docs - v5.0.1 | ||
|
|
||
| ## Reorder | ||
|
|
||
| ### akslack *<a target="_blank" href="http://siddhi.io/documentation/siddhi-5.x/query-guide-5.x/#stream-processor">(Stream Processor)</a>* | ||
|
|
||
| <p style="word-wrap: break-word">This stream processor extension performs reordering of an event stream which is out of order.<br> It implements the AQ-K-Slack based out-of-order handling algorithm which is originally described in <br>'http://dl.acm.org/citation.cfm?doid=2675743.2771828'.</p> | ||
|
|
||
| <span id="syntax" class="md-typeset" style="display: block; font-weight: bold;">Syntax</span> | ||
| ``` | ||
| reorder:akslack(<LONG> timestamp, <INT|FLOAT|LONG|DOUBLE> correlation.field, <LONG> batch.size, <LONG> timer.timeout, <LONG> max.k, <BOOL> discard.flag, <DOUBLE> error.threshold, <DOUBLE> confidence.level) | ||
| ``` | ||
|
|
||
| <span id="query-parameters" class="md-typeset" style="display: block; color: rgba(0, 0, 0, 0.54); font-size: 12.8px; font-weight: bold;">QUERY PARAMETERS</span> | ||
| <table> | ||
| <tr> | ||
| <th>Name</th> | ||
| <th style="min-width: 20em">Description</th> | ||
| <th>Default Value</th> | ||
| <th>Possible Data Types</th> | ||
| <th>Optional</th> | ||
| <th>Dynamic</th> | ||
| </tr> | ||
| <tr> | ||
| <td style="vertical-align: top">timestamp</td> | ||
| <td style="vertical-align: top; word-wrap: break-word">The attribute used for ordering the events.</td> | ||
| <td style="vertical-align: top"></td> | ||
| <td style="vertical-align: top">LONG</td> | ||
| <td style="vertical-align: top">No</td> | ||
| <td style="vertical-align: top">No</td> | ||
| </tr> | ||
| <tr> | ||
| <td style="vertical-align: top">correlation.field</td> | ||
| <td style="vertical-align: top; word-wrap: break-word">This corresponds to the data field of which the accuracy directly gets affected, by the adaptive operation of the Alpha K-Slack extension. This field is used to calculate the runtime window coverage threshold which is an upper limit set for the unsuccessfully handled late arrivals.</td> | ||
| <td style="vertical-align: top"></td> | ||
| <td style="vertical-align: top">INT<br>FLOAT<br>LONG<br>DOUBLE</td> | ||
| <td style="vertical-align: top">No</td> | ||
| <td style="vertical-align: top">No</td> | ||
| </tr> | ||
| <tr> | ||
| <td style="vertical-align: top">batch.size</td> | ||
| <td style="vertical-align: top; word-wrap: break-word">The parameter 'batch.size' denotes the number of events that should be considered in the calculation of an alpha value. It should be a value which should be greater than or equal to fifteen.</td> | ||
| <td style="vertical-align: top">10,000</td> | ||
| <td style="vertical-align: top">LONG</td> | ||
| <td style="vertical-align: top">Yes</td> | ||
| <td style="vertical-align: top">No</td> | ||
| </tr> | ||
| <tr> | ||
| <td style="vertical-align: top">timer.timeout</td> | ||
| <td style="vertical-align: top; word-wrap: break-word">This corresponds to a fixed time out value in milliseconds, which is set at the beginning of the process. Once the time out value expires, the extension drains out all the events that are buffered within the reorder extension. The time out has been implemented internally using a timer. The events buffered within the extension are released each time the timer ticks.</td> | ||
| <td style="vertical-align: top">-1 (timeout is infinite)</td> | ||
| <td style="vertical-align: top">LONG</td> | ||
| <td style="vertical-align: top">Yes</td> | ||
| <td style="vertical-align: top">No</td> | ||
| </tr> | ||
| <tr> | ||
| <td style="vertical-align: top">max.k</td> | ||
| <td style="vertical-align: top; word-wrap: break-word">This is the maximum threshold value for 'K' parameter in the Alpha K-Slack algorithm.</td> | ||
| <td style="vertical-align: top">9,223,372,036,854,775,807 (The maximum Long value)</td> | ||
| <td style="vertical-align: top">LONG</td> | ||
| <td style="vertical-align: top">Yes</td> | ||
| <td style="vertical-align: top">No</td> | ||
| </tr> | ||
| <tr> | ||
| <td style="vertical-align: top">discard.flag</td> | ||
| <td style="vertical-align: top; word-wrap: break-word">This indicates whether the out-of-order events which appear after the expiration of the Alpha K-slack window should be discarded or not. When this value is set to 'true', the events are discarded.</td> | ||
| <td style="vertical-align: top">false</td> | ||
| <td style="vertical-align: top">BOOL</td> | ||
| <td style="vertical-align: top">Yes</td> | ||
| <td style="vertical-align: top">No</td> | ||
| </tr> | ||
| <tr> | ||
| <td style="vertical-align: top">error.threshold</td> | ||
| <td style="vertical-align: top; word-wrap: break-word">The error threshold to be applied in Alpha K-Slack algorithm. This parameter must be defined simultaneously with 'confidenceLevel'.</td> | ||
| <td style="vertical-align: top">0.03 (3%)</td> | ||
| <td style="vertical-align: top">DOUBLE</td> | ||
| <td style="vertical-align: top">Yes</td> | ||
| <td style="vertical-align: top">No</td> | ||
| </tr> | ||
| <tr> | ||
| <td style="vertical-align: top">confidence.level</td> | ||
| <td style="vertical-align: top; word-wrap: break-word">The confidence level to be applied in Alpha K-Slack algorithm. This parameter must be defined simultaneously with 'errorThreshold'.</td> | ||
| <td style="vertical-align: top">0.95 (95%)</td> | ||
| <td style="vertical-align: top">DOUBLE</td> | ||
| <td style="vertical-align: top">Yes</td> | ||
| <td style="vertical-align: top">No</td> | ||
| </tr> | ||
| </table> | ||
| <span id="extra-return-attributes" class="md-typeset" style="display: block; font-weight: bold;">Extra Return Attributes</span> | ||
| <table> | ||
| <tr> | ||
| <th>Name</th> | ||
| <th style="min-width: 20em">Description</th> | ||
| <th>Possible Types</th> | ||
| </tr> | ||
| <tr> | ||
| <td style="vertical-align: top">beta0</td> | ||
| <td style="vertical-align: top; word-wrap: break-word">The timestamp based on which the reordering is performed.</td> | ||
| <td style="vertical-align: top">LONG</td> | ||
| </tr> | ||
| <tr> | ||
| <td style="vertical-align: top">beta1</td> | ||
| <td style="vertical-align: top; word-wrap: break-word">An upper limit value assigned for the unsuccessfully handled late arrivals.</td> | ||
| <td style="vertical-align: top">DOUBLE</td> | ||
| </tr> | ||
| <tr> | ||
| <td style="vertical-align: top">beta2</td> | ||
| <td style="vertical-align: top; word-wrap: break-word">The number of events that should be considered in the calculation of an alpha value.</td> | ||
| <td style="vertical-align: top">LONG</td> | ||
| </tr> | ||
| <tr> | ||
| <td style="vertical-align: top">beta3</td> | ||
| <td style="vertical-align: top; word-wrap: break-word">The fixed time-out value in milliseconds assigned for flushing all the events buffered inside the extension.</td> | ||
| <td style="vertical-align: top">LONG</td> | ||
| </tr> | ||
| <tr> | ||
| <td style="vertical-align: top">beta4</td> | ||
| <td style="vertical-align: top; word-wrap: break-word">The maximum threshold value assigned for 'K' parameter.</td> | ||
| <td style="vertical-align: top">LONG</td> | ||
| </tr> | ||
| <tr> | ||
| <td style="vertical-align: top">beta5</td> | ||
| <td style="vertical-align: top; word-wrap: break-word">The flag set to indicate whether the out-of-order events which arrive after buffer eviction are to be discarded or not.</td> | ||
| <td style="vertical-align: top">BOOL</td> | ||
| </tr> | ||
| <tr> | ||
| <td style="vertical-align: top">beta6</td> | ||
| <td style="vertical-align: top; word-wrap: break-word">The error threshold value set for Alpha K-Slack algorithm.</td> | ||
| <td style="vertical-align: top">DOUBLE</td> | ||
| </tr> | ||
| <tr> | ||
| <td style="vertical-align: top">beta7</td> | ||
| <td style="vertical-align: top; word-wrap: break-word">The confidence level set for the Alpha K-Slack algorithm.</td> | ||
| <td style="vertical-align: top">DOUBLE</td> | ||
| </tr> | ||
| </table> | ||
|
|
||
| <span id="examples" class="md-typeset" style="display: block; font-weight: bold;">Examples</span> | ||
| <span id="example-1" class="md-typeset" style="display: block; color: rgba(0, 0, 0, 0.54); font-size: 12.8px; font-weight: bold;">EXAMPLE 1</span> | ||
| ``` | ||
| define stream InputStream (eventtt long,data double); | ||
| @info(name = 'query1') | ||
| from InputStream#reorder:akslack(eventtt, data, 20) | ||
| select eventtt, data | ||
| insert into OutputStream; | ||
| ``` | ||
| <p style="word-wrap: break-word">This query performs reordering based on the 'eventtt' attribute values. In this example, 20 represents the batch size.</p> | ||
|
|
||
| ### kslack *<a target="_blank" href="http://siddhi.io/documentation/siddhi-5.x/query-guide-5.x/#stream-processor">(Stream Processor)</a>* | ||
|
|
||
| <p style="word-wrap: break-word">This stream processor extension performs reordering of an out-of-order event stream.<br> It implements the K-Slack based out-of-order handling algorithm which is originally described in <br>'https://www2.informatik.uni-erlangen.de/publication/download/IPDPS2013.pdf'.)</p> | ||
|
|
||
| <span id="syntax" class="md-typeset" style="display: block; font-weight: bold;">Syntax</span> | ||
| ``` | ||
| reorder:kslack(<LONG> timestamp, <LONG> timer.timeout, <LONG> max.k, <BOOL> discard.flag) | ||
| ``` | ||
|
|
||
| <span id="query-parameters" class="md-typeset" style="display: block; color: rgba(0, 0, 0, 0.54); font-size: 12.8px; font-weight: bold;">QUERY PARAMETERS</span> | ||
| <table> | ||
| <tr> | ||
| <th>Name</th> | ||
| <th style="min-width: 20em">Description</th> | ||
| <th>Default Value</th> | ||
| <th>Possible Data Types</th> | ||
| <th>Optional</th> | ||
| <th>Dynamic</th> | ||
| </tr> | ||
| <tr> | ||
| <td style="vertical-align: top">timestamp</td> | ||
| <td style="vertical-align: top; word-wrap: break-word">This is the attribute used for ordering the events.</td> | ||
| <td style="vertical-align: top"></td> | ||
| <td style="vertical-align: top">LONG</td> | ||
| <td style="vertical-align: top">No</td> | ||
| <td style="vertical-align: top">No</td> | ||
| </tr> | ||
| <tr> | ||
| <td style="vertical-align: top">timer.timeout</td> | ||
| <td style="vertical-align: top; word-wrap: break-word">This corresponds to a fixed time-out value in milliseconds, which is set at the beginning of the process. Once the time-out value expires, the extension drains out all the events that are buffered within the reorder extension. The time-out has been implemented internally using a timer. The events buffered within the extension are released each time the timer ticks.</td> | ||
| <td style="vertical-align: top">-1 (timeout is infinite)</td> | ||
| <td style="vertical-align: top">LONG</td> | ||
| <td style="vertical-align: top">Yes</td> | ||
| <td style="vertical-align: top">No</td> | ||
| </tr> | ||
| <tr> | ||
| <td style="vertical-align: top">max.k</td> | ||
| <td style="vertical-align: top; word-wrap: break-word">The maximum threshold value for 'K' parameter in the K-Slack algorithm.</td> | ||
| <td style="vertical-align: top">9,223,372,036,854,775,807 (The maximum Long value)</td> | ||
| <td style="vertical-align: top">LONG</td> | ||
| <td style="vertical-align: top">Yes</td> | ||
| <td style="vertical-align: top">No</td> | ||
| </tr> | ||
| <tr> | ||
| <td style="vertical-align: top">discard.flag</td> | ||
| <td style="vertical-align: top; word-wrap: break-word">This indicates whether the out-of-order events which appear after the expiration of the K-slack window should be discarded or not. When this value is set to 'true', the events would get discarded.</td> | ||
| <td style="vertical-align: top">false</td> | ||
| <td style="vertical-align: top">BOOL</td> | ||
| <td style="vertical-align: top">Yes</td> | ||
| <td style="vertical-align: top">No</td> | ||
| </tr> | ||
| </table> | ||
|
|
||
| <span id="examples" class="md-typeset" style="display: block; font-weight: bold;">Examples</span> | ||
| <span id="example-1" class="md-typeset" style="display: block; color: rgba(0, 0, 0, 0.54); font-size: 12.8px; font-weight: bold;">EXAMPLE 1</span> | ||
| ``` | ||
| define stream InputStream (eventtt long, price long, volume long); | ||
| @info(name = 'query1') | ||
| from InputStream#reorder:kslack(eventtt, 1000) | ||
| select eventtt, price, volume | ||
| insert into OutputStream; | ||
| ``` | ||
| <p style="word-wrap: break-word">This query performs reordering based on the 'eventtt' attribute values. In this example, the timeout value is set to 1000 milliseconds</p> | ||
|
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,4 +1,4 @@ | ||
| # API Docs - v5.0.0 | ||
| # API Docs - v5.0.1 | ||
|
|
||
| ## Reorder | ||
|
|
||
|
|
||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters