grafana

Documentation

Overview

Package grafana implements Grafana client

Index

• type Grafana
  • func NewGrafana(webURL string, webSkipTLSVerify bool, logger log.Logger) (*Grafana, error)
  • func (g *Grafana) Available() bool
  • func (g *Grafana) Ping() error
  • func (g *Grafana) String() string
  • func (g *Grafana) TeamMembers(teamID string) ([]string, error)
• type GrafanaTeamsReponse

Types

type Grafana

type Grafana struct {
	URL                 *url.URL
	Client              *http.Client
	TeamMembersEndpoint string
	// contains filtered or unexported fields
}

Grafana struct

func NewGrafana

func NewGrafana(webURL string, webSkipTLSVerify bool, logger log.Logger) (*Grafana, error)

NewGrafana return a new instance of Grafana struct

func (*Grafana) Available

func (g *Grafana) Available() bool

Available returns true if Grafana is available

func (*Grafana) Ping

func (g *Grafana) Ping() error

Ping attempts to ping Grafana

func (*Grafana) String

func (g *Grafana) String() string

String receiver for Grafana struct

func (*Grafana) TeamMembers

func (g *Grafana) TeamMembers(teamID string) ([]string, error)

TeamMembers fetches team members from a Grafana team

type GrafanaTeamsReponse

type GrafanaTeamsReponse struct {
	OrgID      int      `json:"orgId"`
	TeamID     int      `json:"teamId"`
	TeamUID    string   `json:"teamUID"`
	UserID     int      `json:"userId"`
	AuthModule string   `json:"auth_module"`
	Email      string   `json:"email"`
	Name       string   `json:"name"`
	Login      string   `json:"login"`
	AvatarURL  string   `json:"avatarUrl"`
	Labels     []string `json:"labels"`
	Permission int      `json:"permission"`
}

GrafanaTeamsReponse is the API response struct from Grafana