org.apache.flume.channel.file.instrumentation

Interface FileChannelCounterMBean

All Superinterfaces:

ChannelCounterMBean

All Known Implementing Classes:

FileChannelCounter

public interface FileChannelCounterMBean
extends ChannelCounterMBean

Method Summary

Modifier and Type	Method and Description
long	getCheckpointBackupWriteErrorCount() A count of the number of errors encountered while trying to write the backup checkpoints.
long	getCheckpointWriteErrorCount() A count of the number of errors encountered while trying to write the checkpoints.
int	getClosed() The numeric representation (0/1) of the negated value of the open flag.
long	getEventPutErrorCount() A count of the number of IOExceptions encountered while trying to put() onto the channel.
long	getEventTakeErrorCount() A count of the number of errors encountered while trying to take() from the channel, including IOExceptions and corruption-related errors.
int	getUnhealthy() A value of 0 represents that the channel is in a healthy state: it is either starting up (i.e.
boolean	isOpen()

Methods inherited from interface org.apache.flume.instrumentation.ChannelCounterMBean

getChannelCapacity, getChannelFillPercentage, getChannelSize, getEventPutAttemptCount, getEventPutSuccessCount, getEventTakeAttemptCount, getEventTakeSuccessCount, getStartTime, getStopTime, getType

Method Detail

isOpen

boolean isOpen()

getClosed

int getClosed()

The numeric representation (0/1) of the negated value of the open flag.

getUnhealthy

int getUnhealthy()

A value of 0 represents that the channel is in a healthy state: it is either starting up (i.e. the replay is running) or already started up successfully. A value of 1 represents that the channel is in a permanently failed state, which means that the startup was unsuccessful due to an exception during the replay. Once the channel started up successfully the *ErrorCount (or the ratio of the *AttemptCount and *SuccessCount) counters should be used to check whether it is functioning properly. Note: this flag doesn't report the channel as unhealthy if the configuration failed because the ChannelCounter might not have been instantiated/started yet.

getEventPutErrorCount

long getEventPutErrorCount()

A count of the number of IOExceptions encountered while trying to put() onto the channel.

See Also:

FileChannel.FileBackedTransaction.doPut(Event)

getEventTakeErrorCount

long getEventTakeErrorCount()

A count of the number of errors encountered while trying to take() from the channel, including IOExceptions and corruption-related errors.

See Also:

FileChannel.FileBackedTransaction.doTake()

getCheckpointWriteErrorCount

long getCheckpointWriteErrorCount()

A count of the number of errors encountered while trying to write the checkpoints. This includes any Throwables.

See Also:

Log.BackgroundWorker.run()

getCheckpointBackupWriteErrorCount

long getCheckpointBackupWriteErrorCount()

A count of the number of errors encountered while trying to write the backup checkpoints. This includes any Throwables.

See Also:

EventQueueBackingStoreFile.startBackupThread()