Enum InstrumentationType

  • All Implemented Interfaces:
    java.io.Serializable, java.lang.Comparable<InstrumentationType>

    public enum InstrumentationType
    extends java.lang.Enum<InstrumentationType>
    Indicates why a method was instrumented - through custom configuration, an annotation, or the agent's built in instrumentation sets.
    • Enum Constant Summary

      Enum Constants 
      Enum Constant Description
      BuiltIn
      Custom instrumentation that's built into the agent.
      CustomYaml
      Instrumentation from custom extension yaml.
      LocalCustomXml
      Instrumentation from custom extension xml.
      Pointcut
      Instrumentation added because of the agent's built in pointcuts.
      RemoteCustomXml
      Instrumentation from custom extension xml.
      TraceAnnotation
      Instrumentation added because of a trace annotation on a method.
      TracedWeaveInstrumentation
      An @Trace annotation from weaved instrumentation.
      Unknown
      This should not be used, but it indicates that a method was traced but the agent was unable to track the origin.
      WeaveInstrumentation
      Instrumentation added because of an instrumentation packaged containing a weave class.
    • Method Summary

      All Methods Static Methods Concrete Methods 
      Modifier and Type Method Description
      static InstrumentationType valueOf​(java.lang.String name)
      Returns the enum constant of this type with the specified name.
      static InstrumentationType[] 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

      • RemoteCustomXml

        public static final InstrumentationType RemoteCustomXml
        Instrumentation from custom extension xml.
      • LocalCustomXml

        public static final InstrumentationType LocalCustomXml
        Instrumentation from custom extension xml.
      • CustomYaml

        public static final InstrumentationType CustomYaml
        Instrumentation from custom extension yaml.
      • Pointcut

        public static final InstrumentationType Pointcut
        Instrumentation added because of the agent's built in pointcuts. We report them all as the same instrumentation type, causing APM to display them as timing points, even though some point cuts actually don't add tracers.
      • TracedWeaveInstrumentation

        public static final InstrumentationType TracedWeaveInstrumentation
        An @Trace annotation from weaved instrumentation.
      • WeaveInstrumentation

        public static final InstrumentationType WeaveInstrumentation
        Instrumentation added because of an instrumentation packaged containing a weave class.
      • TraceAnnotation

        public static final InstrumentationType TraceAnnotation
        Instrumentation added because of a trace annotation on a method.
      • BuiltIn

        public static final InstrumentationType BuiltIn
        Custom instrumentation that's built into the agent. These are not legacy pointcuts or weaved instrumentation. Currently all of the built in instrumentation times methods. If you want to create, non-timing built in instrumentation, please create a new enum value. The UI assumes this is timed instrumentation.
      • Unknown

        public static final InstrumentationType Unknown
        This should not be used, but it indicates that a method was traced but the agent was unable to track the origin.
    • Method Detail

      • values

        public static InstrumentationType[] 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 (InstrumentationType c : InstrumentationType.values())
            System.out.println(c);
        
        Returns:
        an array containing the constants of this enum type, in the order they are declared
      • valueOf

        public static InstrumentationType 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