-
Notifications
You must be signed in to change notification settings - Fork 386
/
dashboard_pipeline.go
480 lines (400 loc) · 13.1 KB
/
dashboard_pipeline.go
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
package grafanadashboard
import (
"bytes"
"context"
"encoding/json"
"errors"
"fmt"
"io"
"io/ioutil"
"net/http"
"net/url"
"path"
"strconv"
"strings"
"time"
"github.com/go-logr/logr"
"github.com/google/go-jsonnet"
"github.com/grafana-operator/grafana-operator/v4/api/integreatly/v1alpha1"
"github.com/grafana-operator/grafana-operator/v4/controllers/config"
corev1 "k8s.io/api/core/v1"
metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
"sigs.k8s.io/controller-runtime/pkg/client"
"sigs.k8s.io/controller-runtime/pkg/log"
)
type SourceType int
const (
SourceTypeJson SourceType = 1
SourceTypeJsonnet SourceType = 2
SourceTypeUnknown SourceType = 3
)
var (
grafanaComDashboardApiUrlRoot string = "https://grafana.com/api/dashboards"
)
type DashboardPipeline interface {
ProcessDashboard(knownHash string, folderId *int64, folderName string, forceRecreate bool) ([]byte, error)
NewHash() string
}
type DashboardPipelineImpl struct {
Client client.Client
Dashboard *v1alpha1.GrafanaDashboard
JSON string
Board map[string]interface{}
Logger logr.Logger
Hash string
Context context.Context
}
func NewDashboardPipeline(client client.Client, dashboard *v1alpha1.GrafanaDashboard, ctx context.Context) DashboardPipeline {
if dashboard.Spec.ContentCacheDuration == nil {
dashboard.Spec.ContentCacheDuration = &metav1.Duration{Duration: 24 * time.Hour}
}
return &DashboardPipelineImpl{
Client: client,
Dashboard: dashboard,
JSON: "",
Logger: log.Log.WithName(fmt.Sprintf("dashboard-%v", dashboard.Name)),
Context: ctx,
}
}
func (r *DashboardPipelineImpl) ProcessDashboard(knownHash string, folderId *int64, folderName string, forceRecreate bool) ([]byte, error) {
err := r.obtainJson()
if err != nil {
return nil, err
}
// Dashboard unchanged?
hash := r.Dashboard.Hash()
if hash == knownHash && !forceRecreate {
r.Hash = knownHash
return nil, nil
}
r.Hash = hash
// Datasource inputs to resolve?
err = r.resolveDatasources()
if err != nil {
return nil, err
}
// Dashboard valid?
err = r.validateJson()
if err != nil {
return nil, err
}
// Dashboards are never expected to come with an ID, it is
// always assigned by Grafana. If there is one, we ignore it
r.Board["id"] = nil
// Overwrite in case any user provided uid exists
r.Board["uid"] = r.Dashboard.UID()
r.Board["folderId"] = folderId
r.Board["folderName"] = folderName
raw, err := json.Marshal(r.Board)
if err != nil {
return nil, err
}
return bytes.TrimSpace(raw), nil
}
// Make sure the dashboard contains valid JSON
func (r *DashboardPipelineImpl) validateJson() error {
contents, err := r.Dashboard.Parse(r.JSON)
r.Board = contents
return err
}
// Try to get the dashboard json definition either from a provided URL or from the
// raw json in the dashboard resource. The priority is as follows:
// 1) try to fetch from url or grafanaCom if provided
// 2) url or grafanaCom fails or not provided: try to fetch from configmap ref
// 3) no configmap specified: try to use embedded json
// 4) no json specified: try to use embedded jsonnet
func (r *DashboardPipelineImpl) obtainJson() error {
// TODO(DeanBrunt): Add earlier validation for this
if r.Dashboard.Spec.Url != "" && r.Dashboard.Spec.GrafanaCom != nil {
return errors.New("both dashboard url and grafana.com source specified")
}
if r.Dashboard.Status.Content != "" && r.Dashboard.Status.ContentTimestamp.Add(r.Dashboard.Spec.ContentCacheDuration.Duration).After(time.Now()) {
r.JSON = r.Dashboard.Status.Content
return nil
}
if r.Dashboard.Spec.GrafanaCom != nil {
if err := r.loadDashboardFromGrafanaCom(); err != nil {
r.Logger.Error(err, "failed to request dashboard from grafana.com, falling back to config map; if specified")
} else {
return nil
}
}
if r.Dashboard.Spec.Url != "" {
err := r.loadDashboardFromURL()
if err != nil {
r.Logger.Error(err, "failed to request dashboard url, falling back to config map; if specified")
} else {
return nil
}
}
if r.Dashboard.Spec.ConfigMapRef != nil {
err := r.loadDashboardFromConfigMap()
if err != nil {
r.Logger.Error(err, "failed to get config map, falling back to raw json")
} else {
return nil
}
}
if r.Dashboard.Spec.Json != "" {
r.JSON = r.Dashboard.Spec.Json
return nil
}
if r.Dashboard.Spec.Jsonnet != "" {
json, err := r.loadJsonnet(r.Dashboard.Spec.Jsonnet)
if err != nil {
r.Logger.Error(err, "failed to parse jsonnet")
} else {
r.JSON = json
return nil
}
}
return errors.New("unable to obtain dashboard contents")
}
// Compiles jsonnet to json and makes the grafonnet library available to
// the template
func (r *DashboardPipelineImpl) loadJsonnet(source string) (string, error) {
cfg := config.GetControllerConfig()
jsonnetLocation := cfg.GetConfigString(config.ConfigJsonnetBasePath, config.JsonnetBasePath)
vm := jsonnet.MakeVM()
vm.Importer(&jsonnet.FileImporter{
JPaths: []string{jsonnetLocation},
})
return vm.EvaluateSnippet(r.Dashboard.Name, source) // nolint
}
// Try to obtain the dashboard json from a provided url
func (r *DashboardPipelineImpl) loadDashboardFromURL() error {
url, err := url.ParseRequestURI(r.Dashboard.Spec.Url)
if err != nil {
return fmt.Errorf("invalid url %v", r.Dashboard.Spec.Url)
}
resp, err := http.Get(r.Dashboard.Spec.Url)
if err != nil {
return fmt.Errorf("cannot request %v", r.Dashboard.Spec.Url)
}
defer resp.Body.Close()
body, err := ioutil.ReadAll(resp.Body)
if err != nil {
return err
}
if resp.StatusCode != 200 {
retries := 0
if r.Dashboard.Status.Error != nil {
retries = r.Dashboard.Status.Error.Retries
}
r.Dashboard.Status = v1alpha1.GrafanaDashboardStatus{
Error: &v1alpha1.GrafanaDashboardError{
Message: string(body),
Code: resp.StatusCode,
Retries: retries + 1,
},
ContentTimestamp: &metav1.Time{Time: time.Now()},
}
if err := r.Client.Status().Update(r.Context, r.Dashboard); err != nil {
return fmt.Errorf("failed to request dashboard and failed to update status %s: %w", string(body), err)
}
return fmt.Errorf("request failed with status %v", resp.StatusCode)
}
sourceType := r.getFileType(url.Path)
switch sourceType {
case SourceTypeJson, SourceTypeUnknown:
// If unknown, assume json
r.JSON = string(body)
case SourceTypeJsonnet:
json, err := r.loadJsonnet(string(body))
if err != nil {
return err
}
r.JSON = json
}
r.Dashboard.Status = v1alpha1.GrafanaDashboardStatus{
Content: r.JSON,
ContentTimestamp: &metav1.Time{Time: time.Now()},
ContentUrl: r.Dashboard.Spec.Url,
}
if err := r.Client.Status().Update(r.Context, r.Dashboard); err != nil {
return fmt.Errorf("failed to update status with content for dashboard %s/%s: %w", r.Dashboard.Namespace, r.Dashboard.Name, err)
}
return nil
}
func (r *DashboardPipelineImpl) loadDashboardFromGrafanaCom() error {
url, err := r.getGrafanaComDashboardUrl()
if err != nil {
return fmt.Errorf("failed to get grafana.com dashboard url: %w", err)
}
resp, err := http.Get(url) // nolint:gosec
if err != nil {
return fmt.Errorf("failed to request dashboard url '%s': %w", url, err)
}
defer resp.Body.Close()
body, err := ioutil.ReadAll(resp.Body)
if err != nil {
return err
}
if resp.StatusCode != 200 {
retries := 0
if r.Dashboard.Status.Error != nil {
retries = r.Dashboard.Status.Error.Retries
}
r.Dashboard.Status = v1alpha1.GrafanaDashboardStatus{
Error: &v1alpha1.GrafanaDashboardError{
Message: string(body),
Code: resp.StatusCode,
Retries: retries + 1,
},
ContentTimestamp: &metav1.Time{Time: time.Now()},
}
if err := r.Client.Status().Update(r.Context, r.Dashboard); err != nil {
return fmt.Errorf("failed to request dashboard and failed to update status %s: %w", string(body), err)
}
return fmt.Errorf("failed to request dashboard: %s", string(body))
}
r.JSON = string(body)
// Update JSON so dashboard is not refetched
r.Dashboard.Status = v1alpha1.GrafanaDashboardStatus{
Content: r.JSON,
ContentTimestamp: &metav1.Time{Time: time.Now()},
ContentUrl: url,
}
if err := r.Client.Status().Update(r.Context, r.Dashboard); err != nil {
return fmt.Errorf("failed to update status with content for dashboard %s/%s: %w", r.Dashboard.Namespace, r.Dashboard.Name, err)
}
return nil
}
func (r *DashboardPipelineImpl) getGrafanaComDashboardUrl() (string, error) {
grafanaComSource := r.Dashboard.Spec.GrafanaCom
var revision int
if grafanaComSource.Revision == nil {
var err error
revision, err = r.getLatestRevisionForGrafanaComDashboard()
if err != nil {
return "", fmt.Errorf("failed to get latest revision for dashboard id %d: %w", r.Dashboard.Spec.GrafanaCom.Id, err)
}
} else {
revision = *grafanaComSource.Revision
}
u, err := url.Parse(grafanaComDashboardApiUrlRoot)
if err != nil {
return "", err
}
u.Path = path.Join(u.Path, strconv.Itoa(grafanaComSource.Id), "revisions", strconv.Itoa(revision), "download")
return u.String(), nil
}
func (r *DashboardPipelineImpl) getLatestRevisionForGrafanaComDashboard() (int, error) {
u, err := url.Parse(grafanaComDashboardApiUrlRoot)
if err != nil {
return 0, err
}
u.Path = path.Join(u.Path, strconv.Itoa(r.Dashboard.Spec.GrafanaCom.Id), "revisions")
resp, err := http.Get(u.String())
if err != nil {
return 0, fmt.Errorf("failed to make request to %s: %w", u.String(), err)
}
defer resp.Body.Close()
if resp.StatusCode != 200 {
return 0, fmt.Errorf("request to list available grafana dashboard revisions failed with status code '%d'", resp.StatusCode)
}
listResponse, err := r.unmarshalListDashboardRevisionsResponseBody(resp.Body)
if err != nil {
return 0, fmt.Errorf("failed to unmarshal list dashboard revisions response: %w", err)
}
if listResponse == nil || len(listResponse.Items) == 0 {
return 0, errors.New("list dashboard revisions request succeeded but no revisions returned")
}
return r.getMaximumRevisionFromListDashboardRevisionsResponse(listResponse), nil
}
// This will attempt to discover the latest revision, initially by using knowledge of the
// default sort method (ordering by revision), falling back on our own manual discovery of
// the maximum if the default changes away from revision ordering or using an unhandled
// direction.
func (r *DashboardPipelineImpl) getMaximumRevisionFromListDashboardRevisionsResponse(resp *listDashboardRevisionsResponse) int {
if resp.OrderBy == "revision" {
if resp.Direction == "asc" {
return resp.Items[len(resp.Items)-1].Revision
}
if resp.Direction == "desc" {
return resp.Items[0].Revision
}
}
var maxRevision int
for _, item := range resp.Items {
if maxRevision < item.Revision {
maxRevision = item.Revision
}
}
return maxRevision
}
// This is an incomplete representation of the expected response,
// including only fields we care about.
type listDashboardRevisionsResponse struct {
Items []dashboardRevisionItem `json:"items"`
OrderBy string `json:"orderBy"`
Direction string `json:"direction"`
}
type dashboardRevisionItem struct {
Revision int `json:"revision"`
}
func (r *DashboardPipelineImpl) unmarshalListDashboardRevisionsResponseBody(
body io.Reader,
) (*listDashboardRevisionsResponse, error) {
bodyBytes, err := ioutil.ReadAll(body)
if err != nil {
return nil, err
}
resp := &listDashboardRevisionsResponse{}
if err := json.Unmarshal(bodyBytes, resp); err != nil {
return nil, fmt.Errorf("failed to unmarshal raw json to list dashboard revisions response: %w", err)
}
return resp, nil
}
// Try to determine the type (json or grafonnet) or a remote file by looking
// at the filename extension
func (r *DashboardPipelineImpl) getFileType(path string) SourceType {
fragments := strings.Split(path, ".")
if len(fragments) == 0 {
return SourceTypeUnknown
}
extension := strings.TrimSpace(fragments[len(fragments)-1])
switch strings.ToLower(extension) {
case "json":
return SourceTypeJson
case "grafonnet":
return SourceTypeJsonnet
case "jsonnet":
return SourceTypeJsonnet
default:
return SourceTypeUnknown
}
}
// Try to obtain the dashboard json from a config map
func (r *DashboardPipelineImpl) loadDashboardFromConfigMap() error {
ctx := context.Background()
objectKey := client.ObjectKey{Name: r.Dashboard.Spec.ConfigMapRef.Name, Namespace: r.Dashboard.Namespace}
var cm corev1.ConfigMap
err := r.Client.Get(ctx, objectKey, &cm)
if err != nil {
return err
}
r.JSON = cm.Data[r.Dashboard.Spec.ConfigMapRef.Key]
return nil
}
func (r *DashboardPipelineImpl) NewHash() string {
return r.Hash
}
func (r *DashboardPipelineImpl) resolveDatasources() error {
if len(r.Dashboard.Spec.Datasources) == 0 {
return nil
}
currentJson := r.JSON
for _, input := range r.Dashboard.Spec.Datasources {
if input.DatasourceName == "" || input.InputName == "" {
msg := "invalid datasource input rule, input or datasource empty"
r.Logger.Info(msg)
return errors.New(msg)
}
searchValue := fmt.Sprintf("${%s}", input.InputName)
currentJson = strings.ReplaceAll(currentJson, searchValue, input.DatasourceName)
r.Logger.Info("resolving input", "input.InputName", input.InputName, "input.DatasourceName", input.DatasourceName)
}
r.JSON = currentJson
return nil
}