eG Administration
 

Adding a New Test

This page appears when you click the Add New Test button in the INTEGRATION CONSOLE - TEST page of the eG administrative interface.

To add a new test using the Integration Console capability, do the following:

  • Choose the type of test that you wish to add from the Test type list. By default, Performance will be chosen from this list. If you wish to add a configuration test, then choose Configuration from this list.

  • Specify the name of the test in the Test name text box.

    Note:

    Ensure that the test name always ends with "_ex". Otherwise, users will not be permitted to add the test. If you wish to add a configuration test, then, ensure that the test name always ends with _cf_ex.

  • Once the test name is specified, you will have to indicate whether/not the test being added is a duplicate of an existing test. eG Enterprise allows users to duplicate an existing IC*#45;based test, so that the complete configuration of the existing test (i.e., the test type, category, the test parameters, its measures, and all other test specifications except the test name) is automatically copied to the new test. This duplication is particularly useful when you want to create two/more tests with the same/similar functionality, and assign them to different layers or components.

  • If the test being added is a duplicate of an existing test, then set the Duplicate flag to Yes. From the Test to be duplicated list that then appears, pick the existing test that is to be duplicated. Upon selection of the test, the Test type of the chosen test will automatically apply to the new test. Now, click the Add button to add the new test.

    On the other hand, if you set the Duplicate flag to No, then you would have to explicitly provide the new test's details. Then, proceed to specify the mode of Execution of the test. The Execution field governs whether the test is to be executed by an internal agent or by an external agent. As a rule of thumb, if the test relies on application counters, log files, etc., it must be executed by an internal agent. On the other hand, if the test uses the Simple Network Management Protocol (SNMP), HTTP, or emulates user requests, it can be executed by an external agent. When adding a test, you also have to specify whether the test is Port based or not. In other words, you have to indicate whether the test corresponds to a server that is listening on a specific TCP/UDP port or not. Typically, if a new test is to be mapped to any of the bottom 3 layers of a component (i.e., host-specific layers), then such a test should be a non-port-based test only; accordingly, you should set the Port based parameter to No for such a test.

  • The user then needs to indicate the Category of the new test, by selecting one of the following options from the list box:

    • Custom: Tests of this type offer complete flexibility to users in developing and integrating new monitoring functionality into the eG system. In order to develop a Custom test, a user must use eG's Java-based programming interface.

    • Script/Batch File: In some cases it may be easier to build new monitoring capabilities using simple shell scripts, VB scripts, or batch files. To support this capability, the Integration Console supports a Script/Batch File test. When choosing this type, the user provides the script/batch file to be used and the Integration Console takes care of integrating the script into the eG framework.

      Upon selecting this Category, the user will be prompted to indicate whether the test is to be associated with a script or with a batch file. If the test is to be associated with a shell script, the user has to select the UNIX option against the OS type flag . On the other hand, if the test is to be associated with a batch file or a VB script, the user has to select the Windows option.

    • Sql Query: Many a times critical statistics on an application are stored in a database. To make it possible to extract such statistics from the database without having to write elaborate programs, the Integration Console includes an SQL Query category. Once the Sql Query category is selected, the user will be prompted to choose the database on which the Sql query or the stored procedure is to be executed. If the query/procedure is to run on an Oracle database, select Oracle as the DB TYPE. If the query/procedure is to run on an MsSql database, then pick MsSql as the DB TYPE. Similarly, if the query/procedure is to run on a Sybase or MySql server, pick Sybase or Mysql as the DB TYPE.

    • Perfmon: Perfmon tests can operate only on Windows environments. This option provides a quick and easy way of building tests that interface with the Windows Perfmon capability to collect various metrics of interest.

    • SNMP: Tests of this type are typically executed on network devices such as routers, hubs, switches etc., so that performance statistics pertaining to the same can be obtained using the SNMP protocol.

    • JMX: Java-based web servers and application servers (eg., Tomcat, JBoss, WebLogic, WebSphere, etc.) are common place in many IT infrastructures. Though eG Enterprise provides comprehensive monitoring models for most of these servers, some administrators might want to monitor certain additional server attributes that are not supported out-of-the-box by the eG agent. Likewise, in some other environments, custom Java applications may operate for which eG Enterprise may not provide out-of-the-box monitoring support. To enable administrators to extend the capabilities of the eG agent to report on additional attributes related to Java-based web and application servers, and to easily develop custom monitoring models for unsupported Java applications, eG Enterprise offers the Jmx test type. JMX (Java Management Extensions) is a Java technology that enables external programs like the eG agent to pull out performance metrics from a target Java application/server. By adding a test of type Jmx, you can easily equip the eG agent with the ability to leverage the JMX technology for connecting to any Java application/server, and reading the current values of those attributes of the target that interest you.

      Note:

      Prior to adding a new Jmx test, you need to enable the JMX support for the JRE of the target application. Please refer to the Extending the Monitoring Capabilities of eG Enterprise manual for the detailed steps to be followed in order to achieve this.

    • REST: With the growth of the IT industry, new technologies are introduced frequently. One such technology is the REST API which is more frequently used nowadays. Users of eG Enterprise are now provided the option to build a test using the REST API test type. When choosing this type, the user provides the output of the REST API to be used and the Integration Console takes care of integrating the API into the eG framework.

  • Upon clicking the Add button, the new test will be added to eG Enterprise.

Modifying an Existing Test

To modify an existing test, click on the icon against the test name in the INTEGRATION CONSOLE - TEST page. All the details of the test will then be made available to the user, for modification.

  • The Test name and Test type will be displayed, by default. These fields are not editable. Likewise, once you set the Duplicate flag during the time of adding the new test, you will not be allowed to modify the same.

  • The user can alter the selected Execution mode of the test (i.e. whether the test is to be executed by an Internal or an External agent).

  • Similarly, while adding the test, the user would have specified whether the test is Port based or not. This specification can also be reset. Typically, if a new test is to be mapped to any of the bottom 3 layers of a component (i.e., host-specific layers), then such a test should be a non-port-based test only; accordingly, you should set the Port based parameter to No for such a test.

  • If the category chosen during test creation is Script/Batch File, then the OS (whether UNIX or Windows) chosen by the user will appear. The user can choose a different OS while modifying the test.

  • If the category chosen during test creation is Sql Query, then the DB type selected will appear. The user can opt for a different DB type while modifying the test.

  • To update the changes to the test details, click on the Modify button in this page.

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