KPI Metrics Report

Using the KPI Metrics Report offered by eG Enterprise, administrators can compare the performance of key metrics pertaining to two different components or historically analyze the performance of a component during different time periods. Using this report, administrators can actually compare the load on the servers over a chosen time period, identify the server that is resource-hungry and allocate additional resources to that server. The report also reveals the best/worst players in a particular performance area, thereby bringing to light components that are problem-prone, and which hence require continuous attention.

To historically analyze the performance of a component during different time periods, do the following:

  1. Select the KPI Metrics option from the Comparison Reports node of the REPORTS BY FUNCTION tree.

  2. Figure 1 will then appear.

    Figure 1 : Generating a KPI Analysis Report

  3. Clicking the button against the Selection 1 option will lead you to Figure 2.

    Figure 2 : Selecting a component for which the report is to be generated

  4. From Figure 2, select the Component Type and Component for which the report is to be generated.

  5. Then, specify the Timeline for the graph. You can either provide a fixed time line such as 1 hour, 2 days, etc., or select the Any option from the list to provide a From and To date/time for report generation.

    Note:

    For every user registered with the eG Enterprise system, the administrator can indicate the maximum timeline for which that user can generate a report. Once the maximum timeline is set for a user, then, whenever that user logs into eG Reporter and attempts to generate a report, the Timeline list box in the report page will display options according to the maximum timeline setting of that user. For instance, if a user can generate a report for a maximum period of 3 days only, then 3 days will be the highest option displayed in the Timeline list - i.e., 3 days will be the last option in the fixed Timeline list. Similarly, if the user chooses the Any option from the Timeline list and proceeds to provide a start date and end date for report generation using the From and To specifications, eG Enterprise will first check if the user's Timeline specification conforms to his/her maximum timeline setting. If not, report generation will fail. For instance, for a user who is allowed to generate reports spanning over a maximum period of 3 days only, the difference between the From and To dates should never be over 3 days. If it is, then, upon clicking the Run Report button a message box will appear, prompting the user to change the From and To specification.

  6. Clicking the Add button will add your selection to Selection 1.

  7. If you wish to change the label for Selection 1, then you can do so by clicking the icon.

    Figure 3 : Changing the label for Selection 1

  8. Entering the name of your choice and clicking the Update button will change the label of Selection 1.
  9. Follow the steps 3-5 to add a selection to Selection 2. The Component Type and Component chosen in Selection 1 will automatically apply to Selection 2. By default, the Timeline for Selection 2 is 1 day. If you wish to change the Timeline, then you can do so by selecting an appropriate Timeline of your choice. Clicking the Add button will add your selection to Selection 2.

  10. To select the measures for which the report is to be generated, click the icon. Figure 4 will then appear.

    Figure 4 : The Define Configuration pop up window

  11. From Figure 4, select a Test and Measure for which the report is to be generated. click the Add button will populate your selection in the section below. By default, a set of default tests and measures for which the report will be generated is displayed in this section as shown in Figure 4. If you wish to delete a set of test and measure, then you can do so by clicking the icon against each Test-Measure combination.
  12. Once the selection criterion is chosen, click the Done button. This will lead you back to Figure 1.

  13. Then, specify the Timeline for the graph. You can either provide a fixed time line such as 1 hour, 2 days, etc., or select the Any option from the list to provide a From and To date/time for report generation.

    Note:

    For every user registered with the eG Enterprise system, the administrator can indicate the maximum timeline for which that user can generate a report. Once the maximum timeline is set for a user, then, whenever that user logs into eG Reporter and attempts to generate a report, the Timeline list box in the report page will display options according to the maximum timeline setting of that user. For instance, if a user can generate a report for a maximum period of 3 days only, then 3 days will be the highest option displayed in the Timeline list - i.e., 3 days will be the last option in the fixed Timeline list. Similarly, if the user chooses the Any option from the Timeline list and proceeds to provide a start date and end date for report generation using the From and To specifications, eG Enterprise will first check if the user's Timeline specification conforms to his/her maximum timeline setting. If not, report generation will fail. For instance, for a user who is allowed to generate reports spanning over a maximum period of 3 days only, the difference between the From and To dates should never be over 3 days. If it is, then, upon clicking the Run Report button a message box will appear, prompting the user to change the From and To specification.

  14. In large environments, reports generated using months of data can take a long time to complete. Administrators now have the option of generating reports on-line or in the background. When a report is scheduled for background generation, administrators can proceed with their other monitoring, diagnosis, and reporting tasks, while the eG manager is processing the report. This saves the administrator valuable time. To schedule background processing of a report, select the Background Save - PDF option from the Report Generation list. In this case, a Report Name text box will appear, where you would have to provide the name with which the report is to be saved in the background. To process reports in the foreground, select the Foreground Generation - HTML option from this list.

    Note:

    • The Report Generation list will appear only if the EnableBackgroundReport flag in the [BACKGROUND_PROCESS] section of the eg_report.ini file (in the [EG_INSTALL_DIR]\manager\config directory) is set to Yes.
    • The default selection in the Report Generation list will change according to the Timeline specified for the report. If the Timeline set is greater than or equal to the number of days specified against the MinDurationForReport parameter in the [BACKGROUND_PROCESS] section of the eg_report.ini file, then the default selection in the Report Generation list will be Background Save - PDF. On the other hand, if the Timeline set for the report is lesser than the value of the MinDurationForReport parameter, then the default selection in the Report Generation list will be Foreground. This is because, the MinDurationForReport setting governs when reports are to be processed in the background. By default, this parameter is set to 2 weeks - this indicates that by default, reports with a timeline of 2 weeks and above will be processed in the background.

  15. Finally, clicking the Run Report will generate the report.

    Figure 5 : Generating the Comparison Reports - KPI Metrics

  16. From Figure 5, administrators can actually figure out the time during which the performance of the component was at peak and the time during which the maximum amount of resources have been utilized. By simply viewing this report, administrators can figure out if the resource utilization is always at its peak or is there a sudden surge in the resource utilization. If the resource utilization is constantly high, then administrators can infer that additional resources need to be added to the server so that performance of the server can be maintained consistently.