com.newrelic.agent.xray

Class XRaySessionService

java.lang.Object

com.newrelic.agent.service.AbstractService

com.newrelic.agent.xray.XRaySessionService

All Implemented Interfaces:

HarvestListener, Service, IXRaySessionService

public class XRaySessionService
extends AbstractService
implements HarvestListener, IXRaySessionService

Maintains the active collection of X-Ray sessions. This object registers itself to be notified after every harvest cycle, and at that time it expires out old sessions. The processSessionsList method is called from the processEnabled method of StartXRayCommand, which gets triggered from the harvest cycle if get_agent_commands returns any X-Ray commands. This object is not thread-safe.

Field Summary

Fields

Modifier and Type	Field and Description
static int	MAX_SESSION_COUNT
static long	MAX_SESSION_DURATION_SECONDS
static long	MAX_TRACE_COUNT

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

logger

Constructor Summary

Constructors

Constructor and Description
XRaySessionService()

Method Summary

Modifier and Type	Method and Description
void	addListener(XRaySessionListener listener)
void	afterHarvest(java.lang.String appName) Called after the harvest.
void	beforeHarvest(java.lang.String appName, StatsEngine statsEngine) Called before the harvest.
protected void	doStart()
protected void	doStop()
boolean	isEnabled() Is the service enabled.
java.util.Map<?,?>	processSessionsList(java.util.List<java.lang.Long> incomingList, IRPMService rpmService) This method accepts a list of Longs which are assumed to be X-Ray session IDs.
void	removeListener(XRaySessionListener listener)

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

Methods inherited from interface com.newrelic.agent.service.Service

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

Field Detail

MAX_SESSION_COUNT

public static final int MAX_SESSION_COUNT

See Also:

Constant Field Values

MAX_SESSION_DURATION_SECONDS

public static final long MAX_SESSION_DURATION_SECONDS

See Also:

Constant Field Values

MAX_TRACE_COUNT

public static final long MAX_TRACE_COUNT

See Also:

Constant Field Values

Constructor Detail

XRaySessionService

public XRaySessionService()

Method Detail

isEnabled

public boolean isEnabled()

Description copied from interface: Service

Is the service enabled.

Specified by:

isEnabled in interface Service

Specified by:

isEnabled in interface IXRaySessionService

Returns:

true if the service is enabled

doStart

protected void doStart()
                throws java.lang.Exception

Specified by:

doStart in class AbstractService

Throws:

java.lang.Exception

doStop

protected void doStop()
               throws java.lang.Exception

Specified by:

doStop in class AbstractService

Throws:

java.lang.Exception

beforeHarvest

public void beforeHarvest(java.lang.String appName,
                          StatsEngine statsEngine)

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 appName)

Description copied from interface: HarvestListener

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

Specified by:

afterHarvest in interface HarvestListener

processSessionsList

public java.util.Map<?,?> processSessionsList(java.util.List<java.lang.Long> incomingList,
                                              IRPMService rpmService)

This method accepts a list of Longs which are assumed to be X-Ray session IDs. It does the necessary adds and deletes to make our local store match that new list of active X-Ray session IDs. For new sessions being added, the metadata is fetched from RPM in order to populate details about the session via a call to get_xray_metadata on the collector.

Specified by:

processSessionsList in interface IXRaySessionService

Parameters:

incomingList -

rpmService -

Returns:

result value to be returned from startXrayCommand.processRunning()

addListener

public void addListener(XRaySessionListener listener)

Specified by:

addListener in interface IXRaySessionService

removeListener

public void removeListener(XRaySessionListener listener)

Specified by:

removeListener in interface IXRaySessionService