injectproxy

Documentation

Index

• Variables
• func MustLabelValue(ctx context.Context) string
• func MustLabelValues(ctx context.Context) []string
• func NewRoutes(upstream *url.URL, label string, extractLabeler ExtractLabeler, opts ...Option) (*routes, error)
• func WithLabelValues(ctx context.Context, labels []string) context.Context
• type ExtractLabeler
• type HTTPFormEnforcer
  • func (hff HTTPFormEnforcer) ExtractLabel(next http.HandlerFunc) http.Handler
• type HTTPHeaderEnforcer
  • func (hhe HTTPHeaderEnforcer) ExtractLabel(next http.HandlerFunc) http.Handler
• type Option
  • func WithActiveAlerts() Option
  • func WithEnabledLabelsAPI() Option
  • func WithErrorOnReplace() Option
  • func WithPassthroughPaths(paths []string) Option
  • func WithPrometheusRegistry(reg prometheus.Registerer) Option
  • func WithRegexMatch() Option
• type PromQLEnforcer
  • func NewPromQLEnforcer(errorOnReplace bool, ms ...*labels.Matcher) *PromQLEnforcer
  • func (ms *PromQLEnforcer) Enforce(q string) (string, error)
  • func (ms PromQLEnforcer) EnforceMatchers(targets []*labels.Matcher) ([]*labels.Matcher, error)
  • func (ms PromQLEnforcer) EnforceNode(node parser.Node) error
• type StaticLabelEnforcer
  • func (sle StaticLabelEnforcer) ExtractLabel(next http.HandlerFunc) http.Handler

Variables

var (
	// ErrQueryParse is returned when the input query is invalid.
	ErrQueryParse = errors.New("failed to parse query string")

	// ErrIllegalLabelMatcher is returned when the input query contains a conflicting label matcher.
	ErrIllegalLabelMatcher = errors.New("conflicting label matcher")

	// ErrEnforceLabel is returned when the label matchers couldn't be enforced.
	ErrEnforceLabel = errors.New("failed to enforce label")
)

Functions

func MustLabelValue

func MustLabelValue(ctx context.Context) string

MustLabelValue returns the first (alphabetical order) label value previously stored using WithLabelValue() from the given context. Similar to MustLabelValues, it will panic if no label is found or the value is empty.

func MustLabelValues

func MustLabelValues(ctx context.Context) []string

MustLabelValues returns labels (previously stored using WithLabelValue()) from the given context. It will panic if no label is found or the value is empty.

func NewRoutes

func NewRoutes(upstream *url.URL, label string, extractLabeler ExtractLabeler, opts ...Option) (*routes, error)

func WithLabelValues

func WithLabelValues(ctx context.Context, labels []string) context.Context

WithLabelValues stores labels in the given context.

Types

type ExtractLabeler

type ExtractLabeler interface {
	ExtractLabel(next http.HandlerFunc) http.Handler
}

ExtractLabeler is an HTTP handler that extract the label value to be enforced from the HTTP request. If a valid label value is found, it should store it in the request's context. Otherwise it should return an error in the HTTP response (usually 400 or 500).

type HTTPFormEnforcer

type HTTPFormEnforcer struct {
	ParameterName string
}

HTTPFormEnforcer enforces a label value extracted from the HTTP form and query parameters.

func (HTTPFormEnforcer) ExtractLabel

func (hff HTTPFormEnforcer) ExtractLabel(next http.HandlerFunc) http.Handler

ExtractLabel implements the ExtractLabeler interface.

type HTTPHeaderEnforcer

type HTTPHeaderEnforcer struct {
	Name            string
	ParseListSyntax bool
}

HTTPHeaderEnforcer enforces a label value extracted from the HTTP headers.

func (HTTPHeaderEnforcer) ExtractLabel

func (hhe HTTPHeaderEnforcer) ExtractLabel(next http.HandlerFunc) http.Handler

ExtractLabel implements the ExtractLabeler interface.

type Option

type Option interface {
	// contains filtered or unexported methods
}

func WithActiveAlerts

func WithActiveAlerts() Option

WithActiveAlerts causes the proxy to return rules with active alerts.

func WithEnabledLabelsAPI

func WithEnabledLabelsAPI() Option

WithEnabledLabelsAPI enables proxying to labels API. If false, "501 Not implemented" will be return for those.

func WithErrorOnReplace

func WithErrorOnReplace() Option

WithErrorOnReplace causes the proxy to return 400 if a label matcher we want to inject is present in the query already and matches something different

func WithPassthroughPaths

func WithPassthroughPaths(paths []string) Option

WithPassthroughPaths configures routes to register given paths as passthrough handlers for all HTTP methods. that, if requested, will be forwarded without enforcing label. Use with care. NOTE: Passthrough "all" paths like "/" or "" and regex are not allowed.

func WithPrometheusRegistry

func WithPrometheusRegistry(reg prometheus.Registerer) Option

WithPrometheusRegistry configures the proxy to use the given registerer.

func WithRegexMatch

func WithRegexMatch() Option

WithRegexMatch causes the proxy to handle tenant name as regexp

type PromQLEnforcer

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

PromQLEnforcer can enforce label matchers in PromQL expressions.

func NewPromQLEnforcer

func NewPromQLEnforcer(errorOnReplace bool, ms ...*labels.Matcher) *PromQLEnforcer

func (*PromQLEnforcer) Enforce

func (ms *PromQLEnforcer) Enforce(q string) (string, error)

Enforce the label matchers in a PromQL expression.

func (PromQLEnforcer) EnforceMatchers

func (ms PromQLEnforcer) EnforceMatchers(targets []*labels.Matcher) ([]*labels.Matcher, error)

EnforceMatchers appends the enforced label matcher(s) to the list of matchers if not already present.

If the label matcher that is to be injected is present (by labelname), the behavior depends on the errorOnReplace variable and the enforced matcher(s): * If errorOnReplace is false

• And the label matcher type is '=', the existing matcher is silently discarded whatever is the original value.
• Otherwise the existing matcher is preserved.

* if errorOnReplace is true

• And the label matcher and the enforced matcher are disjoint, the function returns an error.
• Otherwise the existing matcher is preserved.

func (PromQLEnforcer) EnforceNode

func (ms PromQLEnforcer) EnforceNode(node parser.Node) error

EnforceNode walks the given node recursively and enforces the given label enforcer on it.

Whenever a parser.MatrixSelector or parser.VectorSelector AST node is found, their label enforcer is being potentially modified. If a node's label matcher has the same name as a label matcher of the given enforcer, then it will be replaced.

type StaticLabelEnforcer

type StaticLabelEnforcer []string

StaticLabelEnforcer enforces a static label value.

func (StaticLabelEnforcer) ExtractLabel

func (sle StaticLabelEnforcer) ExtractLabel(next http.HandlerFunc) http.Handler

ExtractLabel implements the ExtractLabeler interface.