com.newrelic.agent.service.logging

Class LogSenderServiceImpl

java.lang.Object

com.newrelic.agent.service.AbstractService

com.newrelic.agent.service.logging.LogSenderServiceImpl

All Implemented Interfaces:

EventService, LogSenderService, Service, com.newrelic.api.agent.Logs

public class LogSenderServiceImpl
extends AbstractService
implements LogSenderService

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	LogSenderServiceImpl.TransactionLogs Used to record LogEvents on Transactions

Field Summary

Fields

Modifier and Type	Field and Description
protected AgentConfigListener	configListener Listener to detect changes to the agent config
static java.lang.String	LOG_SENDER_SERVICE
static java.lang.String	METHOD
protected ExtendedTransactionListener	transactionListener Lifecycle listener for log events associated with a transaction

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

logger

Constructor Summary

Constructors

Constructor and Description
LogSenderServiceImpl()

Method Summary

Modifier and Type	Method and Description
void	addHarvestableToService(java.lang.String appName) Register LogSenderHarvestable
void	clearReservoir() Reset the event reservoir to allow for the next harvest to start
void	clearReservoir(java.lang.String appName)
protected void	doStart() Start the LogSenderService
protected void	doStop() Stop the LogSenderService
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.LogEvent>	getReservoir(java.lang.String appName) Get the LogEvent reservoir
com.newrelic.api.agent.Logs	getTransactionLogs(AgentConfig config) Returns an insights instance used to track events created during a transaction.
void	harvestEvents(java.lang.String appName) Harvest and send the LogEvents
void	harvestHarvestables()
void	harvestPendingEvents()
boolean	isEnabled() Whether the LogSenderService is enabled or not
void	recordApplicationLoggingSupportabilityMetrics(boolean forwardingEnabled, boolean metricsEnabled, boolean localDecoratingEnabled, boolean logLabelsEnabled)
void	recordLogEvent(java.util.Map<com.newrelic.agent.bridge.logging.LogAttributeKey,?> attributes) Records a LogEvent.
void	setMaxSamplesStored(int maxSamplesStored) Update the current limit of events to store per harvest interval.
void	setReportPeriodInMillis(long reportPeriodInMillis) Update the reporting period for harvesting, in case it is needed for config changes.
void	storeEvent(java.lang.String appName, com.newrelic.agent.model.LogEvent event) Store a LogEvent instance

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

METHOD

public static final java.lang.String METHOD

See Also:

Constant Field Values

LOG_SENDER_SERVICE

public static final java.lang.String LOG_SENDER_SERVICE

See Also:

Constant Field Values

transactionListener

protected final ExtendedTransactionListener transactionListener

Lifecycle listener for log events associated with a transaction

configListener

protected final AgentConfigListener configListener

Listener to detect changes to the agent config

Constructor Detail

LogSenderServiceImpl

public LogSenderServiceImpl()

Method Detail

recordApplicationLoggingSupportabilityMetrics

public void recordApplicationLoggingSupportabilityMetrics(boolean forwardingEnabled,
                                                          boolean metricsEnabled,
                                                          boolean localDecoratingEnabled,
                                                          boolean logLabelsEnabled)

isEnabled

public boolean isEnabled()

Whether the LogSenderService is enabled or not

Specified by:

isEnabled in interface Service

Returns:

true if enabled, else false

doStart

protected void doStart()
                throws java.lang.Exception

Start the LogSenderService

Specified by:

doStart in class AbstractService

Throws:

java.lang.Exception - if service fails to start

doStop

protected void doStop()
               throws java.lang.Exception

Stop the LogSenderService

Specified by:

doStop in class AbstractService

Throws:

java.lang.Exception - if service fails to stop

recordLogEvent

public void recordLogEvent(java.util.Map<com.newrelic.agent.bridge.logging.LogAttributeKey,?> attributes)

Records a LogEvent. If a LogEvent occurs within a Transaction it will be associated with it.

Specified by:

recordLogEvent in interface com.newrelic.api.agent.Logs

Parameters:

attributes - A map of log event data (e.g. log message, log timestamp, log level) Each key should be a String and each value should be a String, Number, or Boolean. For map values that are not String, Number, or Boolean object types the toString value will be used.

addHarvestableToService

public void addHarvestableToService(java.lang.String appName)

Register LogSenderHarvestable

Specified by:

addHarvestableToService in interface LogSenderService

Parameters:

appName - application name

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.

setReportPeriodInMillis

public void setReportPeriodInMillis(long reportPeriodInMillis)

Description copied from interface: EventService

Update the reporting period for harvesting, in case it is needed for config changes.

Specified by:

setReportPeriodInMillis in interface EventService

Parameters:

reportPeriodInMillis - the number of millis between reporting/harvesting cycles

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.LogEvent event)

Store a LogEvent instance

Specified by:

storeEvent in interface LogSenderService

Parameters:

appName - application name

event - log event

getReservoir

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

Get the LogEvent reservoir

Parameters:

appName - app name

Returns:

Queue of LogEvent instances

harvestEvents

public void harvestEvents(java.lang.String appName)

Harvest and send the LogEvents

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

getTransactionLogs

public com.newrelic.api.agent.Logs getTransactionLogs(AgentConfig config)

Description copied from interface: LogSenderService

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:

getTransactionLogs in interface LogSenderService