Skip to content

Commit 7ec4803

Browse files
Leo-DiCaraLeo-DiCara
authored
feat(bigTent slo): Custom Validate function for big tent SLO schema (#2016)
* feat(bigTent slo): Custom Validate function for big tent SLO schema * feat(bigTent slo): Tests for custom validate functions * chore(bigTent slo): update documentation
1 parent d8ec8ab commit 7ec4803

File tree

10 files changed

+695
-35
lines changed

10 files changed

+695
-35
lines changed

‎docs/data-sources/slos.md

+9
Original file line numberDiff line numberDiff line change
@@ -214,6 +214,7 @@ Read-Only:
214214
Read-Only:
215215

216216
- `freeform` (List of Object) (see [below for nested schema](#nestedobjatt--slos--query--freeform))
217+
- `grafana_queries` (List of Object) (see [below for nested schema](#nestedobjatt--slos--query--grafana_queries))
217218
- `ratio` (List of Object) (see [below for nested schema](#nestedobjatt--slos--query--ratio))
218219
- `type` (String)
219220

@@ -225,6 +226,14 @@ Read-Only:
225226
- `query` (String)
226227

227228

229+
<a id="nestedobjatt--slos--query--grafana_queries"></a>
230+
### Nested Schema for `slos.query.grafana_queries`
231+
232+
Read-Only:
233+
234+
- `grafana_queries` (String)
235+
236+
228237
<a id="nestedobjatt--slos--query--ratio"></a>
229238
### Nested Schema for `slos.query.ratio`
230239

‎docs/resources/slo.md

+105-22
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,58 @@ Resource manages Grafana SLOs.
1717

1818
## Example Usage
1919

20-
### Basic
20+
### Ratio
21+
22+
```terraform
23+
resource "grafana_slo" "ratio" {
24+
name = "Terraform Testing - Ratio Query"
25+
description = "Terraform Description - Ratio Query"
26+
query {
27+
ratio {
28+
success_metric = "kubelet_http_requests_total{status!~\"5..\"}"
29+
total_metric = "kubelet_http_requests_total"
30+
group_by_labels = ["job", "instance"]
31+
}
32+
type = "ratio"
33+
}
34+
objectives {
35+
value = 0.995
36+
window = "30d"
37+
}
38+
destination_datasource {
39+
uid = "grafanacloud-prom"
40+
}
41+
label {
42+
key = "slo"
43+
value = "terraform"
44+
}
45+
alerting {
46+
fastburn {
47+
annotation {
48+
key = "name"
49+
value = "SLO Burn Rate Very High"
50+
}
51+
annotation {
52+
key = "description"
53+
value = "Error budget is burning too fast"
54+
}
55+
}
56+
57+
slowburn {
58+
annotation {
59+
key = "name"
60+
value = "SLO Burn Rate High"
61+
}
62+
annotation {
63+
key = "description"
64+
value = "Error budget is burning too fast"
65+
}
66+
}
67+
}
68+
}
69+
```
70+
71+
### Advanced
2172

2273
```terraform
2374
resource "grafana_slo" "test" {
@@ -66,27 +117,54 @@ resource "grafana_slo" "test" {
66117
}
67118
```
68119

69-
### Advanced
120+
### Grafana Queries - Any supported datasource
121+
122+
Grafana Queries use the grafana_queries field. It expects a JSON string list of valid grafana query JSON objects, the same as you'll find assigned to a Grafana Dashboard panel `targets` field.
70123

71124
```terraform
72125
resource "grafana_slo" "test" {
73-
name = "Complex Resource - Terraform Ratio Query Example"
74-
description = "Complex Resource - Terraform Ratio Query Description"
126+
name = "Terraform Testing"
127+
description = "Terraform Description"
75128
query {
76-
ratio {
77-
success_metric = "kubelet_http_requests_total{status!~\"5..\"}"
78-
total_metric = "kubelet_http_requests_total"
79-
group_by_labels = ["job", "instance"]
129+
grafana_queries {
130+
grafana_queries = jsonencode([
131+
{
132+
datasource : {
133+
"type" : "graphite",
134+
"uid" : "datasource-uid"
135+
},
136+
refId : "Success",
137+
target : "groupByNode(perSecond(web.*.http.2xx_success.*.*), 3, 'avg')"
138+
},
139+
{
140+
datasource : {
141+
"type" : "graphite",
142+
"uid" : "datasource-uid"
143+
},
144+
refId : "Total",
145+
target : "groupByNode(perSecond(web.*.http.5xx_errors.*.*), 3, 'avg')"
146+
},
147+
{
148+
datasource : {
149+
"type" : "__expr__",
150+
"uid" : "__expr__"
151+
},
152+
expression : "$Success / $Total",
153+
refId : "Expression",
154+
type : "math"
155+
}
156+
])
80157
}
81-
type = "ratio"
158+
type = "grafana_queries"
159+
}
160+
destination_datasource {
161+
uid = "grafanacloud-prom"
82162
}
83163
objectives {
84164
value = 0.995
85165
window = "30d"
86166
}
87-
destination_datasource {
88-
uid = "grafanacloud-prom"
89-
}
167+
90168
label {
91169
key = "slo"
92170
value = "terraform"
@@ -101,10 +179,6 @@ resource "grafana_slo" "test" {
101179
key = "description"
102180
value = "Error budget is burning too fast"
103181
}
104-
label {
105-
key = "type"
106-
value = "slo"
107-
}
108182
}
109183
110184
slowburn {
@@ -116,15 +190,15 @@ resource "grafana_slo" "test" {
116190
key = "description"
117191
value = "Error budget is burning too fast"
118192
}
119-
label {
120-
key = "type"
121-
value = "slo"
122-
}
123193
}
124194
}
125195
}
126196
```
127197

198+
For a complete list, see [supported data sources](https://grafana.com/docs/grafana-cloud/alerting-and-irm/slo/set-up/additionaldatasources/#supported-data-sources).
199+
200+
For additional help with SLOs, view our [documentation](https://grafana.com/docs/grafana-cloud/alerting-and-irm/slo/).
201+
128202
<!-- schema generated by tfplugindocs -->
129203
## Schema
130204

@@ -173,19 +247,28 @@ Required:
173247

174248
Required:
175249

176-
- `type` (String) Query type must be one of: "freeform", "query", "ratio", or "threshold"
250+
- `type` (String) Query type must be one of: "freeform", "query", "ratio", "grafana_queries" or "threshold"
177251

178252
Optional:
179253

180254
- `freeform` (Block List, Max: 1) (see [below for nested schema](#nestedblock--query--freeform))
255+
- `grafana_queries` (Block List, Max: 1) Array for holding a set of grafana queries (see [below for nested schema](#nestedblock--query--grafana_queries))
181256
- `ratio` (Block List, Max: 1) (see [below for nested schema](#nestedblock--query--ratio))
182257

183258
<a id="nestedblock--query--freeform"></a>
184259
### Nested Schema for `query.freeform`
185260

186261
Required:
187262

188-
- `query` (String) Freeform Query Field
263+
- `query` (String) Freeform Query Field - valid promQl
264+
265+
266+
<a id="nestedblock--query--grafana_queries"></a>
267+
### Nested Schema for `query.grafana_queries`
268+
269+
Required:
270+
271+
- `grafana_queries` (String) Query Object - Array of Grafana Query JSON objects
189272

190273

191274
<a id="nestedblock--query--ratio"></a>

‎examples/resources/grafana_slo/resource_appDynamics.tf

+96
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,96 @@
1+
resource "grafana_slo" "test" {
2+
name = "Terraform Testing"
3+
description = "Terraform Description"
4+
query {
5+
grafana_queries {
6+
grafana_queries = jsonencode([
7+
{
8+
aggregation : "Sum",
9+
alias : "",
10+
application : "57831",
11+
applicationName : "petclinic",
12+
datasource : {
13+
type : "dlopes7-appdynamics-datasource",
14+
uid : "appdynamics_localdev"
15+
},
16+
delimiter : "|",
17+
isRawQuery : false,
18+
metric : "Service Endpoints|PetClinicEastTier1|/petclinic/api_SERVLET|Errors per Minute",
19+
queryType : "metrics",
20+
refId : "errors",
21+
rollUp : true,
22+
schemaVersion : "3.9.5",
23+
transformLegend : "Segments",
24+
transformLegendText : ""
25+
},
26+
{
27+
aggregation : "Sum",
28+
alias : "",
29+
application : "57831",
30+
applicationName : "petclinic",
31+
datasource : {
32+
type : "dlopes7-appdynamics-datasource",
33+
uid : "appdynamics_localdev"
34+
},
35+
intervalMs : 1000,
36+
maxDataPoints : 43200,
37+
delimiter : "|",
38+
isRawQuery : false,
39+
metric : "Service Endpoints|PetClinicEastTier1|/petclinic/api_SERVLET|Calls per Minute",
40+
queryType : "metrics",
41+
refId : "total",
42+
rollUp : true,
43+
schemaVersion : "3.9.5",
44+
transformLegend : "Segments",
45+
transformLegendText : ""
46+
},
47+
{
48+
datasource : {
49+
type : "__expr__",
50+
uid : "__expr__"
51+
},
52+
expression : "($total - $errors) / $total",
53+
intervalMs : 1000,
54+
maxDataPoints : 43200,
55+
refId : "C",
56+
type : "math"
57+
}
58+
])
59+
}
60+
type = "grafana_queries"
61+
}
62+
objectives {
63+
value = 0.995
64+
window = "30d"
65+
}
66+
destination_datasource {
67+
uid = "grafanacloud-prom"
68+
}
69+
label {
70+
key = "slo"
71+
value = "terraform"
72+
}
73+
alerting {
74+
fastburn {
75+
annotation {
76+
key = "name"
77+
value = "SLO Burn Rate Very High"
78+
}
79+
annotation {
80+
key = "description"
81+
value = "Error budget is burning too fast"
82+
}
83+
}
84+
85+
slowburn {
86+
annotation {
87+
key = "name"
88+
value = "SLO Burn Rate High"
89+
}
90+
annotation {
91+
key = "description"
92+
value = "Error budget is burning too fast"
93+
}
94+
}
95+
}
96+
}

‎examples/resources/grafana_slo/resource_graphite.tf

+71
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,71 @@
1+
resource "grafana_slo" "test" {
2+
name = "Terraform Testing"
3+
description = "Terraform Description"
4+
query {
5+
grafana_queries {
6+
grafana_queries = jsonencode([
7+
{
8+
datasource : {
9+
"type" : "graphite",
10+
"uid" : "datasource-uid"
11+
},
12+
refId : "Success",
13+
target : "groupByNode(perSecond(web.*.http.2xx_success.*.*), 3, 'avg')"
14+
},
15+
{
16+
datasource : {
17+
"type" : "graphite",
18+
"uid" : "datasource-uid"
19+
},
20+
refId : "Total",
21+
target : "groupByNode(perSecond(web.*.http.5xx_errors.*.*), 3, 'avg')"
22+
},
23+
{
24+
datasource : {
25+
"type" : "__expr__",
26+
"uid" : "__expr__"
27+
},
28+
expression : "$Success / $Total",
29+
refId : "Expression",
30+
type : "math"
31+
}
32+
])
33+
}
34+
type = "grafana_queries"
35+
}
36+
destination_datasource {
37+
uid = "grafanacloud-prom"
38+
}
39+
objectives {
40+
value = 0.995
41+
window = "30d"
42+
}
43+
44+
label {
45+
key = "slo"
46+
value = "terraform"
47+
}
48+
alerting {
49+
fastburn {
50+
annotation {
51+
key = "name"
52+
value = "SLO Burn Rate Very High"
53+
}
54+
annotation {
55+
key = "description"
56+
value = "Error budget is burning too fast"
57+
}
58+
}
59+
60+
slowburn {
61+
annotation {
62+
key = "name"
63+
value = "SLO Burn Rate High"
64+
}
65+
annotation {
66+
key = "description"
67+
value = "Error budget is burning too fast"
68+
}
69+
}
70+
}
71+
}

‎go.mod

+1-1
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ require (
1616
github.com/grafana/grafana-openapi-client-go v0.0.0-20241113095943-9cb2bbfeb8a3
1717
github.com/grafana/machine-learning-go-client v0.8.2
1818
github.com/grafana/river v0.3.0
19-
github.com/grafana/slo-openapi-client/go/slo v0.0.0-20240807172758-1b7d00838fc7
19+
github.com/grafana/slo-openapi-client/go/slo v0.0.0-20250218172929-ab9cae090da6
2020
github.com/grafana/synthetic-monitoring-agent v0.34.2
2121
github.com/grafana/synthetic-monitoring-api-go-client v0.11.0
2222
github.com/hashicorp/go-cty v1.4.1-0.20200414143053-d3edf31b6320

0 commit comments

Comments
 (0)