Calculate Real-time Metrics

These actions provide ability to build real-time intelligence and CEP capabilities using Siddhi.

Calculate Real-time Metrics Actions

Get / GetRT

Returns stored real-time data for a given id from Siddhi tables. Event metadata fields applicable for this action are as follows:

Table

Field	Definition	Example	Default
Domain	Name of the Siddhi table to query on	session_latest	-
Input Element	Json path for the input in request event payload	basket	-
Output Element	Json path for the output in response event payload	basket	-

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "title": "Calculate Real-time Metrics Get/GetRT action eventMeta fields",
  "type": "object",
  "properties": {
    "eventMeta": {
      "type": "object",
      "properties": {
        "domain": {
          "type": "string",
          "definition": "Name of the Siddhi table to query on",
          "example": "session_latest",
          "default": null
        },
        "inputElement": {
          "type": "string",
          "definition": "Json path for the input in request event payload",
          "example": "basket",
          "default": null
        },
        "outputElement": {
          "type": "string",
          "definition": "Json path for the output in response event payload",
          "example": "basket",
          "default": null
        }
      }
    }
  }
}

With event metadata parameters as:

Table

Parameter	Definition	Example	Default
Output Pattern	JMESPath pattern to apply on data output, before returning response	{totalPrice:basket.totalPrice}	-
Dataflow	Id of the dataflow from which data will be received	session_dna	-
Id Field	Name of the id field to query on Siddhi table	sessionid	id
Id Path	Json path for the id field in input element	session.id	id

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "title": "Calculate Real-time Metrics Get/GetRT action eventMeta.parameters",
  "type": "object",
  "properties": {
    "eventMeta": {
      "type": "object",
      "properties": {
        "parameters": {
          "type": "object",
          "properties": {
            "outputPattern": {
              "type": "string",
              "definition": "JMESPath pattern to apply on data output, before returning response",
              "example": "{totalPrice:basket.totalPrice}",
              "default": null
            },
            "dataflow": {
              "type": "string",
              "definition": "Id of the dataflow from which data will be received",
              "example": "session_dna",
              "default": null
            },
            "idField": {
              "type": "string",
              "definition": "Name of the id field to query on Siddhi table",
              "example": "sessionid",
              "default": "id"
            },
            "idPath": {
              "type": "string",
              "definition": "Json path for the id field in input element",
              "example": "session.id",
              "default": "id"
            }
          }
        }
      }
    }
  }
}

Example

Input

{
    "parameters": {
        "id": "path-1"
    }
}

Event Metadata

GetQuery / GetQueryRT

Returns stored real-time data for a given id from Siddhi tables. Event metadata fields applicable for this action are as follows:

Table

Field	Definition	Example	Default
Input Element	Json path for the input in request event payload	basket	-
Output Element	Json path for the output in response event payload	product	-

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "title": "Calculate Real-time Metrics GetQuery/GetQueryRT action eventMeta fields",
  "type": "object",
  "properties": {
    "eventMeta": {
      "type": "object",
      "properties": {
        "inputElement": {
          "type": "string",
          "definition": "Json path for the input in request event payload",
          "example": "basket",
          "default": null
        },
        "outputElement": {
          "type": "string",
          "definition": "Json path for the output in response event payload",
          "example": "product",
          "default": null
        }
      }
    }
  }
}

With event metadata parameters as:

Table

Parameter	Definition	Example	Default
Output Pattern	JMESPath pattern to apply on data output, before returning response	{id:id, name:data.name, description:data.description}	-
Dataflow	Id of the dataflow from which data will be received	session_dna	-
Query Id	Id of the query to execute	product_search_0001	-
Query Name	Name of the query to execute	Product Search	-
Query Json	Full Json representation of query to execute	-	-

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "title": "Calculate Real-time Metrics GetQuery/GetQueryRT action eventMeta.parameters",
  "type": "object",
  "properties": {
    "eventMeta": {
      "type": "object",
      "properties": {
        "parameters": {
          "type": "object",
          "properties": {
            "outputPattern": {
              "type": "string",
              "definition": "JMESPath pattern to apply on data output, before returning response",
              "example": "{id:id, name:data.name, description:data.description}",
              "default": null
            },
            "dataflow": {
              "type": "string",
              "definition": "Id of the dataflow from which data will be received",
              "example": "session_dna",
              "default": null
            },
            "queryId": {
              "type": "string",
              "definition": "Id of the query to execute",
              "example": "product_search_0001",
              "default": null
            },
            "queryJson": {
              "type": "object",
              "definition": "Full Json representation of query to execute",
              "default": null
            },
            "queryName": {
              "type": "string",
              "definition": "Name of the query to execute",
              "example": "Product Search",
              "default": null
            }
          }
        }
      }
    }
  }
}

Example

Input

{
    "parameters": {
        "category": "cat-1"
    }
}

Event Metadata