Monitoring (Apache Beam 2.56.0)

java.lang.Object
- org.apache.beam.io.requestresponse.Monitoring

All Implemented Interfaces:: java.io.Serializable

public abstract class Monitoring
extends java.lang.Object
implements java.io.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:: Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class Monitoring.Builder

Nested Classes
Modifier and Type	Class and Description
`static class`	`Monitoring.Builder`

Constructor Summary

Constructors
Constructor and Description

Monitoring()

Constructors
Constructor and Description
`Monitoring()`

Method Summary

All Methods Static Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`static Monitoring.Builder`	`builder()`
`abstract java.lang.Boolean`	`getCountBackoffs()` Count invocations of `BackOff.nextBackOffMillis()`.
`abstract java.lang.Boolean`	`getCountCacheReadFailures()` Count `Cache` read failures.
`abstract java.lang.Boolean`	`getCountCacheReadNonNulls()` Count associated non-null values resulting from `Cache` reads.
`abstract java.lang.Boolean`	`getCountCacheReadNulls()` Count associated null values resulting from `Cache` reads.
`abstract java.lang.Boolean`	`getCountCacheReadRequests()` Count number of attempts to read from the `Cache`.
`abstract java.lang.Boolean`	`getCountCacheWriteFailures()` Count `Cache` write failures.
`abstract java.lang.Boolean`	`getCountCacheWriteRequests()` Count number of attempts to write to the `Cache`.
`abstract java.lang.Boolean`	`getCountCacheWriteSuccesses()` Count `Cache` write successes.
`abstract java.lang.Boolean`	`getCountCalls()` Count invocations of `Caller.call(RequestT)`.
`abstract java.lang.Boolean`	`getCountFailures()` Count failures resulting from `Call`'s successful `Caller` invocation.
`abstract java.lang.Boolean`	`getCountRequests()` Count incoming request elements processed by `Call`'s `DoFn`.
`abstract java.lang.Boolean`	`getCountResponses()` Count outgoing responses resulting from `Call`'s successful `Caller` invocation.
`abstract java.lang.Boolean`	`getCountSetup()` Count invocations of `SetupTeardown.setup()`.
`abstract java.lang.Boolean`	`getCountShouldBackoff()` Count when `CallShouldBackoff.isTrue()` is found true.
`abstract java.lang.Boolean`	`getCountSleeps()` Count invocations of `Sleeper.sleep(long)`.
`abstract java.lang.Boolean`	`getCountTeardown()` Count invocations of `SetupTeardown.teardown()`.
`abstract Monitoring.Builder`	`toBuilder()`
`Monitoring`	`withEverythingCounted()` Turns on all monitoring.
`Monitoring`	`withEverythingCountedExceptedCaching()` Turns on all monitoring except for cache related metrics.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - Monitoring
```
public Monitoring()
```
- Method Detail
  - builder
```
public static Monitoring.Builder builder()
```
  - getCountRequests
```
public abstract java.lang.Boolean getCountRequests()
```
    Count incoming request elements processed by Call's DoFn.
  - getCountResponses
```
public abstract java.lang.Boolean getCountResponses()
```
    Count outgoing responses resulting from Call's successful Caller invocation.
  - getCountCalls
```
public abstract java.lang.Boolean getCountCalls()
```
    Count invocations of Caller.call(RequestT).
  - getCountFailures
```
public abstract java.lang.Boolean getCountFailures()
```
    Count failures resulting from Call's successful Caller invocation.
  - getCountSetup
```
public abstract java.lang.Boolean getCountSetup()
```
    Count invocations of SetupTeardown.setup().
  - getCountTeardown
```
public abstract java.lang.Boolean getCountTeardown()
```
    Count invocations of SetupTeardown.teardown().
  - getCountBackoffs
```
public abstract java.lang.Boolean getCountBackoffs()
```
    Count invocations of BackOff.nextBackOffMillis().
  - getCountSleeps
```
public abstract java.lang.Boolean getCountSleeps()
```
    Count invocations of Sleeper.sleep(long).
  - getCountShouldBackoff
```
public abstract java.lang.Boolean getCountShouldBackoff()
```
    Count when CallShouldBackoff.isTrue() is found true.
  - getCountCacheReadRequests
```
public abstract java.lang.Boolean getCountCacheReadRequests()
```
    Count number of attempts to read from the Cache.
  - getCountCacheReadNulls
```
public abstract java.lang.Boolean getCountCacheReadNulls()
```
    Count associated null values resulting from Cache reads.
  - getCountCacheReadNonNulls
```
public abstract java.lang.Boolean getCountCacheReadNonNulls()
```
    Count associated non-null values resulting from Cache reads.
  - getCountCacheReadFailures
```
public abstract java.lang.Boolean getCountCacheReadFailures()
```
    Count Cache read failures.
  - getCountCacheWriteRequests
```
public abstract java.lang.Boolean getCountCacheWriteRequests()
```
    Count number of attempts to write to the Cache.
  - getCountCacheWriteSuccesses
```
public abstract java.lang.Boolean getCountCacheWriteSuccesses()
```
    Count Cache write successes.
  - getCountCacheWriteFailures
```
public abstract java.lang.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()
```

Class Monitoring

Nested Class Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Monitoring

Method Detail

builder

getCountRequests

getCountResponses

getCountCalls

getCountFailures

getCountSetup

getCountTeardown

getCountBackoffs

getCountSleeps

getCountShouldBackoff

getCountCacheReadRequests

getCountCacheReadNulls

getCountCacheReadNonNulls

getCountCacheReadFailures

getCountCacheWriteRequests

getCountCacheWriteSuccesses

getCountCacheWriteFailures

withEverythingCounted

withEverythingCountedExceptedCaching

toBuilder