The installation and configuration of the End-to-End Monitoring Hybrid Monitoring Agent using the IBM webMethods Installer to your IBM webMethods Integration Server or IBM webMethods Microservices Runtime involves numerous manual steps. This feature simplifies your installation and configuration procedure. The Hybrid Monitoring Agent can now be installed as an Integration Server package that consists of a user interface to configure End-to-End Monitoring.
Advantages of the IS package-based Hybrid Monitoring Agent
You are not required to make any manual changes in the configuration files for Hybrid Monitoring setup.
You can view or modify agent related configuration through a Graphical User Interface (GUI).
Agent to collector connectivity status is available to you in the Graphical User Interface (GUI). Status is Online when connected, or Offline.
Latest agent log information statements are directly streamed to the Graphical User Interface (GUI) for your quick reference.
Hybrid Monitoring support is available for older versions, for example, Integration Server 10.3. See the following Supported Versions for more information.
Supported Versions
IBM webMethods API Gateway
Operating System
10.15
10.11
10.7
10.5
10.3
Linux
Yes
Yes
Yes
Yes
No
Windows
Yes
Yes
Yes
Yes
No
MacOS
Yes
Yes
No
No
No
AIX
Yes
Yes
No
No
No
IBM webMethods Integration Server
Operating System
10.15
10.11
10.7
10.5
10.3
Linux
Yes
Yes
Yes
Yes
Yes
Windows
Yes
Yes
Yes
Yes
Yes
MacOS
Yes
Yes
No
No
No
AIX
Yes
Yes
No
No
No
IBM webMethods Microservices Runtime
Operating System
10.15
10.11
10.7
10.5
10.3
Linux
Yes
Yes
Yes
Yes
No
Windows
Yes
Yes
Yes
Yes
No
MacOS
No
No
No
No
No
AIX
No
No
No
No
No
Note
If your IBM on-premises product version or operating system is not listed or supported, contact IBM support with details about your IBM webMethods product and operating system. We will assess the feasibility of providing support for your specific requirement.
Note that two IS packages are available. Do not install both these packages together.
Product
Package
For Integration Server and Microservices Runtime
WmE2EMIntegrationAgent
For API Gateway
WmE2EMAPIAgent
These packages provide you with an intuitive web interface to configure and manage your End-to-End Monitoring agent. The agent’s collector connectivity status is available to you in the Graphical User Interface. In case of debugging requirements, the web interface directly provides you with logs for analysis. The web interface also facilitates you to restore a previous configuration with a single click.
Note
From v10.15 onwards, product code UHM has changed to UHA. If you come across a file name with UHA in it, consider it the same as a UHM file.
If you cannot locate the file e2ecustomlogback.xml in the installation, then install latest fixes.
To start a new installation of IS package-based Hybrid Monitoring Agent
Click here to obtain webMethods Package Manager (WPM). Search for the latest packages using WPM from here. Select supported registry and search for the tag e2e. Select the relevant version from the version drop-down list and click download. The version format is <IntegrationServerVersion.EndToEndMonitoringFixVersion>. Copy the wpm install command from the Download info box.
For WPM based package installation, use the following format:
In Integration Server Administration, go to Packages > Management > Activate Inactive Packages, to apply this package to a running Integration Server without restarting it.
Select the checked-out package from the drop-down menu and click Activate.
In Administration, go to Packages > Management. In the package list, look for WmE2EMIntegrationAgent/WmE2EMAPIAgent and click on the corresponding Home icon.
Verify the End-to-End Monitoring Connection Status. Check the status of agent to collector connectivity (Online/Offline) once the product configuration is complete.
Verify the End-to-End Monitoring log file contains the required details once the product configuration is complete.
Under product configuration section, verify the custom wrapper configuration for Integration Server and the End-to-End Monitoring configuration to be added to custom_wrapper.conf. Click Merge to append the End-to-End Monitoring configuration into the custom_wrapper.conf file.
Use the Restore option to restore the custom wrapper back to your previous configuration.
Verify End-to-End Monitoring agent configuration. Click Edit, to modify the agent configuration and click Update to save your changes.
You will be prompted to restart the Integration Server, after the custom_wrapper.conf or agent.conf files are successfully updated.
Upon successful connection and registration, the graphical user interface displays the Online status on End-to-End Monitoring along with the necessary logs.
To upgrade an existing installation of Hybrid Monitoring Agent already on the package-based approach
webMethods Integration Server
Stop Integration Server.
Upgrade the package to the tag that matches your Integration Server version and End-to-End Monitoring fix release from here using WPM. Example: wpm update -d C:\IS\Installations\instances\default -ws https://packages.webmethods.io -wr supported WmE2EMIntegrationAgent:v10.15.0.2
Start Integration Server.
Note
The tag name format is <IntegrationServerVersion.EndToEndMonitoringFixVersion>. To find the available releases of the package:
Click on the relevant package, WmE2EMIntegrationAgent or WmE2EMAPIAgent.
Click on the version drop-down.
API Gateway
Stop Integration Server.
Upgrade the package to the tag that matches your Integration Server version and End-to-End Monitoring fix release from here using WPM. Example: wpm update -d C:\IS\Installations\instances\default -ws https://packages.webmethods.io -wr supported WmE2EMIntegrationAgent:v10.15.0.2
Overwrite the file: INSTALL-DIR\IntegrationServer\instances\default\packages\WmAPIGateway\code\jars\uha-API-onpremise-plugin.jar with this file: WmE2EMAPIAgent\resources\agent\plugins\uha-API-onpremise-plugin.jar
Start Integration Server.
Note
The tag name format is <IntegrationServerVersion.EndToEndMonitoringFixVersion>. To find the available releases of the package:
Click on the relevant package, WmE2EMIntegrationAgent or WmE2EMAPIAgent.
Click on the version drop-down.
To upgrade an existing installation of Hybrid Monitoring Agent installed using the IBM webMethods Installer approach
If you have an existing hybrid monitoring agent setup installed using the IBM webMethods Installer and IBM webMethods Update Manager based fixes, use the following steps to install IS package-based hybrid monitoring agent.
Uninstall the existing End-to-End Monitoring setup using the IBM webMethods Installer.
Read the New installation section to install hybrid monitoring agent using package-based approach.
Uninstalling an agent
To completely uninstall the End-to-End Monitoring agent from the Integration Server:
In Integration Server, go to Administration > Packages > Management. In the Package List, click the Home icon for the WmE2EMIntegrationAgent or WmE2EMAPIAgent package. In the End-to-End Monitoring Status and Configuration page, Product Configuration section, click Restore.
Optionally, in Integration Server, go to Administration > Packages > Management. In the Package List, click the Delete icon for the WmE2EMIntegrationAgent or WmE2EMAPIAgent package.
Note
For Integration Server, Microservices Runtime and API Gateway:
To see segment traces of on-premises transactions in logs, set all log levels to DEBUG in
<INSTALL-DIR>\packages\<IS-E2EM package name>\resources\agent\config\e2ecustomlogback.properties.
The agent.trace_transfer_interval=${SW_AGENT_TRACE_TRANSFER_INTERVAL property defines the interval between each write operation to the file, and also defines the data send interval through the gRPC channel. Reduce this time interval from the default value of 18000 ms, to shorter segment trace writes if you prefer a faster sync time.
Note
For Integration Server and Microservices Runtime only:
If your Integration Server setup supports multiple tenant connections and you are also using a custom tenant connection, edit the agent.config file from the user interface and set the below properties: agent.onprem_multitenant_alias = ${SW_AGENT_ONPREM_MULTITENANT_ALIAS:default}: Un-comment this property, replace default with your tenant connection name, and restart the Integration Server.
Note
For API Gateway only:
End-to-End Monitoring, by default monitors all the on-premises API Gateway calls with the tag e2em.
End-to-End Monitoring can trace transactions belonging to a single tenant, even if end-to-end transactions involve multiple API Gateway tenants at a time.
Important
e2ecustomlogback.xml file path for Integration Server:
In Administration, go to Packages > Management. In the package list, look for WmE2EMIntegrationAgent or WmE2EMAPIAgent and click on the corresponding Home icon.
The graphical user interface displays an Online agent collector connectivity status, if your installation is successful.
FAQs
Click here for Frequently Asked Questions on IS package-based Hybrid Monitoring Agent.
