MetricsSource (Apache HBase 1.2.12 API)

java.lang.Object
- org.apache.hadoop.hbase.replication.regionserver.MetricsSource

```
@InterfaceAudience.LimitedPrivate(value="Replication")
public class MetricsSource
extends Object
```
This class is for maintaining the various replication statistics for a source and publishing them through the metrics interfaces.

Field Summary

Fields
Modifier and Type	Field and Description
`private MetricsReplicationSourceSource`	`globalSourceSource`
`private String`	`id`
`private int`	`lastQueueSize`
`private Map<String,Long>`	`lastTimeStamps`
`private static org.apache.commons.logging.Log`	`LOG`
`private MetricsReplicationSourceSource`	`singleSourceSource`

Constructor Summary

Constructors
Constructor and Description

MetricsSource(String id)
Constructor used to register the metrics

Constructors
Constructor and Description
`MetricsSource(String id)` Constructor used to register the metrics

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`clear()` Removes all metrics about this Source.
`Long`	`getAgeOfLastShippedOp()` Get AgeOfLastShippedOp
`String`	`getPeerID()` Get the slave peer ID
`int`	`getSizeOfLogQueue()` Get the sizeOfLogQueue
`long`	`getTimeStampOfLastShippedOp()` Get the timeStampsOfLastShippedOp, if there are multiple groups, return the latest one
`void`	`incrBytesSkippedInUncleanlyClosedWALs(long bytes)`
`void`	`incrCompletedRecoveryQueue()`
`void`	`incrCompletedWAL()`
`void`	`incrLogEditsFiltered()` The number of log edits filtered out.
`void`	`incrLogEditsFiltered(long delta)` Add on the number of log edits filtered
`void`	`incrLogEditsRead()` Increment the number of log edits read by one.
`private void`	`incrLogEditsRead(long delta)` Add on the the number of log edits read
`void`	`incrLogReadInBytes(long readInBytes)` increase the byte number read by source from log file
`void`	`incrRepeatedFileBytes(long bytes)`
`void`	`incrRestartedWALReading()`
`void`	`incrUncleanlyClosedWALs()`
`void`	`incrUnknownFileLengthForClosedWAL()`
`void`	`refreshAgeOfLastShippedOp(String walGroupId)` Convenience method to use the last given timestamp to refresh the age of the last edit.
`void`	`setAgeOfLastShippedOp(long timestamp, String walGroup)` Set the age of the last edit that was shipped
`void`	`setSizeOfLogQueue(int size)` Set the size of the log queue
`void`	`shipBatch(long batchSize, int sizeInKB)` Convience method to apply changes to metrics do to shipping a batch of logs.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - LOG
```
private static final org.apache.commons.logging.Log LOG
```
  - lastTimeStamps
```
private Map<String,Long> lastTimeStamps
```
  - lastQueueSize
```
private int lastQueueSize
```
  - id
```
private String id
```
  - singleSourceSource
```
private final MetricsReplicationSourceSource singleSourceSource
```
  - globalSourceSource
```
private final MetricsReplicationSourceSource globalSourceSource
```
- Constructor Detail
  - MetricsSource
```
public MetricsSource(String id)
```
    Constructor used to register the metrics
    
    Parameters:
    id - Name of the source this class is monitoring
- Method Detail
  - setAgeOfLastShippedOp
```
public void setAgeOfLastShippedOp(long timestamp,
                         String walGroup)
```
    Set the age of the last edit that was shipped
    
    Parameters:
    timestamp - write time of the edit
    walGroup - which group we are setting
  - refreshAgeOfLastShippedOp
```
public void refreshAgeOfLastShippedOp(String walGroupId)
```
    Convenience method to use the last given timestamp to refresh the age of the last edit. Used when replication fails and need to keep that metric accurate.
    
    Parameters:
    walGroupId - id of the group to update
  - setSizeOfLogQueue
```
public void setSizeOfLogQueue(int size)
```
    Set the size of the log queue
    
    Parameters:
    size - the size.
  - incrLogEditsRead
```
private void incrLogEditsRead(long delta)
```
    Add on the the number of log edits read
    
    Parameters:
    delta - the number of log edits read.
  - incrLogEditsRead
```
public void incrLogEditsRead()
```
    Increment the number of log edits read by one.
  - incrLogEditsFiltered
```
public void incrLogEditsFiltered(long delta)
```
    Add on the number of log edits filtered
    
    Parameters:
    delta - the number filtered.
  - incrLogEditsFiltered
```
public void incrLogEditsFiltered()
```
    The number of log edits filtered out.
  - shipBatch
```
public void shipBatch(long batchSize,
             int sizeInKB)
```
    Convience method to apply changes to metrics do to shipping a batch of logs.
    
    Parameters:
    batchSize - the size of the batch that was shipped to sinks.
  - incrLogReadInBytes
```
public void incrLogReadInBytes(long readInBytes)
```
    increase the byte number read by source from log file
  - clear
```
public void clear()
```
    Removes all metrics about this Source.
  - getAgeOfLastShippedOp
```
public Long getAgeOfLastShippedOp()
```
    Get AgeOfLastShippedOp
    
    Returns:
    AgeOfLastShippedOp
  - getSizeOfLogQueue
```
public int getSizeOfLogQueue()
```
    Get the sizeOfLogQueue
    
    Returns:
    sizeOfLogQueue
  - getTimeStampOfLastShippedOp
```
public long getTimeStampOfLastShippedOp()
```
    Get the timeStampsOfLastShippedOp, if there are multiple groups, return the latest one
    
    Returns:
    lastTimestampForAge
  - getPeerID
```
public String getPeerID()
```
    Get the slave peer ID
    
    Returns:
    peerID
  - incrUnknownFileLengthForClosedWAL
```
public void incrUnknownFileLengthForClosedWAL()
```
  - incrUncleanlyClosedWALs
```
public void incrUncleanlyClosedWALs()
```
  - incrBytesSkippedInUncleanlyClosedWALs
```
public void incrBytesSkippedInUncleanlyClosedWALs(long bytes)
```
  - incrRestartedWALReading
```
public void incrRestartedWALReading()
```
  - incrRepeatedFileBytes
```
public void incrRepeatedFileBytes(long bytes)
```
  - incrCompletedWAL
```
public void incrCompletedWAL()
```
  - incrCompletedRecoveryQueue
```
public void incrCompletedRecoveryQueue()
```

Class MetricsSource

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

LOG

lastTimeStamps

lastQueueSize

id

singleSourceSource

globalSourceSource

Constructor Detail

MetricsSource

Method Detail

setAgeOfLastShippedOp

refreshAgeOfLastShippedOp

setSizeOfLogQueue

incrLogEditsRead

incrLogEditsRead

incrLogEditsFiltered

incrLogEditsFiltered

shipBatch

incrLogReadInBytes

clear

getAgeOfLastShippedOp

getSizeOfLogQueue

getTimeStampOfLastShippedOp

getPeerID

incrUnknownFileLengthForClosedWAL

incrUncleanlyClosedWALs

incrBytesSkippedInUncleanlyClosedWALs

incrRestartedWALReading

incrRepeatedFileBytes

incrCompletedWAL

incrCompletedRecoveryQueue