com.newrelic.agent.service.analytics

Class TransactionEventsService

java.lang.Object

com.newrelic.agent.service.AbstractService

com.newrelic.agent.service.analytics.TransactionEventsService

All Implemented Interfaces:

AgentConfigListener, EventService, Service, TransactionListener

public class TransactionEventsService
extends AbstractService
implements EventService, TransactionListener, AgentConfigListener

The TransactionEventsService collects per-transaction analytic events and transmits them to the collectors. This class implements parts of both the Recording Analytics Events for Transactions and Agent Support for Synthetics specifications. Both specifications can be found in Confluence.

Ideally, all analytic events are stored until harvest and then transmitted. If the number of events exceeds a configurable limit, events are replaced using a "reservoir" sampling algorithm.

If the transaction was generated by New Relic Synthetics, however, events are stored deterministically up to a fixed limit after which the reservoir storage is used as a fall-back mechanism.

This service can be configured using transaction_events with enabled or max_samples_stored.

Field Summary

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

logger

Constructor Summary

Constructors

Constructor and Description
TransactionEventsService(TransactionDataToDistributedTraceIntrinsics transactionDataToDistributedTraceIntrinsics)

Method Summary

Modifier and Type	Method and Description
void	addHarvestableToService(java.lang.String appName)
void	clearReservoir() Reset the event reservoir to allow for the next harvest to start
void	configChanged(java.lang.String appName, AgentConfig agentConfig)
TransactionEvent	createEvent(TransactionData transactionData, TransactionStats transactionStats, java.lang.String metricName)
void	dispatcherTransactionFinished(TransactionData transactionData, TransactionStats transactionStats) Called after a dispatcher transaction finishes on the request thread.
protected void	doStart() Register appropriate listeners.
protected void	doStop() Unregister listeners and clear state.
DistributedSamplingPriorityQueue<TransactionEvent>	getDistributedSamplingReservoir(java.lang.String appName)
java.lang.String	getEventHarvestIntervalMetric() Returns the metric name for this service that records the actual interval in which the harvest is happening.
java.lang.String	getEventHarvestLimitMetric() Returns the metric name for this service that records the harvest limit.
int	getMaxSamplesStored() Returns the current limit of events to store per harvest interval.
DistributedSamplingPriorityQueue<TransactionEvent>	getOrCreateDistributedSamplingReservoir(java.lang.String appName)
java.lang.String	getReportPeriodInSecondsMetric() Returns the metric name for this service that records the expected report period.
void	harvestEvents(java.lang.String appName) Perform the harvest of any pending events right now.
boolean	isEnabled() Is the service enabled.
void	setMaxSamplesStored(int maxSamplesStored) Update the current limit of events to store per harvest interval.

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

Constructor Detail

TransactionEventsService

public TransactionEventsService(TransactionDataToDistributedTraceIntrinsics transactionDataToDistributedTraceIntrinsics)

Method Detail

addHarvestableToService

public void addHarvestableToService(java.lang.String appName)

clearReservoir

public void clearReservoir()

Description copied from interface: EventService

Reset the event reservoir to allow for the next harvest to start

Specified by:

clearReservoir in interface EventService

isEnabled

public final boolean isEnabled()

Description copied from interface: Service

Is the service enabled.

Specified by:

isEnabled in interface Service

Returns:

true if the service is enabled

doStart

protected void doStart()
                throws java.lang.Exception

Register appropriate listeners.

Specified by:

doStart in class AbstractService

Throws:

java.lang.Exception

doStop

protected void doStop()
               throws java.lang.Exception

Unregister listeners and clear state.

Specified by:

doStop in class AbstractService

Throws:

java.lang.Exception

getMaxSamplesStored

public int getMaxSamplesStored()

Description copied from interface: EventService

Returns the current limit of events to store per harvest interval. For example, if the maximum size for a 60 second harvest is is 10000 events and this service is configured for 5 second harvests this would return 833 (60/5 = 12, 10000/12 = 833).

Specified by:

getMaxSamplesStored in interface EventService

Returns:

the maximum number of events to store per configured harvest interval

setMaxSamplesStored

public void setMaxSamplesStored(int maxSamplesStored)

Description copied from interface: EventService

Update the current limit of events to store per harvest interval.

Specified by:

setMaxSamplesStored in interface EventService

Parameters:

maxSamplesStored - the new maximum number of events to store per harvest interval.

harvestEvents

public void harvestEvents(java.lang.String appName)

Description copied from interface: EventService

Perform the harvest of any pending events right now.

Specified by:

harvestEvents in interface EventService

Parameters:

appName - the application to harvest for

getEventHarvestIntervalMetric

public java.lang.String getEventHarvestIntervalMetric()

Description copied from interface: EventService

Returns the metric name for this service that records the actual interval in which the harvest is happening. This is different from the report period below because it will be the actual time between harvests, rather than the expected time.

Specified by:

getEventHarvestIntervalMetric in interface EventService

Returns:

harvest interval metric name

getReportPeriodInSecondsMetric

public java.lang.String getReportPeriodInSecondsMetric()

Description copied from interface: EventService

Returns the metric name for this service that records the expected report period. This will be the value we get back on connect.

Specified by:

getReportPeriodInSecondsMetric in interface EventService

Returns:

report period metric name

getEventHarvestLimitMetric

public java.lang.String getEventHarvestLimitMetric()

Description copied from interface: EventService

Returns the metric name for this service that records the harvest limit. This will be the value we get back on connect.

Specified by:

getEventHarvestLimitMetric in interface EventService

Returns:

event harvest limit metric name

dispatcherTransactionFinished

public void dispatcherTransactionFinished(TransactionData transactionData,
                                          TransactionStats transactionStats)

Description copied from interface: TransactionListener

Called after a dispatcher transaction finishes on the request thread.

Specified by:

dispatcherTransactionFinished in interface TransactionListener

Parameters:

transactionData - the final data from the transaction

transactionStats - the final metric information from the transaction

createEvent

public TransactionEvent createEvent(TransactionData transactionData,
                                    TransactionStats transactionStats,
                                    java.lang.String metricName)

configChanged

public void configChanged(java.lang.String appName,
                          AgentConfig agentConfig)

Specified by:

configChanged in interface AgentConfigListener

getDistributedSamplingReservoir

public DistributedSamplingPriorityQueue<TransactionEvent> getDistributedSamplingReservoir(java.lang.String appName)

getOrCreateDistributedSamplingReservoir

public DistributedSamplingPriorityQueue<TransactionEvent> getOrCreateDistributedSamplingReservoir(java.lang.String appName)