Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Anchor
top71
top71


Tip

Learn to Add/Edit KPIs on this page. 


Explore the various KPI Attributes in the table given below - 

esquery
Panel


groupByFieldaverageFieldstartTimeFieldendTimeFieldresultOutPutTypeisComparisionKpi
KPI AttributeDescription

kpiID

It is like a primary key of a KPI. It should be unique, and have numerical value.
expectedTrend

It is expected trend of the KPI.

Eg. UPWARDS / DOWNWARDS

nameIt denotes the name of the KPI.
action

It is the Mathematical Function that is imposed on a KPI.

Eg. AVERAGE / COUNT / MINMAX

schedule

It is the job schedule of a KPI.

Eg. DAILY / WEEKLY / MONTHLY / YEARLY

vector

It denoted the DevOps vector of a tool, which is specified in the KPI.

Eg. BUILD, CODEQUALITY, DEFECTS, DEPLOYMENT etc,.

toolName
isGroupBygroupByFieldName

It is the name of the DevOps tool.

Eg. JIRA, Jenkins, Sonar, Rundeck etc,.

isGroupBy

It is used for Aggregation if more than one instance is specified. Its value is Boolean.

Eg. true / false 

groupByFieldIt is required when "isGroupBy" is set to true. It is used for Aggregation if more than one instance is specified. It's generally the name of the field on which Aggregation will be imposed.
averageFieldIt is required only when the KPI "action" is AVERAGE. Input the name of the field on which AVERAGE Mathematical Calculations must be imposed.
startTimeFieldIt indicates the Start time property name. Its input is a String value.
endTimeFieldIt indicates the End time property name. Its input is a String value.
resultOutPutType

It indicates the result type of the KPI. For instance, AVERAGE type KPI could have result as Average Time or Average of Number. Use time when the type of output is Time Duration, and number when the type of output is just a Normal Number.

Eg. time / number

isComparisionKpi

It is a Boolean value. It generally indicates whether or not the KPI result should have a comparison with previous KPI result.

Eg. true / false

esqueryIt is a Elasticsearch query to fetch the data and collect the results. 
timeFormat
esresource
es-index-read-missing-as-empty
nextRun
lastRunTime
isActive