Usage Data

telemetry usage data, telemetry data
{"URL":["/*.*/awa/administration_usage_data"],"heroDescriptionIdentifier":"ice_usagedata_intro","customCards":[{"id":"ice_usagedata_list","title":"Usage Data List","type":"customize","url":"https://docs.automic.com/documentation/webhelp/english/ALL/components/DOCU/*.*/Automic%20Automation%20Guides/Content/Telemetry/admin_Telemetry_UsageData.htm","languages":["en-us"]},{"id":"ice_usagedata_filtering","title":"Filtering Usage Data","type":"customize","url":"https://docs.automic.com/documentation/webhelp/english/ALL/components/DOCU/*.*/Automic%20Automation%20Guides/Content/Telemetry/admin_Telemetry_UsageData.htm","languages":["en-us"]},{"id":"ice_usagedata_exportingdetail","title":"Exporting Usage Data Details","type":"customize","url":"https://docs.automic.com/documentation/webhelp/english/ALL/components/DOCU/*.*/Automic%20Automation%20Guides/Content/Telemetry/admin_Telemetry_UsageData.htm","languages":["en-us"]},{"id":"ice_usagedata_exprotingcsv","title":"Exporting the Usage Data Table to CSV","type":"customize","url":"https://docs.automic.com/documentation/webhelp/english/ALL/components/DOCU/*.*/Automic%20Automation%20Guides/Content/Telemetry/admin_Telemetry_UsageData.htm","languages":["en-us"]}]}

The Usage Data page of the Telemetry section of the Administration perspective is only visible in Client 0 and after you have configured telemetry in your system. For more information, see Usage Data (Telemetry) Configuration.

Note: Only users who have the Access to the metrics endpoint of Automation REST API AWI privilege can see the Usage Data page.

This page includes the following:

Usage Data List

telemetry usage data list, telemetry data list

By default, the Usage Data list displays the telemetry usage data for the last full month for the product you selected while configuring telemetry.

The following columns are displayed by default:

  • Product SKU

  • Product Name

  • Metric (SKU description)

  • Product Version

  • Reporting End Date

  • Usage

The Usage Data list also allows you to display a detailed list of the elements that make up the technology nodes, application nodes, mainframe nodes, or orchestrated systems in your environment. To access the detailed list, click the relevant Product SKU to expand the list.

Filtering Usage Data

filtering telemetry usage data, filtering telemetry data

You can use the Filter function in the Usage Data page to define a specific usage period. Click the Filter button to open the Filter pane. Click it again to close it.

When you open the filter, the following filter options are displayed:

  • From/to: Starting and ending date for which you want to see the usage data

    Important! Since the telemetry usage data is only relevant for past full months, make sure you select the first and last days of the month. You do not have to change the time in the filter. The time is set to cover a complete day by default. This is also the status of the filter when you press the Reset button.

    To use this option, activate From/to and select the month(s):

    1. Click the icon to open the calendar view.

    2. Use the arrows at the top of the calendar view to select the first day of the month.

    3. Click on the date.

    4. Do the same to define the end of the month.

  • Within last: Point in time on which the time frame begins. The end is always the end of the last full month if you select this option.

    To use this option, activate Within last and select the time frame. Use the spin buttons to select the number of Months you want to define.

    The date and starting/ending times you have selected are displayed beneath this option.

    Again, since the data is relevant only for the last full month, only the Months setting is relevant for this filter option.

Press the Filter button at the bottom of the filter to apply your search criteria or press the Reset button to set the filter to its precious status.

Exporting Usage Data Details

exporting telemetry data details, exporting telemetry data

Once you have the list of your usage data for past full months, you can export the detailed information per node (SKU). By default, the detail data is retained for 18 months.

To export it, you have two options:

  • select the relevant node and click the Export Detail Data button on the menu bar

  • right-click the relevant node and select Export Detail Data from the context menu

The usage data is exported as comma-separated values in a CSV file.

The Export Detail Data option is available only when you select one node. If you select more than one node or no node at all, the option is disabled.

This option is available also via the AE REST API using the following endpoint:

Request: GET http://{host}:{port}/ae/api/v1/{client}/telemetry/export/details

Example:

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

For more information and examples on how to use this endpoint, see:

Exporting the Usage Data Table to CSV

exporting telemetry data to CSV

Use the Export Table option to extract the table content as comma-separated values in a CSV file. For more information, see Exporting Tables to CSV.