Instrumentation

public interface Instrumentation

Options to register asm class visitors and to configure the instrumentation process.

Summary

Public methods
`abstract @NonNull SetProperty<@NonNull String>`	`getExcludes()` The set of glob patterns to exclude from instrumentation.
`abstract void`	`setAsmFramesComputationMode(@NonNull FramesComputationMode mode)` Sets the frame computation mode that will be applied to the bytecode of the classes instrumented by ASM visitors registered through `transformClassesWith`.
`abstract void`	`<ParamT extends InstrumentationParameters> transformClassesWith( @NonNull Class<@NonNull AsmClassVisitorFactory<@NonNull ParamT>> classVisitorFactoryImplClass, @NonNull InstrumentationScope scope, @NonNull Function1<@NonNull ParamT, Unit> instrumentationParamsConfig )` Registers an asm class visitor to instrument the classes defined by the given scope.

Public methods

getExcludes

abstract @NonNull SetProperty<@NonNull String> getExcludes()

The set of glob patterns to exclude from instrumentation. Classes matching any of these patterns in the project sources and dependencies jars do not get instrumented by any AsmClassVisitorFactory registered via transformClassesWith.

Do not add the file extension to the end as the filtration is done on compiled classes and the .class suffix is not included in the pattern matching.

Example usage:

androidComponents {
    onVariants(selector().all(), {
        instrumentation.excludes.add("com`/`example`/`donotinstrument`/`**")
        instrumentation.excludes.add("**`/`*Test")
    })
}

setAsmFramesComputationMode

abstract void setAsmFramesComputationMode(@NonNull FramesComputationMode mode)

Sets the frame computation mode that will be applied to the bytecode of the classes instrumented by ASM visitors registered through transformClassesWith. The default mode is to copy frames.

When setting this multiple times, the mode with the highest enum value will be selected.

transformClassesWith

abstract void <ParamT extends InstrumentationParameters> transformClassesWith(
    @NonNull Class<@NonNull AsmClassVisitorFactory<@NonNull ParamT>> classVisitorFactoryImplClass,
    @NonNull InstrumentationScope scope,
    @NonNull Function1<@NonNull ParamT, Unit> instrumentationParamsConfig
)

Registers an asm class visitor to instrument the classes defined by the given scope. An instance of the factory will be instantiated and used to create visitors for each class.

Example:

androidComponents {
    onVariants(selector().all(), {
        instrumentation.transformClassesWith(AsmClassVisitorFactoryImpl.class,
                                             InstrumentationScope.Project) { params ->
            params.x = "value"
        }
        instrumentation.setAsmFramesComputationMode(COMPUTE_FRAMES_FOR_INSTRUMENTED_METHODS)
    })
}

Parameters
`@NonNull Class<@NonNull AsmClassVisitorFactory<@NonNull ParamT>> classVisitorFactoryImplClass`	the factory class implementing `AsmClassVisitorFactory`
`@NonNull InstrumentationScope scope`	either instrumenting the classes of the current project or the project and its dependencies
`@NonNull Function1<@NonNull ParamT, Unit> instrumentationParamsConfig`	the configuration function to be applied to the instantiated `InstrumentationParameters` object before passed to `AsmClassVisitorFactory.createClassVisitor`.