Class CSVLogger

java.lang.Object

io.perl.logger.impl.ResultsLogger

io.sbk.logger.impl.AbstractRWLogger

io.sbk.logger.impl.SystemLogger

io.sbk.logger.impl.CSVLogger

All Implemented Interfaces:

io.perl.logger.PerformanceLogger, io.perl.logger.Print, io.perl.logger.ReportLatency, CountReaders, CountRW, CountWriters, Logger, ReadRequestsLogger, RWLogger, RWPrint, SetRW, WriteRequestsLogger

Direct Known Subclasses:

PrometheusLogger

public class CSVLogger
extends SystemLogger

Class for recoding/printing results to a CSV file called `out.csv`.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	DISABLE_STRING	DISABLE_STRING = "no".
static final String	REGULAR_PRINT	REGULAR_PRINT = "Regular".
static final String	TOTAL_PRINT	TOTAL_PRINT = "Total".

Constructor Summary

Constructors

Constructor	Description
CSVLogger()	calls its super class SystemLogger.

Method Summary

Modifier and Type	Method	Description
void	addArgs(InputOptions params)	Add the Metric type specific command line arguments.
void	close(ParsedOptions params)	Close the Logger.
protected final String	getCsvFile()
protected final boolean	isCsvEnable()
void	open(ParsedOptions params, String storageName, Action action, io.time.Time time)	Open the Logger.
final void	openCSV()	Open the CSV and write the header line.
void	parseArgs(ParsedOptions params)	Parse the Metric specific command line arguments.
void	print(int writers, int maxWriters, int readers, int maxReaders, long writeRequestBytes, double writeRequestMbPerSec, long writeRequestRecords, double writeRequestRecordsPerSec, long readRequestBytes, double readRequestMbPerSec, long readRequestRecords, double readRequestRecordsPerSec, long writeResponsePendingRecords, long writeResponsePendingBytes, long readResponsePendingRecords, long readResponsePendingBytes, long writeReadRequestPendingRecords, long writeReadRequestPendingBytes, long writeTimeoutEvents, double writeTimeoutEventsPerSec, long readTimeoutEvents, double readTimeoutEventsPerSec, double seconds, long bytes, long records, double recsPerSec, double mbPerSec, double avgLatency, long minLatency, long maxLatency, long invalid, long lowerDiscard, long higherDiscard, long slc1, long slc2, long[] percentileLatencies, long[] percentileLatencyCounts)	Print the periodic results to System.out at the end of each interval.
void	printTotal(int writers, int maxWriters, int readers, int maxReaders, long writeRequestBytes, double writeRequestMbPerSec, long writeRequestRecords, double writeRequestRecordsPerSec, long readRequestBytes, double readRequestsMbPerSec, long readRequestRecords, double readRequestRecordsPerSec, long writeResponsePendingRecords, long writeResponsePendingBytes, long readResponsePendingRecords, long readResponsePendingBytes, long writeReadRequestPendingRecords, long writeReadRequestPendingBytes, long writeTimeoutEvents, double writeTimeoutEventsPerSec, long readTimeoutEvents, double readTimeoutEventsPerSec, double seconds, long bytes, long records, double recsPerSec, double mbPerSec, double avgLatency, long minLatency, long maxLatency, long invalid, long lowerDiscard, long higherDiscard, long slc1, long slc2, long[] percentileLatencies, long[] percentileLatencyCounts)	Print the final accumulated totals to System.out at the end of the run.
final void	writeToCSV(String header, String type, long connections, long maxConnections, int writers, int maxWriters, int readers, int maxReaders, long writeRequestBytes, double writeRequestMbPerSec, long writeRequestRecords, double writeRequestRecordsPerSec, long readRequestBytes, double readRequestsMbPerSec, long readRequestRecords, double readRequestRecordsPerSec, long writeResponsePendingRecords, long writeResponsePendingBytes, long readResponsePendingRecords, long readResponsePendingBytes, long writeReadRequestPendingRecords, long writeReadRequestPendingBytes, long writeTimeoutEvents, double writeTimeoutEventsPerSec, long readTimeoutEvents, double readTimeoutEventsPerSec, double seconds, long bytes, long records, double recsPerSec, double mbPerSec, double avgLatency, long minLatency, long maxLatency, long invalid, long lowerDiscard, long higherDiscard, long slc1, long slc2, long[] percentileLatencies, long[] percentileLatencyCounts)	Write a single record (row) to the CSV file.

Methods inherited from class AbstractRWLogger

appendResultString, appendWriteAndReadRequests, appendWriteAndReadRequestsPending, appendWriteAndReadTimeoutEvents, appendWritesAndReaders, decrementReaders, decrementWriters, getAction, getLoggerConfigStream, getMaxReaderIDs, getMaxReadersCount, getMaxWriterIDs, getMaxWritersCount, getPrintingIntervalSeconds, getReadersCount, getStorageName, getTime, getWritersCount, incrementReaders, incrementWriters, isReadRequestsEnabled, isWriteRequestsEnabled, print, printTotal, recordReadRequests, recordReadTimeoutEvents, recordWriteRequests, recordWriteTimeoutEvents, setMaxReaders, setMaxReadersIds, setMaxWriters, setMaxWritersIds, setReaders, setWriters

Methods inherited from class io.perl.logger.impl.ResultsLogger

appendResultString, getMaxLatency, getMinLatency, getPercentileNames, getPercentiles, getPrefix, getTimeUnit, setMaxLatency, setMinLatency, setPercentiles, setPrefix, setTimeUnit

Methods inherited from class Object

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

Methods inherited from interface Logger

setExceptionHandler

Methods inherited from interface io.perl.logger.PerformanceLogger

getMaxLatency, getMinLatency, getPercentiles, getTimeUnit, recordLatency

Field Details

DISABLE_STRING

public static final String DISABLE_STRING

DISABLE_STRING = "no".

See Also:

• Constant Field Values

REGULAR_PRINT

public static final String REGULAR_PRINT

REGULAR_PRINT = "Regular".

See Also:

• Constant Field Values

TOTAL_PRINT

public static final String TOTAL_PRINT

TOTAL_PRINT = "Total".

See Also:

• Constant Field Values

Constructor Details

CSVLogger

public CSVLogger()

calls its super class SystemLogger.

Method Details

isCsvEnable

protected final boolean isCsvEnable()

getCsvFile

protected final String getCsvFile()

addArgs

public void addArgs(InputOptions params)
             throws IllegalArgumentException

Description copied from interface: Logger

Add the Metric type specific command line arguments.

Specified by:

addArgs in interface Logger

Overrides:

addArgs in class AbstractRWLogger

Parameters:

params - InputOptions object to be extended.

Throws:

IllegalArgumentException - If an exception occurred.

parseArgs

public void parseArgs(ParsedOptions params)
               throws IllegalArgumentException

Description copied from interface: Logger

Parse the Metric specific command line arguments.

Specified by:

parseArgs in interface Logger

Overrides:

parseArgs in class AbstractRWLogger

Parameters:

params - ParsedOptions containing driver/logger specific parameters/arguments.

Throws:

IllegalArgumentException - If an exception occurred.

openCSV

public final void openCSV()
                   throws IOException

Open the CSV and write the header line.

Throws:

IOException - If an exception occurred.

open

public void open(ParsedOptions params,
 String storageName,
 Action action,
 io.time.Time time)
          throws IOException

Description copied from interface: Logger

Open the Logger.

Specified by:

open in interface Logger

Overrides:

open in class AbstractRWLogger

Parameters:

params - ParsedOptions including logger-specific configuration.

storageName - The Name of the storage.

action - action to print

time - time interface

Throws:

IOException - If an exception occurred.

writeToCSV

public final void writeToCSV(String header,
 String type,
 long connections,
 long maxConnections,
 int writers,
 int maxWriters,
 int readers,
 int maxReaders,
 long writeRequestBytes,
 double writeRequestMbPerSec,
 long writeRequestRecords,
 double writeRequestRecordsPerSec,
 long readRequestBytes,
 double readRequestsMbPerSec,
 long readRequestRecords,
 double readRequestRecordsPerSec,
 long writeResponsePendingRecords,
 long writeResponsePendingBytes,
 long readResponsePendingRecords,
 long readResponsePendingBytes,
 long writeReadRequestPendingRecords,
 long writeReadRequestPendingBytes,
 long writeTimeoutEvents,
 double writeTimeoutEventsPerSec,
 long readTimeoutEvents,
 double readTimeoutEventsPerSec,
 double seconds,
 long bytes,
 long records,
 double recsPerSec,
 double mbPerSec,
 double avgLatency,
 long minLatency,
 long maxLatency,
 long invalid,
 long lowerDiscard,
 long higherDiscard,
 long slc1,
 long slc2,
 long[] percentileLatencies,
 long[] percentileLatencyCounts)

Write a single record (row) to the CSV file.

Parameters:

header - String

type - String

connections - long

maxConnections - long

writers - number of active writers

maxWriters - Max writers

readers - number of active readers

maxReaders - Max Readers

writeRequestBytes - Write requests Bytes

writeRequestMbPerSec - Write requests MB/sec

writeRequestRecords - Write Requests

writeRequestRecordsPerSec - Write Requests/sec

readRequestBytes - Read requests Bytes

readRequestsMbPerSec - Read requests MB/sec

readRequestRecords - Read requests

readRequestRecordsPerSec - Read Requests/sec

writeResponsePendingRecords - Write response pending records

writeResponsePendingBytes - Write response pending bytes

readResponsePendingRecords - Read response pending records

readResponsePendingBytes - Read response pending bytes

writeReadRequestPendingRecords - Write read pending records

writeReadRequestPendingBytes - Write read pending bytes

writeTimeoutEvents - Timeout Write Events

writeTimeoutEventsPerSec - Timeout Write Events/sec

readTimeoutEvents - Timeout Read Events

readTimeoutEventsPerSec - Timeout Write Events/sec

seconds - reporting duration in seconds

bytes - number of bytes read/write

records - data to write.

recsPerSec - records per second.

mbPerSec - Throughput value in terms of MB (Mega Bytes) per Second.

avgLatency - Average Latency.

minLatency - Minimum Latency.

maxLatency - Maximum Latency.

invalid - Number of invalid/negative latencies.

lowerDiscard - number of discarded latencies which are less than minimum latency.

higherDiscard - number of discarded latencies which are higher than maximum latency.

slc1 - Sliding Latency Coverage factor

slc2 - Sliding Latency Coverage factor

percentileLatencies - Array of percentile latency values.

percentileLatencyCounts - Array of percentile latency counts

print

public void print(int writers,
 int maxWriters,
 int readers,
 int maxReaders,
 long writeRequestBytes,
 double writeRequestMbPerSec,
 long writeRequestRecords,
 double writeRequestRecordsPerSec,
 long readRequestBytes,
 double readRequestMbPerSec,
 long readRequestRecords,
 double readRequestRecordsPerSec,
 long writeResponsePendingRecords,
 long writeResponsePendingBytes,
 long readResponsePendingRecords,
 long readResponsePendingBytes,
 long writeReadRequestPendingRecords,
 long writeReadRequestPendingBytes,
 long writeTimeoutEvents,
 double writeTimeoutEventsPerSec,
 long readTimeoutEvents,
 double readTimeoutEventsPerSec,
 double seconds,
 long bytes,
 long records,
 double recsPerSec,
 double mbPerSec,
 double avgLatency,
 long minLatency,
 long maxLatency,
 long invalid,
 long lowerDiscard,
 long higherDiscard,
 long slc1,
 long slc2,
 long[] percentileLatencies,
 long[] percentileLatencyCounts)

Description copied from class: SystemLogger

Print the periodic results to System.out at the end of each interval.

Specified by:

print in interface RWPrint

Overrides:

print in class SystemLogger

Parameters:

writers - number of active writers

maxWriters - maximum writers seen

readers - number of active readers

maxReaders - maximum readers seen

writeRequestBytes - write request bytes in this interval

writeRequestMbPerSec - write request throughput in MB/sec

writeRequestRecords - write request count

writeRequestRecordsPerSec - write requests per second

readRequestBytes - read request bytes in this interval

readRequestMbPerSec - read request throughput in MB/sec

readRequestRecords - read request count

readRequestRecordsPerSec - read requests per second

writeResponsePendingRecords - pending write response records

writeResponsePendingBytes - pending write response bytes

readResponsePendingRecords - pending read response records

readResponsePendingBytes - pending read response bytes

writeReadRequestPendingRecords - write-read pending records delta

writeReadRequestPendingBytes - write-read pending bytes delta

writeTimeoutEvents - write timeout events count

writeTimeoutEventsPerSec - write timeout events per second

readTimeoutEvents - read timeout events count

readTimeoutEventsPerSec - read timeout events per second

seconds - reporting interval seconds

bytes - total bytes processed in interval

records - total records processed in interval

recsPerSec - records per second

mbPerSec - MB per second

avgLatency - average latency

minLatency - minimum latency

maxLatency - maximum latency

invalid - invalid/negative latency count

lowerDiscard - discarded below min latency

higherDiscard - discarded above max latency

slc1 - sliding latency coverage 1

slc2 - sliding latency coverage 2

percentileLatencies - percentile latency values

percentileLatencyCounts - percentile latency counts

printTotal

public void printTotal(int writers,
 int maxWriters,
 int readers,
 int maxReaders,
 long writeRequestBytes,
 double writeRequestMbPerSec,
 long writeRequestRecords,
 double writeRequestRecordsPerSec,
 long readRequestBytes,
 double readRequestsMbPerSec,
 long readRequestRecords,
 double readRequestRecordsPerSec,
 long writeResponsePendingRecords,
 long writeResponsePendingBytes,
 long readResponsePendingRecords,
 long readResponsePendingBytes,
 long writeReadRequestPendingRecords,
 long writeReadRequestPendingBytes,
 long writeTimeoutEvents,
 double writeTimeoutEventsPerSec,
 long readTimeoutEvents,
 double readTimeoutEventsPerSec,
 double seconds,
 long bytes,
 long records,
 double recsPerSec,
 double mbPerSec,
 double avgLatency,
 long minLatency,
 long maxLatency,
 long invalid,
 long lowerDiscard,
 long higherDiscard,
 long slc1,
 long slc2,
 long[] percentileLatencies,
 long[] percentileLatencyCounts)

Description copied from class: SystemLogger

Print the final accumulated totals to System.out at the end of the run.

Specified by:

printTotal in interface RWLogger

Overrides:

printTotal in class SystemLogger

Parameters:

writers - number of active writers

maxWriters - maximum writers seen

readers - number of active readers

maxReaders - maximum readers seen

writeRequestBytes - write request bytes total

writeRequestMbPerSec - write request throughput in MB/sec

writeRequestRecords - write request count total

writeRequestRecordsPerSec - write requests per second

readRequestBytes - read request bytes total

readRequestsMbPerSec - read request throughput in MB/sec

readRequestRecords - read request count total

readRequestRecordsPerSec - read requests per second

writeResponsePendingRecords - pending write response records

writeResponsePendingBytes - pending write response bytes

readResponsePendingRecords - pending read response records

readResponsePendingBytes - pending read response bytes

writeReadRequestPendingRecords - write-read pending records delta

writeReadRequestPendingBytes - write-read pending bytes delta

writeTimeoutEvents - write timeout events count

writeTimeoutEventsPerSec - write timeout events per second

readTimeoutEvents - read timeout events count

readTimeoutEventsPerSec - read timeout events per second

seconds - reporting seconds

bytes - total bytes processed

records - total records processed

recsPerSec - records per second

mbPerSec - MB per second

avgLatency - average latency

minLatency - minimum latency

maxLatency - maximum latency

invalid - invalid/negative latency count

lowerDiscard - discarded below min latency

higherDiscard - discarded above max latency

slc1 - sliding latency coverage 1

slc2 - sliding latency coverage 2

percentileLatencies - percentile latency values

percentileLatencyCounts - percentile latency counts

close

public void close(ParsedOptions params)
           throws IOException

Description copied from interface: Logger

Close the Logger.

Specified by:

close in interface Logger

Overrides:

close in class AbstractRWLogger

Parameters:

params - ParsedOptions used during open; may carry shutdown options.

Throws:

IOException - If an exception occurred.