PDFs


This page applies to an earlier version of the AppDynamics App IQ Platform.
See the latest version of the documentation.


On this page:

Related pages:

Your Rating:
Results:
PatheticBadOKGoodOutstanding!
57 rates

This topic describes the agent configuration properties, including controller-info-xml elements, system property options, and environment variables where applicable.  You can configure agent system properties in different ways depending on your operating system and the installation package you use. For many properties you have a choice of using controller-info-xml, system properties (on the command line or in the startup script), and environment variables. 

System Property Syntax

  • System properties are case-sensitive.
  • Values that contain spaces must be surrounded with double quotes.

Reference

Controller Host

This is the host name or the IP address of the AppDynamics Controller, e.g. 192.168.1.22 or myhost or myhost.abc.com. This is the same host that you use to access the AppDynamics browser-based user interface.

Element in controller-info.xml:  <controller-host>

System Property: -Dappdynamics.controller.hostName

Environment Variable: APPDYNAMICS_CONTROLLER_HOST_NAME

Type: String

Default: None

Required: Yes If the Enable Orchestration property is false.
If Enable Orchestration is true, and if the agent is deployed in a compute cloud instance created by an AppDynamics workflow, do not set the Controller host unless you want to override the auto-detected value. See Enable Orchestration Property.

Controller Port

The HTTP(S) port of the AppDynamics Controller. This is the same port that you use to access the AppDynamics browser-based user interface. If the Controller SSL Enabled property is set to true, specify the HTTPS port of the Controller; otherwise specify the HTTP port. See Controller SSL Enabled Property.

Element in controller-info.xml:  <controller-port>

System Property: -Dappdynamics.controller.port

Environment Variable: APPDYNAMICS_CONTROLLER_PORT

Type: Positive Integer

On-premises Default:port 8090 for HTTP and port 8181 for HTTPS

SaaS Default: SaaS Controller, port 80 for HTTP and port 443 for HTTPS

Required: Yes, if the Enable Orchestration property is false.
If Enable Orchestration is true, and if the agent is deployed in a compute cloud instance created by an AppDynamics workflow, do not set the Controller port unless you want to override the auto-detected value. See Enable Orchestration Property.

Account Access Key

The account access key used to authenticate with the Controller. This key is generated at installation time and can be found by viewing the license information in the Controller Settings. See License Information.

Element in controller-info.xml:  <account-access-key>

System Property: -Dappdynamics.agent.accountAccessKey

Environment Variable: APPDYNAMICS_AGENT_ACCOUNT_ACCESS_KEY

Type: String

Default: None

Required: Prior to version 4.1, this property was required only for SaaS and multi-tenant Controllers. For versions 4.1 and higher, the account access key property is required to authenticate all agent to Controller communications.

Example: -Dappdynamics.agent.accountAccessKey=165e65645-95c1-40e3-9576-6a1424de9625

Enable Server Monitoring

This enables Server Monitoring. To use Server Monitoring you need the appropriate license.

Element in controller-info.xml:  <sim-enabled>

System Property: -Dappdynamics.sim.enabled

Environment Variable: APPDYNAMICS_SIM_ENABLED

Type: Boolean

Default: false

Required: Required to enable Server Monitoring. See Enable Server Monitoring.

Account Name

The account name used to authenticate with the Controller. If you are using the AppDynamics SaaS Controller, the Account Name is provided in the Welcome email sent by AppDynamics.

Element in controller-info.xml:  <account-name>

System Property: -Dappdynamics.agent.accountName

Environment Variable: APPDYNAMICS_AGENT_ACCOUNT_NAME

Type: String

Default: None

Required: Yes for AppDynamics SaaS Controller and multi-tenant users; not for single-tenant mode (the default). When the agent is registered with an AppDynamics SaaS Controller, features used to run Remediation Scripts are disabled If you later reconfigure the agent controller-info.xml to register with a non-SaaS or on-premise Controller, the agent can run local scripts as usual.

Agent Runtime Directory

Sets the runtime directory for all runtime files, such as logs, for nodes that use this agent installation. If this property is specified, all agent logs are written to <agent-runtime-dir>/logs/node-name. Used when deploying multiple machine agents from a common directory. See Deploy Multiple Machine Agents From a Common Directory. 

 

System Property: -Dappdynamics.agent.runtime.dir

Environment Variable: N/A

Type: String

Default: None

Required: No

Proxy Host 

The proxy host name or IP address. 

Element in controller-info.xml: N/A

System Property: 

-Dappdynamics.http.proxyHost

-Dappdynamics.https.proxyHost (Use if the agent is communicating with the Controller over SSL. Proxy authentication cannot be used with SSL.)

Environment Variable: N/A

Type: String

Default: None

Required: Yes, if using a proxy to connect to the Controller. Otherwise, no.

Proxy Port

The proxy HTTP(S) port. The default ports are 8090 (HTTP) and 443 (HTTPS). 

Element in controller-info.xml: N/A

System Property: 

-Dappdynamics.http.proxyPort

-Dappdynamics.https.proxyPort (Use if the agent is communicating with the Controller over SSL. Proxy authentication cannot be used with SSL.)

Environment Variable: N/A

Type: Positive Integer

Default: None

Required: Yes, if using a proxy to connect to the Controller. Otherwise, no.

Proxy User Name 

The name of the user that is authenticated by the proxy host.

Element in controller-info.xml: N/A

System Property: -Dappdynamics.http.proxyUser

Environment Variable: N/A

Type: String

Default: None

Required: No

Proxy Password File 

The absolute path to the file containing the password of the user that is authenticated by the proxy host. The password must be the first line of the file and must be in clear (unencrypted) text. To encrypt or obfuscate passwords, see Encrypt Credentials for Agent Configuration.

Element in controller-info.xml: N/A

System Property: -Dappdynamics.http.proxyPasswordFile

Environment Variable: N/A

Type: String

Default: None

Required: No

Example: -Dappdynamics.http.proxyPasswordFile=/path/to/file-with-password

Controller SSL Enabled 

Specifies whether the agent should use SSL (HTTPS) to connect to the Controller. If SSL Enabled is true, set the Controller Port property to the HTTPS port of the Controller. See Controller Port Property.

Element in controller-info.xml:  <controller-ssl-enabled>

System Property: -Dappdynamics.controller.ssl.enabled

Environment Variable: APPDYNAMICS_CONTROLLER_SSL_ENABLED

Type: Boolean

Default: false

Required: No

Controller Keystore Filename

Use a different Java truststore file when full validation of Controller SSL certificates is enabled. The default is <machine-agent-home>/conf/cacerts.jks). You can include an absolute path to the alternative truststore file or use a relative path from <machine-agent-home> (for example, conf/my-alternate-truststore.jks). See Enable SSL for the Standalone Machine Agent.

Element in controller-info.xml:  <controller-keystore-filename>

System Property: N/A

Environment Variable: N/A

Type: String

Default: None

Required: No

Controller Keystore Password 

The plain text or encrypted value of the Controller certificate password. To encrypt or obfuscate passwords, see Encrypt Credentials for Agent Configuration.

Element in controller-info.xml: <controller-keystore-password>

System Property: N/A

Environment Variable: N/A

Type: String

Default: None

Required: No

Force Default SSL Certificate Validation 

Used to override the default behavior for SSL validation.

This property can have three states:

true:  Forces the agent to perform full validation of the certificate sent by the controller, enabling the agent to enforce the SSL trust chain.  Use this setting when a public certificate authority(CA) signs your Controller SSL certificate.

false: Forces the agent to perform minimal validation of the certificate. This property disables full validation of the Controller's SSL certificate. Use this setting when full validation of a SaaS certificate fails.

unspecified:  The validation performed by the agent depends on the context:

    • If the agent is connecting to a SaaS controller, full validation is performed.
    • If the agent is connecting to an on-premise controller, and the cacerts.jks file is present, then full validation is performed using the cacerts.jks file.
    • If the agent is connecting to an on-premise controller, and there is no cacerts.jks file, then minimal validation is performed 

Element in controller-info.xml: N/A

System Property: -Dappdynamics.force.default.ssl.certificate.validation

Environment Variable: N/A

Type: Boolean

Default: None

Required: No

Enable HTTP Listener

When set to true, this property enables the Machine Agent HTTP listener. You can send metrics to the Machine Agent using its HTTP listener. You can report metrics through the Machine Agent by making HTTP calls to the agent instead of piping to the agent through sysout.

Element in controller-info.xml: N/A

System Property: -Dmetric.http.listener

Environment Variable: N/A

Type: Boolean

Default: false

Required: No

HTTP Listener Port

To enable the Machine Agent HTTP listener, you must also specify the HTTP listener port.

Element in controller-info.xml: N/A

System Property: -Dmetric.http.listener.port

Environment Variable: N/A

Type: Numeric

Default: 8293

Required: Only if the HTTP listener is enabled.

.NET Compatibility Mode

You must enable this mode if you want to collect and view Machine or Server metrics on a server with Machine and .NET Agents installed. For additional requirements and important notes, see .NET Compatibility Mode.

Element in controller-info.xml: <dotnet-compatibility-mode>

System Property: -Dappdynamics.machine.agent.dotnetCompatibilityMode

Environment Variable: N/A

Type: boolean

Default: false

Required: This mode is required if you want to collect and view Machine or Server metrics on a server with Machine and .NET Agents installed.

Enable Orchestration

Enables the Machine Agent workflow task execution when set to True. It also enables auto-detection of the controller host and port when the app server is a compute cloud instance created by an AppDynamics orchestration workflow. In a cloud compute environment, auto-detection is necessary for the Create Machine tasks in the workflow to run correctly. The machine agent polls for task executions only when orchestration is enabled. If the host machine on which this agent resides is not created through AppDynamics workflow orchestration, this property should be set to false. Also see Controller Host Property and Controller Port Property.

 

Element in controller-info.xml:  <enable-orchestration>

System Property: N/A

Environment Variable: N/A

Type: Boolean

Default: false

Required: No

Create Node if Absent

Force the machine agent to create an APM node when the agent registers with the controller. 

Element in controller-info.xml: <create-node-if-absent>

System Property: -Dappdynamics.machine.agent.registration.createNodeIfAbsent

Environment Variable: N/A

Type: Boolean

Default: true

Required: No. If you set the app/tier/node in your controller-info.xml file (existing upgrades or by accident), you can prevent the machine agent from creating APM nodes by setting this flag to false. See Standalone Machine Agent Installation Scenarios.

Unique Host ID

This property logically partitions a single physical host or virtual machine. In the context of installing the machine agent, the unique Host ID property is not required. However if you don’t define a unique Host ID, the Machine Agent uses the Java API to get the host ID. The results from the API can be inconsistent and in fact, the same JVM can sometimes return a different value for the same machine each time the machine agent is restarted. To avoid problems of this nature, we recommend that you set the value of unique Host ID to the host ID that you want to see in the UI. 

Element in controller-info.xml: <unique-host-id>

System Property: -Dappdynamics.agent.uniqueHostId

Environment Variable: APPDYNAMICS_AGENT_UNIQUE_HOST_ID

Type: ASCII string without spaces and must be unique across the entire managed infrastructure. 

Default: None

Required: Optional, but recommended.

Service Availability Update Interval

This setting controls the time, in milliseconds, to wait between sending Service Availability Monitoring periodic events to the controller. For support, licensing and other details,  see Service Availability Monitoring.

Element in controller-info.xml: <sam-event-update-interval-millis>

System Property: -Dappdynamics.machine.agent.sam.event.updateIntervalMillis

Environment Variable: N/A

Type: Positive integer

Default: 300000 ms (5 minutes)

Required: No

Machine Hierarchy

You need a Server Monitoring license to use this feature.

This setting enables you to group servers together into arbitrary hierarchies by specifying a hierarchical path to the server. The server hierarchy displays in the Metric Browser and on the Server Monitoring Dashboard. The server hierarchy is also used to select subgroups of machines for health rules. The last element of the path indicates the server name, a name of your choice. This name appears as the Name on the Servers list. If the path contains spaces it must be enclosed in double-quotes. For more information, see Machine Agent Hierarchy.

Element in controller-info.xml: <machine-path>

System Property: -Dappdynamics.machine.agent.hierarchyPath

Environment Variable: APPDYNAMICS_MACHINE_HIERARCHY_PATH

Type: ASCII string with path elements that are separated by a "|" (bar). 

Default: The value specified by Unique Host ID. If the last part of the machine hierarchy is empty, the Unique Host ID is the machine name. For example, if machine hierarchy is "Data Center 1|Rack 2|" and Unique host ID is "Host ID 3", then the machine hierarchy will become "Data Center 1|Rack 2|Host ID 3".

Required: No

Limitation: The length of the characters composing the machine-path up to, but not including, the last pipe cannot exceed 95 characters.

Examples:

  • System Properties: -Dappdynamics.machine.agent.hierarchyPath= "Data Center 1|Rack 2|Machine3"
  • controller-info.xml: 

    <machine-path>
         "Data Center 1|Rack 2|Machine3"
    </machine-path>
  • Environment Variable: APPDYNAMICS_MACHINE_HIERARCHY_PATH="Data Center 1|Rack 2|Machine3

Independent Standalone Machine Agent Install Scenario

Typically, you should only need to use the following properties if you are installing the Machine Agent on a server that does not have any AppDynamics app agents installed on it. 

Application Name

The name of the logical business application that this JVM node belongs to. This is not the deployment name(ear/war/jar) on the application server. If a business application of the configured name does not exist, it is created automatically.

Element in controller-info.xml:  <application-name>

System Property: -Dappdynamics.agent.applicationName

Environment Variable: APPDYNAMICS_AGENT_APPLICATION_NAME

Type: String

Defaults: None

Required: No. See Standalone Machine Agent Installation Scenarios.

Tier Name 

The name of the logical tier that this JVM node belongs to. This is not the deployment name (ear/war/jar) on the application server. If a tier of the configured name does not exist, it is created automatically.

Element in controller-info.xml: <tier-name>

System Property: -Dappdynamics.agent.tierName

Environment Variable: APPDYNAMICS_AGENT_TIER_NAME

Type: String

Defaults: None

Required: No. See Standalone Machine Agent Installation Scenarios.

Node Name 

The name of the JVM node. When not specified, this defaults to Node1 for the Machine Agent.

Element in controller-info.xml: <node-name>

System Property: -Dappdynamics.agent.nodeName

Environment Variable: APPDYNAMICS_AGENT_NODE_NAME

Type: String

Defaults: None

Required: No. See Standalone Machine Agent Installation Scenarios.

  • No labels