grafana

Documentation

Index

• Variables
• type Module
  • func (m *Module) GetDashboardFiles() map[string][]byte
  • func (m *Module) GetDashboards() []map[string]interface{}
  • func (m *Module) GetRules(tg string) rulefmt.RuleGroup
  • func (m *Module) GetTargets(labels []labels.Labels, group string) ([]labels.Labels, error)
  • func (m *Module) HostVars() (map[string]string, error)
  • func (m *Module) Playbook(c context.Context) (*ansible.Playbook, error)
• type ModuleConfig
  • func (m *ModuleConfig) IsEnabled() bool
  • func (m *ModuleConfig) Name() string
  • func (m *ModuleConfig) NewModule(modules.ModuleOptions) (modules.Module, error)
  • func (m *ModuleConfig) UnmarshalYAML(unmarshal func(interface{}) error) error

Variables

var DefaultConfig = ModuleConfig{
	AdminPassword:  "changeme",
	Enabled:        false,
	GrafanaVersion: "latest",
}

Types

type Module

type Module struct {
	// contains filtered or unexported fields
}

func (*Module) GetDashboardFiles

func (m *Module) GetDashboardFiles() map[string][]byte

GetDashboardFiles returns included dashboard files

func (*Module) GetDashboards

func (m *Module) GetDashboards() []map[string]interface{}

GetDashboards returns pointers to grafana.com dashboards

func (*Module) GetRules

func (m *Module) GetRules(tg string) rulefmt.RuleGroup

GetRules returns recording and alerting rules for this module.

func (*Module) GetTargets

func (m *Module) GetTargets(labels []labels.Labels, group string) ([]labels.Labels, error)

func (*Module) HostVars

func (m *Module) HostVars() (map[string]string, error)

func (*Module) Playbook

func (m *Module) Playbook(c context.Context) (*ansible.Playbook, error)

type ModuleConfig

type ModuleConfig struct {
	AdminPassword  string `yaml:"admin_password"`
	Enabled        bool   `yaml:"enabled"`
	GrafanaVersion string `yaml:"grafana_version"`
}

func (*ModuleConfig) IsEnabled

func (m *ModuleConfig) IsEnabled() bool

IsEnabled returns a boolean indicating if the Module is enabled.

func (*ModuleConfig) Name

func (m *ModuleConfig) Name() string

func (*ModuleConfig) NewModule

func (m *ModuleConfig) NewModule(modules.ModuleOptions) (modules.Module, error)

func (*ModuleConfig) UnmarshalYAML

func (m *ModuleConfig) UnmarshalYAML(unmarshal func(interface{}) error) error

UnmarshalYAML implements the yaml.Unmarshaler interface.