KPIOutput

The calculated KPIs and related metadata are delivered in KPIOutput UDRs. 

The generation of this UDR type is triggered by the timestamp field of the incoming KDR UDRs.

When a timestamp value exceeds the upper limit of the current period by a configurable "delay", KPIAggregatedOutput UDRs are generated for the period, which is then considered closed. The delay is configured in the KPI agent for further information, see KPI Agent. 

The length of a period for a KPI is defined by the window size that is set in the service model (kpi object). Calculated KPIs that belong to a closed period will be discarded.

The following fields are included in the KPIOutputUDRs:

Field

Type

Description

Field

Type

Description

instancePath

string

This field contains an instantiated path based on actual input data and the node path of the kpi object in the service model.

Example:

The instancePath to the object referenced by node 2 in the example is "/Example City/SITE_6494".

kpi

string

This field contains the name of the kpi object in the service model.

node

string

This field contains the node path of the kpi object in the service model, e g tree1/region/city.

For the instantiated path, corresponding to actual values in the input, see InstancePath.

outputTime

long

This field contains the system time (Unix time) when the KPIOutput UDR was generated.

outputType

int

0 - UDR generated at the end of a period

1 - UDR generated for an immediate alarm

When a KPI is configured to generate immediate alarms, the alarm output will be generated in a KPIOutout UDRs with outputType 1. A UDR for the same KPI will be generated at the end of the period with outputType 0.

periodEnd

long

This field contains the end time for the period, based on the incoming KDR UDR timestamps.

periodStart

long

This field contains the start time for the period, based on the incoming KDR UDR timestamps.

sampleCount

long

This field contains the number of KDR UDRs that were used for the KPI calculation.

threshold

string

This field contains the level name of threshold object in the service model.

value

double

This field contains the result of the KPI calculation.

windowSize

long

This field contains the length of the period. The period length is determined by windowSize in the the kpi object.