com.newrelic.agent.service.analytics

Class InsightsServiceImpl

java.lang.Object

com.newrelic.agent.service.AbstractService

com.newrelic.agent.service.analytics.InsightsServiceImpl

All Implemented Interfaces:

InsightsService, EventService, Service, com.newrelic.api.agent.Insights

public class InsightsServiceImpl
extends AbstractService
implements InsightsService

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	InsightsServiceImpl.TransactionInsights

Field Summary

Fields

Modifier and Type	Field and Description
protected AgentConfigListener	configListener
protected ExtendedTransactionListener	transactionListener

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

logger

Constructor Summary

Constructors

Constructor and Description
InsightsServiceImpl()

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	clearReservoir(java.lang.String appName)
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.
java.lang.String	getReportPeriodInSecondsMetric() Returns the metric name for this service that records the expected report period.
DistributedSamplingPriorityQueue<com.newrelic.agent.model.CustomInsightsEvent>	getReservoir(java.lang.String appName)
com.newrelic.api.agent.Insights	getTransactionInsights(AgentConfig config) Returns an insights instance used to track events created during a transaction.
void	harvestEvents(java.lang.String appName) Perform the harvest of any pending events right now.
void	harvestHarvestables()
void	harvestPendingEvents()
boolean	isEnabled() Is the service enabled.
void	recordCustomEvent(java.lang.String eventType, java.util.Map<java.lang.String,?> attributes)
void	setMaxSamplesStored(int maxSamplesStored) Update the current limit of events to store per harvest interval.
void	storeEvent(java.lang.String appName, com.newrelic.agent.model.CustomInsightsEvent event) Store event into Reservoir following usual sampling using the given appName.

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

transactionListener

protected final ExtendedTransactionListener transactionListener

configListener

protected final AgentConfigListener configListener

Constructor Detail

InsightsServiceImpl

public InsightsServiceImpl()

Method Detail

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

recordCustomEvent

public void recordCustomEvent(java.lang.String eventType,
                              java.util.Map<java.lang.String,?> attributes)

Specified by:

recordCustomEvent in interface com.newrelic.api.agent.Insights

addHarvestableToService

public void addHarvestableToService(java.lang.String appName)

Specified by:

addHarvestableToService in interface InsightsService

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.

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

clearReservoir

public void clearReservoir(java.lang.String appName)

harvestHarvestables

public void harvestHarvestables()

harvestPendingEvents

public void harvestPendingEvents()

storeEvent

public void storeEvent(java.lang.String appName,
                       com.newrelic.agent.model.CustomInsightsEvent event)

Description copied from interface: InsightsService

Store event into Reservoir following usual sampling using the given appName. Preference should be given to storing the event in TransactionInsights instead of this.

Specified by:

storeEvent in interface InsightsService

getReservoir

public DistributedSamplingPriorityQueue<com.newrelic.agent.model.CustomInsightsEvent> getReservoir(java.lang.String appName)

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

getTransactionInsights

public com.newrelic.api.agent.Insights getTransactionInsights(AgentConfig config)

Description copied from interface: InsightsService

Returns an insights instance used to track events created during a transaction. The events will be reported to the Transaction's application, or to the default application if not in a transaction.

Specified by:

getTransactionInsights in interface InsightsService