experiments

package

v4.0.0-beta.1 Latest Latest Go to latest Published: Apr 22, 2026 License: MIT Imports: 4 Imported by: 0

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
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(ctx context.Context, key string) context.Context
func Enabled(ctx context.Context) []string
func IsEnabled(ctx context.Context, key string) bool
func KnownAndEnabled(ctx context.Context) []string
type State
- func Enable(ctx context.Context, key string) (newctx context.Context, state State)
- func EnableWithWarnings(ctx context.Context, l logger.Logger, key string) (context.Context, State)

Constants ¶

View Source

const (
	// Available experiments
	AgentAPI                       = "agent-api"
	InterpolationPrefersRuntimeEnv = "interpolation-prefers-runtime-env"
	PTYRaw                         = "pty-raw"
	ZipPlugins                     = "zip-plugins"
)

Variables ¶

View Source

var (
	Available = map[string]struct{}{
		AgentAPI:                       {},
		InterpolationPrefersRuntimeEnv: {},
		PTYRaw:                         {},
		ZipPlugins:                     {},
	}

	Promoted = map[string]string{
				// contains filtered or unexported fields
	}
)

Functions ¶

func Disable ¶

func Disable(ctx context.Context, key string) context.Context

Disable a particular experiment in a new context.

func Enabled ¶

func Enabled(ctx context.Context) []string

Enabled returns the keys of all the enabled experiments.

func IsEnabled ¶

func IsEnabled(ctx context.Context, key string) bool

IsEnabled reports whether the named experiment is enabled in the context.

func KnownAndEnabled ¶

func KnownAndEnabled(ctx context.Context) []string

KnownAndEnabled returns the keys of all the known and enabled experiments.

Types ¶

type State ¶

type State string

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

Experiment states

func Enable ¶

func Enable(ctx context.Context, key string) (newctx context.Context, state State)

Enable a particular experiment in a new context.

func EnableWithWarnings ¶

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

EnableWithWarnings enables an experiment in a new context, logging information about unknown and promoted experiments.

Source Files ¶

View all Source files

experiments.go

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