Usage Data (Telemetry) Configuration

{"URL":["/*.*/awa/administration_telemetry_settings"],"heroDescriptionIdentifier":"ice_telemetry_intro","customCards":[{"id":"ice_telemetry_datacollected","title":"What Data is Collected","type":"customize","url":"https://docs.automic.com/documentation/webhelp/english/ALL/components/DOCU/*.*/Automic%20Automation%20Guides/Content/Telemetry/admin_Telemetry.htm","languages":["en-us"]},{"id":"ice_telemetry_calculatedmetrics","title":"How Licensed Metrics Are Calculated","type":"customize","url":"https://docs.automic.com/documentation/webhelp/english/ALL/components/DOCU/*.*/Automic%20Automation%20Guides/Content/Telemetry/admin_Telemetry.htm","languages":["en-us"]},{"id":"ice_telemetry_reportautomatically","title":"How to Report Usage Data Automatically","type":"customize","url":"https://docs.automic.com/documentation/webhelp/english/ALL/components/DOCU/*.*/Automic%20Automation%20Guides/Content/Telemetry/admin_Telemetry.htm","languages":["en-us"]},{"id":"ice_telemetry_reportmanually","title":"How to Report Usage Data Manually","type":"customize","url":"https://docs.automic.com/documentation/webhelp/english/ALL/components/DOCU/*.*/Automic%20Automation%20Guides/Content/Telemetry/admin_Telemetry.htm","languages":["en-us"]}]}

This product does not collect and send usage data by default. You need to 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.

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

telemetry data collected, collected usage data, what telemetry data is collected, what usage data is collected

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

usage data metrics, telemetry metrics, licensed metrics, usage data calculation, telemetry data calculation

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 SaaS sends the total amount of successful job executions

  • Automic Automation for Hybrid Cloud sends the total amount of successful job executions

  • 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

reporting usage data automatically, reporting telemetry data automatically, automatic data usage report, automatic telemetry data report

As an administrator, you 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 Administration perspective. The telemetry Configuration page opens automatically.

  2. On the Telemetry Configuration 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

    • Automic Automation AI Edition

    • Automic Automation SaaS

    • Automic Automation for Hybrid Cloud

    • (LEGACY) Automic Intelligent Remediation

    • (LEGACY) Automic Service Orchestration

    • (LEGACY) 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 and export the detailed information per node (SKU). For more information, see Usage Data.

How to Report Usage Data Manually

reporting usage data manually, reporting telemetry data manually, manual data usage report, manual telemetry data report

The Automation Engine REST API allows you to extract telemetry data while being offline for the past n months, including the current one. You can do so using the telemetry/export/{n_month} REST API endpoint.

  • Request: GET http://{host}/ae/api/v1/{cleint}/telemetry/export/{n_month}

  • Example: http://my-jcp-host:8088/ae/api/v1/0/telemetry/export/3

The connection can only be established with Client 0.

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

For more information, see REST API Reference.