Package io.opentelemetry.javaagent.extension.ignore

Interface IgnoredTypesBuilder

public interface IgnoredTypesBuilder
This interface defines different ways to ignore/allow instrumenting classes or packages.

This interface should not be implemented by the javaagent extension developer - the javaagent will provide the implementation.

  • Method Details

    • ignoreClass

      @CanIgnoreReturnValue IgnoredTypesBuilder ignoreClass(String classNameOrPrefix)
      Ignore the class or package specified by classNameOrPrefix and exclude it from being instrumented. Calling this will overwrite any previous settings for passed prefix.

      classNameOrPrefix can be the full class name (ex. com.example.MyClass), package name (ex. com.example.mypackage.), or outer class name (ex com.example.OuterClass$)

      Returns:
      this

    • allowClass

      @CanIgnoreReturnValue IgnoredTypesBuilder allowClass(String classNameOrPrefix)
      Allow the class or package specified by classNameOrPrefix to be instrumented. Calling this will overwrite any previous settings for passed prefix; in particular, calling this method will override any previous ignoreClass(String) setting.

      classNameOrPrefix can be the full class name (ex. com.example.MyClass), package name (ex. com.example.mypackage.), or outer class name (ex com.example.OuterClass$)

      Returns:
      this

    • ignoreClassLoader

      @CanIgnoreReturnValue IgnoredTypesBuilder ignoreClassLoader(String classNameOrPrefix)
      Ignore the class loader specified by classNameOrPrefix and exclude it from being instrumented. Calling this will overwrite any previous settings for passed prefix.

      classNameOrPrefix can be the full class name (ex. com.example.MyClass), package name (ex. com.example.mypackage.), or outer class name (ex com.example.OuterClass$)

      Returns:
      this

    • allowClassLoader

      @CanIgnoreReturnValue IgnoredTypesBuilder allowClassLoader(String classNameOrPrefix)
      Allow the class loader specified by classNameOrPrefix to be instrumented. Calling this will overwrite any previous settings for passed prefix; in particular, calling this method will override any previous ignoreClassLoader(String) setting.

      classNameOrPrefix can be the full class name (ex. com.example.MyClass), package name (ex. com.example.mypackage.), or outer class name (ex com.example.OuterClass$)

      Returns:
      this

    • ignoreTaskClass

      @CanIgnoreReturnValue IgnoredTypesBuilder ignoreTaskClass(String classNameOrPrefix)
      Ignore the Java concurrent task class specified by classNameOrPrefix and exclude it from being instrumented. Concurrent task classes implement or extend one of the following classes:

      Calling this will overwrite any previous settings for passed prefix.

      classNameOrPrefix can be the full class name (ex. com.example.MyClass), package name (ex. com.example.mypackage.), or outer class name (ex com.example.OuterClass$)

      Returns:
      this