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

Class ReadsAndWritesReportingExecutionListener

java.lang.Object

com.codahale.metrics.ScheduledReporter

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

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

All Implemented Interfaces:

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

public class ReadsAndWritesReportingExecutionListener
extends AbstractMetricsReportingExecutionListener
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 inherited from class com.datastax.oss.dsbulk.executor.api.listener.AbstractMetricsReportingExecutionListener

BYTES_PER_KB, BYTES_PER_MB

Constructor Summary

Constructors

Constructor and Description
ReadsAndWritesReportingExecutionListener() Creates a default instance of ReadsAndWritesReportingExecutionListener.
ReadsAndWritesReportingExecutionListener(MetricsCollectingExecutionListener delegate) Creates an instance of ReadsAndWritesReportingExecutionListener using the given delegate.

Method Summary

Modifier and Type	Method and Description
static AbstractMetricsReportingExecutionListenerBuilder<ReadsAndWritesReportingExecutionListener>	builder() Creates a new builder for this class.
void	report(SortedMap<String,com.codahale.metrics.Gauge> gauges, SortedMap<String,com.codahale.metrics.Counter> counters, SortedMap<String,com.codahale.metrics.Histogram> histograms, SortedMap<String,com.codahale.metrics.Meter> meters, SortedMap<String,com.codahale.metrics.Timer> timers)

Methods inherited from class com.datastax.oss.dsbulk.executor.api.listener.AbstractMetricsReportingExecutionListener

onExecutionFailed, onExecutionStarted, onExecutionSuccessful, onReadRequestFailed, onReadRequestStarted, onReadRequestSuccessful, onRowReceived, onWriteRequestFailed, onWriteRequestStarted, onWriteRequestSuccessful

Methods inherited from class com.codahale.metrics.ScheduledReporter

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

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

onExecutionFailed, onExecutionStarted, onExecutionSuccessful, onReadRequestFailed, onReadRequestStarted, onReadRequestSuccessful, onRowReceived, onWriteRequestFailed, onWriteRequestStarted, onWriteRequestSuccessful

Constructor Detail

ReadsAndWritesReportingExecutionListener

public ReadsAndWritesReportingExecutionListener()

Creates a default instance of ReadsAndWritesReportingExecutionListener.

The instance will express rates in operations per second, and durations in milliseconds.

ReadsAndWritesReportingExecutionListener

public ReadsAndWritesReportingExecutionListener(MetricsCollectingExecutionListener delegate)

Creates an instance of ReadsAndWritesReportingExecutionListener using the given delegate.

The instance will express rates in operations per second, and durations in milliseconds.

Parameters:

delegate - the ReadsAndWritesReportingExecutionListener to use as metrics source.

Method Detail

builder

public static AbstractMetricsReportingExecutionListenerBuilder<ReadsAndWritesReportingExecutionListener> builder()

Creates a new builder for this class.

Returns:

a new builder.

report

public void report(SortedMap<String,com.codahale.metrics.Gauge> gauges,
                   SortedMap<String,com.codahale.metrics.Counter> counters,
                   SortedMap<String,com.codahale.metrics.Histogram> histograms,
                   SortedMap<String,com.codahale.metrics.Meter> meters,
                   SortedMap<String,com.codahale.metrics.Timer> timers)

Specified by:

report in class com.codahale.metrics.ScheduledReporter