featureflags

Documentation

Index

• Variables
• func State() map[string]bool
• func Update(flags string) error
• type FeatureFlag
  • func (ff *FeatureFlag) Enabled() bool

Variables

var (
	// WriteFileContents will store the contents of write observed from strace
	// data during dynamic analysis.
	WriteFileContents = new("WriteFileContents", true)

	// SaveAnalyzedPackages downloads the package archive and saves it
	// to the analyzed packages bucket (if configured) after analysis completes
	SaveAnalyzedPackages = new("SaveAnalyzedPackages", true)

	// PubSubExtender determines whether the worker uses a real GCP extender
	// for keeping messages alive during long-running processing.
	PubSubExtender = new("PubSubExtender", true)

	// CodeExecution invokes package code automatically during dynamic analysis,
	// which may uncover extra malicious behaviour. The names of executed functions,
	// methods and classes are logged to a file.
	CodeExecution = new("CodeExecution", true)

	// StraceDebugLogging enables verbose logging of strace parsing during dynamic analysis.
	// This feature can only be used in the analysis image, and if enabled, the -strace-logs-dir
	// flag must also be set. When enabled, the log files are then accessible via an explicit
	// docker mount or copy of the specified directory from the container to the host filesystem.
	StraceDebugLogging = new("StraceDebugLogging", false)
)

var ErrUndefinedFlag = errors.New("undefined feature flag")

Functions

func State

func State() map[string]bool

State returns a representation of the flags that are enabled and disabled.

func Update

func Update(flags string) error

Update changes the internal state of the flags based on flags passed in.

flags is a comma separated list of flag names. If a flag name is present it will be enabled. If a flag name is preceeded with a "-" character it will be disabled.

For example: "MyFeature,-ExperimentalFeature" will enable the flag "MyFeature" and disable the flag "ExperimentalFeature".

If a flag is undefined an error wrapping ErrUndefinedFlag will be returned.

Types

type FeatureFlag

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

FeatureFlag stores the state for a single flag.

Call Enabled() to see if the flag is enabled.

func (*FeatureFlag) Enabled

func (ff *FeatureFlag) Enabled() bool

Enabled returns whether or not the feature is enabled.