General Settings

The following table is the complete list of settings in the require statement that you insert into your application code. Not all of these settings are required.

Property Name Description
controllerHostName The IP address or hostname of your Controller. For SaaS, you will receive this URL in your welcome email from Splunk AppDynamics. For on-premises, you will set these when you install the Controller.
controllerPort

The port to which the agent connects to the Controller. It is 8090 for an on-premises Controller and 443 for a SaaS Controller.

controllerSslEnabled Set this property to true if connecting to the Controller via SSL.
accountName The account name on the Controller to which this agent will report.
accountAccessKey Account access key on the Controller.
applicationName Name that represents the entire application in the Splunk AppDynamics console.
tierName Name that represents your Node.js app or service in the flow maps.
nodeName Name of the Node.js process to be monitored by this agent. See Node Names.
noNodeNameSuffix Optional, set to true if you do not want the agent to add a suffix, such as -0, -1, -2, and so on, to the node name. See Node Names.
proxyHost, proxyPort Set these options to route data to the Controller through a proxy server. The proxyHost is the hostname or IP address of the proxy server. The proxyPort is the proxy server's HTTP or HTTPS port, whichever you are using. If you set the host, you must set the port as well.
proxyUser, proxyPasswordFile Configure the proxy username and password file if the proxy server requires credentials.
proxy Set this property to true if you want to use the Java proxy version of the Node.js Agent.
alwaysAddEumMetadataInHttpHeaders Set this property to true to have the Node.js Agent write business transaction metadata to the XHR header and in a cookie even if the request is considered cross-origin. See the description for the equivalent setting always-add-eum-metadata-in-http-headers in App Agent Node Properties Reference.
btEntryPointDelayDisabled true | false - Optional, defaults to false. Setting this property to true can accelerate the startup of business transactions, but it can adversely affect the drill-down in distributed transactions.
debug Set this property to true to enable debug level logging for the agent. The default is false.
logging The location, level, and other settings related to agent logging. See Node.js Agent Logging.
maxProcessSnapshotsPerPeriod Optional. The default is 2. The number of automatic process snapshots allowed in processSnapshotCountResetPeriodSeconds seconds.
processSnapshotCountResetPeriodSeconds Optional. The default is 60. Frequency, in seconds, at which the automatic process snapshot count is reset to 0.
autoSnapshotDurationSeconds

Optional. The default is 10. Length, in seconds, of automatically-triggered process snapshots.
proxyAutolaunchDisabled

true | false - Optional, defaults to false. Set this property to true if you need to manually launch the proxy for this agent. See Start the Proxy Manually for Node.js.
proxyCtrlDir Directory path for the directory containing the domain control socket, which the agent uses to start an Splunk AppDynamics node. Optional, set by the agent. Set manually if you are setting up a multi-tenant proxy. See Share a Proxy Among Node.js Agents.
rootTmpDir

Directory path for the root of the directory that stores the agent files. Optional, defaults to /tmp/appds.
tmpDir Directory path for the subdirectory of the root directory for the monitored node. Optional, defaults to a hash of the Controller info for the instrumented node.
reuseNode

Set this property to true to enable reusing node names. This property is useful for monitoring environments where there are many nodes with short life spans. The default is false.

Note: A SIGTERM (15) shutdown of the Node.js process is a requirement for reuseNode feature.
reuseNodePrefix Set this property to the string that prefixes the node name when reuseNode is set to true. The Controller uses this prefix to generate node names dynamically.
certificateFile Directory path for the directory containing the .pem SSL certificate.
uniqueHostId The unique host ID can be set to any value that will identify the host. If a value is not specified, the agent will generate the host ID. This setting is only available for the proxyless version of the Node.js Agent.