runtime

Documentation

Overview

Package runtime handles runtime errors Wraps and reconfigures functionality in apimachinery/pkg/runtime

Index

• Variables
• func EnableAllFeatures()
• func EncodeFeatures() string
• func FeatureEnabled(feature Feature) bool
• func FeaturesBindEnv() error
• func FeaturesBindFlags()
• func HandleError(logger *logrus.Entry, err error)
• func Must(err error)
• func NewLoggerWithSource(source string) *logrus.Entry
• func NewLoggerWithType(obj interface{}) *logrus.Entry
• func NewServerMux() *gwruntime.ServeMux
• func ParseFeatures(queryString string) error
• func ParseFeaturesFromEnv() error
• func SetLevel(level logrus.Level)
• type Feature

Variables

var (

	// FeatureTestMutex is a mutex to be shared between tests to ensure that a test that involves changing featureGates
	// cannot accidentally run at the same time as another test that also changing feature flags.
	FeatureTestMutex sync.Mutex
)

Functions

func EnableAllFeatures

func EnableAllFeatures()

EnableAllFeatures turns on all feature flags. This is useful for libraries/processes/tests that want to enable all Alpha/Beta features without having to track all the current feature flags.

func EncodeFeatures

func EncodeFeatures() string

EncodeFeatures returns the feature set as a URL encoded query string

func FeatureEnabled

func FeatureEnabled(feature Feature) bool

FeatureEnabled returns if a Feature is enabled or not

func FeaturesBindEnv

func FeaturesBindEnv() error

FeaturesBindEnv binds the environment variables, based on the flags provided. call after viper.SetEnvKeyReplacer(...) if it is being set.

func FeaturesBindFlags

func FeaturesBindFlags()

FeaturesBindFlags does the Viper arguments configuration. Call before running pflag.Parse()

func HandleError

func HandleError(logger *logrus.Entry, err error)

HandleError wraps runtime.HandleError so that it is possible to use WithField with logrus.

func Must

func Must(err error)

Must panics if there is an error

func NewLoggerWithSource

func NewLoggerWithSource(source string) *logrus.Entry

NewLoggerWithSource returns a logrus.Entry to use when you want to specify an source

func NewLoggerWithType

func NewLoggerWithType(obj interface{}) *logrus.Entry

NewLoggerWithType returns a logrus.Entry to use when you want to use a data type as the source such as when you have a struct with methods

func NewServerMux

func NewServerMux() *gwruntime.ServeMux

NewServerMux returns a ServeMux which is a request multiplexer for grpc-gateway. It matches http requests to pattern and invokes the corresponding handler. ref: https://grpc-ecosystem.github.io/grpc-gateway/docs/development/grpc-gateway_v2_migration_guide/#we-now-emit-default-values-for-all-fields

func ParseFeatures

func ParseFeatures(queryString string) error

ParseFeatures parses the url encoded query string of features and stores the value for later retrieval

func ParseFeaturesFromEnv

func ParseFeaturesFromEnv() error

ParseFeaturesFromEnv will parse the feature flags from the Viper args configured by FeaturesBindFlags() and FeaturesBindEnv()

func SetLevel

func SetLevel(level logrus.Level)

SetLevel select level to filter logger output

Types

type Feature

type Feature string

Feature is a type for defining feature gates.

const (
	// FeatureGateFlag is a name of a command line flag, which turns on specific tests for FeatureGates
	FeatureGateFlag = "feature-gates"

	// FeatureCustomFasSyncInterval is a feature flag that enables a custom FleetAutoscaler resync interval
	FeatureCustomFasSyncInterval Feature = "CustomFasSyncInterval"

	// FeatureSafeToEvict enables the `SafeToEvict` API to specify disruption tolerance.
	FeatureSafeToEvict Feature = "SafeToEvict"

	// FeatureSDKGracefulTermination is a feature flag that enables SDK to support gracefulTermination
	FeatureSDKGracefulTermination Feature = "SDKGracefulTermination"

	// FeatureStateAllocationFilter is a feature flag that enables state filtering on Allocation.
	FeatureStateAllocationFilter Feature = "StateAllocationFilter"

	// FeaturePlayerAllocationFilter is a feature flag that enables the ability for Allocations to filter based on
	// player capacity.
	FeaturePlayerAllocationFilter Feature = "PlayerAllocationFilter"

	// FeaturePlayerTracking is a feature flag to enable/disable player tracking features.
	FeaturePlayerTracking Feature = "PlayerTracking"

	// FeatureResetMetricsOnDelete is a feature flag that tells the metrics service to unregister and register
	// relevant metric views to reset their state immediately when an Agones resource is deleted.
	FeatureResetMetricsOnDelete Feature = "ResetMetricsOnDelete"

	// FeaturePodHostname enables the Pod Hostname being assigned the name of the GameServer
	FeaturePodHostname = "PodHostname"

	// FeatureSplitControllerAndExtensions is a feature flag that will split agones-controller into two deployments
	FeatureSplitControllerAndExtensions = "SplitControllerAndExtensions"

	// FeatureFleetAllocateOverflow enables setting labels and/or annotations on Allocated GameServers
	// if the desired number of the underlying GameServerSet drops below the number of Allocated GameServers
	FeatureFleetAllocateOverflow = "FleetAllocationOverflow"

	// FeatureCountsAndLists is a feature flag that enables/disables counts and lists feature
	// (a generic implenetation of the player tracking feature).
	FeatureCountsAndLists Feature = "CountsAndLists"

	// FeatureExample is an example feature gate flag, used for testing and demonstrative purposes
	FeatureExample Feature = "Example"
)