Configure Telemetry for the PLA Model

uim902
HID_ESD_PLA_TELEMETRY
Telemetry is a foundational element of the Enterprise Software Portfolio License Agreement (PLA) model. The initial requirement of the Telemetry effort is to collect and report product-specific usage daily in support of the new consumption model. Broadcom uses its own endpoint to support the Enterprise Software Telemetry rollout. This endpoint provides a centralized platform for the collection and routing of usage data through various pre-built integrations and destinations.
It is mandatory for a customer under Enterprise Software PLA to enable telemetry and share the usage data. This article describes how to enable telemetry and route the usage data to Broadcom.
Contents:
Data Collected by Telemetry
Telemetry collects two types of details for each PLA customer:
  • Customer data:
    This data identifies the customer, its site through the site ID, and an optional Charge back ID to identify the division or group to be charged for usage. For this, you must configure the customer details in the
    esdplatelemetry_customerinfo.properties
    file.
  • Usage data:
    This is the actual usage data based on the consumption, which is collected and shared on to Broadcom API. You must enable the upload of the usage data in
    wasp.cfg
    file. For more information on how to enable the telemetry uploads, see Enable Telemetry Uploads.
The collected Telemetry data is stored at: 'probes/service/wasp/esdplatelemetry/'.
Both the customer and usage data is shared over API for internal reporting purpose.
Telemetry does not collect any personally identifiable information (PII) or sensitive information. For additional information about how the your information is collected and used, read our privacy statement.
Frequency of Data Collection
By default, telemetry collects and stores the data daily at 12.00 a.m. If the scheduler is not active at 12.00 a.m., the data is collected only in the next day run. The data is collected only once per day.
Enable Telemetry Uploads
Prerequisite
Ensure that the
uimesdplatelemetry web service
is deployed on the uimserver wasp.
Step 1: Define the Customer Details in the
esdplatelemetry_customerinfo.properties
File
  1. Copy the
    wasp/conf/esdplatelemetry_customerinfo.properties.template
    file to
    wasp/conf/esdplatelemetry_customerinfo.properties
    .
  2. Edit the
    wasp/conf/esdplatelemetry_customerinfo.properties
    file and define the following properties with the appropriate customer information:
    1. domain_name
      : the customer domain name.
    2. site_id
      : customer site ID. To find the customer ID, log into the Broadcom Support site and view the customer site ID information from your profile.
    3. pla_enabled
      : define the value as true or false, to determine whether an install or upgrade is related to incremental use as a result of PLA. Contact the Broadcom sales team for more details on whether an installation is incremental or not.
    4. (Optional)
      chargeback_id
      : define the division or group to be charged for consumption usage reported to broadcom.com. Defining the charge back details is useful in understanding which Unified Infrastructure Management environment the report originates from.
Step 2: Configure the Telemetry Properties in wasp
You can configure the telemetry properties using one of the following options:
  • Update the properties in wasp.cfg, or,
  • Update the properties from Infrastructure Manager, or,
  • Update the properties from the Administration Console 
Update the Properties in the wasp.cfg File
  1. Edit the ./wasp.cfg file and define the following parameters in the
    <webapps>
    1. esdplatelemetryconfig.upload_enabled_flag
      : it is mandatory for all PLA customers to set this property as
      true
      to upload the data to Broadcom. By default, the flag is set to
      false
      .
    2. (Optional)
      esdplatelemetryconfig.proxy_url
      : define the URL to the proxy server from the UIM Server. For example: esdplatelemetryconfig.proxy_url = http://testproxy:8080
    3. (Optional)
      esdplatelemetryconfig.proxy_auth_username
      : configure the authenticated username using the Infrastructure Manager (IM) or Administration Console (AC) only. For more information, see Update the Properties from Infrastructure Manager and Update the Properties from the Administration Console.
    4. (Optional)
      esdplatelemetryconfig.proxy_auth_password
      : configure the authenticated password using the Infrastructure Manager (IM) or Administration Console (AC) only. For more information, see Update the Properties from Infrastructure Manager and Update the Properties from the Administration Console.
      Do not configure the
      esdplatelemetryconfig.proxy_auth_username
      and
      esdplatelemetryconfig.proxy_auth_password parameters
      in the wasp.cfg file. Doing so leads to proxy authentication failure and a loss of transmitted payloads to Broadcom.
    5. (Optional)
      esdplatelemetryconfig.envtype
      : if you want to override the default endpoint where the data is uploaded, specify the appropriate value for the environment type. By default, the value is
      prod
      . You can change the value (for example) to
      qa
      .
<webapps> <uimesdplatelemetry> path = /uimesdplatelemetry load_on_startup = true reloadable = true cross_context = true reinitialize = true unpack_war = true <custom> <uncrypted> customerinfo.properties_filepath = ./conf/esdplatelemetry_customerinfo.properties esdplatelemetryconfig.upload_enabled_flag = true esdplatelemetryconfig.proxy_url = esdplatelemetryconfig.proxy_auth_username = esdplatelemetryconfig.envtype = prod usage_metering_address = usage_metering </uncrypted> <crypted> esdplatelemetryconfig.proxy_auth_password = </crypted> </custom> </uimesdplatelemetry></webapps>
Update the Properties from Infrastructure Manager
  1. In Infrastructure Manager, double-click on wasp to open the wasp configuration UI.
  2. Navigate to the
    uimesdplatelemetry
    webapp.
  3. Right-click on
    uimesdplatelemetry
    and select
    Edit
    .
  4. Navigate to the
    Custom
    tab.
  5. Update and save the values for properties that are related to telemetry:
    1. e
      sdplatelemetryconfig.upload_enabled_flag
      : it is mandatory for all PLA customers to set this property as
      true
      to upload the data to Broadcom. By default, the flag is set to
      false
      .
    2. (Optional)
      esdplatelemetryconfig.proxy_url
      : define the URL to the proxy server from the UIM Server. For example: esdplatelemetryconfig.proxy_url = http://testproxy:8080
    3. (Optional)
      esdplatelemetryconfig.proxy_auth_username
      : define the authentication username to access the proxy
    4. (Optional)
      esdplatelemetryconfig.proxy_auth_password
      : define the authentication password to access the proxy
    5. (Optional)
      esdplatelemetryconfig.envtype
      : if you want to override the default endpoint where the data is uploaded, specify the appropriate value for the environment type. By default, the value is
      prod
      . You can change the value (for example) to
      qa
      .
  6. Select
    OK
    to exit the properties dialog.
The following screenshot shows the mandatory and some of the optional parameters that are being set:
im_properties_telemetry.png
Update the Properties from the Administration Console
  1. In Administration Console, navigate to wasp and click Configure from the context menu open the wasp configuration UI.
  2. Navigate to Web Applications and select
    uimesdplatelemetry
    .
  3. In the properties pane, navigate to the
    Custom
    Properties
    section.
  4. Update the values for properties that are related to telemetry and then select
    Save
    :
    1. esdplatelemetryconfig.upload_enabled_flag
      : it is mandatory for all PLA customers to set this property as
      true
      to upload the data to Broadcom. By default, the flag is set to
      false
      .
    2. (Optional)
      esdplatelemetryconfig.proxy_url
      : define the URL to the proxy server from the UIM Server. For example: esdplatelemetryconfig.proxy_url = http://testproxy:8080
    3. (Optional)
      esdplatelemetryconfig.proxy_auth_username
      : define the authentication username to access the proxy
    4. (Optional)
      esdplatelemetryconfig.proxy_auth_password
      : define the authentication password to access the proxy
    5. (Optional)
      esdplatelemetryconfig.envtype
      : if you want to override the default endpoint where the data is uploaded, specify the appropriate value for the environment type. By default, the value is
      prod
      . You can change the value (for example) to
      qa
      .
The following screenshot shows the mandatory and some of the optional parameters that are being set:
ac_properties_telemetry.png
Step 3: Restart wasp
Restart the uimserver wasp for the uimesdplatelemetry web service to initialize using the newly created configuration values.
Troubleshoot
For any errors, review the
uimesdplatelemetry.log
file stored in the directory 'probes/service/wasp/'. The web service performs a validation at startup, and errors are logged if the configuration is in error. The uploads are performed once a day at midnight, we recommend that you review the log file next day as a final validation.