Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: CORE-51475
Appd tocbox

On this page:

Table of Contents
maxLevel2
minLevel2

As an alternative to using system properties or controller-info.xml to configure the application name, tier name, and so on, you can configure the agent based on environment variables. Environment variables give you another mechanism for configuring the agent based on dynamically set values.   

About Environment Variables

To configure the agent with environment variables, simply set the value of the appropriate environment variable in the environment in which the monitored application runs.

There are environment variables defined for most of the agent settings you can configure in the controller-info.xml file. For example, there are variables for the application name, node name, Controller connection settings, and more.  

For example, to To set the node name for the agent using an environment variable, use set the value of the APPDYNAMICS_AGENT_NODE_NAME environment variable . The following command sets the variable to node23. When the agent subsequently starts up, it automatically takes node23 as its node nameas you normally would for the operating system you are using and restart the JVM.

For example, to set the variable from the Linux command line, enter this command

No Format
export APPDYNAMICS_AGENT_NODE_NAME=node23

Since an agent setting can be specified in several places, the agent applies the following order of priority in taking a value for the setting:  

  1. Environment variable 
  2. System property 
  3. controller-info.xml

For each setting, the agent checks each of these sources. For the value, the agent uses the value from the first source that contains a non-empty value (based on the order shown).

Environment Variables

You can use the following environment variables to configure the Java Agent.When the agent subsequently starts up, it takes node23 as its node name. 

Environment Variables Used by the Agent

The Java Agent takes configuration settings from the following environment variables, when set: 

Environment VariableEquivalent property
APPDYNAMICS_CONTROLLER_HOST_NAME<controller-host>
APPDYNAMICS_CONTROLLER_PORT<controller-port>
APPDYNAMICS_CONTROLLER_SSL_ENABLED<controller-ssl-enabled>
APPDYNAMICS_AGENT_APPLICATION_NAME<application-name>
APPDYNAMICS_AGENT_TIER_NAME<tier-name>
APPDYNAMICS_AGENT_NODE_NAME<node-name>
APPDYNAMICS_AGENT_ACCOUNT_NAME_ENV_VAR<account-name>
APPDYNAMICS_AGENT_ACCOUNT_ACCESS_KEY_ENV_VAR<account-access-key>
APPDYNAMICS_AGENT_UNIQUE_HOST_ID_ENV_VARUnique host name
APPDYNAMICS_AGENT_BASE_DIR<agent-runtime-dir>

Notice that not all configurable agent settings are configurable through environment variables. For those settings, you need to use system properties or controller-info.xml, as described on Java Agent Configuration Properties