org.apache.gobblin.util.filesystem

Class FileSystemInstrumentationFactory<S extends ScopeType<S>>

java.lang.Object

org.apache.gobblin.util.filesystem.FileSystemInstrumentationFactory<S>

Direct Known Subclasses:

ThrottledFileSystem.Factory

public class FileSystemInstrumentationFactory<S extends ScopeType<S>>
extends Object

A factory that instruments FileSystem. Instrumentations are usually decorators of the underlying FileSystem that add some additional features to it. Implementations can extend FileSystemInstrumentation for convenience.

Constructor Summary

Constructors

Constructor and Description
FileSystemInstrumentationFactory()

Method Summary

Modifier and Type	Method and Description
org.apache.hadoop.fs.FileSystem	instrumentFileSystem(org.apache.hadoop.fs.FileSystem fs, SharedResourcesBroker<S> broker, ConfigView<S,FileSystemKey> config) Return an instrumented version of the input FileSystem.

Methods inherited from class java.lang.Object

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

Constructor Detail

FileSystemInstrumentationFactory

public FileSystemInstrumentationFactory()

Method Detail

instrumentFileSystem

public org.apache.hadoop.fs.FileSystem instrumentFileSystem(org.apache.hadoop.fs.FileSystem fs,
                                                            SharedResourcesBroker<S> broker,
                                                            ConfigView<S,FileSystemKey> config)

Return an instrumented version of the input FileSystem. Generally, this will return a decorator for the input FileSystem. If the instrumentation will be a no-op (due to, for example, configuration), it is recommended to return the input FileSystem directly for performance.