org.apache.hudi.common.metrics

Interface Registry

All Superinterfaces:

Serializable

All Known Implementing Classes:

LocalRegistry

public interface Registry
extends Serializable

Interface which defines a lightweight Metrics Registry to track Hudi events.

Field Summary

Fields

Modifier and Type	Field and Description
static ConcurrentHashMap<String,Registry>	REGISTRY_MAP

Method Summary

Modifier and Type	Method and Description
void	add(String name, long value) Add value to the metric.
void	clear() Clear all metrics.
default Map<String,Long>	getAllCounts() Get all Counter type metrics.
Map<String,Long>	getAllCounts(boolean prefixWithRegistryName) Get all Counter type metrics.
static Map<String,Long>	getAllMetrics(boolean flush, boolean prefixWithRegistryName) Get all registered metrics.
static Registry	getRegistry(String registryName) Get (or create) the registry for a provided name.
static Registry	getRegistry(String registryName, String clazz) Get (or create) the registry for a provided name and given class.
void	increment(String name) Increment the metric.
void	set(String name, long value) Set the value to the metric.

Field Detail

REGISTRY_MAP

static final ConcurrentHashMap<String,Registry> REGISTRY_MAP

Method Detail

getRegistry

static Registry getRegistry(String registryName)

Get (or create) the registry for a provided name. This function creates a LocalRegistry.

Parameters:

registryName - Name of the registry

getRegistry

static Registry getRegistry(String registryName,
                            String clazz)

Get (or create) the registry for a provided name and given class.

Parameters:

registryName - Name of the registry.

clazz - The fully qualified name of the registry class to create.

getAllMetrics

static Map<String,Long> getAllMetrics(boolean flush,
                                      boolean prefixWithRegistryName)

Get all registered metrics.

Parameters:

flush - clear all metrics after this operation.

prefixWithRegistryName - prefix each metric name with the registry name.

Returns:

clear

void clear()

Clear all metrics.

increment

void increment(String name)

Increment the metric.

Parameters:

name - Name of the metric to increment.

add

void add(String name,
         long value)

Add value to the metric.

Parameters:

name - Name of the metric.

value - The value to add to the metrics.

set

void set(String name,
         long value)

Set the value to the metric. If the metric does not exist, it is added. If the metrics already exists, its value is replaced with the provided value.

Parameters:

name - Name of the metric.

value - The value to set for the metrics.

getAllCounts

default Map<String,Long> getAllCounts()

Get all Counter type metrics.

getAllCounts

Map<String,Long> getAllCounts(boolean prefixWithRegistryName)

Get all Counter type metrics.

Parameters:

prefixWithRegistryName - If true, the names of all metrics are prefixed with name of this registry.