Use Application Discovery

Application Discovery enables system administrator bus users to automatically discover, to group, and to monitor devices in their environment. Application Discovery comes with default scripts that determine the discovery of the applications that are running on your monitored systems:
uim203
application_discovery
Application Discovery enables system administrator bus users to automatically discover, to group, and to monitor devices in their environment. Application Discovery comes with default scripts that determine the discovery of the applications that are running on your monitored systems:
  • Apache
  • Active Directory
  • Exchange Server
  • IIS
  • MySQL
  • Microsoft SQL
  • Oracle
  • Sharepoint
In the Administration of the Settings View in the Operator Console, you select which applications that you want the Application Discovery scripts to discover. In the Monitoring Configuration Service (MCS), you then select which default monitoring profiles that you want to enable. You view the monitoring data in the CA UIM visualization components, including OC or the CABI Dashboards for CA UIM. If the default scripts do not discover the devices that you want to find in your environment, you can create custom scripts.
UIM 20.3.3 has removed dependency on CA Business Intelligence (CABI) for rendering the native OC screens: Home page, Group view page, Device view page, and Monitoring Technologies (probes) view page. Custom and Out-of-the-Box dashboards and reports are still rendered by using CABI; that is, they have a dependency on CABI. However, the native OC screens are no longer dependent on CABI (Jaspersoft) and are rendered by using HTML5. For more information about the native OC screens using HTML5, see the Configuring and Viewing Monitoring Data article or the "Removing CABI Dependency (Native Operator Console)" section in the UIM 20.3.3 article.
Contents
Workflow
Before you start the workflow for the Application Discovery feature, verify that you meet the prerequisites. The prerequisites include installing the robot 9.31 (or later) on your primary hub and all the devices that you want to monitor. You must also have the Attribute Publisher plug-in in your archive. The robot and Attribute Publisher plug-in work with the nis_server and the CA UIM database to enable discovery of devices by application.
  1. To activate Application Discovery, select at least one of the applications that the feature can discover and monitor. Select them in the Administration pane of the Settings View in Operator Console. In the Administration pane, select one or more of the Application Discovery groups that you want to discover and monitor.
    Note
    : The Application Discovery feature depends on the Application Discovery Unix and Windows groups to push the Attribute Publisher plug-in that contains the discovery scripts to monitoring targets. Therefore, the Application Discovery groups for Unix and Windows are automatically selected when you select any one of the other Application Discovery groups and click
    Save
    .
  2. When you select at least one Application Discovery group and save the change, MCS pushes the Attribute Publisher plug-in out to the robots installed on the devices in your monitoring environment. The plug-in runs a discovery script to identify devices based on the desired attribute. For example, if you select the Application Discovery: Apache group, the discovery script for Apache identifies devices that host an Apache server.
  3. In the OC, these identified devices appear in the Discovered Application Systems group. Devices are placed in subgroups based on their attribute, such as Apache server. To configure a monitoring profile for a subgroup, select the desired subgroup in the Groups view. Then click on the
    Monitoring Config
    (Monitoring Config Icon) icon in the right top menu.
  4. When you click the Monitoring Config, the MCS configuration pane appears.The available profile types for each device appear in the MCS pane. MCS automatically determines these available profile types for each subgroup based on its role. For more information, see Monitoring Configuration Service.
  5. To activate monitoring for a subgroup, such as Apache, you need
    only
    to enable the configuration profile for it. It is optional to configure any other profile that is available for the subgroup. To activate monitoring for a subgroup, such as Apache, click on the arrow next to the profile type to expand it. Then, click on the configuration profile for the subgroup, such as Discovered Apache. You can either accept the default configuration or modify it. Apply the profile configuration by clicking
    Enable
    to activate the profile.
    The Application Discovery group profiles appear with an orange pause (Orange Pause Icon) icon that indicates they are in a suspended state. To apply monitoring to a group, accept or modify the default configuration in the profile and then click
    Enable
    . Once you enable a profile, the suspended icon goes away and a
    Save
    button replaces the
    Enable
    button.
  6. When you enable a profile, MCS deploys the necessary probes to all the devices in the subgroup. The probes publish alarms and Key Performance Indicators (KPIs or metrics) for each device that you can view in CA Unified Infrastructure Management, including the OC and the CABI Dashboard for CA Unified Infrastructure Management for the relevant MCS profile.
    • If the necessary probes are not in the archive or are missing a license, you see an error message at the top of the profile.
    • From CA UIM 9.2.0 onward, hub/robot- and probe-level licensing requirements have been removed. Deploy the hub, robot, and distsrv versions released with CA UIM 9.2.0 to remove the license dependency. If you want to continue with the older versions of hub and probes that require an extension of the license, contact Support so that they can assist you in extending the license (if required).
    • UIM 20.3.3 has removed dependency on CA Business Intelligence (CABI) for rendering the native OC screens: Home page, Group view page, Device view page, and Monitoring Technologies (probes) view page. Custom and Out-of-the-Box dashboards and reports are still rendered by using CABI; that is, they have a dependency on CABI. However, the native OC screens are no longer dependent on CABI (Jaspersoft) and are rendered by using HTML5. For more information about the native OC screens using HTML5, see the Configuring and Viewing Monitoring Data article or the "Removing CABI Dependency (Native Operator Console)" section in the UIM 20.3.3 article.
Workflow Diagram
The following diagram shows the workflow for grouping and monitoring devices with the Application Discovery feature:
ApplicationDiscovery_workflow
ApplicationDiscovery_workflow
Key Terms
  • Administration Tile and Pane
    To activate Application Discovery, select at least one of the applications that the feature can discover and monitor. Do this in the Settings view of the Operator Console by clicking the Administration tile. When you click on the tile, the Administration pane appears. In the Administration pane, select one or more of the Application Discovery groups that you want to discover and monitor.
    Note
    : If you open the Administration pane in OC, and you see that the Application Discovery: Unix and Application Discovery: Windows groups are already selected, then Application Discovery monitoring is already configured. Unless you want to remove the previous Application Discovery configuration, do
    not
    clear the selection of either group.
  • Attribute Publisher
    Plug-in
    A plug-in called the Attribute Publisher runs one or more discovery scripts to identify devices based on the attributes of each device. The Attribute Publisher is a plug-in that works with the robot 7.90 or later. An attribute is the role that a device plays, such as an Apache server. You determine the script or scripts that the plug-in runs by selecting one or more Application Discovery groups in the Administration pane of OC.
  • Discovered Application Systems Group
    The Discovered Application Systems group appears in the navigation tree in Inventory view of the OC. The Discovered Application Systems group is populated with subgroups of the devices that are identified and tagged by attribute. An attribute can be an application, operating system, or other role that the device plays in your environment. Once the Discovered Application Systems group is populated with these subgroups, you can select any subgroup. You manage a subgroup, similar to how you manage any other group, using OC. You configure monitoring for a subgroup using MCS.
  • Monitoring Config
    The Monitoring Config appears in the top right of the Groups view in OC, and it is highlighted when a group or subgroup is selected. After you select the desired group or subgroup in the Groups view of OC, you click on the Monitoring Config to open the MCS pane.
  • MCS Pane
    The profile types that you use to create configuration profiles appear in the MCS pane.
  • nis_server
    When you first install CA UIM, the nis_server creates groups of devices. The nis_server initiates a discovery to interrogate these devices for the applications that you can discover and monitor with the Application Discovery feature. The nis_server tags any active applications that it discovers in your environment with the relevant attributes. An attribute is the role that a device plays, such as an Apache server. The Attribute Publisher then executes application discovery scripts. An application discovery script, such as the one for Apache, searches the CA UIM database for devices that the nis_server has tagged with the relevant attribute.
  • Setup Application Discovery
    Group
    The Setup Application Discovery group appears in the navigation tree in Groups view of OC. The Setup Application Discovery group contains a UNIX subgroup and a Windows subgroup.
    (Optional)
    The default configuration for the subgroup is applied automatically. Or, if you want to change the default values for the subgroup, select the UNIX or Windows subgroup that is relevant to your environment. Click the Monitoring Config for the MCS pane. Click the add (+) icon and select the desired Application Discovery profile:
    • Application Discovery Scripts
      Profile
      (Optional)
      Use this profile to
      change the default values
      for the discovery scripts that are provided for the Application Discovery feature. Or, if you have written your own custom discovery script, enter the Package Name and Script Filename for your script in the Script Package Profile section of this profile.
      • Group Profile Priority
        : Enter a Group Profile Priority. The Group Profile Priority is used to determine the precedence of configuration profiles.For devices that are members of several groups, the configuration profile with the higher Group Profile Priority number is applied. Possible values are 0 to 100. The default value is 100.
      • Package Name
        : Enter a package name. The default value is the script filename.
      • Script Filename
        : Enter a script filename.
      • Interval
        : Select the interval at which the scripts, including those which ship with the Application Discovery feature, discover devices to monitor. The default value is 15 minutes. The interval value that you enter here overrides the interval value in the Set Up Application Discovery Defaults Profile.
    • Setup Application Discovery Defaults Profile
      (Optional)
      Use this profile to
      change the default values
      for the Application Discovery feature.
      • Group Profile Priority
        : Enter a Group Profile Priority. The Group Profile Priority is used to determine the precedence of configuration profiles. For devices that are members of several groups, the configuration profile with the higher Group Profile Priority number is applied. Possible values are 0 to 100. The default value is 100.
      • Interval
        : Select the interval at which any custom Application Discovery scripts discover devices to monitor. The default interval value is one day.
      • Grace Period
        : Select the interval (seconds) at which devices are deleted if they were previously discovered but now fail to respond. The default value is 259200 (three days).
      • Scripts Path
        : If you want to use custom scripts, enter the path that you want to use for your custom discovery scripts. Otherwise, leave the default value.
Verify Prerequisites
Meet the Software Requirements
  • On the primary hub:
    • CA Unified Infrastructure Management server v20.3 or later
    • CA Unified Infrastructure Management robot v9.31 or later
  • On all the devices that you want to monitor:
    • CA Unified Infrastructure Management robot v9.31 or later
      Note
      : For more information about how to deploy robots, see Deploy Robots.
  • In the archive on a hub:
    • nis_server v20.1 or later
    • Attribute Publisher plug-in (attr_publisher) v9.31 or later
    • The latest versions of the following probes:
      • ad_server
      • apache
      • exchange_monitor
      • iis
      • perfmon (required for iis and exchange_monitor)
      • processes (required for exchange_monitor)
      • mysql
      • ntservices (required for exchange_monitor)
      • sqlserver
      • oracle
        For the oracle probe, verify that you meet the prerequisites that are described in the oracle (Oracle Database Monitoring) Release Notes on the Probes Documentation Space.
  • (Optional) Install CA Business Intelligence with CA UIM 20.3
Important!
If you are upgrading from a previous version of CA UIM and want to keep the MCS configuration that you have set in your profile templates for the applications that are affected by Application Discovery, see the Monitoring Configuration Service Release Notes on the Probes Documentation Space.
(Optional) Set Up and Run Discovery in OC
If you want to ensure that the Discovered Application Systems group contains any recently added devices, you can run Discovery in OC before you configure any monitoring. You can launch the Discovery Wizard whenever you want to run discovery or change your discovery settings.
For more information about Discovery, see Run Discovery in OC.
Configure and Enable Monitoring Profiles
  1. In the OC, click on the Administration tile of the Settings View.
  2. In the Administration pane, select one or more of the Application Discovery groups that you want to discover and monitor.
    Note
    : The Application Discovery feature depends on the Application Discovery Unix and Windows groups to push the Attribute Publisher plug-in that contains the discovery scripts to monitoring targets. Therefore, the Application Discovery groups for Unix and Windows are automatically selected when you select any one of the other Application Discovery groups. If you open the Administration pane in OC, and you see that the Application Discovery: Unix and Application Discovery: Windows groups are already selected, then Application Discovery monitoring is already configured. Unless you want to remove the previous Application Discovery configuration, do
    not
    clear the selection of either group.
  3. Click
    Save
    .
    MCS pushes the Attribute Publisher plug-in out to the robots that are installed on the devices in your monitoring environment. The plug-in runs a discovery script to identify devices based on the desired attribute. For example, if you select the Application Discovery: Apache group, the discovery script for Apache identifies devices that host an Apache server. In OC, these identified devices appear in the Discovered Application Systems group. Devices are placed in subgroups based on their attribute, such as Apache server.
  4. In the navigation tree of the Groups view, select the desired subgroup.
    For example, Apache.
  5. Click on the
    Monitoring Config
    (Monitoring Config Icon) icon in the right top menu.
    The MCS configuration pane appears. The available profile types for each device appear in the MCS pane.
    Note
    : The Application Discovery group profiles appear with an orange pause icon that indicates they are in a suspended state.  
  6. Click the profile type to expand it. Then, click on the configuration profile for the subgroup.
    For example, Discovered Apache.
  7. Accept the default configuration in the profile or modify it.
  8. Click
    Enable
    (or
    Save
    ) at the bottom of each profile to save your changes and to activate the profile.
    Note
    : When you click
    Enable
    , the profile is active. Thereafter, the
    Enable
    button goes away and is replaced by a
    Save
    button. You cannot put the profile back to a suspended state.
  9. Repeat steps 1 through 7 as needed.
When you use the Application Discovery feature, the rules for group and device configuration in MCS apply as usual. For more information about MCS, see Monitoring Configuration Service.
View Data in
Unified Infrastructure Management
When you activate a profile, MCS deploys the necessary probes to all the devices in the subgroup. The probes publish alarms and Key Performance Indicators (KPIs or metrics) for each device that you can view in CA UIM, including the OC and the CABI Dashboard for CA UIM for the relevant MCS profile.
View Discovered Application Systems Groups in OC
You view a Discovered Application Systems group like you view any group using OC. The Discovered Application Systems group appears in the navigation tree in the Groups view of OC. The Discovered Application Systems group is populated with subgroups of devices that are identified and tagged by attribute. An attribute can be an application, operating system, or other role that the device plays in your environment. Once the Discovered Application Systems group is populated with these subgroups, you can select any subgroup to manage it in OC.
(Optional) Use SQL Queries to Filter Application Groups
You manage a Discovered Application Systems group like you manage any group using OC. Flexible grouping features allow you to organize your infrastructure into a hierarchy of static and dynamic groups and subgroups. You can organize groups according to concepts, such as service, customer, organization, or technology. You can also create or modify groups based on specific attributes or combinations of attributes in the group filters.
The Application Discovery monitoring profiles create additional SQL queries to define membership for each group. The queries appear as group filters. To view the SQL query, select or hover over a group name and click the
Edit group
(gear) icon to the right. In the filter at the bottom of the screen, click the
Edit query…
link. You can edit these filters to modify the member devices in each group.
Note
: SQL queries are a powerful way to filter the members of a Discovered Application Systems group in OC. Therefore, we recommend that you use them only if you are familiar with how to format an SQL query.
For more information about using filters for groups, see Create and Manage Groups in OC.
(Optional) View Data in the Default CABI Dashboard for CA UIM
Before you can view data in the Default CABI Dashboard for CA UIM, first you must install CA Business Intelligence with CA UIM.
UIM 20.3.3 has removed dependency on CA Business Intelligence (CABI) for rendering the native OC screens: Home page, Group view page, Device view page, and Monitoring Technologies (probes) view page. Custom and Out-of-the-Box dashboards and reports are still rendered by using CABI; that is, they have a dependency on CABI. However, the native OC screens are no longer dependent on CABI (Jaspersoft) and are rendered by using HTML5. For more information about the native OC screens using HTML5, see the Configuring and Viewing Monitoring Data article or the "Removing CABI Dependency (Native Operator Console)" section in the UIM 20.3.3 article.
Known Issues
  • If you remove a device from monitoring, the device continues to appear in the OC UI for up to three days. This is expected behavior because the grace period, the interval at which devices are deleted if they were previously discovered but now fail to respond, is three days.
  • If the hostnames for Windows devices are not unique, device correlation might not be accurate.
Known Issues with Workarounds
Oracle Devices
Symptom
You see that no QoS or alarms are generated for the Discovered Oracle monitoring profile in MCS, which you have enabled.
Test Connection in IM
Follow these steps:
  1. In IM, double-click the probe.
  2. Click the Connections tab.
  3. Double-click the profile
    Discovered Oracle
    .
  4. Click the
    Test
    button.
  5. You see an error stating that a connection cannot be made. You might also see a message that states: Create OCI environment failed with rc = -1.
Test Connection in AC
Follow these steps:
  1. Open
    Admin Console
    .
  2. In the top ribbon, click
    Robots
    .
  3. Click the name of the robot that hosts the oracle probe.
  4. In the top ribbon, click
    Probes
    .
  5. Click the Options (…) icon next to the probe and select
    Configure
    .
    A new browser tab appears.
  6. Click
    Discovered Oracle
    .
  7. From the Action button select
    Test Connection
    .
    You see the error “Message: Unable to start the probe as either the Database client is not installed or any other pre-requisite step is pending.”
Solution
To use the Application Discovery feature to discover and monitor Oracle devices, you must modify the connection settings in the Discovered Oracle MCS monitoring profile. (Modifying the connection settings in IM does not work because MCS overwrites them when it deploys the oracle probe.) You must also configure the environmental variables for the robot.
Modify the Profile and Database Instance Connection Settings
Follow these steps:
  1. In the Groups View of the Operator Console, go the Monitoring Config.
  2. Select the Discovered Oracle profile.
  3. In the Discovered Oracle profile, go to Profile and Database Instance Connection Settings. Enter the following information:
    • User ID:
      defines the user ID with authorization to read the database views.
      Enter: SYS AS SYSDBA
    • Password:
      specifies the password for the defined
      User ID
      . The password is encrypted and placed into the configuration file.
      Enter: A valid password for the "SYS" User ID
    • Service Name:
      specifies the service name that is defined in the
      tnsnames.ora
      file.
      For example, ORCL.
  4. Click
    Save
    .
Configure the Robot Environment Variables
To configure the robot environment variables, use the controller probe.
Follow these steps
:
  1. In Infrastructure Manager, double-click the controller probe.
  2. Select the Environment tab.
  3. Right-click in the window. Select
    New
    or
    Edit
    to add or edit the following variables and their values:
Variable
Example
Value
Note
: The example values in the table below might vary from your values. Verify the correct values for your system.
LD_LIBRARY_PATH
/home/oracle/app/oracle/product/12.1.0/dbhome_1/lib
ORACLE_HOME
/home/oracle/app/oracle/product/12.1.0/dbhome_1
ORACLE_BASE
/home/oracle/app
ORACLE_SID
orcl.ca.com
PATH
$PATH:/ /home/oracle/app/oracle/product/12.1.0/dbhome_1/lib
TNS_ADMIN
/home/oracle/app/oracle/product/12.1.0/dbhome_1/network/admin