This chapter describes how to install JENNIFER .NET Agent.
Versions Supporting .NET Agent
Supported OS
The operating systems in which the .NET agent can be installed properly are as follows.
Windows Server 2008 x86/x64 (including R2)
Windows Server 2012 x64 (including R2)
Windows Server 2016 x64
Windows Server 2019 x64
With Windows for client, although the .NET Agent operates on Windows XP SP3 or higher, official technical support is not provided to such operating systems.
Not supported for Windows Server 2003 SP2 since .NET Agent 5.4.0.5
Install and Uninstall JENNIFER Agent
Install JENNIFER Agent
Unzip the jennifer-agent-dotnet-[version].zip file, and then the Installer.exe and Installer.exe.config files are created. Run the Installer.exe file, then bin, config, log and utility subfolders are created and the program registration is completed.
Directory | Description |
|---|---|
bin/ | Directory that contains Agent execution files |
config/ | Directory to save the configuration and settings files for applications to which the Agent is applied |
log/ | Directory that contains Agent log files |
utility/ | Directory that contains utility execution files |
After the program has been properly registered, it is necessary to select an application to be monitored. Once the application to be monitored is determined, you need to create a configuration information file to run the JENNIFER .NET Agent. For more information about this operation, refer to Configure Settings File for Monitoringsection.
Uninstall Agent
Type "/u" factor when running the Install.exe file to uninstall the Agent (or you can run the uninstall.bat file, which is created when installation was performed by using the Install.exe file).
...> Installer.exe /u or ...> uninstall.bat
The above strings only remove the information registered in the system. The process that is currently being monitored may still use the JENNIFER Agent module.
Therefore, if there is a program currently being monitored, you will need to close the process (EXE) and restart it to unload the JENNIFER module completely (for example, for an IIS website, you must execute the "iisreset" command).
The folder in which the JENNIFER .NET Agent is installed can be deleted after the use of Agent is released from all processes.
If it is not possible to delete, check whether there is any process in operation on which the JENNIFER module is loaded. If there is, terminate the process and try to delete again.
Apply New Version and Roll Back to Previous Version
How to Apply a New Version
You can easily apply a new version of the .NET Agent by selecting Upgrade Agent (http://docs.jennifersoft.com/r/viewer/book/030835299a0ceff3#mng_agentUpgrade) from the menu in the JENNIFER console. Alternatively, you can install the .NET Agent directly, as follows.
Overwrite the existing Installer.exe file with a new version of Installer.exe.
Run the new Installer.exe file to register.
If there is a process (EXE) being monitored, you will need to terminate the process and restart it to apply the Agent of a new version (for example, in the case of IIS, you must execute the Recycle command).
How to Roll Back to a Previous Version
In the /bin folder, Agent installation files which have been used are stored in the form of Installer.[version number].exe. For example, if you have installed version 5.0.7.0 of the JENNIFER .NET Agent, you can locate the bin/Installer.5.0.7.0.exe file. This means that you just need to run the applicable .exe file again to register the Agent of version 5.0.7.0.
After completing the registration, terminate all existing processes and restart the Agent to apply the registration (for example, in the case of IIS, you must execute the Recycle command).
Configure Settings File for Monitoring
After installing the .NET Agent file, you will need to select a .NET application to monitor. If the type of the application belongs to IIS web, NT service or COM+, you can perform configuration easily using the bin/IISConfigHelper.exe tool. On the other hand, for a stand-alone application, you will have to configure the settings file manually.
How to Configure Settings for IIS Web Applications
The operator processes (w3wp.exe) in IIS web applications are controlled by the unit of application pool. As JENNIFER.NET Agent is activated inside w3wp.exe, it also controls the monitoring unit for each application pool in the same manner as IIS.
For example, the following screen shows that "DefaultAppPool" and "Jennifer40.WebSiteTest4" are registered in the application pool containing ".NET web applications".
List of application pools registered in IIS
In the figure, as ".NET v2.0", ".NET v2.0 Classic", ".NET v4.5", ".NET v4.5 Classic" and "Classic .NET AppPool" do not have any web applications registered, it is not possible to install the JENNIFER .NET Agent.
If you are running the /bin/IISConfigHelper.exe tool in this environment, JENNIFER .NET displays the names of two application pools that can be activated in the "IIS" node.
List of application pools in which JENNIFER .NET can be installed
Right-click the application pool for installation and an "Install" menu will appear. Select the menu, and then a screen will be launched in which you can input values for the required settings, as shown below.
Apply the JENNIFER .NET Agent to the selected application pool
Each setting should be configured according to the following standards.
Field Name | Description |
|---|---|
Jennifer Server | IP address of DNS name of the computer on which the JENNIFER Data server is installed |
Server Port | listen_port value of JENNIFER Data Server |
System Id | Domain ID registered in JENNIFER Data Server Valid range: an integer from 1 to 32767 |
Start Instance Id | Unique identifier for the application for which JENNIFER Agent is activated. The ID of each Agent connected to the Data server should be unique. Up to 100 Instances can access a single Domain (when more than 100 Instances are configured, access by a new agent is denied). For IIS web applications, as multiple w3wp.exe processes can be activated according to the "Web Garden" settings, a range should be designated. |
Auto Select | This option is activated only for IIS web applications, and when selected, all web applications belonging to the applicable application pool are monitored. When this option is released, you can select web applications to monitor from among those listed in the box at the bottom. |
After configuring, press the Save button to apply the settings. The settings configured are saved as [application pool].conf file in the [agent installation folder]\config\iis.
How to Configure Settings for COM+ Applications
COM+ applications registered in the component services are mainly divided into 2 activation types.
Library activation: COM+ application activated in the process of calling the applicable COM+ application
Server activation: COM+ application activated in the dllhost.exe hosting process
As library activation is activated in the call process, configuration for this type of COM+ application is not necessary. However, in cases of server activation, COM+ application is activated through a separate dllhost.exe process rather than a call process, and it is necessary to configure the JENNIFER .NET configuration file to perform monitoring on such application.
When running the /bin/IISConfigHelper.exe tool, only COM+ applications belonging to "server activation" are automatically displayed. This means that you can just create the configuration file for the desired application using the "Install" menu. For example, the following screen shows an example of configuring a COM+ application in "MyComponentServer".
Setting the configuration file for COM+ application according to the server activation type
The input value for each field is as explained in the Descriptions of required options section.
How to Configure Settings for Service Applications
When running the /bin/IISConfigHelper.exe tool, only .NET Framework-based applications are listed under the "NT Service" node among the service programs registered in the operating system.
The screen below shows an example of creating a configuration file for the "RemoteTestService40" item, using the "Install" menu, among 5 .NET based service programs.
Setting the configuration file for service application
Similarly, the input value for each field is as explained in the Descriptions of required options section.
How to Configure Settings for Stand-alone Applications
For a stand-alone EXE program that does not belong to IIS, COM+ or service, you will need to create a configuration file manually. Copy the app_pool.conf file into the [agent installation folder]/config folder and save it as [EXE file name].exe.conf.
After saving, change the configuration settings using an editor such as notepad.exe with reference to Descriptions of required options and then save the changes.
How to Apply and Release .NET Agent
After installing the Agent and creating a configuration file for the application to monitor, run the EXE process again, then the monitoring operation is activated (for example, in the case of the IIS website, restart w3wp.exe using the "iisreset" command).
On the other hand, if you want to release the application of .NET Agent, remove the configuration file and run the EXE process again (alternatively, you can run the "Uninstall" menu provided from the IISConfigHelper application).
Differences from JENNIFER .NET Ver. 4.x
Although JENNIFER .NET Ver. 4.x also uses IISConfigHelper.exe to install, there are a number of changes, which are as stated below.
/conf folder in the previous version has been changed to /config folder as of JENNIFER .NET 5
Config files for websites are stored separately in the /config/iis folder.
Config files for COM+ are stored separately in the /config/complus folder.
JENNIFER_PROFILE environment variables are no longer used.
For web applications, conf files are configured by the unit of "virtual application" in Ver. 4.x, while config files are configured by the unit of "application pool" from ver. 5.0 (effect: the number of conf files is reduced).
How to Migrate from JENNIFER .NET Ver. 4.x
You can perform migration as follows.
Run the uninstall_jennifer.bat file in the [JENNIFER 4.x installation folder] to uninstall Ver. 4.x.
Run the installer.exe file in the [JENNIFER 5 installation folder] to install Ver. 5.0.
As the configuration file is not compatible, create a new configuration file in conformance with the configuration information for Ver. 4.x.