slo

Documentation

Index

• Constants
• Variables
• func AddMiddleware(ctx context.Context, s *backend.DataSourceInstanceSettings) (httpclient.Options, error)
• func FromStatus(status backend.Status) backend.ErrorSource
• func Middleware() httpclient.Middleware
• func NewClient(opts ...httpclient.Options) (*http.Client, error)
• func RoundTripper(_ httpclient.Options, next http.RoundTripper) http.RoundTripper
• func SanitizeLabelName(name string) (string, error)
• type Collector
  • func NewMetrics(dsName, dsType string) Collector
• type Duration
  • func NewDuration(value float64) *Duration
  • func (d *Duration) Add(value float64, source Source, statusCode int, err error)
  • func (d *Duration) Value() float64
• type DurationKey
• type Endpoint
• type Metrics
  • func (m Metrics) CollectDuration(source Source, status Status, statusCode int, duration float64)
  • func (m Metrics) WithEndpoint(endpoint Endpoint) Collector
• type MetricsWrapper
  • func NewMetricsWrapper(plugin any, s backend.DataSourceInstanceSettings, c ...Collector) *MetricsWrapper
  • func (ds *MetricsWrapper) CallResource(ctx context.Context, req *backend.CallResourceRequest, ...) error
  • func (ds *MetricsWrapper) CheckHealth(ctx context.Context, req *backend.CheckHealthRequest) (*backend.CheckHealthResult, error)
  • func (ds *MetricsWrapper) QueryData(ctx context.Context, req *backend.QueryDataRequest) (*backend.QueryDataResponse, error)
• type Source
• type Status

Constants

const (
	StatusOK         Status   = "ok"
	StatusError      Status   = "error"
	EndpointHealth   Endpoint = "health"
	EndpointQuery    Endpoint = "query"
	EndpointResource Endpoint = "resource"
	SourceDownstream Source   = "downstream"
	SourcePlugin     Source   = "plugin"
)

const DataSourceSLOMiddlewareName = "slo"

DataSourceSLOMiddlewareName is the middleware name used by Middleware.

Variables

var Logger = log.DefaultLogger

Functions

func AddMiddleware

func AddMiddleware(ctx context.Context, s *backend.DataSourceInstanceSettings) (httpclient.Options, error)

AddMiddleware adds the middleware to the http client options.

func FromStatus

func FromStatus(status backend.Status) backend.ErrorSource

FromStatus returns the error source from backend status

func Middleware

func Middleware() httpclient.Middleware

Middleware applies the duration to the context.

func NewClient

func NewClient(opts ...httpclient.Options) (*http.Client, error)

NewClient wraps the existing http client constructor and adds the duration middleware

func RoundTripper

func RoundTripper(_ httpclient.Options, next http.RoundTripper) http.RoundTripper

RoundTripper captures the duration of the request in the context

func SanitizeLabelName

func SanitizeLabelName(name string) (string, error)

Types

type Collector

type Collector interface {
	CollectDuration(source Source, status Status, statusCode int, duration float64)
	WithEndpoint(endpoint Endpoint) Collector
}

func NewMetrics

func NewMetrics(dsName, dsType string) Collector

NewMetrics creates a new Metrics instance

type Duration

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

Duration is stored in the Context and used to collect metrics

func NewDuration

func NewDuration(value float64) *Duration

func (*Duration) Add

func (d *Duration) Add(value float64, source Source, statusCode int, err error)

func (*Duration) Value

func (d *Duration) Value() float64

type DurationKey

type DurationKey struct{}

DurationKey is a key for storing the duration in the context

type Endpoint

type Endpoint string

Endpoint is the endpoint of the request (health, query, resource)

type Metrics

type Metrics struct {
	DSName   string
	DSType   string
	Endpoint Endpoint
}

Metrics is an abstraction for collecting metrics

func (Metrics) CollectDuration

func (m Metrics) CollectDuration(source Source, status Status, statusCode int, duration float64)

CollectDuration collects the duration as a metric

func (Metrics) WithEndpoint

func (m Metrics) WithEndpoint(endpoint Endpoint) Collector

WithEndpoint returns a new Metrics instance with the given endpoint

type MetricsWrapper

type MetricsWrapper struct {
	Name string
	Type string

	Metrics Collector
	// contains filtered or unexported fields
}

MetricsWrapper is a wrapper for a plugin that collects metrics

func NewMetricsWrapper

func NewMetricsWrapper(plugin any, s backend.DataSourceInstanceSettings, c ...Collector) *MetricsWrapper

NewMetricsWrapper creates a new MetricsWrapper instance

func (*MetricsWrapper) CallResource

func (ds *MetricsWrapper) CallResource(ctx context.Context, req *backend.CallResourceRequest, sender backend.CallResourceResponseSender) error

CallResource calls the CallResourceHandler and collects metrics

func (*MetricsWrapper) CheckHealth

func (ds *MetricsWrapper) CheckHealth(ctx context.Context, req *backend.CheckHealthRequest) (*backend.CheckHealthResult, error)

CheckHealth calls the CheckHealthHandler and collects metrics

func (*MetricsWrapper) QueryData

func (ds *MetricsWrapper) QueryData(ctx context.Context, req *backend.QueryDataRequest) (*backend.QueryDataResponse, error)

QueryData calls the QueryDataHandler and collects metrics

type Source

type Source string

Source is the source of the error (downstream, plugin)

type Status

type Status string

Status is the status of the request