kanela.agent.api.instrumentation.listener

Class InstrumentationRegistryListener

java.lang.Object

net.bytebuddy.agent.builder.AgentBuilder.Listener.Adapter

kanela.agent.api.instrumentation.listener.InstrumentationRegistryListener

All Implemented Interfaces:

net.bytebuddy.agent.builder.AgentBuilder.Listener

public final class InstrumentationRegistryListener
extends net.bytebuddy.agent.builder.AgentBuilder.Listener.Adapter

Captures and exposes the instrumentation modules known by Kanela. Since users of this class might be trying to access the exposed data from a ClassLoader that is not connected to Kanela's (e.g. when running an application from SBT), we will only expose data using plain Java types which are guaranteed to be loaded by the Bootstrap ClassLoader.

Nested Class Summary

Nested classes/interfaces inherited from interface net.bytebuddy.agent.builder.AgentBuilder.Listener

net.bytebuddy.agent.builder.AgentBuilder.Listener.Adapter, net.bytebuddy.agent.builder.AgentBuilder.Listener.Compound, net.bytebuddy.agent.builder.AgentBuilder.Listener.Filtering, net.bytebuddy.agent.builder.AgentBuilder.Listener.ModuleReadEdgeCompleting, net.bytebuddy.agent.builder.AgentBuilder.Listener.NoOp, net.bytebuddy.agent.builder.AgentBuilder.Listener.StreamWriting, net.bytebuddy.agent.builder.AgentBuilder.Listener.WithErrorsOnly, net.bytebuddy.agent.builder.AgentBuilder.Listener.WithTransformationsOnly

Field Summary

Fields inherited from interface net.bytebuddy.agent.builder.AgentBuilder.Listener

LOADED

Constructor Summary

Constructors

Constructor and Description
InstrumentationRegistryListener()

Method Summary

Modifier and Type	Method and Description
void	clear() Removes all collected information on this listener.
static InstrumentationRegistryListener	instance()
boolean	isModuleActive(java.lang.String moduleKey)
void	onError(java.lang.String typeName, java.lang.ClassLoader classLoader, net.bytebuddy.utility.JavaModule module, boolean loaded, java.lang.Throwable throwable)
void	onTransformation(net.bytebuddy.description.type.TypeDescription typeDescription, java.lang.ClassLoader classLoader, net.bytebuddy.utility.JavaModule module, boolean loaded, net.bytebuddy.dynamic.DynamicType dynamicType) We try to figure out if any applied transformation belongs to any of the known modules and if so, register what type was transformed.
void	register(KanelaConfiguration.ModuleConfiguration moduleConfig, TypeTransformation typeTransformation) Registers a module.
static java.util.Map<java.lang.String,java.util.List<java.lang.Throwable>>	shareErrors() Returns a map of target type to any exceptions that occurred while instrumenting that type.
static java.util.List<java.util.Map<java.lang.String,java.lang.String>>	shareModules() Returns a list of all modules known to this registry, encoded with JDK-only types that can be safely shared across classes loaded by different ClassLoaders.

Methods inherited from class net.bytebuddy.agent.builder.AgentBuilder.Listener.Adapter

onComplete, onDiscovery, onIgnored

Methods inherited from class java.lang.Object

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

Constructor Detail

InstrumentationRegistryListener

public InstrumentationRegistryListener()

Method Detail

instance

public static InstrumentationRegistryListener instance()

clear

public void clear()

Removes all collected information on this listener.

register

public void register(KanelaConfiguration.ModuleConfiguration moduleConfig,
                     TypeTransformation typeTransformation)

Registers a module. Registering a module makes the registry aware of its existence, but it does not mean that any of the module's transformations have been applied. See onTransformation for more details.

onTransformation

public void onTransformation(net.bytebuddy.description.type.TypeDescription typeDescription,
                             java.lang.ClassLoader classLoader,
                             net.bytebuddy.utility.JavaModule module,
                             boolean loaded,
                             net.bytebuddy.dynamic.DynamicType dynamicType)

We try to figure out if any applied transformation belongs to any of the known modules and if so, register what type was transformed. This helps us figure out which modules are active since we will only consider a module to be active once it has transformed a class.

Specified by:

onTransformation in interface net.bytebuddy.agent.builder.AgentBuilder.Listener

Overrides:

onTransformation in class net.bytebuddy.agent.builder.AgentBuilder.Listener.Adapter

onError

public void onError(java.lang.String typeName,
                    java.lang.ClassLoader classLoader,
                    net.bytebuddy.utility.JavaModule module,
                    boolean loaded,
                    java.lang.Throwable throwable)

Specified by:

onError in interface net.bytebuddy.agent.builder.AgentBuilder.Listener

Overrides:

onError in class net.bytebuddy.agent.builder.AgentBuilder.Listener.Adapter

isModuleActive

public boolean isModuleActive(java.lang.String moduleKey)

shareModules

public static java.util.List<java.util.Map<java.lang.String,java.lang.String>> shareModules()

Returns a list of all modules known to this registry, encoded with JDK-only types that can be safely shared across classes loaded by different ClassLoaders. Each entry contains the following properties: - configPath: The configuration path within "kanela.modules" on which the module was found. - name: The module's name. - description: The module's description. - enabled: Contains "true" or "false" to indicate whether the module will proceed to apply transformations if any of its target types are loaded. - active: Contains "true" or "false" to indicate whether the module has already applied transforamtion to any of its target types.

shareErrors

public static java.util.Map<java.lang.String,java.util.List<java.lang.Throwable>> shareErrors()

Returns a map of target type to any exceptions that occurred while instrumenting that type.