object StandardToggleMap
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:
- A mutable, in-process ToggleMap.Mutable.
- The
GlobalFlag
-backed ToggleMap, provided via ToggleMap.flags. - The service-owner controlled JSON file-based ToggleMap, provided via JsonToggleMap.
- The dynamically loaded ToggleMap, provided via ServiceLoadedToggleMap.apply.
- The library-owner controlled JSON file-based ToggleMap, provided via JsonToggleMap.
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 a
resources/com/twitter/toggles/configs/com.twitter.finagle.json
and service
owners can customize toggles via
resources/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
or resources/com/twitter/toggles/configs/com.twitter.finagle-service-$environment.json
where the environment
from com.twitter.finagle.server.ServerInfo$.apply is used to determine which
one to load.
- Alphabetic
- By Inheritance
- StandardToggleMap
- AnyRef
- Any
- Hide All
- Show All
- Public
- Protected
Value Members
- final def !=(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- final def ##: Int
- Definition Classes
- AnyRef → Any
- final def ==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- def apply(libraryName: String, statsReceiver: StatsReceiver, duplicateHandling: DuplicateHandling = JsonToggleMap.FailParsingOnDuplicateId): Mutable
Get a ToggleMap for the given
libraryName
.Get a ToggleMap for the given
libraryName
.- 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 areA-Z
,a-z
,0-9
,_
,-
,.
.- statsReceiver
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".
- Note
If a given
libraryName
has already been loaded, only a single instance will always be returned for all calls to apply (even if theStatsReceiver
differs).
- final def asInstanceOf[T0]: T0
- Definition Classes
- Any
- def clone(): AnyRef
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.CloneNotSupportedException]) @native()
- final def eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- def equals(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef → Any
- def finalize(): Unit
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.Throwable])
- final def getClass(): Class[_ <: AnyRef]
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
- def hashCode(): Int
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
- final def isInstanceOf[T0]: Boolean
- Definition Classes
- Any
- final def ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- final def notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
- final def notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
- def registeredLibraries: Map[String, Mutable]
Returns all registered ToggleMaps that have been created by apply, keyed by
libraryName
. - final def synchronized[T0](arg0: => T0): T0
- Definition Classes
- AnyRef
- def toString(): String
- Definition Classes
- AnyRef → Any
- final def wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- final def wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- final def wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException]) @native()