User Defined Functions
Extending the analytics ecosystem through UDFs with the Analytics API
Overview
This analytic processor enables complex calculation to be executed using a provided analytical function implemented using the Analytics API. This feature also provides the ability to set a rolling number of events to be used with the calculation.
Leverage this feature for complex calculations and control the implementation complexity
Key Features
Pluggable
Analytics API
DSL support
Example
The analytic function ema
, Exponential Moving Average, is defined inline using the standard Joule DSL
Attributes
Attribute | Description | Data Type | Required |
---|---|---|---|
fields | Fields to calculated from the event | String[] | |
event history | Number of rolling events to stored and used for the calculation | Integer | |
assign prefix | Prefix to use for the result assignment. This is used to allow the same function to be used multiple times. If this is not provided the function postfix will be applied e.g. ask_EMA | String Default: Function postfix |
Further example
This example demonstrates how you would combine complex calculation with a final analytic expression to trigger an alert.
Example function implementation
The below is an implementation example for a custom analytics function. Further details can be found in the Analytics API documentation.
Last updated