AppDynamics Application Intelligence Platform

3.8.x Documentation

PDFs

Videos

Release Notes

Skip to end of metadata
Go to start of metadata

Where to Configure Machine Agent Properties

You can configure Machine Agent properties:

  • in the controller-info.xml file located in the <Machine_Agent_Installation_Directory>/conf directory
  • in the system properties (-D options) section in the JVM start-up script: 
           java options -jar jarfile arguments

The system properties override the settings in the controller-info.xml file. Note that the system properties are case-sensitive.

Example Machine Agent controller-info.xml File

<?xml version="1.0" encoding="UTF-8"?>
<controller-info>

	<controller-host>192.10.10.10</controller-host>

	<controller-port>8090</controller-port>

	<controller-ssl-enabled>false</controller-ssl-enabled>

	<enable-orchestration>false</enable-orchestration>

	<account-name></account-name>
	<account-access-key></account-access-key>

	<application-name></application-name>
	<tier-name></tier-name>
	<node-name></node-name>

	<force-agent-registration>false</force-agent-registration>

</controller-info>

Example Startup Configuration Using System Properties

A bash example. Note that the system properties are case-sensitive.

-Dappdynamics.controller.hostName=192.168.1.20 -Dappdynamics.controller.port=8090 -Dappdynamics.agent.applicationName=ACMEOnline -Dappdynamics.agent.tierName=Inventory -Dappdynamics.agent.nodeName=inventory1 org.tomcat.TomcatServer

Machine Agent Properties

This section describes the Machine Agent configuration properties, including their controller-info-xml elements and their system property options.

Agent-Controller Communication Properties

Controller Host Property

Description: 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

Type: String

Default: None

Required: 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 Property

Description: This is 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

Type: Positive Integer

Default: The default values are 8090 for HTTP and 8181 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.

Machine Agent Identification Properties

If the machine agent is installed on a machine that does not have an App Server agent, configure the application name, tier name and the node name. Otherwise these configurations are not required for the machine agent.

Application Name Property

Description:  This is the name of the logical business application that this JVM node belongs to. Note that 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

Type: String

Defaults: None

Required: If a registered app server agent is already installed on the same host as this machine agent, this configuration is not required.

Tier Name Property

Description:  This is the name of the logical tier that this JVM node belongs to. Note that 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

Type: String

Defaults: None

Required: If a registered app server agent is already installed on the same host as this machine agent, this configuration is not required.

Node Name Property

Description:  This is the name of the JVM node.

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

System Property: -Dappdynamics.agent.nodeName

Type: String

Defaults: None

Required: If a registered app server agent is already installed on the same host as this machine agent, this configuration is not required.

Multi-Tenant Mode Properties

If the AppDynamics Controller is running in multi-tenant mode or if you are using the AppDynamics SaaS Controller, specify the account name and account access key for this agent to authenticate with the Controller.

If the Controller is running in single-tenant mode (the default) there is no need to configure these values.

Account Name Property

Description:  This is 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

Type: String

Default: None

Required: Yes for AppDynamics SaaS Controller and other multi-tenant users; no for single-tenant users.

Account Access Key Property

Description:  This is the account access key used to authenticate with the Controller.

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

System Property: -Dappdynamics.agent.accountAccessKey

Type: String

Default: None

Required: Yes for AppDynamics SaaS Controller and other multi-tenant users; no for single-tenant users.

Proxy Properties for the Controller

These properties route data to the Controller through a proxy.

Proxy Host Property

Description:  This is the proxy host name or IP address.

Element in controller-info.xml: Not applicable

System Property: -Dappdynamics.http.proxyHost

Type: String

Default: None

Required No

Proxy Port Property

Description:  This is the proxy HTTP(S) port.

Element in controller-info.xml: Not applicable

System Property: -Dappdynamics.http.proxyPort

Type: Positive Integer

Default: None

Required: No

Other Properties

Controller SSL Enabled Property

Description:  This property 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

Type: Boolean

Default: False

Required: No

Enable Orchestration Property

Description:  When set to true, this property enables machine agent workflow task execution.
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.

See Controller Host Property and Controller Port Property.

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.

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

System Property: Not applicable

Type: Boolean

Default: False

Required: No

Force Agent Registration Property

Description:  Set to true only under the following conditions:

  • The Agent has been moved to a new application and/or tier from the UI
    and
  • You want to override that move by specifying a new application name and/or tier name in the agent configuration.

If there is already a registered app server agent installed on the same host as this machine agent, this override does not work. If you want to override the UI in this case, you must force the agent registration change from the app server agent configuration.

Element in controller-info.xml:  <force-agent-registration>

System Property: Not applicable

Type: Boolean

Default: False

Required: No

Unique Host ID Property

Description:  This property logically partitions a single physical host or virtual machine.

You can use the unique host id when you want to use the same node name for multiple nodes on the same physical machine.

Set the value to a string that is unique across the entire managed infrastructure. The string may not contain any spaces.

If this property is set on the machine agent, it must be set on the app agent as well.

Note that if more than one app agent is running on the host, to see machine agent metrics it is necessary to run a new machine agent instance every time you specify a different unique host id on that host.

Element in controller-info.xml: Not applicable

System Property: -Dappdynamics.agent.uniqueHostId

Type: String

Default: None

Required: No

Learn More