Documentation
¶
Overview ¶
Package envknob provides access to environment-variable tweakable debug settings.
These are primarily knobs used by Tailscale developers during development or by users when instructed to by Tailscale developers when debugging something. They are not a stable interface and may be removed or any time.
A related package, control/controlknobs, are knobs that can be changed at runtime by the control plane. Sometimes both are used: an envknob for the default/explicit value, else falling back to the controlknob value.
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func Bool ¶
Bool returns the boolean value of the named environment variable. If the variable is not set, it returns false. An invalid value exits the binary with a failure.
func BoolDefaultTrue ¶
BoolDefaultTrue is like Bool, but returns true by default if the environment variable isn't present.
func LookupBool ¶
LookupBool returns the boolean value of the named environment value. The ok result is whether a value was set. If the value isn't a valid int, it exits the program with a failure.
func LookupInt ¶
LookupInt returns the integer value of the named environment value. The ok result is whether a value was set. If the value isn't a valid int, it exits the program with a failure.
func OptBool ¶
OptBool is like Bool, but returns an opt.Bool, so the caller can distinguish between implicitly and explicitly false.
func String ¶
String returns the named environment variable, using os.Getenv.
If the variable is non-empty, it's also tracked & logged as being an in-use knob.
func UseWIPCode ¶
func UseWIPCode() bool
UseWIPCode is whether TAILSCALE_USE_WIP_CODE is set to permit use of Work-In-Progress code.
Types ¶
This section is empty.