com.newrelic.agent.config

Interface ApplicationLoggingConfig

All Known Implementing Classes:

ApplicationLoggingConfigImpl

public interface ApplicationLoggingConfig

Configuration for application logging features. These settings do not pertain to agent logs.

Method Summary

Modifier and Type	Method and Description
java.util.List<java.lang.String>	getForwardingContextDataExclude() Get the exclude list for context data.
java.util.List<java.lang.String>	getForwardingContextDataInclude() Get the include list for context data.
java.util.Set<java.lang.String>	getLogLabelsExcludeSet() Get the set of excluded labels.
int	getMaxSamplesStored() Get the max number of LogEvents that can be stored during a harvest period before sampling takes place.
boolean	isEnabled() Determines whether the application_logging features are completely disabled or can be controlled individually.
boolean	isForwardingContextDataEnabled() Allow the agent to forward context data along with the application logs to New Relic.
boolean	isForwardingEnabled() Allow the agent to forward application logs to New Relic.
boolean	isLocalDecoratingEnabled() Allow the agent to decorate application log files and console output with New Relic specific linking metadata.
boolean	isLogLabelsEnabled() Allow the agent to add labels to application logs.
boolean	isMetricsEnabled() Allow metrics to be generated to provide data such as the number of lines logged at each log level.
java.util.Map<java.lang.String,java.lang.String>	removeExcludedLogLabels(java.util.Map<java.lang.String,java.lang.String> labels) Removes excluded labels from the labels map.

Method Detail

isEnabled

boolean isEnabled()

Determines whether the application_logging features are completely disabled or can be controlled individually.

Returns:

true if the application_logging features can be controlled individually, false if the entire stanza is disabled

isMetricsEnabled

boolean isMetricsEnabled()

Allow metrics to be generated to provide data such as the number of lines logged at each log level.

Returns:

true is log metrics are enabled, otherwise false

isForwardingEnabled

boolean isForwardingEnabled()

Allow the agent to forward application logs to New Relic.

Returns:

true is log forwarding is enabled, otherwise false

isForwardingContextDataEnabled

boolean isForwardingContextDataEnabled()

Allow the agent to forward context data along with the application logs to New Relic.

Returns:

true if context data forwarding is enabled, false otherwise

isLocalDecoratingEnabled

boolean isLocalDecoratingEnabled()

Allow the agent to decorate application log files and console output with New Relic specific linking metadata.

Returns:

true is local log decorating is enabled, otherwise false

getMaxSamplesStored

int getMaxSamplesStored()

Get the max number of LogEvents that can be stored during a harvest period before sampling takes place.

Returns:

max number of LogEvents stored per harvest

getForwardingContextDataInclude

java.util.List<java.lang.String> getForwardingContextDataInclude()

Get the include list for context data.

Returns:

getForwardingContextDataExclude

java.util.List<java.lang.String> getForwardingContextDataExclude()

Get the exclude list for context data.

Returns:

a list of Strings

isLogLabelsEnabled

boolean isLogLabelsEnabled()

Allow the agent to add labels to application logs.

Returns:

true if logging labels are enabled, false otherwise

removeExcludedLogLabels

java.util.Map<java.lang.String,java.lang.String> removeExcludedLogLabels(java.util.Map<java.lang.String,java.lang.String> labels)

Removes excluded labels from the labels map.

Returns:

a map of filtered log labels

getLogLabelsExcludeSet

java.util.Set<java.lang.String> getLogLabelsExcludeSet()

Get the set of excluded labels.

Returns:

a Set of excluded labels