featuregate

Documentation

Overview

Package featuregate provides a way to gate features in the collector based on different options, such as the feature's stability level and user-defined minimum allowed stability level. This package is used by Flow Mode only.

Index

• func AllowedValues() []string
• func CheckAllowed(stability Stability, minStability Stability, featureName string) error
• type Stability
  • func (s *Stability) Set(str string) error
  • func (s Stability) String() string
  • func (s Stability) Type() string

Functions

func AllowedValues

func AllowedValues() []string

func CheckAllowed

func CheckAllowed(stability Stability, minStability Stability, featureName string) error

Types

type Stability

type Stability int

Stability is used to designate the stability level of a feature or a minimum stability level the collector is allowed to operate with.

const (
	// StabilityUndefined is the default value for Stability, which indicates an error and should never be used.
	StabilityUndefined Stability = iota
	// StabilityExperimental is used to designate experimental features.
	StabilityExperimental
	// StabilityBeta is used to designate beta features.
	StabilityBeta
	// StabilityStable is used to designate stable features.
	StabilityStable
)

func (*Stability) Set

func (s *Stability) Set(str string) error

Set implements the pflag.Value interface.

func (Stability) String

func (s Stability) String() string

String implements the pflag.Value interface. The returned strings are "double-quoted" already.

func (Stability) Type

func (s Stability) Type() string

Type implements the pflag.Value interface. This value is displayed as a placeholder in help messages.