Investigate the required status of the metric ID field in dashboard YAML

Problem Statement

At the moment, our docs state that the id property for metric is not required (docs link).

However, if a few panels are present in a dashboard, each of them missing their id for metric, only one of those panels' charts will be successfully rendered (the last one) - example here. A thing to note is the same thing happens if all the ids are the same.

But if those same panels are given a unique id for their metrics, all of the charts will display just fine - example here. Note: at the moment the monitor sandbox project is malfunctioning, so custom dashboards, the aforementioned examples included, might not work. Locally testing of those dashboards is recommended.

We must think of a solution to remove this undocumented barrier for users with no prior experience.

Possible solutions would be

  • fixing this behaviour to be more in line with the docs
  • amending the docs to explain what could happen in case of missing metric ids

Screenshot of malfunctioning dashboard

Screenshot_2020-08-18_at_16.29.46

Reach

Impact

Confidence

Effort

Edited Aug 18, 2020 by Andrei Stoicescu
Assignee Loading
Time tracking Loading