influxdb

Documentation

Index

• Constants
• func NewInfluxdbAPI(metric v1alpha1.Metric, kubeclientset kubernetes.Interface) (influxapi.QueryAPI, error)
• type Provider
  • func NewInfluxdbProvider(api influxapi.QueryAPI, logCtx log.Entry) *Provider
  • func (p *Provider) GarbageCollect(run *v1alpha1.AnalysisRun, metric v1alpha1.Metric, limit int) error
  • func (p *Provider) GetMetadata(metric v1alpha1.Metric) map[string]string
  • func (p *Provider) Resume(run *v1alpha1.AnalysisRun, metric v1alpha1.Metric, ...) v1alpha1.Measurement
  • func (p *Provider) Run(run *v1alpha1.AnalysisRun, metric v1alpha1.Metric) v1alpha1.Measurement
  • func (p *Provider) Terminate(run *v1alpha1.AnalysisRun, metric v1alpha1.Metric, ...) v1alpha1.Measurement
  • func (p *Provider) Type() string

Constants

const (
	//ProviderType indicates the provider is InfluxDB
	ProviderType = "Influxdb"
	//DefaultInfluxdbTokensSecretName is the k8s secret that has InfluxDB api token, org and address
	DefaultInfluxdbTokensSecretName = "influxdb"
)

Functions

func NewInfluxdbAPI

func NewInfluxdbAPI(metric v1alpha1.Metric, kubeclientset kubernetes.Interface) (influxapi.QueryAPI, error)

NewInfluxdbAPI generates a Influx API from the metric configuration

Types

type Provider

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

Provider contains all the required components to run a influxdb flux query

func NewInfluxdbProvider

func NewInfluxdbProvider(api influxapi.QueryAPI, logCtx log.Entry) *Provider

NewInfluxdbProvider Creates a new Influxdb client

func (*Provider) GarbageCollect

func (p *Provider) GarbageCollect(run *v1alpha1.AnalysisRun, metric v1alpha1.Metric, limit int) error

GarbageCollect is a no-op for the influxdb provider

func (*Provider) GetMetadata

func (p *Provider) GetMetadata(metric v1alpha1.Metric) map[string]string

GetMetadata returns any additional metadata which needs to be stored & displayed as part of the metrics result.

func (*Provider) Resume

func (p *Provider) Resume(run *v1alpha1.AnalysisRun, metric v1alpha1.Metric, measurement v1alpha1.Measurement) v1alpha1.Measurement

Resume should not be used by the influxdb provider since all the work should occur in the Run method.

func (*Provider) Run

func (p *Provider) Run(run *v1alpha1.AnalysisRun, metric v1alpha1.Metric) v1alpha1.Measurement

Run queries influxdb for the metric

func (*Provider) Terminate

func (p *Provider) Terminate(run *v1alpha1.AnalysisRun, metric v1alpha1.Metric, measurement v1alpha1.Measurement) v1alpha1.Measurement

Terminate should not be used by the influxdb provider since all the work should occur in the Run method.

func (*Provider) Type

func (p *Provider) Type() string

Type indicates provider is a influxdb provider