com.newrelic.agent.service.analytics

Class SpanEventsServiceImpl

java.lang.Object

com.newrelic.agent.service.AbstractService

com.newrelic.agent.service.analytics.SpanEventsServiceImpl

All Implemented Interfaces:

AgentConfigListener, SpanEventsService, EventService, Service, TransactionListener

public class SpanEventsServiceImpl
extends AbstractService
implements AgentConfigListener, SpanEventsService, TransactionListener

The SpanEventsServiceImpl collects span events and transmits them to the collectors.

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

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

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	SpanEventsServiceImpl.Builder

Field Summary

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

logger

Constructor Summary

Constructors

Constructor and Description
SpanEventsServiceImpl(SpanEventsServiceImpl.Builder builder)

Method Summary

Modifier and Type	Method and Description
void	addHarvestableToService(java.lang.String appName) There is only one event reservoir for Distributed Tracing so there only needs to be one harvestable for it.
static SpanEventsServiceImpl.Builder	builder()
void	clearReservoir() Reset the event reservoir to allow for the next harvest to start
void	configChanged(java.lang.String appName, AgentConfig agentConfig)
void	dispatcherTransactionFinished(TransactionData transactionData, TransactionStats transactionStats) Called after a dispatcher transaction finishes on the request thread.
protected void	doStart()
protected void	doStop()
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.
com.newrelic.agent.interfaces.SamplingPriorityQueue<com.newrelic.agent.model.SpanEvent>	getOrCreateDistributedSamplingReservoir()
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) For the setting to take effect, the reservoir must be re-created.
void	storeEvent(com.newrelic.agent.model.SpanEvent event)

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

SpanEventsServiceImpl

public SpanEventsServiceImpl(SpanEventsServiceImpl.Builder builder)

Method Detail

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

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

isEnabled

public 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

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

storeEvent

public void storeEvent(com.newrelic.agent.model.SpanEvent event)

Specified by:

storeEvent in interface SpanEventsService

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)

For the setting to take effect, the reservoir must be re-created. Callers should harvest pending events before calling this.

Specified by:

setMaxSamplesStored in interface EventService

Parameters:

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

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

addHarvestableToService

public void addHarvestableToService(java.lang.String appName)

There is only one event reservoir for Distributed Tracing so there only needs to be one harvestable for it.

Specified by:

addHarvestableToService in interface SpanEventsService

configChanged

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

Specified by:

configChanged in interface AgentConfigListener

getOrCreateDistributedSamplingReservoir

public com.newrelic.agent.interfaces.SamplingPriorityQueue<com.newrelic.agent.model.SpanEvent> getOrCreateDistributedSamplingReservoir()

Specified by:

getOrCreateDistributedSamplingReservoir in interface SpanEventsService

builder

public static SpanEventsServiceImpl.Builder builder()