Package org.apache.beam.io.requestresponse

Class Monitoring

java.lang.Object
org.apache.beam.io.requestresponse.Monitoring
All Implemented Interfaces:
Serializable
public abstract class Monitoring extends Object implements Serializable
Configures Metrics throughout various features of RequestResponseIO. By default, all monitoring is turned off. 
 Cache metrics are not yet supported. See https://github.com/apache/beam/issues/29888
See Also:

  • Constructor Details

    • Monitoring

      public Monitoring()

  • Method Details

    • builder

      public static Monitoring.Builder builder()

    • getCountRequests

      public abstract boolean getCountRequests()
      Count incoming request elements processed by Call's DoFn.

    • getCountResponses

      public abstract boolean getCountResponses()
      Count outgoing responses resulting from Call's successful Caller invocation.

    • getCountCalls

      public abstract boolean getCountCalls()
      Count invocations of Caller.call(RequestT).

    • getCountFailures

      public abstract boolean getCountFailures()
      Count failures resulting from Call's successful Caller invocation.

    • getCountSetup

      public abstract boolean getCountSetup()
      Count invocations of SetupTeardown.setup().

    • getCountTeardown

      public abstract boolean getCountTeardown()
      Count invocations of SetupTeardown.teardown().

    • getCountBackoffs

      public abstract boolean getCountBackoffs()
      Count invocations of BackOff.nextBackOffMillis().

    • getCountSleeps

      public abstract boolean getCountSleeps()
      Count invocations of Sleeper.sleep(long).

    • getCountShouldBackoff

      public abstract boolean getCountShouldBackoff()
      Count when CallShouldBackoff.isTrue() is found true.

    • getCountCacheReadRequests

      public abstract boolean getCountCacheReadRequests()
      Count number of attempts to read from the Cache.

    • getCountCacheReadNulls

      public abstract boolean getCountCacheReadNulls()
      Count associated null values resulting from Cache reads.

    • getCountCacheReadNonNulls

      public abstract boolean getCountCacheReadNonNulls()
      Count associated non-null values resulting from Cache reads.

    • getCountCacheReadFailures

      public abstract boolean getCountCacheReadFailures()
      Count Cache read failures.

    • getCountCacheWriteRequests

      public abstract boolean getCountCacheWriteRequests()
      Count number of attempts to write to the Cache.

    • getCountCacheWriteSuccesses

      public abstract boolean getCountCacheWriteSuccesses()
      Count Cache write successes.

    • getCountCacheWriteFailures

      public abstract boolean getCountCacheWriteFailures()
      Count Cache write failures.

    • withEverythingCounted

      public Monitoring withEverythingCounted()
      Turns on all monitoring. The purpose of this method is, when used with toBuilder() and other setters, to turn everything on except for a few select counters.

    • withEverythingCountedExceptedCaching

      public Monitoring withEverythingCountedExceptedCaching()
      Turns on all monitoring except for cache related metrics.

    • toBuilder

      public abstract Monitoring.Builder toBuilder()