(DI-1911) Define a Custom KPI

Owned by DVD ROBOT
Last updated: Nov 04, 2019
4 min read

With the KPI definition you set up how a custom KPI is displayed in charts, from where it is collected and other settings which are mentioned below.

Before you define a new custom KPI for the first time, you must choose a collector which defines how data is collected into a KPI. You choose a collector based on the method of KPI creation, which you select in the step (DI-1911) Create a Custom KPI.

It is also possible to return to this step and adjust the definition of a custom KPI.

You may find an overview of the complete process under (DI-1911) The Complete Process of Custom KPI Creation and Data Collection.

Instructions

  1. In the main Insights screen (transaction /DVD/MON) go to Settings > Monitoring settings.
  2. In KPI definitions, click New Entries.
  3. Fill in all the required fields mentioned below and save.

Definition

  • KPI name: case sensitive name of a KPI.

    Your KPI name must start with a capital Z*, Y* as the standard customizing (field entries except the ones starting with Z*, Y*) can not be changed or added.

  • KPI description: description that is used in charts and other outputs as the KPI label
  • Long description (optional): long description of a KPI, which is displayed in the KPI info pop-up and in the KPI charts

  • KPI collector: determines which collector collects the KPI (for input help press F4). Select a collector according to the type of KPI you are creating.

    If you create a custom KPI from existing KPIs, we recommend to use the collector "/DVD/MON_CL_COLLECTOR". See below Calculate KPI from another KPI(s).

Properties

  • Unit of measurement: unit of measurement which is displayed next to the KPI value in the chart
  • Number of decimals: number of decimals which is displayed in charts. An empty field means that no decimals are displayed.

  • Monitoring area: Monitoring area of a system, which is specific for a KPI. A KPI is collected only for specific Monitoring areas, such as ERP, BW, CRM, SRM and others.
    To select a Monitoring area use the search help (F4), which displays only Monitoring areas which are supported for the system on which the KPI is collected.

    If you type a Monitoring area, which isn't supported for the monitored systems, the message KPI is suitable only for a system type... appears.


Collection

  • Collected on: system on which the KPI is collected or calculated. Possible values are "Remote system" or "Central system".

    Choose "Central system", if you create a KPI from an existing KPI. For more information, see below Calculate KPI from another KPI(s).


  • and for: KPI value is calculated for a system or a server level.

    Please select this field according to the collector you have previously chosen in KPI collector. For example the KPI "Size of a table" is a system KPI and the KPI "CPU load" is a server dependent KPI.

  • Server specification: If you have chosen in the above field and for "Server", choose among the server types "any server", "only application server", "only database server" or "only external server".

Calculate KPI from another KPI(s) - optional

This sections is optional and servers for creating a KPI from already existing KPIs. For more information about the calculation functions, please see the chapter (DI-1911) Create a KPI from an Existing KPI Based on a Calculation Function.

If you don't want to choose this option, leave the fields in this section empty.

Chart settings (optional)

You may set the lower and upper limit for displaying your KPI chart.

  • Lower/Upper limit mode: mode according to which your KPI chart is displayed
    • Limit is calculated from minimum/maximum values
    • Limit is a fixed value
    • Limit is calculated from fixed and minimum/maximum values
  • Lower/Upper limit value: value of the selected limit mode, based on which your KPI is displayed in charts
  • Chart line type: "Simple line", "Spline line" or "Discrete line"
  • Logarithmic Y scale: Y axis labels are values of the common logarithm (decimal)
  • Don't display KPI in charts: by the selected checkbox the KPI isn't displayed in charts or in the KPI group list. For example, you may select this field if you want to use the KPI value for other KPI calculations or aggregations.

Recommendation (optional) 

  • Recommended period: recommendation how often the KPI should be collected. This field serves only as information for other users about the period they should enter when starting the monitoring of this KPI. 
  • Recommended retention (days): recommended time for storage of KPI data in a system, before this data is deleted. This field serves only as information for other users about the retention time they should specify when scheduling the monitoring of this KPI. 

Log

  • Changed by/at: user who changed the KPI definition and the time of change
  • Created by/at: user who created the KPI definition and the time of creation

4. Save the KPI (CTRL+S).

Edit a custom KPI

It is possible only to edit the definition of custom KPIs (starting with Z*, Y*).

To next step for creation of a custom KPI depends on the collector.

If you have chosen the Collector for user defined SQL, go to the section Choose how data is collected into the custom KPI through a SQL SELECT statement.

If you have chosen the Collector for a custom KPI, go to the section Choose how data is collected into the custom KPI through editing the collector.

If you have chosen the Custom collector for a custom KPI, go to the section Implement the logic of a Custom collector.

An exception is when you create a KPI from a KPI, when you don't need to adjust the collector.