com.newrelic.agent.extension

Class ExtensionService

java.lang.Object

com.newrelic.agent.service.AbstractService

com.newrelic.agent.extension.ExtensionService

All Implemented Interfaces:

HarvestListener, Service

public class ExtensionService
extends AbstractService
implements HarvestListener

Extensions are jars, xml, or yml configuration files that allow the agent to be extended with extra instrumentation and additional JMX configuration. Multiple extension files can be combined into a single jar extension. The agent reads extensions from within the agent jar file itself by loading all of the xml and yml files in META-INF/extensions. It also reads from the extensions directory in the New Relic home directory. Extensions directory is checked every harvest for changes. If changes are detected, the instrumentation is reloaded and matching classes are retransformed.

Field Summary

Fields inherited from class com.newrelic.agent.service.AbstractService

logger

Constructor Summary

Constructors

Constructor and Description
ExtensionService(ConfigService configService, ExtensionsLoadedListener extensionsLoadedListener)

Method Summary

Modifier and Type	Method and Description
void	addConstruct(ConfigurationConstruct construct) This method allows other services to extend the yml parser to support their own custom yml.
protected void	addInternalExtensionForTesting(Extension ext)
void	afterHarvest(java.lang.String pAppName) Called after the harvest.
void	beforeHarvest(java.lang.String pAppName, StatsEngine pStatsEngine) Called before the harvest.
protected void	doStart()
protected void	doStop()
java.util.List<ExtensionClassAndMethodMatcher>	getEnabledPointCuts() Returns the point cuts read in from extension files.
java.util.Set<Extension>	getExtensions() Returns the extensions last loaded from the extensions directory.
java.util.Map<java.lang.String,Extension>	getInternalExtensions() Returns a map of extensions.
java.util.Set<java.io.File>	getWeaveExtensions() Returns the files that contain weave instrumentation.
boolean	isEnabled() Always enabled to support dynamic instrumentation.
protected Extension	validateExtension(Extension extension, java.util.Map<java.lang.String,Extension> existingExtensions) Validates extension against existingExtensions for name and version issues.

Methods inherited from class com.newrelic.agent.service.AbstractService

getLogger, getName, isStarted, isStartedOrStarting, isStopped, isStoppedOrStopping, start, stop

Methods inherited from class java.lang.Object

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

Constructor Detail

ExtensionService

public ExtensionService(ConfigService configService,
                        ExtensionsLoadedListener extensionsLoadedListener)

Method Detail

isEnabled

public boolean isEnabled()

Always enabled to support dynamic instrumentation.

Specified by:

isEnabled in interface Service

Returns:

true if the service is enabled

doStart

protected void doStart()

Specified by:

doStart in class AbstractService

doStop

protected void doStop()

Specified by:

doStop in class AbstractService

beforeHarvest

public void beforeHarvest(java.lang.String pAppName,
                          StatsEngine pStatsEngine)

Description copied from interface: HarvestListener

Called before the harvest. The service may or may not be currently connected.

Specified by:

beforeHarvest in interface HarvestListener

afterHarvest

public void afterHarvest(java.lang.String pAppName)

Description copied from interface: HarvestListener

Called after the harvest. The service may or may not be currently connected.

Specified by:

afterHarvest in interface HarvestListener

addInternalExtensionForTesting

protected void addInternalExtensionForTesting(Extension ext)

validateExtension

protected Extension validateExtension(Extension extension,
                                      java.util.Map<java.lang.String,Extension> existingExtensions)

Validates extension against existingExtensions for name and version issues.

Parameters:

extension - The extension to validate.

existingExtensions - Map to compare against for version issues.

Returns:

validated extension, or null if not valid.

getEnabledPointCuts

public final java.util.List<ExtensionClassAndMethodMatcher> getEnabledPointCuts()

Returns the point cuts read in from extension files. This includes XML and YML files.

Returns:

The pointcuts form extension files.

addConstruct

public void addConstruct(ConfigurationConstruct construct)

This method allows other services to extend the yml parser to support their own custom yml.

Parameters:

construct -

getInternalExtensions

public final java.util.Map<java.lang.String,Extension> getInternalExtensions()

Returns a map of extensions. The key is the extension name.

Returns:

The map of xml and yml extensions.

getExtensions

public final java.util.Set<Extension> getExtensions()

Returns the extensions last loaded from the extensions directory. May change on harvest cycle if contents from disk change.

getWeaveExtensions

public java.util.Set<java.io.File> getWeaveExtensions()

Returns the files that contain weave instrumentation.