dashboard_lib

package module

v0.0.0-...-a34a17a Latest Latest Go to latest Published: May 3, 2024 License: MIT Imports: 12 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/smartcontractkit/chainlink

Links

Open Source Insights

README ¶

Chainlink Grafana Dashboards Library

This library offers dashboard components and tools for constructing and testing Grafana dashboards at Chainlink.

Components structure is as follows:

dashboard
  |- lib
     |- component_1
        |- component.go
     |- component_2
        |- component.go
|- go.mod
|- go.sum

Each component should contain rows, logic and unique variables in component.go

Components should be imported from this module, see example

How to convert from JSON using Grabana codegen utility

Download Grabana binary here
./bin/grabana convert-go -i dashboard.json > lib/my_new_component/rows.go
Create a component

Documentation ¶

Index ¶

Constants
Variables
func DecodeBasicAuth(authString string) (string, string, error)
type Dashboard
- func NewDashboard(name string, deployOpts EnvConfig, opts []dashboard.Option) *Dashboard
type DashboardOpts
type DataSources
type EnvConfig
- func ReadEnvDeployOpts() EnvConfig

Constants ¶

View Source

const (
	LogLevelEnvVar = "DASHBOARD_LOG_LEVEL"
)

Variables ¶

View Source

var (
	L zerolog.Logger
)

Functions ¶

func DecodeBasicAuth ¶

func DecodeBasicAuth(authString string) (string, string, error)

Types ¶

type Dashboard ¶

type Dashboard struct {
	Name       string
	DeployOpts EnvConfig
	/* SDK panels that are missing in Grabana */
	SDKPanels []map[string]interface{}

	Opts []dashboard.Option
	// contains filtered or unexported fields
}

func NewDashboard ¶

func NewDashboard(
	name string,
	deployOpts EnvConfig,
	opts []dashboard.Option,
) *Dashboard

func (*Dashboard) Add ¶

func (m *Dashboard) Add(opts []dashboard.Option)

func (*Dashboard) AddSDKPanel ¶

func (m *Dashboard) AddSDKPanel(panel map[string]interface{})

func (*Dashboard) Delete ¶

func (m *Dashboard) Delete() error

func (*Dashboard) Deploy ¶

func (m *Dashboard) Deploy() error

type DashboardOpts ¶

type DashboardOpts struct {
	Tags        []string
	AutoRefresh string
}

type DataSources ¶

type DataSources struct {
	Loki       string
	Prometheus string
}

type EnvConfig ¶

type EnvConfig struct {
	Name                     string
	Platform                 string
	GrafanaURL               string
	GrafanaToken             string
	GrafanaBasicAuthUser     string
	GrafanaBasicAuthPassword string
	GrafanaFolder            string
	DataSources              DataSources
	PanelsIncluded           map[string]bool
}

func ReadEnvDeployOpts ¶

func ReadEnvDeployOpts() EnvConfig

Source Files ¶

View all Source files

Directories ¶

Path	Synopsis
atlas-don
ccip-load-test-view
core-don
core-node-components
core-ocrv2-ccip
k8s-pods

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL