Metrics for custom monitoring

Add infrastructure monitoring

1. Log on to the IoT Platform console.
2. In the upper-left corner of the console, select the region where your Enterprise instance is located. On the Instance Overview page, find the Enterprise instance and click the instance name.
3. In the navigation pane on the left, choose O&M > Real-time Monitoring.
4. On the Monitoring Report tab, click Add Infrastructure Monitoring.
5. In the Add Infrastructure Monitoring dialog box, click the data metrics that you want to display.
   Note You can select metrics that are already displayed on the Monitoring Report tab.
6. Click OK.

   By default, the Monitoring Report tab displays statistics for All Products over the last hour. You can select from the following time ranges: Last 30 minutes, Last 1 hour, Last 4 hours, Last 12 hours, Last 1 day, Last 2 days, Last 7 days, and Custom. The maximum custom time range is 30 days.

   Important

   • After you add a metric or update its dimension to All Products, it takes 5 minutes to aggregate the statistics for the product dimension, which causes a delay in the metric data. For example, the curve for an Over-the-Air (OTA) metric might show a downward trend. Wait 5 minutes to view the accurate statistical value for the current time.
   • If a metric does not support data statistics for the All Products dimension, a message appears on the metric card that prompts you to edit the metric dimension. For more information, see Edit infrastructure metrics.
7. Optional: In the metric list, click the edit icon in the upper-right corner of a data metric card to view the card in full screen or delete the metric.

Add Thing Model Monitoring

1. On the Monitoring Report tab, click Add TSL Model Monitoring.
2. In the Add TSL Model Monitoring dialog box, select the property metrics to display, and then click OK.

   Parameter Name	Description
   Metric Name	The custom name of the metric. The name must be 1 to 32 characters long and can contain letters, digits, and underscores (_).
   Product	Select the product to which the metric data belongs.
   Property	Select the TSL model module and property under the product. Important Only numeric properties are supported.
   Device	Select the device for the metric data. All Devices is selected by default. You can also select a single device.
   Metric Aggregation	The aggregation methods for the metric data. You can select up to three methods. Supported aggregation methods: Latest, Count, Sum, Min, Max, and Average.
   Aggregation Granularity	The time frequency for data aggregation. Options: 1 minute and 5 minutes.

3. Optional: In the metric list, click the edit icon in the upper-right corner of a TSL model property metric card, and then click Edit Metric to modify the property metric.
   You can also view the metric card in full screen or delete the metric.

Edit infrastructure metrics

The default dimension for infrastructure metric data is All Products. You can modify this setting. You can add the same metric multiple times and configure a different statistical dimension for each one.

To edit the statistical dimension of an infrastructure metric, perform the following steps:

1. In the metric list, click the edit icon in the upper-right corner of a data metric card, and then click Edit Metric.
2. In the Edit Metric dialog box, configure the following parameters.

   Parameter	Description
   Metric Name	The name of the current metric. This parameter cannot be modified.
   Metric Aggregation	The aggregation method for the metric data. The Rules Engine Message Size and Rules Engine Message Latency metrics support the Min, Max, and Average aggregation methods. All other metrics only support Total and cannot be modified.
   Metric Dimension	Select the product for the metric data. All Products is selected by default. You can change this to a single product. For OTA metrics: Daily Upgrade Success Rate by Product metric, the statistical value for the All Products dimension is the sum of the upgrade success rates of all products. Daily Upgrade Success Rate by Instance metric provides overall statistics for the instance dimension. The Metric Dimension parameter is not displayed for this metric.
   Aggregation Granularity	The time frequency for data aggregation. Options: 1 minute and 5 minutes.
   Threshold	This parameter is displayed only for data metrics that are rendered as area charts. The threshold is displayed as a value on the y-axis of the area chart. A reference line parallel to the x-axis is shown at this value. Not set: The reference line is not displayed. Custom: Set a custom value as needed. After you set the value, the reference line is displayed on the metric card. If you create an alert rule, this value is displayed as the Threshold in the alert rule. For more information, see Configure a threshold-triggered alert rule.

3. Click OK.
4. Optional: On the Monitoring Report tab, click Edit Panel. Adjust the layout of the metric cards as prompted, and then click Save.