MetricsCollectingExecutionListener (DataStax Bulk Loader 1.8.0 API)

java.lang.Object
- com.datastax.oss.dsbulk.executor.api.listener.MetricsCollectingExecutionListener

All Implemented Interfaces:

ExecutionListener
```
public class MetricsCollectingExecutionListener
extends Object
implements ExecutionListener
```
A ExecutionListener that records useful metrics about the ongoing bulk operations.

Constructor Summary

Constructors
Constructor and Description
`MetricsCollectingExecutionListener()` Creates a new instance using a newly-allocated `MetricRegistry`.
`MetricsCollectingExecutionListener(com.codahale.metrics.MetricRegistry registry, ProtocolVersion protocolVersion, CodecRegistry codecRegistry, boolean trackThroughputInBytes)` Creates a new instance using the given `MetricRegistry`.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Optional<com.codahale.metrics.Meter>`	`getBytesReceivedMeter()` Returns a `Meter` that evaluates the total number of bytes received so far.
`Optional<com.codahale.metrics.Meter>`	`getBytesSentMeter()` Returns a `Meter` that evaluates the total number of bytes sent so far.
`com.codahale.metrics.Counter`	`getFailedReadsCounter()` Returns a `Counter` that evaluates the duration of execution of failed reads.
`com.codahale.metrics.Counter`	`getFailedReadsWritesCounter()` Returns a `Counter` that evaluates the duration of execution of all failed operations, including reads and writes.
`com.codahale.metrics.Counter`	`getFailedStatementsCounter()` Returns a `Counter` for failed statement executions.
`com.codahale.metrics.Counter`	`getFailedWritesCounter()` Returns a `Counter` that evaluates the duration of execution of failed writes.
`com.codahale.metrics.Counter`	`getInFlightRequestsCounter()` Returns a `Counter` that evaluates the number of current in-flight requests, i.e.
`com.codahale.metrics.MetricRegistry`	`getRegistry()` Returns the `MetricRegistry` used to aggregate metrics for this listener.
`com.codahale.metrics.Counter`	`getSuccessfulReadsCounter()` Returns a `Counter` that evaluates the duration of execution of successful reads.
`com.codahale.metrics.Counter`	`getSuccessfulReadsWritesCounter()` Returns a `Counter` that evaluates the duration of execution of all successful operations, including reads and writes.
`com.codahale.metrics.Counter`	`getSuccessfulStatementsCounter()` Returns a `Counter` for successful statement executions.
`com.codahale.metrics.Counter`	`getSuccessfulWritesCounter()` Returns a `Counter` that evaluates the duration of execution of successful writes.
`com.codahale.metrics.Timer`	`getTotalReadsTimer()` Returns a `Timer` that evaluates the duration of execution of reads, both successful and failed.
`com.codahale.metrics.Timer`	`getTotalReadsWritesTimer()` Returns a `Timer` that evaluates the duration of execution of all operations, including reads and writes, both successful and failed.
`com.codahale.metrics.Timer`	`getTotalStatementsTimer()` Returns a `Timer` for total statement executions (successful and failed).
`com.codahale.metrics.Timer`	`getTotalWritesTimer()` Returns a `Timer` that evaluates the duration of execution of writes, both successful and failed.
`void`	`onExecutionFailed(BulkExecutionException exception, ExecutionContext context)` Called when a statement execution has failed.
`void`	`onExecutionSuccessful(Statement<?> statement, ExecutionContext context)` Called when a statement has been successfully executed.
`void`	`onReadRequestFailed(Statement<?> statement, Throwable error, ExecutionContext context)` Called when a read request has failed.
`void`	`onReadRequestStarted(Statement<?> statement, ExecutionContext context)` Called when a read request is about to be sent.
`void`	`onReadRequestSuccessful(Statement<?> statement, ExecutionContext context)` Called when a read request has been completed successfully.
`void`	`onRowReceived(Row row, ExecutionContext context)` Called when a row has been successfully received.
`void`	`onWriteRequestFailed(Statement<?> statement, Throwable error, ExecutionContext context)` Called when a write request has failed.
`void`	`onWriteRequestStarted(Statement<?> statement, ExecutionContext context)` Called when a write request is about to be sent.
`void`	`onWriteRequestSuccessful(Statement<?> statement, ExecutionContext context)` Called when a write request has been completed successfully.

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

Methods inherited from interface com.datastax.oss.dsbulk.executor.api.listener.ExecutionListener
onExecutionStarted

- Constructor Detail
  - MetricsCollectingExecutionListener
```
public MetricsCollectingExecutionListener()
```
    Creates a new instance using a newly-allocated MetricRegistry.
  - MetricsCollectingExecutionListener
```
public MetricsCollectingExecutionListener(com.codahale.metrics.MetricRegistry registry,
                                          ProtocolVersion protocolVersion,
                                          CodecRegistry codecRegistry,
                                          boolean trackThroughputInBytes)
```
    Creates a new instance using the given MetricRegistry.
    
    Parameters:
    
    registry - The MetricRegistry to use.
    
    protocolVersion - the ProtocolVersion to use.
    
    codecRegistry - the CodecRegistry to use.
    
    trackThroughputInBytes - Whether to track throughput in bytes or not.
- Method Detail
  - getRegistry
```
public com.codahale.metrics.MetricRegistry getRegistry()
```
    Returns the MetricRegistry used to aggregate metrics for this listener.
    
    Returns:
    
    the MetricRegistry used to aggregate metrics for this listener.
  - getTotalStatementsTimer
```
public com.codahale.metrics.Timer getTotalStatementsTimer()
```
    Returns a Timer for total statement executions (successful and failed).
    A batch statement is counted as one single statement. If that's not what you want, you are probably looking for getTotalWritesTimer().
    
    Returns:
    
    a Timer for total statement executions (successful and failed).
  - getSuccessfulStatementsCounter
```
public com.codahale.metrics.Counter getSuccessfulStatementsCounter()
```
    Returns a Counter for successful statement executions.
    A batch statement is counted as one single statement. If that's not what you want, you are probably looking for getSuccessfulWritesCounter().
    
    Returns:
    
    a Counter for successful statement executions.
  - getFailedStatementsCounter
```
public com.codahale.metrics.Counter getFailedStatementsCounter()
```
    Returns a Counter for failed statement executions.
    A batch statement is counted as one single statement. If that's not what you want, you are probably looking for getFailedWritesCounter().
    
    Returns:
    
    a Counter for failed statement executions.
  - getTotalReadsTimer
```
public com.codahale.metrics.Timer getTotalReadsTimer()
```
    Returns a Timer that evaluates the duration of execution of reads, both successful and failed.
    
    Returns:
    
    a Timer that evaluates the duration of execution of reads, both successful and failed.
  - getSuccessfulReadsCounter
```
public com.codahale.metrics.Counter getSuccessfulReadsCounter()
```
    Returns a Counter that evaluates the duration of execution of successful reads.
    
    Returns:
    
    a Counter that evaluates the duration of execution of successful reads.
  - getFailedReadsCounter
```
public com.codahale.metrics.Counter getFailedReadsCounter()
```
    Returns a Counter that evaluates the duration of execution of failed reads.
    
    Returns:
    
    a Counter that evaluates the duration of execution of failed reads.
  - getTotalWritesTimer
```
public com.codahale.metrics.Timer getTotalWritesTimer()
```
    Returns a Timer that evaluates the duration of execution of writes, both successful and failed.
    A batch statement is counted as many times as the number of child statements it contains. If that's not what you want, you are probably looking for getTotalStatementsTimer().
    
    Returns:
    
    a Timer that evaluates the duration of execution of writes, both successful and failed.
  - getSuccessfulWritesCounter
```
public com.codahale.metrics.Counter getSuccessfulWritesCounter()
```
    Returns a Counter that evaluates the duration of execution of successful writes.
    A batch statement is counted as many times as the number of child statements it contains. If that's not what you want, you are probably looking for getSuccessfulStatementsCounter().
    
    Returns:
    
    a Counter that evaluates the duration of execution of successful writes.
  - getFailedWritesCounter
```
public com.codahale.metrics.Counter getFailedWritesCounter()
```
    Returns a Counter that evaluates the duration of execution of failed writes.
    A batch statement is counted as many times as the number of child statements it contains. If that's not what you want, you are probably looking for getFailedStatementsCounter().
    
    Returns:
    
    a Counter that evaluates the duration of execution of failed writes.
  - getTotalReadsWritesTimer
```
public com.codahale.metrics.Timer getTotalReadsWritesTimer()
```
    Returns a Timer that evaluates the duration of execution of all operations, including reads and writes, both successful and failed.
    
    Returns:
    
    a Timer that evaluates the duration of execution of all operations.
  - getSuccessfulReadsWritesCounter
```
public com.codahale.metrics.Counter getSuccessfulReadsWritesCounter()
```
    Returns a Counter that evaluates the duration of execution of all successful operations, including reads and writes.
    
    Returns:
    
    a Counter that evaluates the duration of execution of all successful operations.
  - getFailedReadsWritesCounter
```
public com.codahale.metrics.Counter getFailedReadsWritesCounter()
```
    Returns a Counter that evaluates the duration of execution of all failed operations, including reads and writes.
    
    Returns:
    
    a Counter that evaluates the duration of execution of all failed operations.
  - getInFlightRequestsCounter
```
public com.codahale.metrics.Counter getInFlightRequestsCounter()
```
    Returns a Counter that evaluates the number of current in-flight requests, i.e. the number of uncompleted futures waiting for a response from the server.
    
    Returns:
    
    a Counter that evaluates the number of current in-flight requests.
  - getBytesSentMeter
```
public Optional<com.codahale.metrics.Meter> getBytesSentMeter()
```
    Returns a Meter that evaluates the total number of bytes sent so far.
    Note that this counter's value is an estimate of the actual amount of data sent; it might be inaccurate or even zero, if the data size cannot be calculated.
    
    Returns:
    
    a Meter that evaluates the total number of bytes sent so far.
  - getBytesReceivedMeter
```
public Optional<com.codahale.metrics.Meter> getBytesReceivedMeter()
```
    Returns a Meter that evaluates the total number of bytes received so far.
    Note that this counter's value is an estimate of the actual amount of data received; it might be inaccurate or even zero, if the data size cannot be calculated.
    
    Returns:
    
    a Meter that evaluates the total number of bytes received so far.
  - onWriteRequestStarted
```
public void onWriteRequestStarted(Statement<?> statement,
                                  ExecutionContext context)
```
    Description copied from interface: ExecutionListener
    
    Called when a write request is about to be sent.
    
    Specified by:
    
    onWriteRequestStarted in interface ExecutionListener
    
    Parameters:
    
    statement - the statement to execute.
    
    context - the local request execution context.
  - onReadRequestStarted
```
public void onReadRequestStarted(Statement<?> statement,
                                 ExecutionContext context)
```
    Description copied from interface: ExecutionListener
    
    Called when a read request is about to be sent.
    
    Specified by:
    
    onReadRequestStarted in interface ExecutionListener
    
    Parameters:
    
    statement - the statement to execute.
    
    context - the local request execution context.
  - onWriteRequestSuccessful
```
public void onWriteRequestSuccessful(Statement<?> statement,
                                     ExecutionContext context)
```
    Description copied from interface: ExecutionListener
    
    Called when a write request has been completed successfully.
    
    Specified by:
    
    onWriteRequestSuccessful in interface ExecutionListener
    
    Parameters:
    
    statement - the statement to execute.
    
    context - the local request execution context.
  - onWriteRequestFailed
```
public void onWriteRequestFailed(Statement<?> statement,
                                 Throwable error,
                                 ExecutionContext context)
```
    Description copied from interface: ExecutionListener
    
    Called when a write request has failed.
    
    Specified by:
    
    onWriteRequestFailed in interface ExecutionListener
    
    Parameters:
    
    statement - the statement to execute.
    
    error - the request execution error.
    
    context - the local request execution context.
  - onReadRequestSuccessful
```
public void onReadRequestSuccessful(Statement<?> statement,
                                    ExecutionContext context)
```
    Description copied from interface: ExecutionListener
    
    Called when a read request has been completed successfully.
    
    Specified by:
    
    onReadRequestSuccessful in interface ExecutionListener
    
    Parameters:
    
    statement - the statement to execute.
    
    context - the local request execution context.
  - onRowReceived
```
public void onRowReceived(Row row,
                          ExecutionContext context)
```
    Description copied from interface: ExecutionListener
    
    Called when a row has been successfully received. Applicable only for reads.
    Note: this method is called when the row is effectively read and emitted to downstream subscribers, which might be later than the moment when it was made available by the driver.
    
    Specified by:
    
    onRowReceived in interface ExecutionListener
    
    Parameters:
    
    row - the row.
    
    context - the local request execution context.
  - onReadRequestFailed
```
public void onReadRequestFailed(Statement<?> statement,
                                Throwable error,
                                ExecutionContext context)
```
    Description copied from interface: ExecutionListener
    
    Called when a read request has failed.
    
    Specified by:
    
    onReadRequestFailed in interface ExecutionListener
    
    Parameters:
    
    statement - the statement to execute.
    
    error - the request execution error.
    
    context - the local request execution context.
  - onExecutionSuccessful
```
public void onExecutionSuccessful(Statement<?> statement,
                                  ExecutionContext context)
```
    Description copied from interface: ExecutionListener
    
    Called when a statement has been successfully executed.
    
    Specified by:
    
    onExecutionSuccessful in interface ExecutionListener
    
    Parameters:
    
    statement - the executed statement.
    
    context - the global statement execution context.
  - onExecutionFailed
```
public void onExecutionFailed(BulkExecutionException exception,
                              ExecutionContext context)
```
    Description copied from interface: ExecutionListener
    
    Called when a statement execution has failed.
    
    Specified by:
    
    onExecutionFailed in interface ExecutionListener
    
    Parameters:
    
    exception - the error encountered.
    
    context - the statement execution context.

Class MetricsCollectingExecutionListener

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface com.datastax.oss.dsbulk.executor.api.listener.ExecutionListener

Constructor Detail

MetricsCollectingExecutionListener

MetricsCollectingExecutionListener

Method Detail

getRegistry

getTotalStatementsTimer

getSuccessfulStatementsCounter

getFailedStatementsCounter

getTotalReadsTimer

getSuccessfulReadsCounter

getFailedReadsCounter

getTotalWritesTimer

getSuccessfulWritesCounter

getFailedWritesCounter

getTotalReadsWritesTimer

getSuccessfulReadsWritesCounter

getFailedReadsWritesCounter

getInFlightRequestsCounter

getBytesSentMeter

getBytesReceivedMeter

onWriteRequestStarted

onReadRequestStarted

onWriteRequestSuccessful

onWriteRequestFailed

onReadRequestSuccessful

onRowReceived

onReadRequestFailed

onExecutionSuccessful

onExecutionFailed