apmgtw AC Configuration

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_AC
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 can configure the apmgtw probe to send QoS data from the CA Unified Infrastructure Management probes that you define. For each probe that you configure, you can also define the specific QoS metrics that apmgtw sends to the CA APM database.
You can configure the CA APM to use this data in dashboards.
 
This article is for probe version 2.0 and later.
 
This section describes the process to configure the apmgtw probe in 
CA Unified Infrastructure Management
. The probe is configurable only through Admin Console.
 
Contents
 
 
 
Verify Prerequisites
Verify the following prerequisites before configuring the probe:
  • Required hardware and software is available and installation prerequisites and upgrade considerations are met. For more information, see apmgtw (CA APM Gateway) Release Notes.
  • CA APM and CA APM Workstation are installed
  • For the apmgtw probe to receive data, you need to, run the CA Unified Management Portal (UMP) installer on a hub or robot. See Install Unified Management Portal for more details about installing UMP.
  • Deploy webservices_rest probe to set up RESTful web services.
  • For the probe to send metrics to CA APM, you need to install the EPAgent pointing to the target APM server to which the metrics should be sent.
(apmgtw 3.10 and later) Understand the Impact of Raw Configure Settings
The following table details the keys in the Raw Configure that can impact the apmgtw probe functionality:
Key
Default Value
UI Impact
 
configure_probe_file
 
True
The probe displays all the probes selected from the 
apmgtw
 node > 
QoS Selection
 > 
Selected Probes
 dropdown under the 
Available Probes
 list in the left navigation pane.
If you set this key value as 
True
:
    • The probe retrieves the group for the 
      Selected Probes
       from the probes.txt file. If the selected probes are not available, you must enter the probe group, probe name at the End of File (EOF) before you start the probe. Format: <probe-group>.<probe-name>. Example : System.cdm, System.logmon
If you set this key value as 
False
:
    •  The probe creates the 
      Available Probes
       list in the left navigation pane from the filter fields such as 
      Domain
      Hubs
       and 
      Robots
      .
 
configure_qos_nisapi
 
False
If you set this key value as 
True
:
    • The probe retrieves the qos definitions for the probes displayed under the 
      Available Probes
       list using NISAPI REST call.
If you set this key value as 
False
:
    • The probe retrieves the qos definitions for the probes displayed under the 
      Available Probes
       list using database query.
      Note
      : The probe tries to retrieve the qos definitions from the qosdefintions.txt file. If the probe is not able to retrieve the QoS definitions from this file, then, the probe triggers a DB call to retrieve the qos definitions.
 
Format
: <probe-name>.<qos-definition>.<description>.<Unit>.<Short-Unit>
 
Example
: cdm.QOS_COMPUTER_UPTIME.Computer Uptime.Seconds.scdm.QOS_MEMORY_USAGE.Memory Usage.Megabytes.MB
 
configure_host_db
 
True
If you set this key value as 
True
:
On probe configuration, the probe retrieves database connection information from the primary hub and loads the host data details into memory by querying the database.
If you set this key value as 
False
:
The probe uses NIS API calls.
 
queue_batch_size
 
200
The bulk message size of apmgtw_qos_message queue to be subscribed.
 
batch_threshold
 
200
The batch size of metric feeds sent to EPAgent.
 
batch_interval
 
5000
The interval at which the probe sends metric feed request to EPAgent.
 
buffer_count
 
3
The total number of buffers queues.
 
buffer_size
 
1000
The total size of the array blocking queue.
 
producer_threads
 
3
The total number of message producer threads.
 
consumer_threads
 
3
The total number of message consumer threads.
 
local_probes
 
cdm|processes|logmon|ntevl|dirscan
On probe configuration, the probe loads the host data for local probe devices into memory using database calls. This happens only when the value of 
configure_host_db 
key is set as
 True.
 
 
included_hosts_as_regex 
 
True
If you set this key value as 
True
, the probe supports regular expression condition for the 
Selected Hosts 
field.
If you set this key value as 
False
, you must use delimiter "|" symbol to select multiple hosts.
 
queue_hub_address 
 
<IP Address>
The IP address of the hub queue.
 
Note
: If you do not configure this key, the probe creates the queue in the primary hub.
 
db_address 
 
<IP Address>
The IP address of the database host.
(Optional) Configure Logging Details
The log file of the probe (not the system log files) contains information about the probe activities. The probe is deployed with default log properties, which you can also modify.
 
Follow these steps:
 
  1. Navigate to the 
    apmgtw 
    node > 
    Probe Setup
     section and select the level of details that are written to the log file from the 
    Log level 
    drop down. You can select the following log levels:
    • 0 - Logs only severe information
    • 1 - Logs errors information
    • 2 - Logs warnings information
    • 3 - Logs general information (default)
    • 4 - Logs debugging messages
    • 5 - Logs tracing/low-level debugging information
    Log as little as possible during normal operation to minimize disk consumption, and increase the amount of detail when debugging. CA recommends you to use levels 4 and 5 only for troubleshooting. Return to log level 3 or lower after troubleshooting to minimize log file size.
  2. Click 
    Save.
     
Define the CA APM Connection Details
You need to connect to the CA APM environment from the apmgtw probe to send the QoS data from the other CA UIM probes.
 
Follow these steps:
 
  1. Navigate to the
     apmgtw 
    node >
     CA APM Connection Details 
    section
     
    and enter the following field information:
    •  
      CA EPAgent MetricFeed URL: 
      enter the CA APM Enterprise Agent Metric Feed URL.
    •  
      Concurrent Requests: 
      enter the number of QoS messages to concurrently send to CA APM. If there are any more QoS messages, they are queued up until the older messages are sent.
      Increasing the number may increase the rate at which the QoS messages are sent to CA APM but it would increase the load on the CA APM EM Server as well as CA APM EPAgent.
  2. Click 
    Save.
     
Connect to CA UIM Probes and Define the QoS Metrics
You must connect to the CA UIM environment, to enable the probe to send the QoS data from other CA UIM probes.
 
Follow these steps:
 
  1. Navigate to the
     apmgtw 
    node >
     CA UIM Connection Details 
    section
     
    and enter the following field information:
    •  
      UMP Host Name: 
      specifies the host name of the CA UMP server.
    •  
      Username
      : specifies
       
      a username to connect to the CA UMP server.
    •  
      Password
      : specifies
       
      a password for the specified username.
    •  
      UMP Port
      : specifies
       
      the UMP port number.
    •  
      (apmgtw 3.1 and later) Domain
      : specifies
       
      the domain address.
    •  
      (apmgtw 3.1 and later) Hubs
      : specifies
       
      the hub names. You can specify multiple hub names by using regular expressions.
    •  
      (apmgtw 3.1 and later) Robots
      : specifies
       
      the robot names. You can specify multiple robot names by using regular expressions.
    •  
      Queue Name
      : specifies
       
      the name of the CA UIM queue from which the probe reads the QoS messages. Consider the following points before specifying the queue name:
      • If the default queue (apmgtw_qos_message) is used, the probe will create the queue on the primary hub if it does not exist and configure it to process all the QoS messages from CA UIM.
      • If you want to use a different queue, or a queue with different subscription characteristics (such as subscribing to a specific set of QoS messages), please create an attach queue in the primary hub and specify the queue name here.
      • The probe can only subscribe to a queue in the primary hub; if you want it to process QoS messages from probes on a different hub, please create a post queue on that hub to forward them to the primary hub so that they can be processed. For more information see Create Hub-to-Hub Queues.
    •  
      HTTPS Enabled: 
      select the check box if CA UIM is hosted on a secure (HTTPS) environment.
  2. For each probe that you configure, you can define the specific QoS metrics that apmgtw sends to the CA APM database. Enter the following field information:
    •  
      Selected Hosts: 
      specify the desired hosts. Probe sends QoS messages from only those hosts. You can provide a delimiter “|” symbol to select multiple hosts. Example: WIN-74ASSHF4J4G| docker-002
       If this field is left blank, the probe selects all the hosts, by default.
    •  
      Selected Origins: 
      An origin identifies a hub within a 
      CA Unified Infrastructure Management
       domain. You can select the origins for which the apmgtw probe retrieves metrics and the probe sends QoS messages from only those origins. You can provide a delimiter “|” symbol to select multiple origins. Example: cho2-hub01| cho2-hub02|cho2-hub03.
    •  
      QoS Auto-Selection: 
      select this field for the probe to selectively forward only a selected set of QoS messages to CA APM.
       field must be selected.
      •  
        Selected Probes: 
        select the probes for which you want to forward QoS messages to CA APM. You can either select a single probe or provide a delimiter “|” symbol to select multiple probes. Example: cdm|processes|ntevl|logmon.
      •  
        Selected QoS Messages: 
        select the set of QoS messages to be forwarded to CA APM. It will override any QoS messages you may have manually selected.
         Use .* to select all QoS messages.
  1. Click 
    Save.
    The selected probes are displayed on the navigation pane under the
     Available Probes
     node. The settings in the Raw Configure largely affect the information that is displayed under the 
    Available Probes 
    node. Refer to the 
    Understand the Impact of Raw Configure Settings
     table.
  2. Select the node that corresponds to the probe for which you want to configure the QoS messages.
  3. Select the
     Enable QoS publishing
     field to enable QoS message publishing for the probe.
  4. In the detail pane below the 
    Enable QoS publishing
     field for each probe, select the QoS messages that you want to enable for the probe.
  5. Repeat Steps 3-5 until all the probes and their QoS messages are configured.
  6. Click 
    Save
    .
  7. Deactivate and activate the apmgtw probe for the changes to take effect.
    You configured the apmgtw probe to send QoS messages from the selected CA UIM probes.
Verify apmgtw Probe Function in CA APM
Check the probe resources in CA APM Workstation.
 
Follow these steps:
 
  1. In CA APM, navigate to 
    Workstation
     > 
    Investigator
     > 
    Metric Browser
    .
  2. In the navigation tree in the left pane, click> the machine name that you supplied CA APM with for the <Nimsoft Monitor Server> Nimsoft> NimsoftAgent>Nimsoft QoS>Nimsoft Hub> 
    <ProbeName>
     > 
    <ResourceName>
     > 
    <QoSMessage>
    .
  3. Underneath the probes in the tree hierarchy, are the Resources and QoS reported to CA APM from the apmgtw probe.
    If no Resources or QoS are displayed in <APM> Workstation, then the probe is not configured properly or there are no QoS messages available to send to CA APM.
    Check configurations or call support.
View Metrics in CA APM
In CA APM, navigate to the following section to view the available metrics with respect to apmgtw:
superDomain > Custom Metric Host (Virtual) > Custom Metric Agnet (Virtual) (*SuperDomain*) > Agents > <APPname> > EPAgentProcess_3.0.0 > EPAgent > Metric Count
  Apm Metrics.png  
: The navigation path of available metrics might differ in your environment according to the EPAgent and APM setup.