KPIs & Group KPIs

Last Updated OnOctober 18, 2023

This section will describe the Topology API for adding Group KPIs and KPIs customized for a Standard or Customized components in the Heal.

KPI Group

Performance KPI metrics can be single like CPU and grouped like Disk Space. If you want a KPI to be grouped, create the KPI Group using the KPI-groups API.
API Name – kpi-groups
Format – POST /api/accounts/<account_identifier>/kpi-groups
JSON Format

{ “groupKpiName”: “<Name of the KPI group>”, “groupKpiIdentifier”: “<Identifier of the KPI group>”, “description”: “<Description of the KPI group>”, “kpiType”: “<Type of the KPI>”, “discovery”: “<Mode of discovery>” }

Input Required

Name	Description	Default Value	Predefined Values	Mandatory	More Info
groupKpiName	Name of the KPI group	–	–	Yes	Name must be unique in the Account
groupKpiIdentifier	Identifier of the KPI group	–	–	No	If you want to auto-generate the identifier by Heal, do not provide this parameter in the JSON.
description	Description of the KPI group	–	–	Yes
kpiType	Type of the KPI	–	Core, Availability, FileWatch, ConfigWatch	Yes
discovery	Mode of discovery	0	0, 1	Yes	0 – Connection created manually 1 – Connection created by the discovery

Sample JSON

{ “groupKpiName”: “BOOKING_CODES”, “groupKpiIdentifier”: “GROUP_KPI_BOOKING_CODES”, “description”: “This group is created for the booking codes “, “kpiType”: “CORE”, “discovery”: 0 }

Success Rest Response

{ “message”: “Created successfully.”, “responseStatus”: “SUCCESS”, “data”: { “38”: “GROUP_KPI_BOOKING_CODES” } }

Failure Rest Response

In the sample above, provide the groupKpiName as “”, provides the following response.

{ “message”: “Invalid request. Reason: Invalid values for one or more attributes. For more details, refer application log file.”, “responseStatus”: “FAILURE”, }

KPI

Performance Metric KPIs can be added as an individual or with mapping to Group KPI. Component and Category must be predefined before creating an API.
API Name – kpis
Format – POST /api/accounts/<account_identifier>/kpis
JSON Format

{ “kpiName”: “<Name of the KPI>”, “kpiIdentifier”: “<Identifier of the KPI>”, “description”: “<Description of the KPI>”, “kpiType”: “<Type of the KPI>”, “dataType”: “<Data type of the KPI>”, “clusterOperation”: “<Aggregation operation>”, “rollupOperation”: “<Aggregation of clusterOperation>”, “clusterAggregation”: “<Aggregation for rollupOperation at cluster level>”, “instanceAggregation”: “<Aggregation for rollupOperation at component instance level>”, “collectionIntervalSeconds”: “<Duration between KPI data collections>” , “measureUnits”:”<Units of measure>”, “groupKpiIdentifier”:”<Identifier of group KPI>”, “componentName”:”<Identifier of the component>”, “componentVersion”:”<Common version of the component>”, “componentType”: “<Type of the component>”, “categoryName”:”<Name of the category>”, “enableAnalytics”:”<Enable or disable analytics>” }

Input Required

Name	Description	Default Value	Predefined Values	Mandatory	More Info
kpiName	Name of the KPI	–	–	Yes	Name must be unique in the Enterprise
kpiIdentifier	Identifier of the KPI	–	–	No	If you want to auto-generate the identifier by Heal, do not provide this parameter in the JSON.
description	Description of the KPI	–	–	Yes
kpiType	Type of the KPI	–	Core, Availability, FileWatch, ConfigWatch	Yes	Use only Predefiened values.
dataType	The data type of the KPI	–	Availability: Integer Core: Integer, Float or Text FileWatch: Text ConfigWatch: Integer, Float Text	Yes	Use only Predefiened values. Text can be upto maximum of 32 characters
clusterOperation	An operation to be applied on the value for this KPI at cluster level	–	Sum, Average or None	Yes	Use only Predefiened values.
rollupOperation	An operation to be applied during the Aggregation aka rollup	–	Sum, Average, Last, Max or None	Yes	Use only Predefiened values.
clusterAggregation	Flag to identify what level the operation to be applied, in case of Group KPI at cluster level	–	SingleValue, MultiValue or None	Yes	Use only Predefiened values.
instanceAggregation	Flag to identify what level the operation to be applied, in case of Group KPI at the instance level	–	SingleValue, MultiValue or None	Yes	Use only Predefiened values.
collectionIntervalSeconds	Data collection frequency for the KPI in Seconds	60	–	Yes	Value should be in multiple of 60 only.
measureUnits	Unit in which the KPI is measured	–	–	Yes	Provide the actual unit in which the KPI is collected.
groupKpiIdentifier	Identifier of group KPI	–	–	Yes	Fetch the right identifier of KPIGroup existing in the Heal database to which the KPI must be mapped to.
componentName	Identifier of the component	–	–	Yes	Fetch the right identifier of Component existing in the Heal database to which the KPI must be mapped to.
componentVersion	The common version of the component	–	–	Yes	Provide the Common Major version of the Component. Example: 8.x, 1.x
componentType	Type of the component	–	Application Server, Database Server, Services, Workload	Yes	Use only Predefiened values.
categoryName	Name of the category	–	–	Yes	Fetch the right identifier of Category existing in the Heal database to which the KPI must be mapped to.
enableAnalytics	Enable or disable analytics	–	0, 1	Yes	0 – false, 1 – true

Sample JSON

{ “kpiName”: “Coupon_Code”, “description”: “Codes of the Coupon Available”, “groupKpiIdentifier”: “GROUP_KPI_BOOKING_CODES”, “dataType”: “Integer”, “kpiType”: “Core”, “clusterOperation”: “None”, “rollupOperation”: “None”, “instanceAggregation”: “None”, “clusterAggregation”: “None”, “collectionIntervalSeconds”: 120, “measureUnits”: “Number”, “componentName”: “BookingComponent”, “componentType”: “Application Server”, “componentVersion”: “1.1”, “categoryName”: “3aa82ecf-ea46-4c19-9abe-fa23ebe241b9”, “enableAnalytics”: 1 }

Success Rest Response

Response for the valid sample above:

{ “message”: “KPI successfully created.”, “responseStatus”: “SUCCESS”, “data”: { “438”: “Coupon_Code-1581066393640” } }

Failure Rest Response

When the Category Name is provided instead of Category Identifier in the sample code, the response is as follows:

{ “message”: “Invalid request. Reason: Invalid values for one or more attributes. For more details, refer application log file.”, “responseStatus”: “FAILURE”, }

How Can We Help?

KPI Group

KPI