grafanacloud

Documentation

Overview

Package grafanacloud provides an interface to the Grafana Cloud API.

Index

• type Client
  • func NewClient(c *http.Client, apiKey, apiURL string) *Client
  • func (c *Client) AgentConfig(ctx context.Context, stackID string) (string, error)

Types

type Client

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

Client is a grafanacloud API client.

func NewClient

func NewClient(c *http.Client, apiKey, apiURL string) *Client

NewClient creates a new Grafana Cloud client. All requests made will be performed using the provided http.Client c. If c is nil, the default http client will be used instead.

apiKey will be used to authenticate against the apiURL.

func (*Client) AgentConfig

func (c *Client) AgentConfig(ctx context.Context, stackID string) (string, error)

AgentConfig generates a Grafana Agent config from the given stack. The config is returned as a string in YAML form.