webmetric

Documentation

Index

• Constants
• func NewWebMetricHttpClient(metric v1alpha1.Metric) (*http.Client, error)
• func NewWebMetricJsonParser(metric v1alpha1.Metric) (*jsonpath.JSONPath, error)
• type Provider
  • func NewWebMetricProvider(logCtx log.Entry, client *http.Client, jsonParser *jsonpath.JSONPath) *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 a web metric
	ProviderType         = "Web"
	ContentTypeKey       = "Content-Type"
	ContentTypeJsonValue = "application/json"
)

Functions

func NewWebMetricHttpClient

func NewWebMetricHttpClient(metric v1alpha1.Metric) (*http.Client, error)

func NewWebMetricJsonParser

func NewWebMetricJsonParser(metric v1alpha1.Metric) (*jsonpath.JSONPath, error)

Types

type Provider

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

Provider contains all the required components to run a WebMetric query Implements the Provider Interface

func NewWebMetricProvider

func NewWebMetricProvider(logCtx log.Entry, client *http.Client, jsonParser *jsonpath.JSONPath) *Provider

func (*Provider) GarbageCollect

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

GarbageCollect is a no-op for the WebMetric 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 the WebMetric 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

func (*Provider) Terminate

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

Terminate should not be used the WebMetric provider since all the work should occur in the Run method

func (*Provider) Type

func (p *Provider) Type() string

Type indicates provider is a WebMetric provider