[v3.2] Add grafana dashboard importing API (#11)
* Add API to import grafana templates to kubesphere dashboard * Merge and fix the latest codes from kubesphere #2501 Signed-off-by: zhu733756 <talonzhu@yunify.com>
This commit is contained in:
zhu733756
240
vendor/github.com/grafana-tools/sdk/board.go
generated
vendored
Normal file
240
vendor/github.com/grafana-tools/sdk/board.go
generated
vendored
Normal file
@@ -0,0 +1,240 @@
|
||||
package sdk
|
||||
|
||||
/*
|
||||
Copyright 2016 Alexander I.Grafov <grafov@gmail.com>
|
||||
Copyright 2016-2019 The Grafana SDK authors
|
||||
|
||||
Licensed under the Apache License, Version 2.0 (the "License");
|
||||
you may not use this file except in compliance with the License.
|
||||
You may obtain a copy of the License at
|
||||
|
||||
http://www.apache.org/licenses/LICENSE-2.0
|
||||
|
||||
Unless required by applicable law or agreed to in writing, software
|
||||
distributed under the License is distributed on an "AS IS" BASIS,
|
||||
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||
See the License for the specific language governing permissions and
|
||||
limitations under the License.
|
||||
|
||||
ॐ तारे तुत्तारे तुरे स्व
|
||||
*/
|
||||
|
||||
import (
|
||||
"bytes"
|
||||
"encoding/json"
|
||||
"strings"
|
||||
|
||||
"github.com/gosimple/slug"
|
||||
)
|
||||
|
||||
var (
|
||||
boardID uint
|
||||
)
|
||||
|
||||
// Constants for templating
|
||||
const (
|
||||
TemplatingHideNone = iota
|
||||
TemplatingHideLabel
|
||||
TemplatingHideVariable
|
||||
)
|
||||
|
||||
type (
|
||||
// Board represents Grafana dashboard.
|
||||
Board struct {
|
||||
ID uint `json:"id,omitempty"`
|
||||
UID string `json:"uid,omitempty"`
|
||||
Slug string `json:"slug"`
|
||||
Title string `json:"title"`
|
||||
OriginalTitle string `json:"originalTitle"`
|
||||
Tags []string `json:"tags"`
|
||||
Style string `json:"style"`
|
||||
Timezone string `json:"timezone"`
|
||||
Editable bool `json:"editable"`
|
||||
HideControls bool `json:"hideControls" graf:"hide-controls"`
|
||||
SharedCrosshair bool `json:"sharedCrosshair" graf:"shared-crosshair"`
|
||||
Panels []*Panel `json:"panels"`
|
||||
Rows []*Row `json:"rows"`
|
||||
Templating Templating `json:"templating"`
|
||||
Annotations struct {
|
||||
List []Annotation `json:"list"`
|
||||
} `json:"annotations"`
|
||||
Refresh *BoolString `json:"refresh,omitempty"`
|
||||
SchemaVersion uint `json:"schemaVersion"`
|
||||
Version uint `json:"version"`
|
||||
Links []Link `json:"links"`
|
||||
Time Time `json:"time"`
|
||||
Timepicker Timepicker `json:"timepicker"`
|
||||
GraphTooltip int `json:"graphTooltip,omitempty"`
|
||||
}
|
||||
Time struct {
|
||||
From string `json:"from"`
|
||||
To string `json:"to"`
|
||||
}
|
||||
Timepicker struct {
|
||||
Now *bool `json:"now,omitempty"`
|
||||
RefreshIntervals []string `json:"refresh_intervals"`
|
||||
TimeOptions []string `json:"time_options"`
|
||||
}
|
||||
Templating struct {
|
||||
List []TemplateVar `json:"list"`
|
||||
}
|
||||
TemplateVar struct {
|
||||
Name string `json:"name"`
|
||||
Type string `json:"type"`
|
||||
Auto bool `json:"auto,omitempty"`
|
||||
AutoCount *int `json:"auto_count,omitempty"`
|
||||
Datasource *string `json:"datasource"`
|
||||
Refresh BoolInt `json:"refresh"`
|
||||
Options []Option `json:"options"`
|
||||
IncludeAll bool `json:"includeAll"`
|
||||
AllFormat string `json:"allFormat"`
|
||||
AllValue string `json:"allValue"`
|
||||
Multi bool `json:"multi"`
|
||||
MultiFormat string `json:"multiFormat"`
|
||||
Query interface{} `json:"query"`
|
||||
Regex string `json:"regex"`
|
||||
Current Current `json:"current"`
|
||||
Label string `json:"label"`
|
||||
Hide uint8 `json:"hide"`
|
||||
Sort int `json:"sort"`
|
||||
}
|
||||
// for templateVar
|
||||
Option struct {
|
||||
Text string `json:"text"`
|
||||
Value string `json:"value"`
|
||||
Selected bool `json:"selected"`
|
||||
}
|
||||
// for templateVar
|
||||
Current struct {
|
||||
Tags []*string `json:"tags,omitempty"`
|
||||
Text *StringSliceString `json:"text"`
|
||||
Value interface{} `json:"value"` // TODO select more precise type
|
||||
}
|
||||
Annotation struct {
|
||||
Name string `json:"name"`
|
||||
Datasource *string `json:"datasource"`
|
||||
ShowLine bool `json:"showLine"`
|
||||
IconColor string `json:"iconColor"`
|
||||
LineColor string `json:"lineColor"`
|
||||
IconSize uint `json:"iconSize"`
|
||||
Enable bool `json:"enable"`
|
||||
Query string `json:"query"`
|
||||
Expr string `json:"expr"`
|
||||
Step string `json:"step"`
|
||||
TextField string `json:"textField"`
|
||||
TextFormat string `json:"textFormat"`
|
||||
TitleFormat string `json:"titleFormat"`
|
||||
TagsField string `json:"tagsField"`
|
||||
Tags []string `json:"tags"`
|
||||
TagKeys string `json:"tagKeys"`
|
||||
Type string `json:"type"`
|
||||
}
|
||||
// Link represents link to another dashboard or external weblink
|
||||
Link struct {
|
||||
Title string `json:"title"`
|
||||
Type string `json:"type"`
|
||||
AsDropdown *bool `json:"asDropdown,omitempty"`
|
||||
DashURI *string `json:"dashUri,omitempty"`
|
||||
Dashboard *string `json:"dashboard,omitempty"`
|
||||
Icon *string `json:"icon,omitempty"`
|
||||
IncludeVars bool `json:"includeVars"`
|
||||
KeepTime *bool `json:"keepTime,omitempty"`
|
||||
Params *string `json:"params,omitempty"`
|
||||
Tags []string `json:"tags,omitempty"`
|
||||
TargetBlank *bool `json:"targetBlank,omitempty"`
|
||||
Tooltip *string `json:"tooltip,omitempty"`
|
||||
URL *string `json:"url,omitempty"`
|
||||
}
|
||||
)
|
||||
|
||||
// Height of rows maybe passed as number (ex 200) or
|
||||
// as string (ex "200px") or empty string
|
||||
type Height string
|
||||
|
||||
func (h *Height) UnmarshalJSON(raw []byte) error {
|
||||
if raw == nil || bytes.Equal(raw, []byte(`"null"`)) {
|
||||
return nil
|
||||
}
|
||||
if raw[0] != '"' {
|
||||
tmp := []byte{'"'}
|
||||
raw = append(tmp, raw...)
|
||||
raw = append(raw, byte('"'))
|
||||
}
|
||||
var tmp string
|
||||
err := json.Unmarshal(raw, &tmp)
|
||||
*h = Height(tmp)
|
||||
return err
|
||||
}
|
||||
|
||||
func NewBoard(title string) *Board {
|
||||
boardID++
|
||||
return &Board{
|
||||
ID: boardID,
|
||||
Title: title,
|
||||
Style: "dark",
|
||||
Timezone: "browser",
|
||||
Editable: true,
|
||||
HideControls: false,
|
||||
Rows: []*Row{},
|
||||
}
|
||||
}
|
||||
|
||||
func (b *Board) AddLink(link Link) {
|
||||
b.Links = append(b.Links, link)
|
||||
}
|
||||
|
||||
func (b *Board) RemoveTags(tags ...string) {
|
||||
// order might change after removing the tags
|
||||
for _, toRemoveTag := range tags {
|
||||
tagLen := len(b.Tags)
|
||||
for i, tag := range b.Tags {
|
||||
if tag == toRemoveTag {
|
||||
b.Tags[tagLen-1], b.Tags[i] = b.Tags[i], b.Tags[tagLen-1]
|
||||
b.Tags = b.Tags[:tagLen-1]
|
||||
break
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
func (b *Board) AddTags(tags ...string) {
|
||||
tagFound := make(map[string]bool, len(b.Tags))
|
||||
for _, tag := range b.Tags {
|
||||
tagFound[tag] = true
|
||||
}
|
||||
for _, tag := range tags {
|
||||
if tagFound[tag] {
|
||||
continue
|
||||
}
|
||||
b.Tags = append(b.Tags, tag)
|
||||
tagFound[tag] = true
|
||||
}
|
||||
}
|
||||
|
||||
func (b *Board) HasTag(tag string) bool {
|
||||
for _, t := range b.Tags {
|
||||
if t == tag {
|
||||
return true
|
||||
}
|
||||
}
|
||||
return false
|
||||
}
|
||||
|
||||
func (b *Board) AddRow(title string) *Row {
|
||||
if title == "" {
|
||||
title = "New row"
|
||||
}
|
||||
row := &Row{
|
||||
Title: title,
|
||||
Collapse: false,
|
||||
Editable: true,
|
||||
Height: "250px",
|
||||
}
|
||||
b.Rows = append(b.Rows, row)
|
||||
return row
|
||||
}
|
||||
|
||||
func (b *Board) UpdateSlug() string {
|
||||
b.Slug = strings.ToLower(slug.Make(b.Title))
|
||||
return b.Slug
|
||||
}
|
||||
Reference in New Issue
Block a user