Package io.perfmark

Class PerfMark

  • public final class PerfMark
extends java.lang.Object
    PerfMark can be automatically enabled by setting the System property io.perfmark.PerfMark.startEnabled to true.

    • Method Summary

      All Methods Static Methods Concrete Methods 
      Modifier and Type Method Description
      static Tag createTag()  
      static Tag createTag​(long id)  
      static Tag createTag​(java.lang.String name)  
      static Tag createTag​(java.lang.String name, long id)  
      static void event​(java.lang.String eventName)  
      static void event​(java.lang.String eventName, Tag tag)  
      static Link link()
      A link connects between two tasks that start asynchronously.
      static void setEnabled​(boolean value)
      Turns on or off PerfMark recording.
      static void startTask​(java.lang.String taskName)  
      static void startTask​(java.lang.String taskName, Tag tag)  
      static void stopTask​(java.lang.String taskName)  
      static void stopTask​(java.lang.String taskName, Tag tag)  

      • Methods inherited from class java.lang.Object

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

    • Method Detail

      • setEnabled

        public static void setEnabled​(boolean value)
        Turns on or off PerfMark recording. Don't call this method too frequently; while neither on nor off have very high overhead, transitioning between the two may be slow.
        Parameters:
        value - true to enable PerfMark recording, or false to disable it.

      • startTask

        public static void startTask​(@CompileTimeConstant
                             java.lang.String taskName,
                             Tag tag)

      • startTask

        public static void startTask​(@CompileTimeConstant
                             java.lang.String taskName)

      • event

        public static void event​(@CompileTimeConstant
                         java.lang.String eventName,
                         Tag tag)

      • event

        public static void event​(@CompileTimeConstant
                         java.lang.String eventName)

      • stopTask

        public static void stopTask​(@CompileTimeConstant
                            java.lang.String taskName,
                            Tag tag)

      • stopTask

        public static void stopTask​(@CompileTimeConstant
                            java.lang.String taskName)

      • createTag

        public static Tag createTag()

      • createTag

        public static Tag createTag​(long id)

      • createTag

        public static Tag createTag​(java.lang.String name)

      • createTag

        public static Tag createTag​(java.lang.String name,
                            long id)

      • link

        public static Link link()
        A link connects between two tasks that start asynchronously. When link() is called, an association between the most recently started task and a yet to be named task on another thread, is created. Links are a one-to-many relationship. A single started task can have multiple associated tasks on other threads.
        Returns:
        A Link to be used in other tasks.