Mongo Database Report

Use this report to obtain visibility into performance, health, and data usage patterns of the target Mongo Database server over a chosen period of time. The insights provided by this report allows administrators to optimize database resources, maintain a smooth user experience, and prevent outages during mission-critical operations.

In order to generate the Mongo Database report, do the following:

  1. Select the Mongo Database option by following the menu sequence: Reports by Function -> Domain-specific Reports -> Database Technologies -> Mongo Database.

  2. Figure 5 then appears.

    Figure 5 : Specifying the criteria for the Mongo Database report

  3. Select a criterion for analysis from the Analyze By list box. Using this report, you can analyze the performance of one/more managed components, or those that are part of a zone, service or segment. The options provided by the Analyze By list box are discussed hereunder:

    • Component: Select this option to choose the component(s) from across all the managed components in the environment.
    • Zone: To generate a report for one/more components that are included in a zone, pick the Zone option. A Zone drop-down list will then appear, from which you would have to select the zone to which the components of interest to you belong to. A Sub zone flag also appears. Indicate whether the components present within the sub-zones of the chosen zone are also to be to be considered for report generation, by setting the Sub zone flag to Yes.
    • Segment: If you want to generate a report for one/more chosen components that belong to a segment, select the Segment option from Analysis By list box, and then pick the Segment from the drop-down list that appears.
    • Service: If you want to generate a report for one/more components involved in the delivery of a service, select the Service option from Analysis By, and then pick the required Service from the drop-down list that appears.
  4. Pick a Component Type for which the report is to be generated. By default, MongoDB is chosen from this list.
  5. The Components list will be populated with all the components that are managed in your environment for the chosen component type. If the Components list consists of too many components, then viewing all the components and selecting the ones you need for report generation could require endless scrolling. To avoid this, you can click the button next to the Components list. A Components pop up window will then appear using which you can view almost all the components in a single interface and Select the ones to be included in this report.

  6. 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.

  7. In addition to the settings discussed above, this report comes with a set of default specifications. These settings are hidden by default. If you do not want to disturb these default settings, then you can proceed to generate the report by clicking the Run Report button soon after you pick one/more components for report generation. However, if you want to view and then alter these settings (if required), click on the icon. The default settings will then appear in the MORE OPTIONS drop down window (See Figure 6). The steps below discuss each of these settings and how they can be customized.

    Figure 6 : The default settings for generating the Mongo Database report

  8. Indicate the report Time Period for which the report is to be generated.

    Note:

    By default, the Time Period is set to 24 hours. Accordingly, the From and To parameters in the [timeframe] section of the eg_report.ini file (in the <eg_install_dir>\manager\config directory) are set to 00:00 and 24:00 respectively. If need be, you can override this default setting by configuring a different timeframe against the From and/or To parameters. 

  9. If the timeline specified for the report needs to exclude the data collected during the Weekends, then set Exclude weekends to Yes (Saturday,Sunday). If not, select No.

    Note:

    By default, the weekend constitutes Saturday and Sunday. To override this default setting, do the following:

    • Edit the eg_report.ini file in the <EG_INSTALL_DIR>\manager\config directory.
    • In the [EXCLUDE_WEEKEND] section of the file, the Days parameter is set to Saturday,Sunday by default. You can modify this by setting the Days parameter to a comma-separated list of other days of the week - say Friday,Saturday.
    • Save the file after making the required changes.

  10. 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, you can either select the Background Save - PDF or Background Save -CSV 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.
    • Click the Done button once you have made the necessary changes in Figure 6.
  11. Click the Done button if any changes were made to the More Options drop down window.
  12. Finally, click the Run Report button to generate the report.

  13. If the Report type is Foreground Generation - HTML, then Figure 7 will appear as soon as you click the Run Report button.

    Figure 7 : The Mongo Database Report

  14. The generated report contains the following sections:

    • The Server Availability section reveals the average percentage of time the chosen Mongo database server was available during the chosen time period. This section also reveals a line graph that plots the availability of the database server over the chosen period of time.
    • The Network section reveals the average percentage of time the chosen Mongo database server was available over the network during the chosen time period. This section also reveals a line graph that plots the network availability of the database server over the chosen period of time.
    • The Connection section reveals the average percentage of time the connection to chosen Mongo database server was available during the chosen time period. This section also reveals a line graph that plots the connection availability of the database server over the chosen period of time.
    • The Is Server Restarted section reveals if the chosen database server was restarted during the chosen period of time.
    • The Response Time section reveals a line chart that pinpoints the administrators on the exact date/time at which the response time of the database server peaked over the chosen period of time.
    • The Connection Usage graph reveals the percentage of database connections that were used over the chosen period of time. This graph helps administrators identify if there was any abnormal database connection usage over the chosen time period.
    • The Errors section reveals the average number of errors encountered on the target Mongo database server over the chosen period of time.
    • The Fatal Error section reveals the average number of fatal errors encountered on the target Mongo database server over the chosen period of time.
    • The Cursors section reveals the number of times the cursors timed out due to inactivity over the chosen period of time.
    • The Memory section reveals the average memory utilization of the target database server over the chosen period of time.
    • The Key Metrics section reveals critical metrics such as the average rate of update operations on the target database server, the average rollback ratio and the average checkpoint duration over the chosen period of time.
    • The Cache Usage graph reveals the percentage of cache utilized over the chosen period of time. This graph helps administrators determine the exact time/date at which the cache was utilized the most.
    • The Dirty Cache Usage graph reveals when exactly the percentage of cached memory that contained modified data that was not written to the disk peaked over the chosen period of time.
    • The Asserts section reveals an at a glance view of the count of rate of message asserts, rate of regular asserts, rate of rollover asserts, rate of user asserts over the chosen period of time.
    • The Ticket Usage section reveals the percentage of read ticket usage and write ticket usage of the target database server in terms of a bar graph over the chosen period of time.
    • The Lock Time section reveals the average read lock time and the average write lock time of each database available in the target database server in terms of a bar graph over the chosen period of time.
  15. On the other hand, if the Background Save - PDF option is chosen from the Report Generation list, then clicking on the Run Report button will not generate the report and display it in this page for your benefit. Instead, a message indicating that the report is being processed in the background will appear. This will be accompanied by a link that will lead you to the page that lists all the reports that are being processed in the background, and their current status. If background report generation fails for a report, you can regenerate that report using this page, or can even delete that report if need be. On the other hand, if background processing successfully completes for your report, then, you can view a PDF of the report by clicking on the icon in that page.