blackbox

Documentation

Index

• Constants
• func MagicMetricNames() []string
• type Config
  • func LoadConfig() *Config
• type MetricStoreMetricsTLS
• type PerformanceCalculator
  • func NewPerformanceCalculator(cfg *Config, log *logger.Logger, debugRegistrar metrics.Registrar) *PerformanceCalculator
  • func (c *PerformanceCalculator) Calculate(client QueryableClient) (PerformanceMetrics, error)
  • func (pc *PerformanceCalculator) CalculatePerformance(egressClient QueryableClient, stopChan chan bool)
  • func (pc *PerformanceCalculator) EmitPerformanceTestMetrics(sourceId string, emissionInterval time.Duration, ...)
• type PerformanceMetrics
• type QueryableClient
• type ReliabilityCalculator
  • func (rc ReliabilityCalculator) Calculate(qc QueryableClient) (float64, error)
  • func (rc *ReliabilityCalculator) CalculateReliability(egressClient QueryableClient, stopChan chan bool)
  • func (rc ReliabilityCalculator) CountMetricPoints(metricName string, client QueryableClient) (uint64, error)
  • func (rc *ReliabilityCalculator) EmitReliabilityMetrics(ingressClient *ingressclient.IngressClient, stopChan chan bool)
  • func (rc ReliabilityCalculator) ExpectedSamples() float64

Constants

const (
	HttpReliability               = "blackbox_http_reliability"
	MalfunctioningMetricsTotal    = "blackbox_malfunctioning_metrics_total"
	BlackboxPerformanceTestCanary = "blackbox_performance_canary"
	BlackboxHTTPReliability       = "blackbox_http_reliability"
	BlackboxPerformanceLatency    = "blackbox_performance_latency"
	BlackboxPerformanceCount      = "blackbox_performance_count"
)

const (
	// see scripts/hack/hash.go
	MAGIC_METRIC_NAME_NODES_0_AND_1 = "blackbox_test_metric_003"
	MAGIC_METRIC_NAME_NODES_1_AND_2 = "blackbox_test_metric_021"
	MAGIC_METRIC_NAME_NODES_2_AND_3 = "blackbox_test_metric_001"
	MAGIC_METRIC_NAME_NODES_3_AND_4 = "blackbox_test_metric_010"
	MAGIC_METRIC_NAME_NODES_4_AND_5 = "blackbox_test_metric_005"
	MAGIC_METRIC_NAME_NODES_5_AND_0 = "blackbox_test_metric_002"
)

Functions

func MagicMetricNames

func MagicMetricNames() []string

Types

type Config

type Config struct {
	EmissionInterval time.Duration `env:"EMISSION_INTERVAL, required, report"`
	SampleInterval   time.Duration `env:"SAMPLE_INTERVAL, required, report"`
	WindowInterval   time.Duration `env:"WINDOW_INTERVAL, required, report"`
	WindowLag        time.Duration `env:"WINDOW_LAG, required, report"`
	SourceId         string        `env:"SOURCE_ID, required, report"`

	MetricsAddr            string `env:"METRICS_ADDR, report"`
	CfBlackboxEnabled      bool   `env:"CF_BLACKBOX_ENABLED, report"`
	MetricStoreHTTPAddr    string `env:"METRIC_STORE_HTTP_ADDR, required, report"`
	MetricStoreIngressAddr string `env:"METRIC_STORE_INGRESS_ADDR, required, report"`
	UaaAddr                string `env:"UAA_ADDR, report"`
	ClientID               string `env:"CLIENT_ID, report"`
	ClientSecret           string `env:"CLIENT_SECRET"`
	SkipTLSVerify          bool   `env:"SKIP_TLS_VERIFY, report"`

	MetricStoreGrpcAddr   string `env:"METRIC_STORE_GRPC_ADDR, required, report"`
	TLS                   sharedtls.TLS
	MetricStoreMetricsTLS MetricStoreMetricsTLS

	LogLevel      string `env:"LOG_LEVEL,                      report"`
	ProfilingAddr string `env:"PROFILING_ADDR"`
}

func LoadConfig

func LoadConfig() *Config

type MetricStoreMetricsTLS

type MetricStoreMetricsTLS struct {
	CAPath   string `env:"METRIC_STORE_METRICS_CA_PATH, required, report"`
	CertPath string `env:"METRIC_STORE_METRICS_CERT_PATH, required, report"`
	KeyPath  string `env:"METRIC_STORE_METRICS_KEY_PATH, required, report"`
}

type PerformanceCalculator

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

func NewPerformanceCalculator

func NewPerformanceCalculator(cfg *Config, log *logger.Logger, debugRegistrar metrics.Registrar) *PerformanceCalculator

func (*PerformanceCalculator) Calculate

func (c *PerformanceCalculator) Calculate(client QueryableClient) (PerformanceMetrics, error)

func (*PerformanceCalculator) CalculatePerformance

func (pc *PerformanceCalculator) CalculatePerformance(egressClient QueryableClient, stopChan chan bool)

func (*PerformanceCalculator) EmitPerformanceTestMetrics

func (pc *PerformanceCalculator) EmitPerformanceTestMetrics(sourceId string, emissionInterval time.Duration, ingressClient *ingressclient.IngressClient, stopChan chan bool)

type PerformanceMetrics

type PerformanceMetrics struct {
	Latency   time.Duration
	Magnitude int
}

type QueryableClient

type QueryableClient interface {
	Query(ctx context.Context, query string, ts time.Time, opts ...prom_versioned_api_client.
		Option) (model.Value, prom_versioned_api_client.Warnings, error)
	LabelValues(ctx context.Context, label string, matches []string, startTime,
		endTime time.Time) (model.LabelValues, prom_versioned_api_client.Warnings, error)
}

type ReliabilityCalculator

type ReliabilityCalculator struct {
	SampleInterval   time.Duration
	WindowInterval   time.Duration
	WindowLag        time.Duration
	EmissionInterval time.Duration
	SourceId         string
	Log              *logger.Logger
	DebugRegistrar   metrics.Registrar
}

func (ReliabilityCalculator) Calculate

func (rc ReliabilityCalculator) Calculate(qc QueryableClient) (float64, error)

func (*ReliabilityCalculator) CalculateReliability

func (rc *ReliabilityCalculator) CalculateReliability(egressClient QueryableClient, stopChan chan bool)

func (ReliabilityCalculator) CountMetricPoints

func (rc ReliabilityCalculator) CountMetricPoints(metricName string, client QueryableClient) (uint64, error)

func (*ReliabilityCalculator) EmitReliabilityMetrics

func (rc *ReliabilityCalculator) EmitReliabilityMetrics(ingressClient *ingressclient.IngressClient, stopChan chan bool)

func (ReliabilityCalculator) ExpectedSamples

func (rc ReliabilityCalculator) ExpectedSamples() float64