Class MetricsUtil


  • @LimitedPrivate({"HDFS","MapReduce"})
    @Evolving
    public class MetricsUtil
    extends java.lang.Object
    Utility class to simplify creation and reporting of hadoop metrics. For examples of usage, see NameNodeMetrics.
    See Also:
    MetricsRecord, MetricsContext, ContextFactory
    • Field Summary

      Fields 
      Modifier and Type Field Description
      static org.slf4j.Logger LOG  
    • Method Summary

      All Methods Static Methods Concrete Methods 
      Modifier and Type Method Description
      static MetricsRecord createRecord​(MetricsContext context, java.lang.String recordName)
      Utility method to create and return new metrics record instance within the given context.
      static MetricsContext getContext​(java.lang.String contextName)  
      static MetricsContext getContext​(java.lang.String refName, java.lang.String contextName)
      Utility method to return the named context.
      • 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
    • Method Detail

      • getContext

        public static MetricsContext getContext​(java.lang.String contextName)
      • getContext

        public static MetricsContext getContext​(java.lang.String refName,
                                                java.lang.String contextName)
        Utility method to return the named context. If the desired context cannot be created for any reason, the exception is logged, and a null context is returned.
      • createRecord

        public static MetricsRecord createRecord​(MetricsContext context,
                                                 java.lang.String recordName)
        Utility method to create and return new metrics record instance within the given context. This record is tagged with the host name.
        Parameters:
        context - the context
        recordName - name of the record
        Returns:
        newly created metrics record