clientfx

Documentation

Overview

Package clientfx provides clients for the Chronosphere API.

Index

• Variables
• type ChronosphereConfig
  • func (c *ChronosphereConfig) Validate() error
• type Component
• type Provider
  • func NewProvider(apiConfig *ChronosphereConfig) (Provider, error)

Variables

var (
	Module = fx.Provide(
		NewProvider,
	)
)

Types

type ChronosphereConfig

type ChronosphereConfig struct {
	APIURL           string `yaml:"apiURL" validate:"nonzero"`
	APIToken         string `yaml:"apiToken"`
	UseLogscale      bool   `yaml:"useLogscale"`
	LogscaleURL      string `yaml:"logscaleURL"`
	LogscaleAPIToken string `yaml:"logscaleAPIToken"`
}

func (*ChronosphereConfig) Validate

func (c *ChronosphereConfig) Validate() error

type Component

type Component string

Component is a value that indicates the part of the CLI that is invoking an API. This is used to set the User-Agent header when making requests to the Chronosphere API.

type Provider

type Provider struct {
	fx.Out

	PrometheusData api.Client `fx:"PrometheusData"`
	ConfigV1       *configv1.ConfigV1API
	DataUnstable   *dataunstable.DataUnstableAPI
	DataV1         *datav1.DataV1API
	StateUnstable  *stateunstable.StateUnstableAPI
	LogScale       logscale.Client `fx:"logscaleClient"`
}

func NewProvider

func NewProvider(apiConfig *ChronosphereConfig) (Provider, error)