apmgtw (CA APM Gateway) Release Notes

The CA Unified Infrastructure Management CA APM Gateway Probe (apmgtw) probe sends QoS messages from CA Unified Infrastructure Management probes to your CA Application Performance Management (APM) database.
uimpga-ga
apmgtw_RN
The CA Unified Infrastructure Management CA APM Gateway Probe (apmgtw) probe sends QoS messages from CA Unified Infrastructure Management probes to your CA Application Performance Management (APM) database.
You configure the apmgtw probe to send QoS data from those CA Unified Infrastructure Management probes that you define. And for each probe that you configure apmgtw to report on, you can also define the specific QoS metrics that apmgtw sends to the CA APM database.
You configure CA APM to use this data in dashboards.
Revision History
This section describes the revision history of the apmgtw probe.
Versions
Description
State
Date
3.23
What's New:
  • Updated the probe to support secured UIM environments (Secure Hub and Robot) in UIM 9 SP1. This version of the probe does not contain any configuration changes. However, since the way the probe communicates with the data_engine has changed, the probe must be deployed on the primary hub robot irrespective of the
    secure
    state.
    • Secure Environments
      - Deploy the probe on the primary hub robot on UIM 9 SP1 or later. For more information, see Secure Hub and Robot.
    • Non-Secure Environments
      - Deploy the probe on the primary hub robot on UIM 9.0.2 or later.
This version of the probe must be deployed on the primary hub robot.
GA
June 2019
3.22
Fixed Defects:
  • Fixed an issue where Origin was not selected for processing.
    Support Case Number 01063654
  • Fixed an issue where QoS was not being sent by apmgtw to APM, and receiving Socket input/output Error
    . Support Case Number 01080926.
  • (October 2018) Updated this probe as part of addressing CVE-2018-13820 and CVE-2018-13819 vulnerabilities in CA UIM 9.0.2.
GA
August 2018
3.2
What's New
:
  • Updated this probe as part of supporting TLS v1.2 in CA UIM for establishing secure communication with the UIM databases: Microsoft SQL Server and Oracle. To run the probe on a remote computer (other than the primary hub), install the required driver (SQLNCLI11) for Microsoft SQL Server, and verify that the probe has the required access to the database server hosting the UIM database. For more information about how to enable TLS v1.2 support in CA UIM, see TLS v1.2 Support for Microsoft SQL Server and TLS v1.2 Support for Oracle.
  • Fixed an issue where apmgtw probe v3.10 was consuming 100% CPU.
    Support Case Number 00922719
  • Fixed an issue where apmgtw is using large amounts of CPU and not sending metrics to APM.
    Support Case Number 00797109.
  • Fixed an issue where apmgtw probe was not able to monitor remote monitoring probes.
    Support Case Number 00886945.
    For more information see known issue.
GA
June 2018
3.1
What's New
:
  • Improved the probe performance with the following enhancements.
    Support case number
    477950
    • Added support to retrieve the list of probes and QoS definitions from a configuration file instead of database or NIS API calls. This reduces the probe start up time.
    • By default, the probe tries to load data directly from the database instead of using NIS API. You can switch to use NIS API through the probe raw configuration interface.
    • The QoS filter fields in the probe configuration interface support the ‘|’ symbol as a delimiter.
    • Added three filter fields:
      Domain
      ,
      Hubs
      and
      Robots
      in the
      CA UIM Connection Details
      section in the probe configuration interface.
GA
July 2017
3.0
What's New
:
  • Added support for auto selecting QoS messages through regular expression.
  • Added the ability to support any CA UIM probe that has QoS data.
  • All CA UIM QoS data is forwarded to CA APM directly, instead of a 15 second average.
Beta
June 2016
2.0
What's New
:
  • Added support for configuration of the probe using Admin Console. The probe is now configurable only through Admin Console.
  • Bug Fixes
GA
September 2015
2.0
What's New
:
Added support for configuration of the probe using Admin Console. The probe is now configurable only through Admin Console.
Beta
August 2015
1.1
What's New
:
Corrected probe GUI and documentation by removing mention of alarms. The apmgtw probe only sends QoS data from probes to CA APM. The probe does not send alarms.
Controlled GA
June 2015
1.0
Initial Beta Release
Beta
November 2014
Probe Specific Software Requirements
  • Windows 2008 Server
  • Windows 2008 Server R2
  • Windows 2012 Server R2
  • Red Hat Enterprise Linux 7.x
  • CentOS 7
  • CA APM Enterprise Manager versions 9.7.1, 10.1, 10.2, 10.5, and 10.7.
  • CA Unified Infrastructure Management
    versions 8.1, 8.2, 8.3, 8.3.5, 8.4, 8.4.7, 8.5.1, 9.0.2, 9 SP1*
  • QoS message names might appear truncated in the
    Admin Console, Configuration
    page. It is recommended that you use
    CA Unified Infrastructure Management
    8.3.5 to view the complete names.
  • To run the probe on a remote computer (other than the primary hub) verify that the probe has the required access to the database server hosting the UIM database. This note is not applicable for version 3.23 and above.
  • You must deploy the probe on the primary hub robot for apmgtw probe version 3.23 and above.
Installation Considerations
Secure Hub & Robot (CA UIM 9 SP1 and above)
In a secure environment, if any probe that is installed on an independent secure robot tries to subscribe to queues in the related secure hub, the probe fails to attach to the queues. As a workaround, if the probes require to read or publish to a hub queue, then deploy the probe on the primary hub robot.
For more information, see Secure Hub and Robot.
Upgrade Considerations
When you upgrade or redeploy an existing version of the probe, the configuration files are migrated to the recent installation upon activation of the
Admin Console, APMGTW Configuration
page. Deactivate and activate the probe for the configuration to take effect.
Troubleshooting
This section describes the troubleshooting procedure for the CA APM Gateway (apmgtw) probe.
Symptom:
I select a probe and its QoS, but QoS is not shown in CA APM Web View when bulk-config is
False
.
The length of the QoS may be too long. Check to see if the corresponding QoS format message in the qos.properties file is more than 150 characters. If the length of the QoS exceeds 150 characters, then apmgtw probe cannot send that QoS to CA APM.
Solution:
Navigate to the qos.properties file: Nimsoft > Probes > Gateway > apmgtw > qos.properties file.
In the metrics section of the qos.properties file, edit the description of the QoS message so that it is fewer than 150 characters.
Symptom:
apmgtw probe is not collecting QoS data for applications being monitored through remote probes, like db2 and SQL Server.
Solution:
On the robot where apmgtw probe is deployed, follow these steps:
  1. Navigate to the Nimsoft > niscache folder.
  2. Backup the niscache data and delete the niscache data.
  3. Restart the robot.
  4. Take a backup of the apmgtw probe and re-deploy the apmgtw probe.
  5. In probes.txt file, add the list of probes for which apmgtw probe is not collecting data.
    Please refer to the example below for the format in which you need to add the probes:
    Database.sqlserver Gateway.snmptd Application.url_response
  6. Deactivate and activate the probe.
    apmgtw probe should now collect QoS data from the probes you have added to the probes.txt file.
Symptom:
apmgtw is not sending metrics to APM and raises exception while getting dataengine address from iptoname response.
Solution:
  1. In the setup --> Open the raw configuration of the apmgtw probe.
  2. Edit the setup section.
  3. Update the robot_address to RobotName (e. g. ROBOT1).
The probe should now start sending data.