org.janusgraph.diskstorage.keycolumnvalue.scan

Interface ScanMetrics

All Known Implementing Classes:

StandardScanMetrics

public interface ScanMetrics

Counters associated with a ScanJob.

Conceptually, this interface contains two separate stores of counters:

• the standard store, accessed via get and increment
• the custom store, accessed via methods with custom in their names

All counters values automatically start at zero.

Author:

Matthias Broecheler ([email protected])

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	ScanMetrics.Metric An enum of standard counters.

Method Summary

Modifier and Type	Method and Description
long	get(ScanMetrics.Metric metric) Get the value of a standard counter.
long	getCustom(String metric) Get the value of a custom counter.
void	increment(ScanMetrics.Metric metric) Increment a standard counter by 1.
void	incrementCustom(String metric) Like incrementCustom(String, long), except the delta is 1.
void	incrementCustom(String metric, long delta) Increment a custom counter by delta.

Method Detail

getCustom

long getCustom(String metric)

Get the value of a custom counter. Only the effects of prior calls to incrementCustom(String) and incrementCustom(String, long) should be observable through this method, never the effects of prior calls to increment(org.janusgraph.diskstorage.keycolumnvalue.scan.ScanMetrics.Metric).

Parameters:

metric -

Returns:

incrementCustom

void incrementCustom(String metric,
                     long delta)

Increment a custom counter by delta. The effects of calls to method should only be observable through getCustom(String), never through get(org.janusgraph.diskstorage.keycolumnvalue.scan.ScanMetrics.Metric).

Parameters:

metric - the name of the counter

delta - the amount to add to the counter

incrementCustom

void incrementCustom(String metric)

Like incrementCustom(String, long), except the delta is 1.

Parameters:

metric - the name of the counter to increment by 1

get

long get(ScanMetrics.Metric metric)

Get the value of a standard counter.

Parameters:

metric - the standard counter whose value should be returned

Returns:

the value of the standard counter

increment

void increment(ScanMetrics.Metric metric)

Increment a standard counter by 1.

Parameters:

metric - the standard counter whose value will be increased by 1