diff --git a/README.md b/README.md index 37d8c8b..586044d 100644 --- a/README.md +++ b/README.md @@ -12,7 +12,7 @@ Find some useful links below: ## Latest API Docs -Latest API Docs is 5.0.0. +Latest API Docs is 5.0.1. ## How to use @@ -46,8 +46,8 @@ Latest API Docs is akslack *(Stream Processor)*

This stream processor extension performs reordering of an event stream which is out of order.
 It implements the AQ-K-Slack based out-of-order handling algorithm which is originally described in
'http://dl.acm.org/citation.cfm?doid=2675743.2771828'.

-* kslack *(Stream Processor)*

This stream processor extension performs reordering of an out-of-order event stream.
 It implements the K-Slack based out-of-order handling algorithm which is originally described in
'https://www2.informatik.uni-erlangen.de/publication/download/IPDPS2013.pdf'.)

+* akslack *(Stream Processor)*

This stream processor extension performs reordering of an event stream which is out of order.
 It implements the AQ-K-Slack based out-of-order handling algorithm which is originally described in
'http://dl.acm.org/citation.cfm?doid=2675743.2771828'.

+* kslack *(Stream Processor)*

This stream processor extension performs reordering of an out-of-order event stream.
 It implements the K-Slack based out-of-order handling algorithm which is originally described in
'https://www2.informatik.uni-erlangen.de/publication/download/IPDPS2013.pdf'.)

## How to Contribute diff --git a/docs/api/5.0.1.md b/docs/api/5.0.1.md new file mode 100644 index 0000000..a8a9307 --- /dev/null +++ b/docs/api/5.0.1.md @@ -0,0 +1,212 @@ +# API Docs - v5.0.1 + +## Reorder + +### akslack *(Stream Processor)* + +

This stream processor extension performs reordering of an event stream which is out of order.
 It implements the AQ-K-Slack based out-of-order handling algorithm which is originally described in
'http://dl.acm.org/citation.cfm?doid=2675743.2771828'.

+ +Syntax +``` +reorder:akslack( timestamp, correlation.field, batch.size, timer.timeout, max.k, discard.flag, error.threshold, confidence.level) +``` + +QUERY PARAMETERS + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDescriptionDefault ValuePossible Data TypesOptionalDynamic
timestampThe attribute used for ordering the events.LONGNoNo
correlation.fieldThis 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.INT
FLOAT
LONG
DOUBLE		NoNo
batch.sizeThe 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.10,000LONGYesNo
timer.timeoutThis 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.-1 (timeout is infinite)LONGYesNo
max.kThis is the maximum threshold value for 'K' parameter in the Alpha K-Slack algorithm.9,223,372,036,854,775,807 (The maximum Long value)LONGYesNo
discard.flagThis 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.falseBOOLYesNo
error.thresholdThe error threshold to be applied in Alpha K-Slack algorithm. This parameter must be defined simultaneously with 'confidenceLevel'.0.03 (3%)DOUBLEYesNo
confidence.levelThe confidence level to be applied in Alpha K-Slack algorithm. This parameter must be defined simultaneously with 'errorThreshold'.0.95 (95%)DOUBLEYesNo
+Extra Return Attributes + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDescriptionPossible Types
beta0The timestamp based on which the reordering is performed.LONG
beta1An upper limit value assigned for the unsuccessfully handled late arrivals.DOUBLE
beta2The number of events that should be considered in the calculation of an alpha value.LONG
beta3The fixed time-out value in milliseconds assigned for flushing all the events buffered inside the extension.LONG
beta4The maximum threshold value assigned for 'K' parameter.LONG
beta5The flag set to indicate whether the out-of-order events which arrive after buffer eviction are to be discarded or not.BOOL
beta6The error threshold value set for Alpha K-Slack algorithm.DOUBLE
beta7The confidence level set for the Alpha K-Slack algorithm.DOUBLE
+ +Examples +EXAMPLE 1 +``` +define stream InputStream (eventtt long,data double); +@info(name = 'query1') +from InputStream#reorder:akslack(eventtt, data, 20) +select eventtt, data +insert into OutputStream; +``` +

This query performs reordering based on the 'eventtt' attribute values. In this example, 20 represents the batch size.

+ +### kslack *(Stream Processor)* + +

This stream processor extension performs reordering of an out-of-order event stream.
 It implements the K-Slack based out-of-order handling algorithm which is originally described in
'https://www2.informatik.uni-erlangen.de/publication/download/IPDPS2013.pdf'.)

+ +Syntax +``` +reorder:kslack( timestamp, timer.timeout, max.k, discard.flag) +``` + +QUERY PARAMETERS + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDescriptionDefault ValuePossible Data TypesOptionalDynamic
timestampThis is the attribute used for ordering the events.LONGNoNo
timer.timeoutThis 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.-1 (timeout is infinite)LONGYesNo
max.kThe maximum threshold value for 'K' parameter in the K-Slack algorithm.9,223,372,036,854,775,807 (The maximum Long value)LONGYesNo
discard.flagThis 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.falseBOOLYesNo
+ +Examples +EXAMPLE 1 +``` +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; +``` +

This query performs reordering based on the 'eventtt' attribute values. In this example, the timeout value is set to 1000 milliseconds

+ diff --git a/docs/api/latest.md b/docs/api/latest.md index 84bf5e6..a8a9307 100644 --- a/docs/api/latest.md +++ b/docs/api/latest.md @@ -1,4 +1,4 @@ -# API Docs - v5.0.0 +# API Docs - v5.0.1 ## Reorder diff --git a/docs/index.md b/docs/index.md index 37d8c8b..586044d 100644 --- a/docs/index.md +++ b/docs/index.md @@ -12,7 +12,7 @@ Find some useful links below: ## Latest API Docs -Latest API Docs is 5.0.0. +Latest API Docs is 5.0.1. ## How to use @@ -46,8 +46,8 @@ Latest API Docs is akslack *(Stream Processor)*

This stream processor extension performs reordering of an event stream which is out of order.
 It implements the AQ-K-Slack based out-of-order handling algorithm which is originally described in
'http://dl.acm.org/citation.cfm?doid=2675743.2771828'.

-* kslack *(Stream Processor)*

This stream processor extension performs reordering of an out-of-order event stream.
 It implements the K-Slack based out-of-order handling algorithm which is originally described in
'https://www2.informatik.uni-erlangen.de/publication/download/IPDPS2013.pdf'.)

+* akslack *(Stream Processor)*

This stream processor extension performs reordering of an event stream which is out of order.
 It implements the AQ-K-Slack based out-of-order handling algorithm which is originally described in
'http://dl.acm.org/citation.cfm?doid=2675743.2771828'.

+* kslack *(Stream Processor)*

This stream processor extension performs reordering of an out-of-order event stream.
 It implements the K-Slack based out-of-order handling algorithm which is originally described in
'https://www2.informatik.uni-erlangen.de/publication/download/IPDPS2013.pdf'.)

## How to Contribute diff --git a/mkdocs.yml b/mkdocs.yml index 836d1b6..a909c6e 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -32,6 +32,7 @@ markdown_extensions: pages: - Welcome: index.md - API Docs: + - 5.0.1: api/5.0.1.md - 5.0.0: api/5.0.0.md - 4.2.2: api/4.2.2.md - 4.2.1: api/4.2.1.md