Add support for multiple datasources #40
Conversation
Add support for multiple datasources prometheus and loki. Prometheus should be named $prometheus_datasource with label "Prometheus Data Source" Loki should be named $loki_datasource with label "Loki Data Source"
| if template.Query != Prometheus && template.Query != Loki { | ||
| return Result{ | ||
| Severity: Error, | ||
| Message: fmt.Sprintf("Dashboard '%s' templated datasource variable query is '%s', should be 'prometheus' or 'loki'", d.Title, template.Query), | ||
| } | ||
| } |
There was a problem hiding this comment.
While the dashboard-linter is currently very focused on prometheus (and increasingly, loki) datasources, we should only raise errors for things that we can check, and for which an opinionated best practice exists.
In this case, it's perfectly valid to have a dashboard with a primary (or single) datasource which is neither prometheus nor loki. The dashboard-linter simply has no opinion or rule for those dashboards.
| // move loki to 0 index | ||
| sort.SliceStable(datasources, func(i, j int) bool { | ||
| return datasources[i].Query < datasources[j].Query | ||
| }) | ||
|
|
||
| if !(datasources[0].Query == Loki && datasources[1].Query == Prometheus) { | ||
| return Result{ | ||
| Severity: Error, | ||
| Message: fmt.Sprintf("Dashboard '%s' with 2 templated datasources should have 'prometheus' and 'loki' types", d.Title), | ||
| } | ||
| } |
There was a problem hiding this comment.
Similar to the previous comment. It's "okay" if a dashboard has two (or more) datasources which are not loki and prometheus. The dashboard linter would simply have no opinion/rule in this case.
| } | ||
| } | ||
|
|
||
| for _, template := range datasources { |
There was a problem hiding this comment.
The checks here are the opinion/rule that we want to enforce. Namely, when multiple datasources do exist, they are named with their query/type. 👍
| if len(datasources) == 1 { | ||
| return d.checkPrometheusOrLokiDS(&datasources[0]) | ||
| } else if len(datasources) == 2 { | ||
| return d.checkPrometheusAndLokiDS(datasources) | ||
| } else { |
There was a problem hiding this comment.
This could be a switch, but also, per the other comments, we only care if there is one datasource template, or more than one.
You could probably combine both of these functions into a single checkDatasourceTemplates or similar, which branches depending on len(...) > 1.
| return Result{ | ||
| Severity: Error, | ||
| Message: fmt.Sprintf("Dashboard '%s' templated datasource variable labeled '%s', should be labeled 'Data Source'", d.Title, template.Label), | ||
| Message: fmt.Sprintf("Dashboard '%s' has %d templated datasources, should be 1 or 2", d.Title, len(datasources)), |
There was a problem hiding this comment.
Any number greater than 0 is what we're looking for.
| if datasource != "$datasource" && datasource != "${datasource}" { | ||
| return []string{"$datasource"} | ||
| } | ||
| } else if datasource_count == 2 { |
There was a problem hiding this comment.
This could be > 1 and I'd advise looping over the datasources, creating a slice containing $<type>_datasource and ${<type>_datasource} then looping over them again to see if the actual name is contained in the slice.
|
|
|
Hi, |
|
Closed in favor of #124 |
Add support for multiple datasources.
prometheus and loki.
If single templated datasource found:
If two templated datasources found: