Package org.apache.hadoop.hdfs.server.namenode.top.metrics

Class TopMetrics

java.lang.Object

org.apache.hadoop.hdfs.server.namenode.top.metrics.TopMetrics

All Implemented Interfaces:

org.apache.hadoop.metrics2.MetricsSource

@Private
public class TopMetrics
extends java.lang.Object
implements org.apache.hadoop.metrics2.MetricsSource

The interface to the top metrics.

Metrics are collected by a custom audit logger, .hdfs.server.namenode.top.TopAuditLogger, which calls TopMetrics to increment per-operation, per-user counts on every audit log call. These counts are used to show the top users by NameNode operation as well as across all operations.

TopMetrics maintains these counts for a configurable number of time intervals, e.g. 1min, 5min, 25min. Each interval is tracked by a RollingWindowManager.

These metrics are published as a JSON string via .hdfs.server .namenode.metrics.FSNamesystemMBean#getTopWindows. This is done by calling .RollingWindowManager#snapshot on each RollingWindowManager.

Thread-safe: relies on thread-safety of RollingWindowManager

Field Summary

Fields

Modifier and Type	Field	Description
static org.slf4j.Logger	LOG
static java.lang.String	TOPMETRICS_METRICS_SOURCE_NAME

Constructor Summary

Constructors

Constructor	Description
TopMetrics(org.apache.hadoop.conf.Configuration conf, int[] reportingPeriods)

Method Summary

Modifier and Type	Method	Description
void	getMetrics(org.apache.hadoop.metrics2.MetricsCollector collector, boolean all)	Flatten out the top window metrics into MetricsRecords for consumption by external metrics systems.
java.util.List<RollingWindowManager.TopWindow>	getTopWindows()	Get a list of the current TopWindow statistics, one TopWindow per tracked time interval.
void	report(boolean succeeded, java.lang.String userName, java.net.InetAddress addr, java.lang.String cmd, java.lang.String src, java.lang.String dst, org.apache.hadoop.fs.FileStatus status)	Pick the same information that DefaultAuditLogger does before writing to a log file.
void	report(long currTime, java.lang.String userName, java.lang.String cmd)
void	report(java.lang.String userName, java.lang.String cmd)

Methods inherited from class java.lang.Object

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

Field Detail

LOG

public static final org.slf4j.Logger LOG

TOPMETRICS_METRICS_SOURCE_NAME

public static final java.lang.String TOPMETRICS_METRICS_SOURCE_NAME

See Also:

Constant Field Values

Constructor Detail

TopMetrics

public TopMetrics(org.apache.hadoop.conf.Configuration conf,
                  int[] reportingPeriods)

Method Detail

getTopWindows

public java.util.List<RollingWindowManager.TopWindow> getTopWindows()

Get a list of the current TopWindow statistics, one TopWindow per tracked time interval.

report

public void report(boolean succeeded,
                   java.lang.String userName,
                   java.net.InetAddress addr,
                   java.lang.String cmd,
                   java.lang.String src,
                   java.lang.String dst,
                   org.apache.hadoop.fs.FileStatus status)

Pick the same information that DefaultAuditLogger does before writing to a log file. This is to be consistent when TopMetrics is charged with data read back from log files instead of being invoked directly by the FsNamesystem

Parameters:

succeeded -

userName -

addr -

cmd -

src -

dst -

status -

report

public void report(java.lang.String userName,
                   java.lang.String cmd)

report

public void report(long currTime,
                   java.lang.String userName,
                   java.lang.String cmd)

getMetrics

public void getMetrics(org.apache.hadoop.metrics2.MetricsCollector collector,
                       boolean all)

Flatten out the top window metrics into MetricsRecords for consumption by external metrics systems. Each metrics record added corresponds to the reporting period a.k.a window length of the configured rolling windows.

Specified by:

getMetrics in interface org.apache.hadoop.metrics2.MetricsSource

Parameters:

collector -

all -