gapi

package module
v0.0.0-...-8755f3a Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Jan 18, 2022 License: Apache-2.0 Imports: 12 Imported by: 0

README

grafana-api-golang-client

Grafana HTTP API Client for Go

Tests

To run the tests:

go test

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type AlertNotification 

type AlertNotification struct {
	Id        int64       `json:"id,omitempty"`
	Name      string      `json:"name"`
	Type      string      `json:"type"`
	IsDefault bool        `json:"isDefault"`
	Settings  interface{} `json:"settings"`
}

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) AddOrgUser 

func (c *Client) AddOrgUser(orgId int64, user, role string) error

func (*Client) AlertNotification 

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

func (*Client) CreateUser 

func (c *Client) CreateUser(user User) (int64, error)

func (*Client) Dashboard 

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

func (*Client) DataSource 

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

func (*Client) DataSources 

func (c *Client) DataSources() ([]DataSource, error)

func (*Client) DeleteAlertNotification 

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

func (*Client) DeleteDashboard 

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

func (*Client) DeleteDataSource 

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

func (*Client) DeleteFolder 

func (c *Client) DeleteFolder(id string) error

func (*Client) DeleteOrg 

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

func (*Client) DeleteUser 

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

func (*Client) Folder 

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

func (*Client) Folders 

func (c *Client) Folders() ([]Folder, error)

func (*Client) NewAlertNotification 

func (c *Client) NewAlertNotification(a *AlertNotification) (int64, error)

func (*Client) NewDashboard 

func (c *Client) NewDashboard(dashboard Dashboard) (*DashboardSaveResponse, error)

func (*Client) NewDataSource 

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

func (*Client) NewFolder 

func (c *Client) NewFolder(title string) (Folder, error)

func (*Client) NewOrg 

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

func (*Client) Org 

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

func (*Client) OrgByName 

func (c *Client) OrgByName(name string) (Org, error)

func (*Client) OrgUsers 

func (c *Client) OrgUsers(orgId int64) ([]OrgUser, error)

func (*Client) Orgs 

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

func (*Client) RemoveOrgUser 

func (c *Client) RemoveOrgUser(orgId, userId int64) error

func (*Client) SaveDashboard deprecated 

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

Deprecated: use NewDashboard instead

func (*Client) Search 

func (c *Client) Search(params map[string]string) ([]SearchResult, error)

func (*Client) UpdateAlertNotification 

func (c *Client) UpdateAlertNotification(a *AlertNotification) error

func (*Client) UpdateDataSource 

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

func (*Client) UpdateFolder 

func (c *Client) UpdateFolder(id string, name string) error

func (*Client) UpdateOrg 

func (c *Client) UpdateOrg(id int64, name string) error

func (*Client) UpdateOrgUser 

func (c *Client) UpdateOrgUser(orgId, userId int64, role string) error

func (*Client) UserByEmail 

func (c *Client) UserByEmail(email string) (User, 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"`
	Folder    int64                  `json:"folderId"`
	Overwrite bool                   `json:overwrite`
}

type DashboardMeta 

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

type DashboardSaveResponse 

type DashboardSaveResponse struct {
	Slug    string `json:"slug"`
	Id      int64  `json:"id"`
	Uid     string `json:"uid"`
	Status  string `json:"status"`
	Version int64  `json:"version"`
}

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"`

	JSONData       JSONData       `json:"jsonData,omitempty"`
	SecureJSONData SecureJSONData `json:"secureJsonData,omitempty"`
}

type Folder 

type Folder struct {
	Id    int64  `json:"id"`
	Uid   string `json:"uid"`
	Title string `json:"title"`
}

type JSONData 

type JSONData map[string]interface{}

JSONData is a representation of the datasource `jsonData` property

type Org 

type Org struct {
	Id   int64  `json:"id"`
	Name string `json:"name"`
}

type OrgUser 

type OrgUser struct {
	OrgId  int64  `json:"orgId"`
	UserId int64  `json:"userId"`
	Email  string `json:"email"`
	Login  string `json:"login"`
	Role   string `json:"role"`
}

type SearchResult 

type SearchResult struct {
	Id          int64    `json:"id"`
	Uid         string   `json:"uid"`
	Title       string   `json:"title"`
	Uri         string   `json:"uri`
	Url         string   `json:"url`
	Slug        string   `json:"slug`
	Type        string   `json:"type`
	Tags        []string `json:"tags`
	IsStarred   bool     `json:"isStarred`
	FolderId    int64    `json:"folderId,omitempty`
	FolderUid   string   `json:"folderUid,omitempty`
	FolderTitle string   `json:"folderTitle,omitempty`
	FolderUrl   string   `json:"folderUrl,omitempty`
}

type SecureJSONData 

type SecureJSONData map[string]interface{}

SecureJSONData is a representation of the datasource `secureJsonData` property

type User 

type User struct {
	Id       int64  `json:"id,omitempty"`
	Email    string `json:"email,omitempty"`
	Name     string `json:"name,omitempty"`
	Login    string `json:"login,omitempty"`
	Password string `json:"password,omitempty"`
	IsAdmin  bool   `json:"isAdmin,omitempty"`
}

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.