The major step in incorporating a new Custom test into the eG Enterprise system is to inform the eG Enterprise system about the number and types of measurements that will be made by the test. This page will enable the administrator to configure the new test and will appear when the Configure button against the test in the list of tests page, is clicked. The details of the new measurements have to be provided in this page.

• The Measure index determines the order in which the measures are to be displayed in the monitor console. For example, if you select 1 as the Measure index then the corresponding measure will appear first in the list of measures displayed in the monitor console. Note that the same Measure index should not be assigned to two different measures of a particular test.

• The Measure name field indicates the name of the measurement (this will be displayed in the eG monitor interface).

• The Database column size field indicates the size of each database record corresponding to a measurement value. For example, Number(7,4) indicates that the output of the measurement will be a number in the range 0 to 100, with the fractional value being limited to four decimal places.

• The Unit (whether %, seconds, requests/sec, etc.) specifies the unit in which the measurement's value is reported. The required unit can be selected from the options available in the list box.

• Sometimes, administrators may want to convert the unit of measurement of a performance metric before displaying the same in the eG monitoring console. For instance, a duration value originally available in ‘milliseconds’ may have to be changed to ‘Secs’ before it is displayed in the console. If you want the unit of the measure being added to be so converted at test run time, then select a Conversion Factor from the list. For example, if a value in ‘milliseconds’ needs to be converted to ‘seconds’, then select /1000 as the conversion factor. By default, 1 is chosen as the Conversion Factor; this implies that, by default, unit conversion does not take place for a new measure at test run time.

Note:

The Conversion Factor list comes with a default set of conversion factors. You can however, override this list by adding more conversion factors. For instance, the default Conversion Factor list does not provide the option to convert Bytes to MB at run time. To include this option in the list, follow the steps below:

• Edit the eg_ui.ini file in the <EG_INSTALL_DIR>\manager\config directory.
• To include a new conversion factor, you will have to append an entry of the following format to the [CONVERSION_FACTORS] section of the file:
  DisplayName=Value
• For instance, to support ‘Bytes to MB’ conversion, append the following entry to the [CONVERSION_FACTORS] section:
  /1048576 (Bytes to MB)=0.00000095367431640625
• In this case, the DisplayName, /1048576 (Bytes to MB), will be displayed as an option in the Conversion Factor drop-down list. If this option is chosen, then, at test run time, the conversion value of 0.00000095367431640625 will be multiplied with the actual measure value that is reported in Bytes to convert it into MB. Care should be taken while specifying the conversion value, as incorrect values will result in wrong measures being reported by the test.
• Once the new entry is appended to the [CONVERSION_FACTORS] section, save the file.
• Finally, restart the manager.

Once this is done, you will find the string /1048576 (Bytes to MB) appear as an option in the Conversion Factor list.

• In the Alarm display string text box, specify the text string that must be displayed in the eG alarm window when the corresponding measurement violates its threshold.

By clicking on the Add button, the measurements of the test can be added.

• When the measurement is successfully added, a response page indicating the measurement and its details will appear. Previously added measurements can be deleted using the Delete button that appears beside every measurement added. Such measurements can also be modified by clicking the Modify button beside the measure name.

• Once all the measurements of a test have been specified, the next step is to specify the implementation of the test. After all the measurements of the Custom test have been specified, the directory in which the test's implementation exists should be specified in the input box corresponding to the Class file specification. The test implementation must exist in a Java class file with the same name as the test name − e.g., the implementation of MsSqlNetTest must exist in a class file named MsSqlNetTest.class. If the class file is present in a remote location, then you can upload it to the eG manager, by clicking on the Choose button adjacent to the Class file text box. This will invoke a pop-up window using which you can Browse for the class file and specify its location. Finally, click on the Upload button in the pop-up window, to upload the class file in the remote location to the eG manager. However, if the class file has already been uploaded to the eG manager, then this procedure can be dispensed with. Instead, just specify the location of the file against the Class file text box.

• Some class files may require certain ".jar" or ".so" (shared object files) files for their execution. The name of the file along with the directory in which these files exist has to be specified in the Library file specification. Please note that the size of these files should not exceed 0.5MB in order to prevent excessive load while uploading. If the library files is present in a remote location, then you can upload it to the eG manager, by clicking on the Choose button adjacent to the Library file text box. This will invoke a pop-up window using which you can Browse for the library file and specify its location. Finally, click on the Upload button in the pop-up window, to upload the library file in the remote location to the eG manager. However, if the library file has already been uploaded to the eG manager, then this procedure can be dispensed with. Instead, just specify the location of the file against the Library file text box.

Note:

When the class and library files are uploaded to the eG manager for the first time, they would be uploaded to the <EG_INSTALL_DIR>/tmp directory in the manager host. When the Generate button is clicked, they would be moved to the <EG_INSTALL_DIR>/config/tests directory. Therefore, subsequent visits to this page will only have the <EG_INSTALL_DIR>/config/tests location displayed against the Class file and Library file text boxes.

• The Load class file checkbox should be selected if the class file has to be loaded every time the Custom test is implemented. For the first time when the class file information is provided, it is mandatory to select this box so as to load the class file along with the new measurements.

• The Load library file checkbox should be selected if the library file has to be loaded every time the Custom test is implemented. For the first time when the library file information is provided, it is mandatory to select this box so as to load the library file along with the new measurements and the associated class file. Multiple library files can be specified, but each entry should be separated by a comma (,).

• To make diagnosis more efficient and accurate, the eG Enterprise suite embeds an optional detailed diagnostic capability. With this capability, the eG agents can be configured to run detailed, more elaborate tests as and when specific problems are detected. For example, when the CPU usage of a host reaches the threshold, the agent can be configured to provide more details - e.g, the top 10 process that are consuming more CPU resources. Alternatively, these tests can also be run periodically for proactive monitoring purposes. The check box Click here to enable detailed diagnosis for this test can be used to define detailed diagnosis capability for a custom test. The option to enable detailed diagnosis for an IC-based test will be available only if the following conditions are fulfilled:

• The eG license should enable the detailed diagnosis capability.
• Both the normal and abnormal detailed diagnosis frequencies should not be 0. For more information on configuring these frequencies, refer to the eG User Manual.

• eG Enterprise embeds a context-sensitive online help system, which enables users to instantly invoke help pages for assistance while configuring the tests run by the eG agent or understanding the measures reported by the tests. By default, the eG manager comes bundled with help pages for the tests it supports out-of-the-box. Each test is associated with an Admin and a Monitor help page. While the Admin help page describes how the test parameters are to be configured, the Monitor help page lists the measures reported by the test and explains the significance of each measure. To know more about customizing the help pages, refer Adding a custom help page.

  For new tests added via the Integration Console plugin however, no such help pages pre-exist. To enable users to include help pages for these new tests into the eG Enterprise system, a specialized interface by means of an Add Help button is provided. With the help of this interface, new Admin and Monitor help pages can be created for an IC-based test and uploaded to the eG manager.

• Clicking on the Generate button will result in the test's implementation being integrated into the eG Enterprise system.

The Back button enables the administrator to go back to the previous screen.