Get a ToggleMap for the given libraryName
.
Get a ToggleMap for the given libraryName
.
if multiple matching service loaded implementations are
found, this will fail with an java.lang.IllegalStateException
.
The names must be in fully-qualified form to avoid
collisions, e.g. "com.twitter.finagle". Valid characters are
A-Z
, a-z
, 0-9
, _
, -
, .
.
used to record the outcomes of Toggles. For general usage this should not be scoped so that the metrics always end up scoped to "toggles/$libraryName".
If a given libraryName
has already been loaded, only a single instance
will always be returned for all calls to apply (even if the StatsReceiver
differs).
Returns all registered ToggleMaps that have been
created by apply, keyed by libraryName
.
A ToggleMap that is the composition of multiple underlying ToggleMap implementations in a specific ordering designed to balance control between the operators/service-owners and the library owners.
The ordering is as such:
GlobalFlag
-backed ToggleMap, provided via ToggleMap.flags.The expectation is that 1, 2, and 3 give service-owners/operators the tools to operate and test toggles while library owners would have control over 4 and 5. Flags and in-memory settings allow for rapid testing and overrides while file-based configs are for static configuration owners have settled on.
The JSON file-based configuration works via Java resources and must be placed in specific locations in your classpath's resources:
resources/com/twitter/toggles/configs/
. The file-names take the form$libraryName.json
for the library owner's configuration and$libraryName-service.json
for the service owner's configuration. As an example, finagle-core would have aresources/com/twitter/toggles/configs/com.twitter.finagle.json
and service owners can customize toggles viaresources/com/twitter/toggles/configs/com.twitter.finagle-service.json
.The JSON files also support optional environment-specific overrides via files that are examined before the non-environment-specific configs. These environment-specific configs must be placed at
resources/com/twitter/toggles/configs/com.twitter.finagle-$environment.json
orresources/com/twitter/toggles/configs/com.twitter.finagle-service-$environment.json
where theenvironment
from com.twitter.finagle.server.ServerInfo$.apply is used to determine which one to load.