Package org.apache.hadoop.io.wrappedio.impl

Class DynamicWrappedStatistics

java.lang.Object

org.apache.hadoop.io.wrappedio.impl.DynamicWrappedStatistics

public final class DynamicWrappedStatistics
extends java.lang.Object

The wrapped IOStatistics methods in WrappedStatistics, dynamically loaded. This is suitable for copy-and-paste into other libraries which have some version of the Parquet DynMethods classes already present.

Field Summary

Fields

Modifier and Type	Field	Description
static java.lang.String	IOSTATISTICS_CONTEXT_AGGREGATE	IOStatisticsContext method: "iostatisticsContext_aggregate".
static java.lang.String	IOSTATISTICS_CONTEXT_ENABLED	IOStatisticsContext method: "iostatisticsContext_enabled".
static java.lang.String	IOSTATISTICS_CONTEXT_GET_CURRENT	IOStatisticsContext method: "iostatisticsContext_getCurrent".
static java.lang.String	IOSTATISTICS_CONTEXT_RESET	IOStatisticsContext method: "iostatisticsContext_reset".
static java.lang.String	IOSTATISTICS_CONTEXT_SET_THREAD_CONTEXT	IOStatisticsContext method: "iostatisticsContext_setThreadIOStatisticsContext".
static java.lang.String	IOSTATISTICS_CONTEXT_SNAPSHOT	IOStatisticsContext method: "iostatisticsContext_snapshot".
static java.lang.String	IOSTATISTICS_COUNTERS	Method name: "iostatistics_counters".
static java.lang.String	IOSTATISTICS_GAUGES	Method name: "iostatistics_gauges".
static java.lang.String	IOSTATISTICS_MAXIMUMS	Method name: "iostatistics_maximums".
static java.lang.String	IOSTATISTICS_MEANS	Method name: "iostatistics_means".
static java.lang.String	IOSTATISTICS_MINIMUMS	Method name: "iostatistics_minimums".
static java.lang.String	IOSTATISTICS_SNAPSHOT_AGGREGATE	Method name: "iostatisticsSnapshot_aggregate".
static java.lang.String	IOSTATISTICS_SNAPSHOT_CREATE	Method name: "iostatisticsSnapshot_create".
static java.lang.String	IOSTATISTICS_SNAPSHOT_FROM_JSON_STRING	Method name: "iostatisticsSnapshot_fromJsonString".
static java.lang.String	IOSTATISTICS_SNAPSHOT_LOAD	Method name: "iostatisticsSnapshot_load".
static java.lang.String	IOSTATISTICS_SNAPSHOT_RETRIEVE	Method name: "iostatisticsSnapshot_retrieve".
static java.lang.String	IOSTATISTICS_SNAPSHOT_SAVE	Method name: "iostatisticsSnapshot_save".
static java.lang.String	IOSTATISTICS_SNAPSHOT_TO_JSON_STRING	Method name: "iostatisticsSnapshot_toJsonString".
static java.lang.String	IOSTATISTICS_TO_PRETTY_STRING	Method name: "iostatistics_toPrettyString".
static java.lang.String	IS_IOSTATISTICS	Method name: "isIOStatistics".
static java.lang.String	IS_IOSTATISTICS_SNAPSHOT	Method name: "isIOStatisticsSnapshot".
static java.lang.String	IS_IOSTATISTICS_SOURCE	Method name: "isIOStatisticsSource".
static java.lang.String	WRAPPED_STATISTICS_CLASSNAME	Classname of the wrapped statistics class: "org.apache.hadoop.io.wrappedio.WrappedStatistics".

Constructor Summary

Constructors

Constructor	Description
DynamicWrappedStatistics()
DynamicWrappedStatistics(java.lang.String classname)

Method Summary

Modifier and Type	Method	Description
java.util.Map<java.lang.String,java.lang.Long>	iostatistics_counters(java.io.Serializable source)	Get the counters of an IOStatisticsSnapshot.
java.util.Map<java.lang.String,java.lang.Long>	iostatistics_gauges(java.io.Serializable source)	Get the gauges of an IOStatisticsSnapshot.
java.util.Map<java.lang.String,java.lang.Long>	iostatistics_maximums(java.io.Serializable source)	Get the maximums of an IOStatisticsSnapshot.
java.util.Map<java.lang.String,java.util.Map.Entry<java.lang.Long,java.lang.Long>>	iostatistics_means(java.io.Serializable source)	Get the means of an IOStatisticsSnapshot.
java.util.Map<java.lang.String,java.lang.Long>	iostatistics_minimums(java.io.Serializable source)	Get the minimums of an IOStatisticsSnapshot.
java.lang.String	iostatistics_toPrettyString(java.lang.Object statistics)	Convert IOStatistics to a string form, with all the metrics sorted and empty value stripped.
boolean	ioStatisticsAvailable()	Are the core IOStatistics methods and classes available.
boolean	iostatisticsContext_aggregate(java.lang.Object source)	Aggregate into the IOStatistics context the statistics passed in via IOStatistics/source parameter.
boolean	iostatisticsContext_enabled()	Probe to check if the thread-level IO statistics enabled.
java.lang.Object	iostatisticsContext_getCurrent()	Get the context's IOStatisticsContext which implements IOStatisticsSource.
void	iostatisticsContext_reset()	Reset the context's IOStatistics.
void	iostatisticsContext_setThreadIOStatisticsContext(java.lang.Object statisticsContext)	Set the IOStatisticsContext for the current thread.
java.io.Serializable	iostatisticsContext_snapshot()	Take a snapshot of the context IOStatistics.
boolean	ioStatisticsContextAvailable()	Are the IOStatisticsContext methods and classes available?
boolean	iostatisticsSnapshot_aggregate(java.io.Serializable snapshot, java.lang.Object statistics)	Aggregate an existing IOStatisticsSnapshot with the supplied statistics.
java.io.Serializable	iostatisticsSnapshot_create()	Create a new IOStatisticsSnapshot instance.
java.io.Serializable	iostatisticsSnapshot_create(java.lang.Object source)	Create a new IOStatisticsSnapshot instance.
java.io.Serializable	iostatisticsSnapshot_fromJsonString(java.lang.String json)	Load IOStatisticsSnapshot from a JSON string.
java.io.Serializable	iostatisticsSnapshot_load(FileSystem fs, Path path)	Load IOStatisticsSnapshot from a Hadoop filesystem.
java.io.Serializable	iostatisticsSnapshot_retrieve(java.lang.Object source)	Extract the IOStatistics from an object in a serializable form.
void	iostatisticsSnapshot_save(java.io.Serializable snapshot, FileSystem fs, Path path, boolean overwrite)	Save IOStatisticsSnapshot to a Hadoop filesystem as a JSON file.
java.lang.String	iostatisticsSnapshot_toJsonString(java.io.Serializable snapshot)	Save IOStatisticsSnapshot to a JSON string.
boolean	isIOStatistics(java.lang.Object object)	Probe for an object being an instance of IOStatisticsSource.
boolean	isIOStatisticsSnapshot(java.io.Serializable object)	Probe for an object being an instance of IOStatisticsSnapshot.
boolean	isIOStatisticsSource(java.lang.Object object)	Probe for an object being an instance of IOStatisticsSource.
boolean	loaded()	Is the wrapped statistics class loaded?
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

WRAPPED_STATISTICS_CLASSNAME

public static final java.lang.String WRAPPED_STATISTICS_CLASSNAME

Classname of the wrapped statistics class: "org.apache.hadoop.io.wrappedio.WrappedStatistics".

See Also:

Constant Field Values

IS_IOSTATISTICS_SOURCE

public static final java.lang.String IS_IOSTATISTICS_SOURCE

Method name: "isIOStatisticsSource".

See Also:

Constant Field Values

IS_IOSTATISTICS

public static final java.lang.String IS_IOSTATISTICS

Method name: "isIOStatistics".

See Also:

Constant Field Values

IS_IOSTATISTICS_SNAPSHOT

public static final java.lang.String IS_IOSTATISTICS_SNAPSHOT

Method name: "isIOStatisticsSnapshot".

See Also:

Constant Field Values

IOSTATISTICS_CONTEXT_AGGREGATE

public static final java.lang.String IOSTATISTICS_CONTEXT_AGGREGATE

IOStatisticsContext method: "iostatisticsContext_aggregate".

See Also:

Constant Field Values

IOSTATISTICS_CONTEXT_ENABLED

public static final java.lang.String IOSTATISTICS_CONTEXT_ENABLED

IOStatisticsContext method: "iostatisticsContext_enabled".

See Also:

Constant Field Values

IOSTATISTICS_CONTEXT_GET_CURRENT

public static final java.lang.String IOSTATISTICS_CONTEXT_GET_CURRENT

IOStatisticsContext method: "iostatisticsContext_getCurrent".

See Also:

Constant Field Values

IOSTATISTICS_CONTEXT_SET_THREAD_CONTEXT

public static final java.lang.String IOSTATISTICS_CONTEXT_SET_THREAD_CONTEXT

IOStatisticsContext method: "iostatisticsContext_setThreadIOStatisticsContext".

See Also:

Constant Field Values

IOSTATISTICS_CONTEXT_RESET

public static final java.lang.String IOSTATISTICS_CONTEXT_RESET

IOStatisticsContext method: "iostatisticsContext_reset".

See Also:

Constant Field Values

IOSTATISTICS_CONTEXT_SNAPSHOT

public static final java.lang.String IOSTATISTICS_CONTEXT_SNAPSHOT

IOStatisticsContext method: "iostatisticsContext_snapshot".

See Also:

Constant Field Values

IOSTATISTICS_SNAPSHOT_AGGREGATE

public static final java.lang.String IOSTATISTICS_SNAPSHOT_AGGREGATE

Method name: "iostatisticsSnapshot_aggregate".

See Also:

Constant Field Values

IOSTATISTICS_SNAPSHOT_CREATE

public static final java.lang.String IOSTATISTICS_SNAPSHOT_CREATE

Method name: "iostatisticsSnapshot_create".

See Also:

Constant Field Values

IOSTATISTICS_SNAPSHOT_FROM_JSON_STRING

public static final java.lang.String IOSTATISTICS_SNAPSHOT_FROM_JSON_STRING

Method name: "iostatisticsSnapshot_fromJsonString".

See Also:

Constant Field Values

IOSTATISTICS_SNAPSHOT_LOAD

public static final java.lang.String IOSTATISTICS_SNAPSHOT_LOAD

Method name: "iostatisticsSnapshot_load".

See Also:

Constant Field Values

IOSTATISTICS_SNAPSHOT_RETRIEVE

public static final java.lang.String IOSTATISTICS_SNAPSHOT_RETRIEVE

Method name: "iostatisticsSnapshot_retrieve".

See Also:

Constant Field Values

IOSTATISTICS_SNAPSHOT_SAVE

public static final java.lang.String IOSTATISTICS_SNAPSHOT_SAVE

Method name: "iostatisticsSnapshot_save".

See Also:

Constant Field Values

IOSTATISTICS_SNAPSHOT_TO_JSON_STRING

public static final java.lang.String IOSTATISTICS_SNAPSHOT_TO_JSON_STRING

Method name: "iostatisticsSnapshot_toJsonString".

See Also:

Constant Field Values

IOSTATISTICS_TO_PRETTY_STRING

public static final java.lang.String IOSTATISTICS_TO_PRETTY_STRING

Method name: "iostatistics_toPrettyString".

See Also:

Constant Field Values

IOSTATISTICS_COUNTERS

public static final java.lang.String IOSTATISTICS_COUNTERS

Method name: "iostatistics_counters".

See Also:

Constant Field Values

IOSTATISTICS_GAUGES

public static final java.lang.String IOSTATISTICS_GAUGES

Method name: "iostatistics_gauges".

See Also:

Constant Field Values

IOSTATISTICS_MINIMUMS

public static final java.lang.String IOSTATISTICS_MINIMUMS

Method name: "iostatistics_minimums".

See Also:

Constant Field Values

IOSTATISTICS_MAXIMUMS

public static final java.lang.String IOSTATISTICS_MAXIMUMS

Method name: "iostatistics_maximums".

See Also:

Constant Field Values

IOSTATISTICS_MEANS

public static final java.lang.String IOSTATISTICS_MEANS

Method name: "iostatistics_means".

See Also:

Constant Field Values

Constructor Detail

DynamicWrappedStatistics

public DynamicWrappedStatistics()

DynamicWrappedStatistics

public DynamicWrappedStatistics(java.lang.String classname)

Method Detail

loaded

public boolean loaded()

Is the wrapped statistics class loaded?

Returns:

true if the wrappedIO class was found and loaded.

ioStatisticsAvailable

public boolean ioStatisticsAvailable()

Are the core IOStatistics methods and classes available.

Returns:

true if the relevant methods are loaded.

ioStatisticsContextAvailable

public boolean ioStatisticsContextAvailable()

Are the IOStatisticsContext methods and classes available?

Returns:

true if the relevant methods are loaded.

isIOStatisticsSource

public boolean isIOStatisticsSource(java.lang.Object object)

Probe for an object being an instance of IOStatisticsSource.

Parameters:

object - object to probe

Returns:

true if the object is the right type, false if the classes were not found or the object is null/of a different type

isIOStatistics

public boolean isIOStatistics(java.lang.Object object)

Probe for an object being an instance of IOStatisticsSource.

Parameters:

object - object to probe

Returns:

true if the object is the right type, false if the classes were not found or the object is null/of a different type

isIOStatisticsSnapshot

public boolean isIOStatisticsSnapshot(java.io.Serializable object)

Probe for an object being an instance of IOStatisticsSnapshot.

Parameters:

object - object to probe

Returns:

true if the object is the right type, false if the classes were not found or the object is null/of a different type

iostatisticsContext_enabled

public boolean iostatisticsContext_enabled()

Probe to check if the thread-level IO statistics enabled. If the relevant classes and methods were not found, returns false

Returns:

true if the IOStatisticsContext API was found and is enabled.

iostatisticsContext_getCurrent

public java.lang.Object iostatisticsContext_getCurrent()
                                                throws java.lang.UnsupportedOperationException

Get the context's IOStatisticsContext which implements IOStatisticsSource. This is either a thread-local value or a global empty context.

Returns:

instance of IOStatisticsContext.

Throws:

java.lang.UnsupportedOperationException - if the IOStatisticsContext API was not found

iostatisticsContext_setThreadIOStatisticsContext

public void iostatisticsContext_setThreadIOStatisticsContext(@Nullable
                                                             java.lang.Object statisticsContext)
                                                      throws java.lang.UnsupportedOperationException

Set the IOStatisticsContext for the current thread.

Parameters:

statisticsContext - IOStatistics context instance for the current thread. If null, the context is reset.

Throws:

java.lang.UnsupportedOperationException - if the IOStatisticsContext API was not found

iostatisticsContext_reset

public void iostatisticsContext_reset()
                               throws java.lang.UnsupportedOperationException

Reset the context's IOStatistics. IOStatisticsContext#reset()

Throws:

java.lang.UnsupportedOperationException - if the IOStatisticsContext API was not found

iostatisticsContext_snapshot

public java.io.Serializable iostatisticsContext_snapshot()
                                                  throws java.lang.UnsupportedOperationException

Take a snapshot of the context IOStatistics. IOStatisticsContext#snapshot()

Returns:

an instance of IOStatisticsSnapshot.

Throws:

java.lang.UnsupportedOperationException - if the IOStatisticsContext API was not found

iostatisticsContext_aggregate

public boolean iostatisticsContext_aggregate(java.lang.Object source)

Aggregate into the IOStatistics context the statistics passed in via IOStatistics/source parameter.

Returns false if the source is null or does not contain any statistics.

Parameters:

source - implementation of IOStatisticsSource or IOStatistics

Returns:

true if the the source object was aggregated.

iostatisticsSnapshot_aggregate

public boolean iostatisticsSnapshot_aggregate(java.io.Serializable snapshot,
                                              @Nullable
                                              java.lang.Object statistics)
                                       throws java.lang.UnsupportedOperationException

Aggregate an existing IOStatisticsSnapshot with the supplied statistics.

Parameters:

snapshot - snapshot to update

statistics - IOStatistics to add

Returns:

true if the snapshot was updated.

Throws:

java.lang.IllegalArgumentException - if the statistics argument is not null but not an instance of IOStatistics, or if snapshot is invalid.

java.lang.UnsupportedOperationException - if the IOStatistics classes were not found

iostatisticsSnapshot_create

public java.io.Serializable iostatisticsSnapshot_create()
                                                 throws java.lang.UnsupportedOperationException

Create a new IOStatisticsSnapshot instance.

Returns:

an empty IOStatisticsSnapshot.

Throws:

java.lang.UnsupportedOperationException - if the IOStatistics classes were not found

iostatisticsSnapshot_create

public java.io.Serializable iostatisticsSnapshot_create(@Nullable
                                                        java.lang.Object source)
                                                 throws java.lang.UnsupportedOperationException,
                                                        java.lang.ClassCastException

Create a new IOStatisticsSnapshot instance.

Parameters:

source - optional source statistics

Returns:

an IOStatisticsSnapshot.

Throws:

java.lang.ClassCastException - if the source is not valid.

java.lang.UnsupportedOperationException - if the IOStatistics classes were not found

iostatisticsSnapshot_toJsonString

public java.lang.String iostatisticsSnapshot_toJsonString(@Nullable
                                                          java.io.Serializable snapshot)
                                                   throws java.io.UncheckedIOException,
                                                          java.lang.UnsupportedOperationException

Save IOStatisticsSnapshot to a JSON string.

Parameters:

snapshot - statistics; may be null or of an incompatible type

Returns:

JSON string value or null if source is not an IOStatisticsSnapshot

Throws:

java.io.UncheckedIOException - Any IO/jackson exception.

java.lang.UnsupportedOperationException - if the IOStatistics classes were not found

iostatisticsSnapshot_fromJsonString

public java.io.Serializable iostatisticsSnapshot_fromJsonString(java.lang.String json)
                                                         throws java.io.UncheckedIOException,
                                                                java.lang.UnsupportedOperationException

Load IOStatisticsSnapshot from a JSON string.

Parameters:

json - JSON string value.

Returns:

deserialized snapshot.

Throws:

java.io.UncheckedIOException - Any IO/jackson exception.

java.lang.UnsupportedOperationException - if the IOStatistics classes were not found

iostatisticsSnapshot_load

public java.io.Serializable iostatisticsSnapshot_load(FileSystem fs,
                                                      Path path)
                                               throws java.io.UncheckedIOException,
                                                      java.lang.UnsupportedOperationException

Load IOStatisticsSnapshot from a Hadoop filesystem.

Parameters:

fs - filesystem

path - path

Returns:

the loaded snapshot

Throws:

java.io.UncheckedIOException - Any IO exception.

java.lang.UnsupportedOperationException - if the IOStatistics classes were not found

iostatisticsSnapshot_retrieve

public java.io.Serializable iostatisticsSnapshot_retrieve(@Nullable
                                                          java.lang.Object source)
                                                   throws java.lang.UnsupportedOperationException

Extract the IOStatistics from an object in a serializable form.

Parameters:

source - source object, may be null/not a statistics source/instance

Returns:

IOStatisticsSnapshot or null if the object is null/doesn't have statistics

Throws:

java.lang.UnsupportedOperationException - if the IOStatistics classes were not found

iostatisticsSnapshot_save

public void iostatisticsSnapshot_save(@Nullable
                                      java.io.Serializable snapshot,
                                      FileSystem fs,
                                      Path path,
                                      boolean overwrite)
                               throws java.io.UncheckedIOException,
                                      java.lang.UnsupportedOperationException

Save IOStatisticsSnapshot to a Hadoop filesystem as a JSON file.

Parameters:

snapshot - statistics

fs - filesystem

path - path

overwrite - should any existing file be overwritten?

Throws:

java.io.UncheckedIOException - Any IO exception.

java.lang.UnsupportedOperationException - if the IOStatistics classes were not found

iostatistics_counters

public java.util.Map<java.lang.String,java.lang.Long> iostatistics_counters(java.io.Serializable source)

Get the counters of an IOStatisticsSnapshot.

Parameters:

source - source of statistics.

Returns:

the map of counters.

iostatistics_gauges

public java.util.Map<java.lang.String,java.lang.Long> iostatistics_gauges(java.io.Serializable source)

Get the gauges of an IOStatisticsSnapshot.

Parameters:

source - source of statistics.

Returns:

the map of gauges.

iostatistics_minimums

public java.util.Map<java.lang.String,java.lang.Long> iostatistics_minimums(java.io.Serializable source)

Get the minimums of an IOStatisticsSnapshot.

Parameters:

source - source of statistics.

Returns:

the map of minimums.

iostatistics_maximums

public java.util.Map<java.lang.String,java.lang.Long> iostatistics_maximums(java.io.Serializable source)

Get the maximums of an IOStatisticsSnapshot.

Parameters:

source - source of statistics.

Returns:

the map of maximums.

iostatistics_means

public java.util.Map<java.lang.String,java.util.Map.Entry<java.lang.Long,java.lang.Long>> iostatistics_means(java.io.Serializable source)

Get the means of an IOStatisticsSnapshot. Each value in the map is the (sample, sum) tuple of the values; the mean is then calculated by dividing sum/sample wherever sample is non-zero.

Parameters:

source - source of statistics.

Returns:

a map of mean key to (sample, sum) tuples.

iostatistics_toPrettyString

public java.lang.String iostatistics_toPrettyString(java.lang.Object statistics)

Convert IOStatistics to a string form, with all the metrics sorted and empty value stripped.

Parameters:

statistics - A statistics instance.

Returns:

string value or the empty string if null

Throws:

java.lang.UnsupportedOperationException - if the IOStatistics classes were not found

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object