mirror of
https://github.com/VictoriaMetrics/VictoriaMetrics.git
synced 2024-11-21 14:44:00 +00:00
3727251910
Use fs.MustReadDir() instead of os.ReadDir() across the code in order to reduce the code verbosity. The fs.MustReadDir() logs the error with the directory name and the call stack on error before exit. This information should be enough for debugging the cause of the error.
104 lines
3.1 KiB
Go
104 lines
3.1 KiB
Go
package vmselect
|
|
|
|
import (
|
|
"encoding/json"
|
|
"flag"
|
|
"fmt"
|
|
"net/http"
|
|
"os"
|
|
"path/filepath"
|
|
|
|
"github.com/VictoriaMetrics/VictoriaMetrics/lib/fs"
|
|
)
|
|
|
|
var (
|
|
vmuiCustomDashboardsPath = flag.String("vmui.customDashboardsPath", "", "Optional path to vmui dashboards. "+
|
|
"See https://github.com/VictoriaMetrics/VictoriaMetrics/tree/master/app/vmui/packages/vmui/public/dashboards")
|
|
)
|
|
|
|
// dashboardSettings represents dashboard settings file struct.
|
|
//
|
|
// See https://github.com/VictoriaMetrics/VictoriaMetrics/tree/master/app/vmui/packages/vmui/public/dashboards
|
|
type dashboardSettings struct {
|
|
Title string `json:"title,omitempty"`
|
|
Filename string `json:"filename,omitempty"`
|
|
Rows []dashboardRow `json:"rows"`
|
|
}
|
|
|
|
// panelSettings represents fields which used to show graph.
|
|
//
|
|
// See https://github.com/VictoriaMetrics/VictoriaMetrics/tree/master/app/vmui/packages/vmui/public/dashboards
|
|
type panelSettings struct {
|
|
Title string `json:"title,omitempty"`
|
|
Description string `json:"description,omitempty"`
|
|
Unit string `json:"unit,omitempty"`
|
|
Expr []string `json:"expr"`
|
|
Alias []string `json:"alias,omitempty"`
|
|
ShowLegend bool `json:"showLegend,omitempty"`
|
|
Width int `json:"width,omitempty"`
|
|
}
|
|
|
|
// dashboardRow represents panels on dashboard.
|
|
//
|
|
// See https://github.com/VictoriaMetrics/VictoriaMetrics/tree/master/app/vmui/packages/vmui/public/dashboards
|
|
type dashboardRow struct {
|
|
Title string `json:"title,omitempty"`
|
|
Panels []panelSettings `json:"panels"`
|
|
}
|
|
|
|
// dashboardsData represents all the dashboards settings.
|
|
type dashboardsData struct {
|
|
DashboardsSettings []dashboardSettings `json:"dashboardsSettings"`
|
|
}
|
|
|
|
func handleVMUICustomDashboards(w http.ResponseWriter) error {
|
|
path := *vmuiCustomDashboardsPath
|
|
if path == "" {
|
|
writeSuccessResponse(w, []byte(`{"dashboardsSettings": []}`))
|
|
return nil
|
|
}
|
|
settings, err := collectDashboardsSettings(path)
|
|
if err != nil {
|
|
return fmt.Errorf("cannot collect dashboards settings by -vmui.customDashboardsPath=%q: %w", path, err)
|
|
}
|
|
writeSuccessResponse(w, settings)
|
|
return nil
|
|
}
|
|
|
|
func writeSuccessResponse(w http.ResponseWriter, data []byte) {
|
|
w.WriteHeader(http.StatusOK)
|
|
w.Header().Set("Content-Type", "application/json")
|
|
w.Write(data)
|
|
}
|
|
|
|
func collectDashboardsSettings(path string) ([]byte, error) {
|
|
if !fs.IsPathExist(path) {
|
|
return nil, fmt.Errorf("cannot find folder %q", path)
|
|
}
|
|
files := fs.MustReadDir(path)
|
|
|
|
var dss []dashboardSettings
|
|
for _, file := range files {
|
|
filename := file.Name()
|
|
if filepath.Ext(filename) != ".json" {
|
|
continue
|
|
}
|
|
filePath := filepath.Join(path, filename)
|
|
f, err := os.ReadFile(filePath)
|
|
if err != nil {
|
|
// There is no need to add more context to the returned error, since os.ReadFile() adds enough context.
|
|
return nil, err
|
|
}
|
|
var ds dashboardSettings
|
|
err = json.Unmarshal(f, &ds)
|
|
if err != nil {
|
|
return nil, fmt.Errorf("cannot parse file %s: %w", filePath, err)
|
|
}
|
|
if len(ds.Rows) > 0 {
|
|
dss = append(dss, ds)
|
|
}
|
|
}
|
|
|
|
dd := dashboardsData{DashboardsSettings: dss}
|
|
return json.Marshal(dd)
|
|
}
|