grafana / iot-sitewise-datasource

IoT Sitewise
Apache License 2.0
19 stars 9 forks source link

Unable to tell which anomaly asset properties belong to which anomaly prediction definition #349

Open hwandersman opened 4 weeks ago

hwandersman commented 4 weeks ago

Since anomaly prediction definition composite model asset properties always have the same names (i.e., AWS/L4E-ANOMALY_RESULT) and the SW Grafana asset property selector only displays asset properties by name, it is not possible for a customer to determine which prediction definition an anomaly result asset property belongs to when selecting in a query. This issue extends to alarms definition composite models, yet the exact ask is for prediction definitions. To solve the problem, it is recommended we prepend the names of composite models to asset property names, as described below.

Recommended solution:

To provide the best user experience while maintaining technical consistency, we recommend showing a navigation path (e.g., MyPrediction1->AWS/L4E-ANOMALY_RESULT) instead of changing the name by prefixing it with the prediction definition name (e.g., MyPrediction1-AWS/L4E-ANOMALY_RESULT). This approach allows users to form a mental model that AWS/L4E-ANOMALY_RESULT is a property within a prediction and avoids creating the impression that MyPrediction1-AWS/L4E-ANOMALY_RESULT is a valid property name in SiteWise, which is not the case.   This navigation path format is also used by SiteWise expressions (when properties are referenced through hierarchies), so this approach will ensure a consistent user experience across both the SiteWise console and Grafana.

image

iwysiu commented 3 weeks ago

It looks like we currently just take the last part of the path as the name (here). Instead we could construct a string based on the path to to be more clear.