gapi

README

grafana-api-golang-client

Grafana HTTP API Client for Go

Documentation

Index

• type Client
  • func New(auth, baseURL string) (*Client, error)
  • func (c *Client) CreateUserForm(settings dtos.AdminCreateUserForm) error
  • func (c *Client) Dashboard(uri string) (*Dashboard, error)
  • func (c *Client) DataSource(id int64) (*DataSource, error)
  • func (c *Client) DeleteDashboard(slug string) error
  • func (c *Client) DeleteDataSource(id int64) error
  • func (c *Client) DeleteOrg(id int64) error
  • func (c *Client) DeleteUser(id int64) error
  • func (c *Client) DoRead(req *http.Request) ([]byte, error)
  • func (c *Client) ListDashboards() (*DashboardList, error)
  • func (c *Client) NewDataSource(s *DataSource) (int64, error)
  • func (c *Client) NewOrg(name string) error
  • func (c *Client) Orgs() ([]Org, error)
  • func (c *Client) SaveDashboard(model map[string]interface{}, overwrite bool) (*DashboardSaveResponse, error)
  • func (c *Client) UpdateDataSource(s *DataSource) error
  • func (c *Client) Users() ([]User, error)
• type Dashboard
• type DashboardEntry
• type DashboardList
• type DashboardMeta
• type DashboardSaveResponse
• type DataSource
• type Org
• type User

Types

type Client

type Client struct {
	*http.Client
	// contains filtered or unexported fields
}

func New

func New(auth, baseURL string) (*Client, error)

New creates a new grafana client auth can be in user:pass format, or it can be an api key

func (*Client) CreateUserForm

func (c *Client) CreateUserForm(settings dtos.AdminCreateUserForm) error

func (*Client) Dashboard

func (c *Client) Dashboard(uri string) (*Dashboard, error)

Dashboard fetches the dashboard with the given uri, and unmarshals it into a Dashboard structure. If uri does not contain a path then "db/" is prepended.

func (*Client) DataSource

func (c *Client) DataSource(id int64) (*DataSource, error)

func (*Client) DeleteDashboard

func (c *Client) DeleteDashboard(slug string) error

func (*Client) DeleteDataSource

func (c *Client) DeleteDataSource(id int64) error

func (*Client) DeleteOrg

func (c *Client) DeleteOrg(id int64) error

func (*Client) DeleteUser

func (c *Client) DeleteUser(id int64) error

func (*Client) DoRead

func (c *Client) DoRead(req *http.Request) ([]byte, error)

func (*Client) ListDashboards

func (c *Client) ListDashboards() (*DashboardList, error)

func (*Client) NewDataSource

func (c *Client) NewDataSource(s *DataSource) (int64, error)

func (*Client) NewOrg

func (c *Client) NewOrg(name string) error

func (*Client) Orgs

func (c *Client) Orgs() ([]Org, error)

func (*Client) SaveDashboard

func (c *Client) SaveDashboard(model map[string]interface{}, overwrite bool) (*DashboardSaveResponse, error)

func (*Client) UpdateDataSource

func (c *Client) UpdateDataSource(s *DataSource) error

func (*Client) Users

func (c *Client) Users() ([]User, error)

type Dashboard

type Dashboard struct {
	Meta  DashboardMeta          `json:"meta"`
	Model map[string]interface{} `json:"dashboard"`
}

type DashboardEntry

type DashboardEntry struct {
	Id        int      `json:"id"`
	Title     string   `json:"title"`
	URI       string   `json:"uri"`
	Type      string   `json:"type"`
	Tags      []string `json:"tags"`
	IsStarred bool     `json:"isStarred"`
}

type DashboardList

type DashboardList []DashboardEntry

type DashboardMeta

type DashboardMeta struct {
	IsStarred bool   `json:"isStarred"`
	Slug      string `json:"slug"`
}

type DashboardSaveResponse

type DashboardSaveResponse struct {
	Slug    string `json:"slug"`
	Status  string `json:"status"`
	Version int64  `json:"version"`
	Message string `json:"message"`
}

type DataSource

type DataSource struct {
	Id     int64  `json:"id,omitempty"`
	Name   string `json:"name"`
	Type   string `json:"type"`
	URL    string `json:"url"`
	Access string `json:"access"`

	Database string `json:"database,omitempty"`
	User     string `json:"user,omitempty"`
	Password string `json:"password,omitempty"`

	OrgId     int64 `json:"orgId,omitempty"`
	IsDefault bool  `json:"isDefault"`

	BasicAuth         bool   `json:"basicAuth"`
	BasicAuthUser     string `json:"basicAuthUser,omitempty"`
	BasicAuthPassword string `json:"basicAuthPassword,omitempty"`
}

type Org

type Org struct {
	Id   int64
	Name string
}

type User

type User struct {
	Id      int64
	Email   string
	Name    string
	Login   string
	IsAdmin bool
}