Class

com.twitter.server.handler

ToggleHandler

Related Doc: package handler

Permalink

class ToggleHandler extends Service[Request, Response]

Admin UI for seeing and modifying the server's com.twitter.finagle.toggle.Toggles.

This handler should be available at "/admin/toggles".

GET requests shows the current state of all StandardToggleMaps. Requests should be of the form "/admin/toggles{/$libraryName}{/$id}". Note that the library name and toggle id components are optional but do allow for filtering the output on those constraints. The output is JSON and it looks roughly like:

{
  "libraries": [
    {
      "libraryName" : "$libraryName",
      "toggles" : [
        {
          "current" : {
            "id" : "$id",
            "fraction" : $fraction,
            "description" : "$description"
          },
          "components" : [
            {
              "source" : "$ToggleMapSource",
              "fraction" : $fraction
            },
            { <other sources here> }
          ]
        },
        { <other toggles here> }
      ]
    },
    { <other libraries here> }
  ]
}

There will be a hash for each library registered with com.twitter.finagle.toggle.StandardToggleMap. For each Toggle the "current" hash shows the current configuration while the "components" array has a hash per ToggleMap source. These are ordered by evaluation order and as such, sources earlier in a component array are used first.

PUT requests allow for update/create of the mutable Toggles while DELETE requests allow for removal. These apply only to the ToggleMap.Mutable within a StandardToggleMap. Requests must be of the form "/admin/toggles/$libraryName/$id". For create and update, and an additional "fraction" request parameter must be set as well.

Linear Supertypes
Service[Request, Response], Closable, (Request) ⇒ Future[Response], AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. ToggleHandler
  2. Service
  3. Closable
  4. Function1
  5. AnyRef
  6. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new ToggleHandler()

    Permalink

Value Members

  1. final def !=(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any

  2. final def ##(): Int

    Permalink
    Definition Classes
    AnyRef → Any

  3. final def ==(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any

  4. def andThen[A](g: (Future[Response]) ⇒ A): (Request) ⇒ A

    Permalink
    Definition Classes
    Function1
    Annotations
    @unspecialized()

  5. def apply(req: Request): Future[Response]

    Permalink
    Definition Classes
    ToggleHandler → Service → Function1

  6. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any

  7. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  8. def close(deadline: Time): Future[Unit]

    Permalink
    Definition Classes
    Service → Closable

  9. def close(after: Duration): Future[Unit]

    Permalink
    Definition Classes
    Closable

  10. final def close(): Future[Unit]

    Permalink
    Definition Classes
    Closable

  11. def compose[A](g: (A) ⇒ Request): (A) ⇒ Future[Response]

    Permalink
    Definition Classes
    Function1
    Annotations
    @unspecialized()

  12. final def eq(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef

  13. def equals(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any

  14. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )

  15. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any

  16. def hashCode(): Int

    Permalink
    Definition Classes
    AnyRef → Any

  17. final def isAvailable: Boolean

    Permalink
    Definition Classes
    Service

  18. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any

  19. def map[Req1](f: (Req1) ⇒ Request): Service[Req1, Response]

    Permalink
    Definition Classes
    Service

  20. final def ne(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef

  21. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef

  22. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef

  23. def status: Status

    Permalink
    Definition Classes
    Service

  24. final def synchronized[T0](arg0: ⇒ T0): T0

    Permalink
    Definition Classes
    AnyRef

  25. def toString(): String

    Permalink
    Definition Classes
    Service → Function1 → AnyRef → Any

  26. final def wait(): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  27. final def wait(arg0: Long, arg1: Int): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  28. final def wait(arg0: Long): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Inherited from Service[Request, Response]

Inherited from Closable

Inherited from (Request) ⇒ Future[Response]

Inherited from AnyRef

Inherited from Any

Ungrouped