client

Documentation

Index

• Variables
• type Credential
• type Grafana
• type GrafanaClient
  • func New(logger log.Logger, conf config.Config, httpClient *http.Client, ...) GrafanaClient
  • func (g GrafanaClient) Dashboard(ctx context.Context, dashUID string) (dashboard.Dashboard, error)
  • func (g GrafanaClient) PanelCSV(_ context.Context, dashUID string, p dashboard.Panel, t dashboard.TimeRange) (dashboard.CSVData, error)
  • func (g GrafanaClient) PanelPNG(ctx context.Context, dashUID string, p dashboard.Panel, t dashboard.TimeRange) (dashboard.PanelImage, error)

Variables

var (
	ErrJavaScriptReturnedNoData = errors.New("javascript did not return any dashboard data")
	ErrDashboardHTTPError       = errors.New("dashboard request does not return 200 OK")
	ErrEmptyBlobURL             = errors.New("empty blob URL")
	ErrEmptyCSVData             = errors.New("empty csv data")
)

Types

type Credential

type Credential struct {
	HeaderName  string
	HeaderValue string
}

type Grafana

type Grafana interface {
	Dashboard(ctx context.Context, dashUID string) (dashboard.Dashboard, error)
	PanelPNG(ctx context.Context, dashUID string, p dashboard.Panel, t dashboard.TimeRange) (dashboard.PanelImage, error)
	PanelCSV(ctx context.Context, dashUID string, p dashboard.Panel, t dashboard.TimeRange) (dashboard.CSVData, error)
}

Grafana is a Grafana API httpClient.

type GrafanaClient

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

GrafanaClient is the struct that will implement required interfaces.

func New

func New(
	logger log.Logger,
	conf config.Config,
	httpClient *http.Client,
	chromeInstance chrome.Instance,
	workerPools worker.Pools,
	appURL string,
	credential Credential,
	queryParams url.Values,
) GrafanaClient

New creates a new Grafana Client. Cookies and Authorization headers, if found, will be forwarded in the requests queryParams are Grafana template variable url values of the form var-{name}={value}, e.g. var-host=dev.

func (GrafanaClient) Dashboard

func (g GrafanaClient) Dashboard(ctx context.Context, dashUID string) (dashboard.Dashboard, error)

Dashboard fetches dashboard from Grafana.

func (GrafanaClient) PanelCSV

func (g GrafanaClient) PanelCSV(_ context.Context, dashUID string, p dashboard.Panel, t dashboard.TimeRange) (dashboard.CSVData, error)

PanelCSV returns CSV data of a given panel.

func (GrafanaClient) PanelPNG

func (g GrafanaClient) PanelPNG(ctx context.Context, dashUID string, p dashboard.Panel, t dashboard.TimeRange) (dashboard.PanelImage, error)

PanelPNG returns encoded PNG image of a given panel.