grafana

Documentation

Index

• type Client
  • func NewGrafanaClient(cloudEnvironmentName, url string, tokens []string) (Client, error)
• type Grafana
  • func (gc *Grafana) AddGrafanaClusterProvisionAnnotation(clusterID string, logger log.FieldLogger)
  • func (gc *Grafana) AddGrafanaClusterResizeAnnotation(clusterID string, logger log.FieldLogger)
  • func (gc *Grafana) AddGrafanaClusterUpgradeAnnotation(clusterID string, logger log.FieldLogger)
  • func (gc *Grafana) LogConfiguration(logger log.FieldLogger)
  • func (gc *Grafana) UpdateGrafanaClusterProvisionAnnotation(clusterID string, logger log.FieldLogger)
  • func (gc *Grafana) UpdateGrafanaClusterResizeAnnotation(clusterID string, logger log.FieldLogger)
  • func (gc *Grafana) UpdateGrafanaClusterUpgradeAnnotation(clusterID string, logger log.FieldLogger)

Types

type Client

type Client interface {
	LogConfiguration(logger log.FieldLogger)

	AddGrafanaClusterProvisionAnnotation(clusterID string, logger log.FieldLogger)
	UpdateGrafanaClusterProvisionAnnotation(clusterID string, logger log.FieldLogger)

	AddGrafanaClusterUpgradeAnnotation(clusterID string, logger log.FieldLogger)
	UpdateGrafanaClusterUpgradeAnnotation(clusterID string, logger log.FieldLogger)

	AddGrafanaClusterResizeAnnotation(clusterID string, logger log.FieldLogger)
	UpdateGrafanaClusterResizeAnnotation(clusterID string, logger log.FieldLogger)
}

Client is an interface for interacting with a Grafana instance.

func NewGrafanaClient

func NewGrafanaClient(cloudEnvironmentName, url string, tokens []string) (Client, error)

NewGrafanaClient returns a GrafanaClient interface. If any errors are encountered a noop client is returned instead.

type Grafana

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

Grafana is a wrapper for one or more Grafana clients which can be used to easily make API calls to a Grafana backend.

func (*Grafana) AddGrafanaClusterProvisionAnnotation

func (gc *Grafana) AddGrafanaClusterProvisionAnnotation(clusterID string, logger log.FieldLogger)

AddGrafanaClusterProvisionAnnotation adds a new cluster provision annotation.

func (*Grafana) AddGrafanaClusterResizeAnnotation

func (gc *Grafana) AddGrafanaClusterResizeAnnotation(clusterID string, logger log.FieldLogger)

AddGrafanaClusterResizeAnnotation adds a new cluster resize annotation.

func (*Grafana) AddGrafanaClusterUpgradeAnnotation

func (gc *Grafana) AddGrafanaClusterUpgradeAnnotation(clusterID string, logger log.FieldLogger)

AddGrafanaClusterUpgradeAnnotation adds a new cluster upgrade annotation.

func (*Grafana) LogConfiguration

func (gc *Grafana) LogConfiguration(logger log.FieldLogger)

LogConfiguration logs client configuration.

func (*Grafana) UpdateGrafanaClusterProvisionAnnotation

func (gc *Grafana) UpdateGrafanaClusterProvisionAnnotation(clusterID string, logger log.FieldLogger)

UpdateGrafanaClusterProvisionAnnotation updates an existing cluster provision annotation.

func (*Grafana) UpdateGrafanaClusterResizeAnnotation

func (gc *Grafana) UpdateGrafanaClusterResizeAnnotation(clusterID string, logger log.FieldLogger)

UpdateGrafanaClusterResizeAnnotation updates an existing cluster resize annotation.

func (*Grafana) UpdateGrafanaClusterUpgradeAnnotation

func (gc *Grafana) UpdateGrafanaClusterUpgradeAnnotation(clusterID string, logger log.FieldLogger)

UpdateGrafanaClusterUpgradeAnnotation updates an existing cluster upgrade annotation.