iface

Documentation

Index

• Constants
• type MetricSubRegistry
• type Policy
• type PolicyBase
• type PolicyRead

Constants

const (
	// PoliciesRoot - path in config and status registry for policies results.
	PoliciesRoot = "policies"
)

Types

type MetricSubRegistry

type MetricSubRegistry interface {
	RegisterHistogramSub(metricNameOrig, metricNameSub string, labelMatchers []*labels.Matcher)
	RegisterMetricSub(metricsNameOrig, metricNameSub string, labelMatchers []*labels.Matcher)
}

MetricSubRegistry is for registering metric substitution patterns (used by FluxMeter).

type Policy

type Policy interface {
	PolicyRead
	MetricSubRegistry
}

Policy is the global interface composed of all of the above APIs.

type PolicyBase

type PolicyBase interface {
	GetPolicyName() string
	GetPolicyHash() string
}

PolicyBase is for read only access to base policy info.

type PolicyRead

type PolicyRead interface {
	PolicyBase
	ResolveMetricNames(query string) (string, error)
	GetEvaluationInterval() time.Duration
}

PolicyRead is for read only access to full policy state.