Enum Tracer.TracerState

  • All Implemented Interfaces:
    java.io.Serializable, java.lang.Comparable<Tracer.TracerState>
    Enclosing interface:
    Tracer

    public static enum Tracer.TracerState
    extends java.lang.Enum<Tracer.TracerState>
    An enumeration used to represent the current tracer state.
    • Enum Constant Summary

      Enum Constants 
      Enum Constant Description
      PAUSED
      The agent is mostly idle, consuming minimal resources, ready to quickly resume back to RUNNING.
      RUNNING
      Indicates that the agent is currently fully functional - tracing, monitoring and sending data to the APM server.
      STOPPED
      Indicates that the agent had been stopped.
      UNINITIALIZED
      The agent's state before it has been started for the first time.
    • Method Summary

      All Methods Static Methods Concrete Methods 
      Modifier and Type Method Description
      static Tracer.TracerState valueOf​(java.lang.String name)
      Returns the enum constant of this type with the specified name.
      static Tracer.TracerState[] values()
      Returns an array containing the constants of this enum type, in the order they are declared.
      • Methods inherited from class java.lang.Enum

        clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf
      • Methods inherited from class java.lang.Object

        getClass, notify, notifyAll, wait, wait, wait
    • Enum Constant Detail

      • UNINITIALIZED

        public static final Tracer.TracerState UNINITIALIZED
        The agent's state before it has been started for the first time.
      • RUNNING

        public static final Tracer.TracerState RUNNING
        Indicates that the agent is currently fully functional - tracing, monitoring and sending data to the APM server.
      • PAUSED

        public static final Tracer.TracerState PAUSED
        The agent is mostly idle, consuming minimal resources, ready to quickly resume back to RUNNING. When the agent is PAUSED, it is not tracing and not communicating with the APM server. However, classes are still instrumented and threads are still alive.
      • STOPPED

        public static final Tracer.TracerState STOPPED
        Indicates that the agent had been stopped. NOTE: this state is irreversible- the agent cannot resume if it has already been stopped.
    • Method Detail

      • values

        public static Tracer.TracerState[] values()
        Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:
        for (Tracer.TracerState c : Tracer.TracerState.values())
            System.out.println(c);
        
        Returns:
        an array containing the constants of this enum type, in the order they are declared
      • valueOf

        public static Tracer.TracerState valueOf​(java.lang.String name)
        Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
        Parameters:
        name - the name of the enum constant to be returned.
        Returns:
        the enum constant with the specified name
        Throws:
        java.lang.IllegalArgumentException - if this enum type has no constant with the specified name
        java.lang.NullPointerException - if the argument is null