AgentConfig (newrelic-agent 6.2.0 API)

All Superinterfaces:

com.newrelic.api.agent.Config, DataSenderConfig

All Known Implementing Classes:

AgentConfigImpl
```
public interface AgentConfig
extends com.newrelic.api.agent.Config, DataSenderConfig
```
General configuration for the agent. Access this by calling ServiceFactory.getConfigService().getDefaultAgentConfig() from internal classes, or AgentBridge.privateApi.getAgentConfig() from instrumentation classes.

Adding new methods to this is no longer preferred. Please access new config using the Config.getValue(String) method with the keyPath being '.' delimited hierarchy of keys, similar to the command line setting override.

Ex: AgentBridge.privateApi.getAgentConfig().getValue("instrumentation.hibernate.stats_sampler.enabled", false)
Ex: ServiceFactory.getConfigService().getDefaultAgentConfig().getValue("class_transformer.netty_dispatcher_class")

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`long`	`getApdexTInMillis()` Get the ApdexT value sent by New Relic, or the default value.
`long`	`getApdexTInMillis(java.lang.String transactionName)` If NewRelic sent an ApdexT for a key transaction, return that; otherwise, return the ApdextT value for the application.
`java.lang.String`	`getApiHost()`
`int`	`getApiPort()`
`java.lang.String`	`getApplicationName()` Get the main application.
`java.util.List<java.lang.String>`	`getApplicationNames()` The applications the Agent reports data to.
`AttributesConfig`	`getAttributesConfig()` Get the attributes configuration.
`TransactionTracerConfig`	`getBackgroundTransactionTracerConfig()` Get the transaction tracer application settings for background transactions.
`BrowserMonitoringConfig`	`getBrowserMonitoringConfig()` Get the browser monitoring application settings.
`CircuitBreakerConfig`	`getCircuitBreakerConfig()`
`ClassTransformerConfig`	`getClassTransformerConfig()` Get the class transformer settings.
`CommandParserConfig`	`getCommandParserConfig()`
`CrossProcessConfig`	`getCrossProcessConfig()` Get the cross process application settings.
`DatastoreConfig`	`getDatastoreConfig()`
`DistributedTracingConfig`	`getDistributedTracingConfig()`
`ErrorCollectorConfig`	`getErrorCollectorConfig()` Get the error collection application settings.
`ExtensionsConfig`	`getExtensionsConfig()`
`ExternalTracerConfig`	`getExternalTracerConfig()`
`boolean`	`getIbmWorkaroundEnabled()`
`java.util.List<java.lang.String>`	`getIgnoreJars()` Jars which should be ignored by java agent and thus should not be sent up to the collector.
`InfiniteTracingConfig`	`getInfiniteTracingConfig()`
`InsightsConfig`	`getInsightsConfig()` Get the Insights configuration.
`Config`	`getInstrumentationConfig()`
`JarCollectorConfig`	`getJarCollectorConfig()` Gets the JarCollectorService configuration settings.
`java.util.Set<java.lang.String>`	`getJDBCSupport()`
`JmxConfig`	`getJmxConfig()` Gets the JMX configuration settings.
`LabelsConfig`	`getLabelsConfig()` Get the agent's label configuration.
`java.lang.String`	`getLanguage()` The agent language (java).
`int`	`getLogFileCount()` The number of log files to use.
`java.lang.String`	`getLogFileName()`
`java.lang.String`	`getLogFilePath()`
`java.lang.String`	`getLogLevel()`
`int`	`getLogLimit()` The maximum number of kilobytes to write to any one log file.
`int`	`getMaxStackTraceLines()`
`java.lang.String`	`getMetricIngestUri()`
`NormalizationRuleConfig`	`getNormalizationRuleConfig()`
`<T> T`	`getProperty(java.lang.String prop)` Get a property value.
`<T> T`	`getProperty(java.lang.String key, T defaultVal)` Get a property value.
`ReinstrumentConfig`	`getReinstrumentConfig()` Gets the Reinstrumentation configuration settings.
`TransactionTracerConfig`	`getRequestTransactionTracerConfig()` Get the transaction tracer application settings for request transactions.
`int`	`getSegmentTimeoutInSec()`
`long`	`getSendDataOnExitThresholdInMillis()` Get the threshold for sending data to the server on exit.
`SpanEventsConfig`	`getSpanEventsConfig()`
`SqlTraceConfig`	`getSqlTraceConfig()` Get the sql trace application settings.
`StripExceptionConfig`	`getStripExceptionConfig()`
`ThreadProfilerConfig`	`getThreadProfilerConfig()` Get the thread profiling application settings.
`int`	`getTokenTimeoutInSec()`
`TransactionEventsConfig`	`getTransactionEventsConfig()`
`TransactionNamingScheme`	`getTransactionNamingScheme()`
`int`	`getTransactionSizeLimit()` Get the limit on the size of a transaction trace.
`TransactionTracerConfig`	`getTransactionTracerConfig()` Get the transaction tracer application settings.
`UtilizationDataConfig`	`getUtilizationDataConfig()`
`boolean`	`isAgentEnabled()`
`boolean`	`isApdexTSet()` Returns true if apdex T was specified (not just the default).
`boolean`	`isApdexTSet(java.lang.String transactionName)` Has the given transaction name been configured as a Key Transaction with an ApdexT?
`boolean`	`isAutoAppNamingEnabled()` If `true` the application name for a web transaction is determined automatically.
`boolean`	`isAutoTransactionNamingEnabled()` If the enable_auto_transaction_naming property is `true` the name of a web transaction is determined automatically.
`boolean`	`isCpuSamplingEnabled()`
`boolean`	`isCustomInstrumentationEditorAllowed()`
`boolean`	`isCustomParametersAllowed()`
`boolean`	`isDebugEnabled()`
`boolean`	`isDebugEnabled(java.lang.String key)`
`boolean`	`isGenericJDBCSupportEnabled()`
`boolean`	`isHighSecurity()`
`boolean`	`isLogDaily()` Logs a daily log if set to true.
`boolean`	`isLoggingToStdOut()`
`boolean`	`isPlatformInformationEnabled()`
`boolean`	`isSendDataOnExit()` If true send data to the server on exit.
`boolean`	`isSendEnvironmentInfo()`
`boolean`	`isSendJvmProps()` Gets the field obfuscateJvmProps.
`boolean`	`isStartupTimingEnabled()` If true, agent startup time will be recorded and sent as a supportability metric
`boolean`	`isSyncStartup()` If `true` the Agent connects to New Relic on startup.
`boolean`	`isTrimStats()`
`boolean`	`laspEnabled()`
`boolean`	`liteMode()`
`java.util.List<java.lang.String>`	`logDeprecatedProperties(java.util.Map<java.lang.String,java.lang.Object> localSettings)`
`boolean`	`openTracingEnabled()`
`java.lang.String`	`securityPoliciesToken()`
`boolean`	`waitForRPMConnect()` If `true` the Agent should wait until it has connected to New Relic before processing transactions.
`int`	`waitForTransactionsInMillis()` How long to wait (in milliseconds) for all transactions to finish before allowing the application to shutdown

Methods inherited from interface com.newrelic.api.agent.Config
getValue, getValue

Methods inherited from interface com.newrelic.agent.config.DataSenderConfig
getAuditModeConfig, getCaBundlePath, getCompressedContentEncoding, getHost, getInsertApiKey, getLicenseKey, getPort, getProxyHost, getProxyPassword, getProxyPort, getProxyScheme, getProxyUser, getTimeoutInMilliseconds, getUsePrivateSSL, isAuditMode, isPutForDataSend, isSimpleCompression

- Method Detail
  - isAgentEnabled
```
boolean isAgentEnabled()
```
  - getApplicationName
```
java.lang.String getApplicationName()
```
    Get the main application.
  - getApplicationNames
```
java.util.List<java.lang.String> getApplicationNames()
```
    The applications the Agent reports data to.
  - isAutoAppNamingEnabled
```
boolean isAutoAppNamingEnabled()
```
    If true the application name for a web transaction is determined automatically.
    
    Returns:
    
    true if auto app naming is enabled
  - isAutoTransactionNamingEnabled
```
boolean isAutoTransactionNamingEnabled()
```
    If the enable_auto_transaction_naming property is true the name of a web transaction is determined automatically.
    
    Returns:
    
    true if auto transaction naming is enabled
  - getApdexTInMillis
```
long getApdexTInMillis()
```
    Get the ApdexT value sent by New Relic, or the default value.
  - getApdexTInMillis
```
long getApdexTInMillis(java.lang.String transactionName)
```
    If NewRelic sent an ApdexT for a key transaction, return that; otherwise, return the ApdextT value for the application.
  - isApdexTSet
```
boolean isApdexTSet()
```
    Returns true if apdex T was specified (not just the default).
  - isApdexTSet
```
boolean isApdexTSet(java.lang.String transactionName)
```
    Has the given transaction name been configured as a Key Transaction with an ApdexT?
  - getTransactionSizeLimit
```
int getTransactionSizeLimit()
```
    Get the limit on the size of a transaction trace.
    
    Returns:
    
    the size limit in bytes
  - isSyncStartup
```
boolean isSyncStartup()
```
    If true the Agent connects to New Relic on startup.
  - waitForRPMConnect
```
boolean waitForRPMConnect()
```
    If true the Agent should wait until it has connected to New Relic before processing transactions. Until the Agent connects it has no URL rules or ApdexT.
  - getTransactionTracerConfig
```
TransactionTracerConfig getTransactionTracerConfig()
```
    Get the transaction tracer application settings.
  - getClassTransformerConfig
```
ClassTransformerConfig getClassTransformerConfig()
```
    Get the class transformer settings.
  - getBrowserMonitoringConfig
```
BrowserMonitoringConfig getBrowserMonitoringConfig()
```
    Get the browser monitoring application settings.
  - getRequestTransactionTracerConfig
```
TransactionTracerConfig getRequestTransactionTracerConfig()
```
    Get the transaction tracer application settings for request transactions.
  - getBackgroundTransactionTracerConfig
```
TransactionTracerConfig getBackgroundTransactionTracerConfig()
```
    Get the transaction tracer application settings for background transactions.
  - getErrorCollectorConfig
```
ErrorCollectorConfig getErrorCollectorConfig()
```
    Get the error collection application settings.
  - getThreadProfilerConfig
```
ThreadProfilerConfig getThreadProfilerConfig()
```
    Get the thread profiling application settings.
  - getSqlTraceConfig
```
SqlTraceConfig getSqlTraceConfig()
```
    Get the sql trace application settings.
  - getJmxConfig
```
JmxConfig getJmxConfig()
```
    Gets the JMX configuration settings.
    
    Returns:
    
    JMX configuration settings.
  - getJarCollectorConfig
```
JarCollectorConfig getJarCollectorConfig()
```
    Gets the JarCollectorService configuration settings.
    
    Returns:
    
    JarCollectorService configuration settings.
  - getReinstrumentConfig
```
ReinstrumentConfig getReinstrumentConfig()
```
    Gets the Reinstrumentation configuration settings.
    
    Returns:
    
    Reinstrumentation configuration settings.
  - getCrossProcessConfig
```
CrossProcessConfig getCrossProcessConfig()
```
    Get the cross process application settings.
  - getInsightsConfig
```
InsightsConfig getInsightsConfig()
```
    Get the Insights configuration.
  - getAttributesConfig
```
AttributesConfig getAttributesConfig()
```
    Get the attributes configuration.
  - getLanguage
```
java.lang.String getLanguage()
```
    The agent language (java).
  - getProperty
```
<T> T getProperty(java.lang.String prop)
```
    Get a property value.
    
    Returns:
    
    the property value or null if absent
  - getProperty
```
<T> T getProperty(java.lang.String key,
                  T defaultVal)
```
    Get a property value.
    
    Returns:
    
    the property value of the default value if absent
  - isSendEnvironmentInfo
```
boolean isSendEnvironmentInfo()
```
  - getApiHost
```
java.lang.String getApiHost()
```
  - getApiPort
```
int getApiPort()
```
  - isDebugEnabled
```
boolean isDebugEnabled()
```
  - isDebugEnabled
```
boolean isDebugEnabled(java.lang.String key)
```
  - isLoggingToStdOut
```
boolean isLoggingToStdOut()
```
  - getLogFileName
```
java.lang.String getLogFileName()
```
  - getLogFilePath
```
java.lang.String getLogFilePath()
```
  - getLogLevel
```
java.lang.String getLogLevel()
```
  - getIgnoreJars
```
java.util.List<java.lang.String> getIgnoreJars()
```
    Jars which should be ignored by java agent and thus should not be sent up to the collector.
    
    Returns:
    
    The list of jars to be ignored.
  - getLogLimit
```
int getLogLimit()
```
    The maximum number of kilobytes to write to any one log file. Default is 0 (no limit).
  - getLogFileCount
```
int getLogFileCount()
```
    The number of log files to use. Default is 1.
  - isLogDaily
```
boolean isLogDaily()
```
    Logs a daily log if set to true.
    
    Returns:
    
    True if a daily log should be created.
  - isSendDataOnExit
```
boolean isSendDataOnExit()
```
    If true send data to the server on exit.
  - getSendDataOnExitThresholdInMillis
```
long getSendDataOnExitThresholdInMillis()
```
    Get the threshold for sending data to the server on exit. Only send data if the JVM has been running longer than the threshold.
  - isCpuSamplingEnabled
```
boolean isCpuSamplingEnabled()
```
  - isSendJvmProps
```
boolean isSendJvmProps()
```
    Gets the field obfuscateJvmProps.
    
    Returns:
    
    the obfuscateJvmProps
  - isTrimStats
```
boolean isTrimStats()
```
  - isPlatformInformationEnabled
```
boolean isPlatformInformationEnabled()
```
  - getJDBCSupport
```
java.util.Set<java.lang.String> getJDBCSupport()
```
  - isGenericJDBCSupportEnabled
```
boolean isGenericJDBCSupportEnabled()
```
  - getMaxStackTraceLines
```
int getMaxStackTraceLines()
```
  - getInstrumentationConfig
```
Config getInstrumentationConfig()
```
  - getMetricIngestUri
```
java.lang.String getMetricIngestUri()
```
  - isHighSecurity
```
boolean isHighSecurity()
```
  - getIbmWorkaroundEnabled
```
boolean getIbmWorkaroundEnabled()
```
  - getLabelsConfig
```
LabelsConfig getLabelsConfig()
```
    Get the agent's label configuration.
    
    Returns:
    
    label configuration
  - getNormalizationRuleConfig
```
NormalizationRuleConfig getNormalizationRuleConfig()
```
  - isStartupTimingEnabled
```
boolean isStartupTimingEnabled()
```
    If true, agent startup time will be recorded and sent as a supportability metric
    
    Returns:
    
    true if startup timing is enabled, false otherwise
  - getCircuitBreakerConfig
```
CircuitBreakerConfig getCircuitBreakerConfig()
```
  - getStripExceptionConfig
```
StripExceptionConfig getStripExceptionConfig()
```
  - getTransactionNamingScheme
```
TransactionNamingScheme getTransactionNamingScheme()
```
  - getUtilizationDataConfig
```
UtilizationDataConfig getUtilizationDataConfig()
```
  - getDatastoreConfig
```
DatastoreConfig getDatastoreConfig()
```
  - getExternalTracerConfig
```
ExternalTracerConfig getExternalTracerConfig()
```
  - liteMode
```
boolean liteMode()
```
  - getSegmentTimeoutInSec
```
int getSegmentTimeoutInSec()
```
  - getTokenTimeoutInSec
```
int getTokenTimeoutInSec()
```
  - openTracingEnabled
```
boolean openTracingEnabled()
```
  - waitForTransactionsInMillis
```
int waitForTransactionsInMillis()
```
    How long to wait (in milliseconds) for all transactions to finish before allowing the application to shutdown
  - laspEnabled
```
boolean laspEnabled()
```
  - securityPoliciesToken
```
java.lang.String securityPoliciesToken()
```
  - isCustomInstrumentationEditorAllowed
```
boolean isCustomInstrumentationEditorAllowed()
```
  - isCustomParametersAllowed
```
boolean isCustomParametersAllowed()
```
  - getTransactionEventsConfig
```
TransactionEventsConfig getTransactionEventsConfig()
```
  - getDistributedTracingConfig
```
DistributedTracingConfig getDistributedTracingConfig()
```
  - getExtensionsConfig
```
ExtensionsConfig getExtensionsConfig()
```
  - getSpanEventsConfig
```
SpanEventsConfig getSpanEventsConfig()
```
  - logDeprecatedProperties
```
java.util.List<java.lang.String> logDeprecatedProperties(java.util.Map<java.lang.String,java.lang.Object> localSettings)
```
  - getCommandParserConfig
```
CommandParserConfig getCommandParserConfig()
```
  - getInfiniteTracingConfig
```
InfiniteTracingConfig getInfiniteTracingConfig()
```

Interface AgentConfig

Method Summary

Methods inherited from interface com.newrelic.api.agent.Config

Methods inherited from interface com.newrelic.agent.config.DataSenderConfig

Method Detail

isAgentEnabled

getApplicationName

getApplicationNames

isAutoAppNamingEnabled

isAutoTransactionNamingEnabled

getApdexTInMillis

getApdexTInMillis

isApdexTSet

isApdexTSet

getTransactionSizeLimit

isSyncStartup

waitForRPMConnect

getTransactionTracerConfig

getClassTransformerConfig

getBrowserMonitoringConfig

getRequestTransactionTracerConfig

getBackgroundTransactionTracerConfig

getErrorCollectorConfig

getThreadProfilerConfig

getSqlTraceConfig

getJmxConfig

getJarCollectorConfig

getReinstrumentConfig

getCrossProcessConfig

getInsightsConfig

getAttributesConfig

getLanguage

getProperty

getProperty

isSendEnvironmentInfo

getApiHost

getApiPort

isDebugEnabled

isDebugEnabled

isLoggingToStdOut

getLogFileName

getLogFilePath

getLogLevel

getIgnoreJars

getLogLimit

getLogFileCount

isLogDaily

isSendDataOnExit

getSendDataOnExitThresholdInMillis

isCpuSamplingEnabled

isSendJvmProps

isTrimStats

isPlatformInformationEnabled

getJDBCSupport

isGenericJDBCSupportEnabled

getMaxStackTraceLines

getInstrumentationConfig

getMetricIngestUri

isHighSecurity

getIbmWorkaroundEnabled

getLabelsConfig

getNormalizationRuleConfig

isStartupTimingEnabled

getCircuitBreakerConfig

getStripExceptionConfig

getTransactionNamingScheme

getUtilizationDataConfig

getDatastoreConfig

getExternalTracerConfig

liteMode

getSegmentTimeoutInSec

getTokenTimeoutInSec

openTracingEnabled

waitForTransactionsInMillis

laspEnabled

securityPoliciesToken

isCustomInstrumentationEditorAllowed

isCustomParametersAllowed

getTransactionEventsConfig

getDistributedTracingConfig