All Products
Search
Document Center

IoT Platform:Metric Retrieval

Last Updated:Oct 16, 2024

IoT DataService Studio provides derived metric data that is not real-time. Utilize the metric retrieval feature to access historical data and swiftly obtain derived metrics. This topic outlines the process for creating a metric retrieval task.

Note

The generation date for derived metric data is T+1 day.

Here, "T" denotes the date when the raw data was received by the IoT Platform.

Create a retrieval task

  1. In the IoT Platform console, click Overview. On the Overview tab, find the instance that you want to manage and click the instance ID or the instance name.

  2. In the left-side navigation pane, select Data Service > Data Metric, and single click Customize Metric.

  3. Navigate to the Customize Metric tab and single click the Metric Task in the upper right corner.

  4. Select the Retrieval Instance tab, then single click Create Retrieval Task.

  5. In the Create Retrieval Task panel, configure the following parameters and select the metric you wish to retrieve.

    Parameter

    Description

    Select Retrieval Date

    The default end time is the day before the task's creation, which can be modified. The date range is adjustable up to 30 days.

    Retrieve Downstream Metrics

    Determine whether to retrieve metrics downstream of the selected metric.

    Note

    Downstream metrics are those derived from a specified metric.

    • To retrieve downstream metrics, select the check box.

    • To retrieve only the selected metric, clear the check box.

  6. Single click Confirm.

    Upon task creation, the Retrieval Instance tab will display the task list with their retrieval status.

    To reattempt retrieval, single click Rerun.

    Important

    Wait for the retrieval status to show Successful after creating the task, after which the metrics can be used as needed.

  7. (Optional) Single click View next to the retrieval task, and on the Retrieval Details page, select a run record to examine the run log.

View recurring instances

The Recurring Instance tab lists periodic data statistics for metrics.

To view detailed statistics for each period, including Data Timestamp, Last Submission Time, Last End Time, Last Execution Status, and Run Log, single click View in the Operation column of the desired task.

In case of a failed recurring instance, single click Rerun to retry execution. For persistent failures, single click View to investigate the failure details, identify the issue, and adjust the metric configuration accordingly.