Versions Compared

Key

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

KB 214 (ABAP): How to

...

generate and send KPIs

...

/Metrics

Category: Information

Priority: High

Platform: ABAP

Version: 1 from 28.11.2024

Description

In some case it might be needed to extract certain KPIs from processed data and send it as a metric to platforms which support metric ingest.

Resolution

Starting from PowerConnect SP 8.03 it is possible to use Administrator->Setup Metric->KPI Definitions to generate KPI based on collection data and send it to the appropriate connections.

...

Please following steps below to create necessary KPIs. All KPIs will be sent under _METRICS_ event subtype.

Create dedicated KPI subgroup (if necessary)

  1. Open Administrator->Setup Metric->KPI Definitions

    image-20241128-154742.png

  2. Double-click on Custom group in the left panel and click.

    image-20241128-154906.png

    This group should be always used for custom KPI definitions.

  3. Populate group details based on the context, set Active flag and confirm

    image-20241128-155104.png

Create KPI definition

  1. Select the group by double-clicking on it. The title should be changed to the name of defined group

    image-20241128-155220.png
  2. Click on Create KPI button Populate
    Name: should be in lowercase and not contain spaces or any non-readable characters
    Description: free text to describe the KPI
    Active: used to activate/deactivate KPI extraction
    Applicable for section is used to select Group Definition/event type and Subgroup/subtype, which will be the source of the KPI data
    Calculation Rule section contains the rule on how to create KPI value.

    Field: the field name, which exists in the selected Group/Subgroup defined in the section above
    Dimensions: used to aggregate data per certain dimensions like Instance name. Indicated field fields should exists in the selected Group/Subgroup defined in the section above

    image-20241129-085150.pngImage Added



    Function: aggregation rule used to generate the value. Following values/functions are supported:
    None - no aggregation made and the value is taken as is from each event (can generate a lot of metrics in case there is big dataset)|
    Average - average value is calculated
    Sum - total sum
    Max - maximum value
    Min - minimum value
    Count - count of events in the batch

    Unit: free text, which would describe the unit

    image-20241128-160143.png

  3. Confirm the dialog

  4. Define conditions (if necessary)
    Once KPI definition is saved, it is possible to filter out events which will be considered during KPI calculation by pression pressing on the Condition button at specific line:

    image-20241128-164143.png

    Conditions are following standard range definition format. Please find below the sample of conditions used to pick only busy dialog work processes.

    image-20241128-164443.png

  5. Confirm and Save dialog


Product version

Product

From

To

*

8.03

*