org.apache.hudi.metrics

Class HoodieMetrics

java.lang.Object

org.apache.hudi.metrics.HoodieMetrics

public class HoodieMetrics
extends Object

Wrapper for metrics-related operations.

Field Summary

Fields

Modifier and Type	Field and Description
String	cleanTimerName
String	commitTimerName
String	compactionTimerName
String	deltaCommitTimerName
String	finalizeTimerName
String	indexTimerName
String	logCompactionTimerName
String	replaceCommitTimerName
String	rollbackTimerName
static String	TOTAL_BYTES_WRITTEN_STR
static String	TOTAL_COMPACTED_RECORDS_UPDATED_STR
static String	TOTAL_CORRUPTED_LOG_BLOCKS_STR
static String	TOTAL_CREATE_TIME_STR
static String	TOTAL_FILES_INSERT_STR
static String	TOTAL_FILES_UPDATE_STR
static String	TOTAL_INSERT_RECORDS_WRITTEN_STR
static String	TOTAL_LOG_FILES_COMPACTED_STR
static String	TOTAL_LOG_FILES_SIZE_STR
static String	TOTAL_PARTITIONS_WRITTEN_STR
static String	TOTAL_RECORDS_DELETED
static String	TOTAL_RECORDS_WRITTEN_STR
static String	TOTAL_ROLLBACK_LOG_BLOCKS_STR
static String	TOTAL_SCAN_TIME_STR
static String	TOTAL_UPDATE_RECORDS_WRITTEN_STR
static String	TOTAL_UPSERT_TIME_STR

Constructor Summary

Constructors

Constructor and Description
HoodieMetrics(HoodieWriteConfig config)

Method Summary

Modifier and Type	Method and Description
void	emitCompactionCompleted()
void	emitCompactionRequested()
void	emitConflictResolutionFailed()
void	emitConflictResolutionSuccessful()
com.codahale.metrics.Timer.Context	getCleanCtx()
com.codahale.metrics.Timer.Context	getClusteringCtx()
com.codahale.metrics.Timer.Context	getCommitCtx()
com.codahale.metrics.Timer.Context	getCompactionCtx()
com.codahale.metrics.Timer.Context	getConflictResolutionCtx()
com.codahale.metrics.Timer.Context	getDeltaCommitCtx()
long	getDurationInMs(long ctxDuration) By default, the timer context returns duration with nano seconds.
com.codahale.metrics.Timer.Context	getFinalizeCtx()
com.codahale.metrics.Timer.Context	getIndexCtx()
com.codahale.metrics.Timer.Context	getLogCompactionCtx()
Metrics	getMetrics()
String	getMetricsName(String action, String metric)
com.codahale.metrics.Timer.Context	getRollbackCtx()
void	reportMetrics(String commitAction, String metricName, long value) Given a commit action, metrics name and value this method reports custom metrics.
void	updateCleanMetrics(long durationInMs, int numFilesDeleted)
void	updateClusteringFileCreationMetrics(long durationInMs)
void	updateCommitMetrics(long commitEpochTimeInMs, long durationInMs, HoodieCommitMetadata metadata, String actionType)
void	updateFinalizeWriteMetrics(long durationInMs, long numFilesFinalized)
void	updateIndexMetrics(String action, long durationInMs)
void	updateMetricsForEmptyData(String actionType)
void	updateRollbackMetrics(long durationInMs, long numFilesDeleted)

Methods inherited from class java.lang.Object

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

Field Detail

TOTAL_PARTITIONS_WRITTEN_STR

public static final String TOTAL_PARTITIONS_WRITTEN_STR

See Also:

Constant Field Values

TOTAL_FILES_INSERT_STR

public static final String TOTAL_FILES_INSERT_STR

See Also:

Constant Field Values

TOTAL_FILES_UPDATE_STR

public static final String TOTAL_FILES_UPDATE_STR

See Also:

Constant Field Values

TOTAL_RECORDS_WRITTEN_STR

public static final String TOTAL_RECORDS_WRITTEN_STR

See Also:

Constant Field Values

TOTAL_UPDATE_RECORDS_WRITTEN_STR

public static final String TOTAL_UPDATE_RECORDS_WRITTEN_STR

See Also:

Constant Field Values

TOTAL_INSERT_RECORDS_WRITTEN_STR

public static final String TOTAL_INSERT_RECORDS_WRITTEN_STR

See Also:

Constant Field Values

TOTAL_BYTES_WRITTEN_STR

public static final String TOTAL_BYTES_WRITTEN_STR

See Also:

Constant Field Values

TOTAL_SCAN_TIME_STR

public static final String TOTAL_SCAN_TIME_STR

See Also:

Constant Field Values

TOTAL_CREATE_TIME_STR

public static final String TOTAL_CREATE_TIME_STR

See Also:

Constant Field Values

TOTAL_UPSERT_TIME_STR

public static final String TOTAL_UPSERT_TIME_STR

See Also:

Constant Field Values

TOTAL_COMPACTED_RECORDS_UPDATED_STR

public static final String TOTAL_COMPACTED_RECORDS_UPDATED_STR

See Also:

Constant Field Values

TOTAL_LOG_FILES_COMPACTED_STR

public static final String TOTAL_LOG_FILES_COMPACTED_STR

See Also:

Constant Field Values

TOTAL_LOG_FILES_SIZE_STR

public static final String TOTAL_LOG_FILES_SIZE_STR

See Also:

Constant Field Values

TOTAL_RECORDS_DELETED

public static final String TOTAL_RECORDS_DELETED

See Also:

Constant Field Values

TOTAL_CORRUPTED_LOG_BLOCKS_STR

public static final String TOTAL_CORRUPTED_LOG_BLOCKS_STR

See Also:

Constant Field Values

TOTAL_ROLLBACK_LOG_BLOCKS_STR

public static final String TOTAL_ROLLBACK_LOG_BLOCKS_STR

See Also:

Constant Field Values

rollbackTimerName

public String rollbackTimerName

cleanTimerName

public String cleanTimerName

commitTimerName

public String commitTimerName

logCompactionTimerName

public String logCompactionTimerName

deltaCommitTimerName

public String deltaCommitTimerName

replaceCommitTimerName

public String replaceCommitTimerName

finalizeTimerName

public String finalizeTimerName

compactionTimerName

public String compactionTimerName

indexTimerName

public String indexTimerName

Constructor Detail

HoodieMetrics

public HoodieMetrics(HoodieWriteConfig config)

Method Detail

getMetrics

public Metrics getMetrics()

getRollbackCtx

public com.codahale.metrics.Timer.Context getRollbackCtx()

getCompactionCtx

public com.codahale.metrics.Timer.Context getCompactionCtx()

getLogCompactionCtx

public com.codahale.metrics.Timer.Context getLogCompactionCtx()

getClusteringCtx

public com.codahale.metrics.Timer.Context getClusteringCtx()

getCleanCtx

public com.codahale.metrics.Timer.Context getCleanCtx()

getCommitCtx

public com.codahale.metrics.Timer.Context getCommitCtx()

getFinalizeCtx

public com.codahale.metrics.Timer.Context getFinalizeCtx()

getDeltaCommitCtx

public com.codahale.metrics.Timer.Context getDeltaCommitCtx()

getIndexCtx

public com.codahale.metrics.Timer.Context getIndexCtx()

getConflictResolutionCtx

public com.codahale.metrics.Timer.Context getConflictResolutionCtx()

updateMetricsForEmptyData

public void updateMetricsForEmptyData(String actionType)

updateCommitMetrics

public void updateCommitMetrics(long commitEpochTimeInMs,
                                long durationInMs,
                                HoodieCommitMetadata metadata,
                                String actionType)

updateRollbackMetrics

public void updateRollbackMetrics(long durationInMs,
                                  long numFilesDeleted)

updateCleanMetrics

public void updateCleanMetrics(long durationInMs,
                               int numFilesDeleted)

updateFinalizeWriteMetrics

public void updateFinalizeWriteMetrics(long durationInMs,
                                       long numFilesFinalized)

updateIndexMetrics

public void updateIndexMetrics(String action,
                               long durationInMs)

getMetricsName

public String getMetricsName(String action,
                             String metric)

updateClusteringFileCreationMetrics

public void updateClusteringFileCreationMetrics(long durationInMs)

reportMetrics

public void reportMetrics(String commitAction,
                          String metricName,
                          long value)

Given a commit action, metrics name and value this method reports custom metrics.

getDurationInMs

public long getDurationInMs(long ctxDuration)

By default, the timer context returns duration with nano seconds. Convert it to millisecond.

emitConflictResolutionSuccessful

public void emitConflictResolutionSuccessful()

emitConflictResolutionFailed

public void emitConflictResolutionFailed()

emitCompactionRequested

public void emitCompactionRequested()

emitCompactionCompleted

public void emitCompactionCompleted()