Public

.. _metrics_stats_filter:

StatsFilter <<<<<<<<<<<

requests A counter of the total number of successes + failures.

success A counter of the total number of successes.

request_latency_ms A histogram of the latency of requests in milliseconds.

pending A gauge of the current total number of outstanding requests.

failures/<exception_name>+ A counter of the number of times a specific exception has been thrown. If you are using a ResponseClassifier that classifies non-Exceptions as failures, it will use a synthetic Exception, com.twitter.finagle.service.ResponseClassificationSyntheticException, to account for these. See the FAQ <https://twitter.github.io/finagle/guide/FAQ.html#what-is-a-com-twitter-finagle-service-responseclassificationsyntheticexception>_ for more details.

failures A counter of the number of times any failure has been observed.

sourcedfailures/<source_service_name>{/<exception_name>}+ A counter of the number of times a specific :src:SourcedException <com/twitter/finagle/Exceptions.scala> or sourced :src:Failure <com/twitter/finagle/Failure.scala> has been thrown. Sourced failures include additional information on what service caused the failure.

sourcedfailures/<source_service_name> A counter of the number of times any :src:SourcedException <com/twitter/finagle/Exceptions.scala> or sourced :src:Failure <com/twitter/finagle/Failure.scala> has been thrown from this service. Sourced failures include additional information on what service caused the failure.

sourcedfailures A counter of the number of times any :src:SourcedException <com/twitter/finagle/Exceptions.scala> or sourced :src:Failure <com/twitter/finagle/Failure.scala> has been thrown. Sourced failures include additional information on what service caused the failure.

StatsFactoryWrapper <<<<<<<<<<<<<<<<<<<

.. _service_factory_failures:

failures/<exception_class_name> A counter of the number of times :doc:Service <ServicesAndFilters> creation has failed with this specific exception.

failures A counter of the number of times :doc:Service <ServicesAndFilters> creation has failed.

service_acquisition_latency_ms A stat of the latency, in milliseconds, to acquire a service (a session). This entails an amortized cost of materializing a connection for each request, either by establishing new (slow path) or by checking it out from the connection pool (fast path).

In the worst case (establishing a connection on each request), this histogram converges on connect_latency_ms (socket connect latency, including SSL/TLS handshaking). In the best case, this represents a cost of acquiring connection from the pool.

ServerStatsFilter <<<<<<<<<<<<<<<<<

handletime_us A stat of the time it takes to handle the request in microseconds. This is how long it takes to set up the chain of Future\s to be used in the response without waiting for the response. Large values suggest blocking code on a Finagle thread.

transit_latency_ms A stat that attempts to measure (wall time) transit times between hops, e.g., from client to server. Be aware that clock drift between hosts, stop the world pauses, and queue backups can contribute here. Not supported by all protocols.

request_classification/total Counter of the total number of requests, including those with responses flagged Ignorable. This can be used as a denominator when calculating the fraction of requests that are retries, requeues, or backups (see counters below).

request_classification/retry Counter of the number of requests received that are retries.

request_classification/requeue Counter of the number of requests received that are requeues (e.g., retried NACKs).

request_classification/backup Counter of the number of requests that are backups.

RequestSemaphoreFilter <<<<<<<<<<<<<<<<<<<<<<

.. _requests_concurrency_limit:

request_concurrency A gauge of the total number of current concurrent requests.

request_queue_size A gauge of the total number of requests which are waiting because of the limit on simultaneous requests.

PayloadSizeFilter (enabled for Mux, HTTP, Thrift) <<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<

request_payload_bytes verbosity:debug A histogram of the number of bytes per request's payload.

response_payload_bytes verbosity:debug A histogram of the number of bytes per response's payload.