telemetry MCS Profile Type Configuration

The telemetry probe provides local monitoring of your canm environment. System administrators use  the telemetry probe to collect data about their hub, robot, and probe inventory that is useful for troubleshooting. This article is for the telemetry probe v1.0 and later.
uimpga-ga
telemetry
The telemetry probe provides local monitoring of your 
CA Unified Infrastructure Management
 environment. System administrators use  the telemetry probe to collect data about their hub, robot, and probe inventory that is useful for troubleshooting. 
This article is for the telemetry probe v1.0 and later
.
 
Contents
 
 
 
Workflow
The probe is automatically installed with CA Unified Infrastructure Management versions 8.5.1 and later. By default, the probe is 
active
 and configured to collect data about your CA Unified Infrastructure Management environment. The probe publishes this data as a JSON file and an HTML file to an output directory that it creates on your local system. If, during the installation of CA Unified Infrastructure Management, you opt in to send data to Support, the probe also sends this data to Support. The probe sends the data to Support at the default interval of once a week. If you contact Support for help, Support uses this data for troubleshooting purposes.
Optionally, you can use the 
Setup telemetry
 monitoring profile in the Monitoring Configuration Service (MCS) in the Unified Service Manager (USM) portlet to change the default settings for the probe. For example, you can change the log level, the log size, or the collection interval. Or, you can select "Show IP and Hostnames." By default, the active probe does 
not
 show IP addresses or hostnames.
Workflow Diagram
The graphic below shows the workflow for the telemetry probe.
telemetry_workflow
telemetry_workflow
Verify Prerequisites
  • Verify that you have installed the telemetry probe with 
    CA Unified Infrastructure Management
     v8.5.1 or later.
(Optional) Configure the Setup telemetry Profile in MCS
By default, the probe is active and configured to collect data. Optionally, you can modify the default settings.
 
Follow these steps
:
  1. In the Unified Service Manager, select your primary hub.
  2. Click the Monitoring tab.
  3. Select the 
    Setup telemetry
     profile.
  4. Accept the profile default settings or modify them to fit your needs.
    •  
      Log Level
      Select the level of information to be written to the log file [1-5]. The recommend value is 3. Increase, if necessary, for troubleshooting.
    •  
      Log Size
      Enter the maximum size of the probe log file. The default size is 10,000 kB.
    •  
      Interval
      Enter the interval at which the probe collects data. The default value is once a week.
       
  5. Select the profile options that you desire.
    •  
      Show IP and Hostnames
      By default, the probe does 
      not
       show IP addresses or hostnames. If you select the Show IP and Hostnames option, the probe shows them in plain text in the JSON file output.
    •  
      Telemetry Service Settings
      Important!
       If you changed any configuration settings within the MCS profile for the telemetry probe, you must re-enter them here. If you did not opt in to send data to Support during the installation of UIM, then the probe does not use the credentials to send data to Support. If your 
      CA Unified Infrastructure Management
       Support credentials have changed since you entered them during the installation of 
      CA Unified Infrastructure Management
      , enter the new credentials here
    •  
      Proxy Server Settings
      If you want to use a proxy server to send data, enter your proxy server credentials and setting information.
  6. Click 
    Create 
    or
     Save
    .
    You modified the default settings for the probe.
    Note
    : If you delete the MCS profile for the telemetry probe, all configuration for the probe is disabled. If the telemetry probe is running when you delete the MCS profile for it, the probe stops and the profile is deleted.
 Only one instance of a configuration profile can be applied to a target device. When devices are members of more than one USM group, the configuration profile with the higher Group Profile Priority number is applied. 
 
View Data on Your Local System
Instead of publishing data to a graphic user interface, such as Admin Console, the telemetry probe generates both a JSON file and a viewable HTML file that it sends to an output directory that it creates on your local system.
By default, the probe publishes both a JSON and HTML file to the output directory that it creates on your local system. If, during the installation of 
CA Unified Infrastructure Management
, you select the option to Upload Data to Support, the probe also sends the data over an encrypted connection to a secure server in Support.
To view the telemetry probe data, you navigate to the output directory on your local system and open the HTML file.
 
Follow these steps
:
  1. On your local system, navigate to the output directory for the telemetry probe. If you accepted the default output directory path when you set up the probe in MCS, the path should be similar to:
    NIMSOFT_HOME/probes/service/telemetry/output_data
  2. Select the HTML file.
  3. Open the file in a web browser.