experiments

package

v3.52.1 Latest Latest Go to latest Published: Aug 24, 2023 License: MIT Imports: 2 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/buildkite/agent

Links

Open Source Insights

Documentation ¶

Overview ¶

Package experiments provides a global registry of enabled and disabled experiments.

It is intended for internal use by buildkite-agent only.

Index ¶

Constants
Variables
func Disable(key string)
func EnableWithUndo(key string) func()
func Enabled() []string
func IsEnabled(key string) bool
type State
- func Enable(key string) (state State)
- func EnableWithWarnings(l logger.Logger, key string) State

Constants ¶

View Source

const (
	// Available experiments
	AgentAPI                   = "agent-api"
	DescendingSpawnPrioity     = "descending-spawn-priority"
	JobAPI                     = "job-api"
	KubernetesExec             = "kubernetes-exec"
	NormalisedUploadPaths      = "normalised-upload-paths"
	PolyglotHooks              = "polyglot-hooks"
	ResolveCommitAfterCheckout = "resolve-commit-after-checkout"
	AvoidRecursiveTrap         = "avoid-recursive-trap"
	IsolatedPluginCheckout     = "isolated-plugin-checkout"

	// Promoted experiments
	ANSITimestamps    = "ansi-timestamps"
	FlockFileLocks    = "flock-file-locks"
	GitMirrors        = "git-mirrors"
	InbuiltStatusPage = "inbuilt-status-page"
)

Variables ¶

View Source

var (
	Available = map[string]struct{}{
		AgentAPI:                   {},
		DescendingSpawnPrioity:     {},
		JobAPI:                     {},
		KubernetesExec:             {},
		NormalisedUploadPaths:      {},
		PolyglotHooks:              {},
		ResolveCommitAfterCheckout: {},
		AvoidRecursiveTrap:         {},
		IsolatedPluginCheckout:     {},
	}

	Promoted = map[string]string{
		ANSITimestamps:    standardPromotionMsg(ANSITimestamps, "v3.48.0"),
		FlockFileLocks:    standardPromotionMsg(FlockFileLocks, "v3.48.0"),
		GitMirrors:        standardPromotionMsg(GitMirrors, "v3.47.0"),
		InbuiltStatusPage: standardPromotionMsg(InbuiltStatusPage, "v3.48.0"),
	}
)

Functions ¶

func Disable ¶ added in v3.22.0

func Disable(key string)

Disable a particular experiment in the agent.

func EnableWithUndo ¶ added in v3.47.0

func EnableWithUndo(key string) func()

func Enabled ¶

func Enabled() []string

Enabled returns the keys of all the enabled experiments.

func IsEnabled ¶

func IsEnabled(key string) bool

IsEnabled reports whether the named experiment is enabled.

Types ¶

type State ¶ added in v3.47.0

type State string

const (
	StateKnown    State = "known"
	StatePromoted State = "promoted"
	StateUnknown  State = "unknown"
)

Experiment states

func Enable ¶

func Enable(key string) (state State)

Enable a particular experiment in the agent.

func EnableWithWarnings ¶ added in v3.47.0

func EnableWithWarnings(l logger.Logger, key string) State

Source Files ¶

View all Source files

experiments.go

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL