Package org.apache.hadoop.util

Class InstrumentedReadLock

java.lang.Object

org.apache.hadoop.util.InstrumentedLock

org.apache.hadoop.util.InstrumentedReadLock

All Implemented Interfaces:

Lock

@Private
@Unstable
public class InstrumentedReadLock
extends InstrumentedLock

This is a wrap class of a ReadLock. It extends the class InstrumentedLock, and can be used to track whether a specific read lock is being held for too long and log warnings if so. The logged warnings are throttled so that logs are not spammed.

Nested Class Summary

Nested classes/interfaces inherited from class org.apache.hadoop.util.InstrumentedLock

InstrumentedLock.SuppressedSnapshot

Constructor Summary

Constructors

Constructor	Description
InstrumentedReadLock(String name, org.slf4j.Logger logger, ReentrantReadWriteLock readWriteLock, long minLoggingGapMs, long lockWarningThresholdMs)

Method Summary

Modifier and Type	Method	Description
protected void	startLockTiming()	Starts timing for the instrumented read lock.
void	unlock()

Methods inherited from class org.apache.hadoop.util.InstrumentedLock

check, getLock, getTimer, lock, lockInterruptibly, newCondition, tryLock, tryLock

Methods inherited from class java.lang.Object

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

Constructor Details

InstrumentedReadLock

public InstrumentedReadLock(String name,
 org.slf4j.Logger logger,
 ReentrantReadWriteLock readWriteLock,
 long minLoggingGapMs,
 long lockWarningThresholdMs)

Method Details

unlock

public void unlock()

Specified by:

unlock in interface Lock

Overrides:

unlock in class InstrumentedLock

startLockTiming

protected void startLockTiming()

Starts timing for the instrumented read lock. It records the time to ThreadLocal.

Overrides:

startLockTiming in class InstrumentedLock