Usage Data (Telemetry)

You can configure your product to collect and send telemetry data — product usage and system configuration data — to Broadcom. Use the information on this page to learn how to send usage data to Broadcom.

If you are licensed to use this product under a Portfolio License Agreement (PLA) subscription, you must configure it to collect and send product-specific usage data. If you are licensed to use this product under a standard license, you can consent to having this product collect and send usage data. By default, this product does not collect and send usage data.

For Automic Automation, the reporting options are:

Note: Please contact Product Management if you are running a version lower than 12.3.

What Data We Collect

The usage data information is securely transmitted to Broadcom. The data includes the number of devices that are being monitored. No Personally Identifiable Information (PII, as legally defined) covered under GDPR is transmitted. For more information about how your information is collected and used, read our Privacy Policy. The following table describes some of the usage data that your product may send to Broadcom.

Name Description
Product This product or product family identifier
Instance ID A product-generated unique ID representing a single installation or environment
Date Collected Use the yyyy-MM-dd format
Product Version The product model and version
Site ID The Enterprise Support Site ID of the customer
Licenses A summary of the installed product licenses
Usage The maximum meter count which was used during a reporting period
Serial Number A value that associates a customer with a specific entitlement (allowed usage and time period) to a Broadcom product, typically included in a license
SKU The product SKU based on the entitlement

How Licensed Metrics Are Calculated

Automic Automation, Automation Analytics and Intelligence, Automic Intelligent Remediation, Automic Service Orchestration, Automic Workload Automation, and Automic Continuous Delivery Automation collect and send system configuration information about the number of instances in use and whether the systems run as a High Availability cluster. All other usage data metrics differ depending on your system's setup:

  • Automic Automation and Automic Workload Automation send the number of technology nodes, application nodes, mainframe/midrange nodes

  • Task-based Automic Workload Automation sends the number of successfully executed tasks

  • Automic Service Orchestration sends the number of orchestration targets

  • Automation Analytics and Intelligence sends the sum of the numbers of technology nodes, application nodes, mainframe/midrange nodes

  • Automic Intelligent Remediation sends the number of technology nodes

  • Automic Continuous Delivery Automation sends the maximum number of deployment targets

How to Report Usage Data Automatically

As an administrator, configure telemetry after installing or upgrading the product.

The first time you log in to Client 0, you are prompted to configure telemetry.

  1. Click the link in the notification to access the Telemetry page of the perspective.

  2. On the Telemetry page, define if the instance is subject to a PLA and consent to send telemetry data.

    When you consent to send telemetry data, the Automation Engine collects it in a data report and uploads it once a day, one report per client database.

  3. Select your product:

    • Automic Automation

    • Automation Analytics and Intelligence

    • Automic Intelligent Remediation

    • Automic Service Orchestration

    • Automic Workload Automation

    • Automic Workload Automation - Task Edition

    • Automic Continuous Delivery Automation

  4. Provide the mandatory Activation Data.

  5. Select the Use a Proxy checkbox if you want to use a proxy to send telemetry data.

  6. Save your changes.

This information is also reflected in the UC_TELEMETRY_SETTINGS variable, see UC_TELEMETRY_SETTINGS - Telemetry Configuration.

You can also see your usage data for the last full month in the Usage Data page in the Telemetry section of the Administration perspective. For more information, see Usage Data.

How to Use the Product Usage Collector

The Product Usage Collector (PUC) is an application for Windows or MacOS that is installed by the customer on a system that can access the product. The PUC alleviates the need for special firewall rules to access product licensed metrics, and does not require a dedicated system in your data center. For complete documentation on the PUC, see Product Usage Collector.

The PUC requires two different credentials:

  • Broadcom Okta credentials

    Your account that has a Subscription Manger role on support.broadcom.com. Use these credentials when you start PUC, to allow it to retrieve your SiteID, entitlements, and a list of product versions supporting PUC.

  • Product access credentials

    The user name and password for each product for which you are reporting usage, see below.

Defining Product-Specific Information

The PUC requires product-specific information to return the relevant data.

As an administrator, you make sure the following requirements are in place:

  1. Make sure that telemetry is configured correctly in Automic Automation.

    1. On the Telemetry Configuration page, define if the instance is subject to a PLA. When you use the PUC you do not have to send telemetry data automatically.

    2. Select your product:

      • Automic Automation

      • Automation Analytics and Intelligence

      • Automic Intelligent Remediation

      • Automic Service Orchestration

      • Automic Workload Automation

      • Automic Workload Automation - Task Edition

      • Automic Continuous Delivery Automation

    3. Provide the mandatory Activation Data.

    4. Save your changes.

  2. Save the credentials of the Client 0 in the configuration file of the PUC. Otherwise, the PUC cannot establish a connection to the Client.

  3. Create a PUC User in Client 0, see Users (USER).

  4. Grant the PUC User the Access to the metrics endpoint of Automation REST API (ACCESS_METRICS_ENDPOINT) AWI privilege, see Granting Automation Engine Privileges.

Important! For security reasons, only grant the PUC User the Access to the metrics endpoint of Automation REST API (ACCESS_METRICS_ENDPOINT) AWI privilege, thus ensuring that the user cannot access any other data.

PUC REST API Endpoint

The Product Usage Collector (PUC) establishes the connection to the target system through a REST API call. For this purpose, the AE REST API provides the productusage endpoint, which allows you to use the PUC to pull your usage data on demand. This connection can only be established with Client 0.

Request: GET http://{host}:{port}/ae/api/v1/{client}/productusage

Example: http://my-jcp-host:8088/ae/api/v1/0/productusage

More information:

How to Report Usage Data Manually

You can extract the telemetry data offline by using the Automic Automation REST API. It is found by using a date range. For example:

http://{AA_instance:port}/ae/api/v1/0/telemetry/export/{n_month}

After you have pulled your data, submit it to Broadcom by using the Usage Reporting Portal.

For more information refer to the AE Rest API reference: https://docs.automic.com/documentation/webhelp/english/AA/21.0/DOCU/21.0/REST%20API/Automation.Engine/index.html?overrideUrls=../Automation.Engine/swagger.json,../Continuous.Delivery.Automation/swagger.json,../Analytics/swagger.json,../Infrastructure.Manager/swagger.json#/telemetry/export