com.datastax.oss.dsbulk.executor.api.listener

Class AbstractMetricsReportingExecutionListener

java.lang.Object

com.codahale.metrics.ScheduledReporter

com.datastax.oss.dsbulk.executor.api.listener.AbstractMetricsReportingExecutionListener

All Implemented Interfaces:

com.codahale.metrics.Reporter, ExecutionListener, Closeable, AutoCloseable

Direct Known Subclasses:

ReadsAndWritesReportingExecutionListener, ReadsReportingExecutionListener, StatementsReportingExecutionListener, WritesReportingExecutionListener

public abstract class AbstractMetricsReportingExecutionListener
extends com.codahale.metrics.ScheduledReporter
implements ExecutionListener

An ExecutionListener that reports useful metrics about ongoing bulk read and write operations. It relies on a delegate MetricsCollectingExecutionListener as its source of metrics.

Field Summary

Fields

Modifier and Type	Field and Description
protected static double	BYTES_PER_KB
protected static double	BYTES_PER_MB

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractMetricsReportingExecutionListener(MetricsCollectingExecutionListener delegate, String name, com.codahale.metrics.MetricFilter filter, TimeUnit rateUnit, TimeUnit durationUnit)
protected	AbstractMetricsReportingExecutionListener(MetricsCollectingExecutionListener delegate, String name, com.codahale.metrics.MetricFilter filter, TimeUnit rateUnit, TimeUnit durationUnit, ScheduledExecutorService scheduler)

Method Summary

Modifier and Type	Method and Description
void	onExecutionFailed(BulkExecutionException exception, ExecutionContext context) Called when a statement execution has failed.
void	onExecutionStarted(Statement<?> statement, ExecutionContext context) Called when a statement is about to be executed.
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 com.codahale.metrics.ScheduledReporter

close, convertDuration, convertRate, getDisabledMetricAttributes, getDurationUnit, getRateUnit, isShutdownExecutorOnStop, report, report, start, start, stop

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

BYTES_PER_KB

protected static final double BYTES_PER_KB

See Also:

Constant Field Values

BYTES_PER_MB

protected static final double BYTES_PER_MB

See Also:

Constant Field Values

Constructor Detail

AbstractMetricsReportingExecutionListener

protected AbstractMetricsReportingExecutionListener(MetricsCollectingExecutionListener delegate,
                                                    String name,
                                                    com.codahale.metrics.MetricFilter filter,
                                                    TimeUnit rateUnit,
                                                    TimeUnit durationUnit)

AbstractMetricsReportingExecutionListener

protected AbstractMetricsReportingExecutionListener(MetricsCollectingExecutionListener delegate,
                                                    String name,
                                                    com.codahale.metrics.MetricFilter filter,
                                                    TimeUnit rateUnit,
                                                    TimeUnit durationUnit,
                                                    ScheduledExecutorService scheduler)

Method Detail

onExecutionStarted

public void onExecutionStarted(Statement<?> statement,
                               ExecutionContext context)

Description copied from interface: ExecutionListener

Called when a statement is about to be executed.

Specified by:

onExecutionStarted in interface ExecutionListener

Parameters:

statement - the statement to execute.

context - the global statement execution context.

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.