org.hawkular.apm.tools.instrumenter

Class InstrumenterUtil

java.lang.Object

org.hawkular.apm.tools.instrumenter.InstrumenterUtil

public class InstrumenterUtil
extends Object

This class provides utility functions for instrumenting an archive at build time.

Author:

gbrown

Constructor Summary

Constructors

Constructor and Description
InstrumenterUtil()

Method Summary

Modifier and Type	Method and Description
static org.hawkular.apm.api.model.config.CollectorConfiguration	getCollectorConfiguration(String type, String version, boolean offline) This method returns the complete collector configuration for the requested version.
static void	initRuntime(org.hawkular.apm.api.model.config.CollectorConfiguration config) This method initializes the instrumentation rules at runtime.
static boolean	instrument(org.jboss.shrinkwrap.api.spec.JavaArchive archive, org.hawkular.apm.api.model.config.CollectorConfiguration config) This method attempts to instrument the classes within the supplied archive using the instrumentation rules associated with the supplied configuration.
static void	main(String[] args) The main function for the instrumenter util.

Methods inherited from class java.lang.Object

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

Constructor Detail

InstrumenterUtil

public InstrumenterUtil()

Method Detail

main

public static void main(String[] args)

The main function for the instrumenter util.

Parameters:

args - The archive path and config json path

instrument

public static boolean instrument(org.jboss.shrinkwrap.api.spec.JavaArchive archive,
                                 org.hawkular.apm.api.model.config.CollectorConfiguration config)

This method attempts to instrument the classes within the supplied archive using the instrumentation rules associated with the supplied configuration. If the classes are instrumented, then the return value will be true.

Parameters:

archive - The archive to be instrumented

config - The instrumentation rules

Returns:

Whether the archive was instrumented (changed)

getCollectorConfiguration

public static org.hawkular.apm.api.model.config.CollectorConfiguration getCollectorConfiguration(String type,
                                                                                                 String version,
                                                                                                 boolean offline)
                                                                                          throws Exception

This method returns the complete collector configuration for the requested version.

Parameters:

type - The client environment type

version - The version

offline - Whether to obtain the config offline (otherwise contacts remove maven repo)

Returns:

The collector configuration, or null if not found

Throws:

Exception - Failed to get collector configuration

initRuntime

public static void initRuntime(org.hawkular.apm.api.model.config.CollectorConfiguration config)

This method initializes the instrumentation rules at runtime.

Parameters:

config - The collector configuration