handler

Type Members

class AbortHandler extends Service[Request, Response]
class AdminRedirectHandler extends Service[Request, Response]
class AnnouncerHandler extends Service[Request, Response]

class AttachedClientsHandler extends Service[Request, Response]

A handler that reports information about connected clients, by server.

A handler that reports information about connected clients, by server. For example:

{
  "servers": [
    {
      "address": "127.0.0.1:8080",
      "clients": [
        {
          "address": "127.0.0.1:9090",
          "ssl": {
            "session_id": "sessionid",
            "cipher_suite": "cipher?sweeeeet!",
            "peer_certificate": {
              "common_name": "remoteprincipal"
            }
          }
        }
      ]
    }
  ]
}

class ClientRegistryHandler extends Service[Request, Response]

Renders information about clients registered to Finagle's ClientRegistry in an html fragment.
Renders information about clients registered to Finagle's ClientRegistry in an html fragment. Clients can be queried by passing in the client name as part of the uri (ex. "/admin/clients/myclient").
class ContentionHandler extends Service[Request, Response]
final class DtabHandler extends Service[Request, Response]

Dumps a simple JSON string representation of the current com.twitter.finagle.Dtab.base.
Dumps a simple JSON string representation of the current com.twitter.finagle.Dtab.base.
From the Dtab docs: A Dtab--short for delegation table--comprises a sequence of delegation rules. Together, these describe how to bind a path to an Addr.
```
{
  "dtab": [
    "/srv => /srv#/production",
    "/srv => /srv#/prod",
    "/s => /srv/local",
    "/$/inet => /$/nil",
    "/zk => /$/nil"
  ]
}
```
See also
com.twitter.finagle.Dtab
class FailedLintRuleHandler extends Service[Request, Response]

Renders failed lint rule alert in an html fragment onto /admin/failedlint.
class HeapResourceHandler extends Service[Request, Response]
class IndexHandler extends Service[Request, Response]

A handler which outputs patterns as html anchors.
A handler which outputs patterns as html anchors. By default, it outputs the patterns from the globals com.twitter.finagle.http.HttpMuxer and com.twitter.finagle.http.HttpMuxer.
class LintHandler extends Service[Request, Response]

UI for running the globally registered lint Rules.
final class LoadBalancersHandler extends Service[Request, Response]

Renders information about clients registered in Finagle's BalancerRegistry.
Renders information about clients registered in Finagle's BalancerRegistry.
Filtering by client label is supported by passing a "label" query string param. e.g. "/admin/balancers.json?label=cool_service"
class MetricQueryHandler extends Service[Request, Response]

A handler which accepts metrics queries via http query strings and returns json encoded metrics.
class MetricTypeQueryHandler extends Service[Request, Response]

A handler which accepts metrics metadata queries via http query strings and returns json encoded metrics with their types and an indicator of whether or not counters are latched.
A handler which accepts metrics metadata queries via http query strings and returns json encoded metrics with their types and an indicator of whether or not counters are latched.
This is a temporary endpoint which will be replaced by a more fleshed out metadata endpoint.

Note
When passing an explicit histogram metric via ?m=, users must provide the raw histogram name, no percentile (eg, .p99) appended. Example Request: http://$HOST:$PORT/admin/exp/metric_metadata?m=srv/http/requests&m=srv/http/pending&m=srv/mux/framer/write_stream_bytes Response: { "latched" : true, "metrics" : [ { "name" : "srv/http/requests", "kind" : "counter" }, { "name" : "srv/http/pending", "kind" : "gauge" }, { "name" : "srv/mux/framer/write_stream_bytes", "kind" : "histogram" } ] }
class NoLoggingHandler extends Service[Request, Response]
class ProfileResourceHandler extends Service[Request, Response]
class RegistryHandler extends Service[Request, Response]

A com.twitter.finagle.Service for displaying the current state of the registry.
A com.twitter.finagle.Service for displaying the current state of the registry.
It's intended to be used as a handler for TwitterServer. As an admin endpoint, it displays the GlobalRegistry in JSON format.
It takes an optional HTTP request parameter, "filter", which allows for simple filtering of the returned data.
See the user guide for additional details.
class ReplyHandler extends Service[Request, Response]
class ResourceHandler extends Service[Request, Response]

A handler designed to serve static resources.
class ServerInfoHandler extends Service[Request, Response]

A simple http service for serving up information pulled from a build.properties file.
class ServerRegistryHandler extends Service[Request, Response]

Renders information about servers registered to Finagle's ServerRegistry in an html fragment.
Renders information about servers registered to Finagle's ServerRegistry in an html fragment. Servers can be queried by passing in the server name as part of the uri (ex. "/admin/servers/myserver").
class ShutdownHandler extends Service[Request, Response]
class SummaryHandler extends Service[Request, Response]
class ThreadsHandler extends Service[Request, Response]

"Controller" for displaying the current state of threads.
"Controller" for displaying the current state of threads.
Possibilities for future endeavors in the web ui: - group threads by "similarity" - provide a mechanism for exp/imp - javascript control for searching within stacktraces

See also
ThreadsView
class ToggleHandler extends Service[Request, Response]

Admin UI for seeing and modifying the server's com.twitter.finagle.toggle.Toggles.
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.
class TracingHandler extends Service[Request, Response]
class TunableHandler extends Service[Request, Response]

In-memory Tunables can be manipulated using the endpoint /admin/tunables/.
In-memory Tunables can be manipulated using the endpoint /admin/tunables/. PUT and DELETE requests to update the Tunables for a given id should be made to /admin/tunables/$id and have a JSON body in the same format as a Tunable configuration file:
{ "tunables": [ { "id" : "$id1", "value" : $value, "type" : "$class" }, { "id" : "$id2", "value" : $value, "type" : "$class" } ] }
In the case of a PUT, these Tunables will be updated or added for the TunableMap corresponding to id. Note that this PUT request will *not* cause any existing Tunables to be removed.
In the case of a DELETE, these Tunables will cleared from the TunableMap corresponding to id. The Tunables are keyed by "id" and "type"; the "value" for each of Tunables to delete can be any valid value for this Tunable. Because the value of a Tunable is the result of a composition of TunableMaps (see StandardTunableMap), deleting an in-memory Tunable will cause the value from the composition of the other TunableMaps to be used.
trait TwitterHandler extends Service[Request, Response]

package handler

Type Members

class AbortHandler extends Service[Request, Response]

class AdminRedirectHandler extends Service[Request, Response]

class AnnouncerHandler extends Service[Request, Response]

class AttachedClientsHandler extends Service[Request, Response]

class ClientRegistryHandler extends Service[Request, Response]

class ContentionHandler extends Service[Request, Response]

final class DtabHandler extends Service[Request, Response]

class FailedLintRuleHandler extends Service[Request, Response]

class HeapResourceHandler extends Service[Request, Response]

class IndexHandler extends Service[Request, Response]

class LintHandler extends Service[Request, Response]

final class LoadBalancersHandler extends Service[Request, Response]

class MetricQueryHandler extends Service[Request, Response]

class MetricTypeQueryHandler extends Service[Request, Response]

class NoLoggingHandler extends Service[Request, Response]

class ProfileResourceHandler extends Service[Request, Response]

class RegistryHandler extends Service[Request, Response]

class ReplyHandler extends Service[Request, Response]

class ResourceHandler extends Service[Request, Response]

class ServerInfoHandler extends Service[Request, Response]

class ServerRegistryHandler extends Service[Request, Response]

class ShutdownHandler extends Service[Request, Response]

class SummaryHandler extends Service[Request, Response]

class ThreadsHandler extends Service[Request, Response]

class ToggleHandler extends Service[Request, Response]

class TracingHandler extends Service[Request, Response]

class TunableHandler extends Service[Request, Response]

trait TwitterHandler extends Service[Request, Response]

Value Members

object HistogramQueryHandler

object ResourceHandler

object TunableHandler

Ungrouped