Packages

o

com.twitter.finagle.toggle

StandardToggleMap

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:

  1. A mutable, in-process ToggleMap.Mutable.
  2. The GlobalFlag-backed ToggleMap, provided via ToggleMap.flags.
  3. The service-owner controlled JSON file-based ToggleMap, provided via JsonToggleMap.
  4. The dynamically loaded ToggleMap, provided via ServiceLoadedToggleMap.apply.
  5. 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.

Linear Supertypes
AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. StandardToggleMap
  2. AnyRef
  3. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. def apply(libraryName: String, statsReceiver: StatsReceiver): 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 are A-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 the StatsReceiver differs).

  5. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  6. def clone(): AnyRef
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @native() @throws( ... )
  7. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  8. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  9. def finalize(): Unit
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  10. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  11. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  12. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  13. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  14. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  15. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  16. def registeredLibraries: Map[String, Mutable]

    Returns all registered ToggleMaps that have been created by apply, keyed by libraryName.

  17. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  18. def toString(): String
    Definition Classes
    AnyRef → Any
  19. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  20. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  21. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @throws( ... )

Inherited from AnyRef

Inherited from Any

Ungrouped