This page applies to an earlier version of the AppDynamics App IQ Platform.
For documentation on the latest version, see the 4.4 Documentation.


On this page:

Related pages:

Your Rating:
Results:
PatheticBadOKGoodOutstanding!
49 rates

Where to Configure Database Agent Properties

You can configure agent properties:

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

Agent properties related to naming agents or designating them as backup partners can only be configured on the command line or in the JVM start-up script. However, you can specify the Controller/Agent connection details in the controller-info.xml file.

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

Example Database 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>
    <account-access-key>165e65645-95c1-40e3-9576-6a1424de9625</account-access-key>
	<!-- The following attribute enables or disables SSL communications between the Database Agent and the Controller.-->
	<controller-ssl-enabled>false</controller-ssl-enabled>
 
	<!-- The following account-related parameters are necessary only for SaaS installations-->
	<!--account-name></account-name-->

</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 

Database Agent Properties

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

Required System Properties

Path to the Agent jar File 

Description: Provides the absolute path to  sqlijdbc_auth.dll.  

System Property: -jar

 Value: <db_agent_home>db-agent-jar

Type:  If <db_agent_name> contains spaces, you must enclose the entire name in double quotes (" ") on Windows and single quotes (' ') on Linux .

Required: Yes 

Example: -jar="D:\AppDynamics\Database Agent\db-agent.jar"

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 Controller UI.

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

System Property: -Dappdynamics.controller.hostName

Type: String

Default: None

Required: Yes

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:  For On-premise installations, port 8090 for HTTP and port 8181 for HTTPS are the default ports the Controller listens to.
For the SaaS Controller Service, port 80 for HTTP and port 443 for HTTPS are the default ports the Controller listens to.

Required: Yes

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. Prior to version 4.1, this property was required only for SaaS and multi-tenant Controllers. The account access key property is now required to authenticate all agent to Controller communications.

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

Multiple Agent Environment Properties

The following properties are useful or necessary when you are configuring your system to include more than one Database Agent or more than one agent on the same machine.

Unique Host ID Property 

Description: Uniquely identifies the machine running the Database Agent.  

The value of this property must be different for every Database Agent in your environment. 

System Property: -Dappdynamics.agent.uniqueHostId=<unique_host_ID> 

Type: ASCII string, including spaces. If <db_agent_name> contains spaces, you must enclose the entire name in double quotes (" ") on Windows and single quotes (' ') on Linux . 

Default: N/A  

Required: Required if there is also an App Agent or another Database Agent installed on that machine. 

Example: -Dappdynamics.agent.uniqueHostId="Scarborough Server Agent One"

Path to the Java Library 

Description: Provides the absolute path to  sqlijdbc_auth.dll.  

System Property: -Djava.library.path 

Value:  

  • For 64-bit systems: <agent_home>\auth\x64
  • For 32-bit systems: <agent_home>\auth\x32 

Type:  If <db_agent_name> contains spaces, you must enclose the entire name in double quotes (" ") on Windows and single quotes (' ') on Linux. 

Required: Recommended. Required for SQL Server Windows Authentication on Windows 64-bit systems. 

Example: -Djava.library.path="D:\AppDynamics\Database Agent\auth\x64"

Database Agent Name Property

Description: This property uniquely identifies the Database Agent to the Controller. 

If you already have a (pre-4.0.4) Database Agent in your environment, it can report data to a 4.0.4 and higher controller, and will automatically receive the default name, Default Database Agent. You do not need to supply a name for this agent.

System Property: -Ddbagent.name=<db_agent_name>

Type: ASCII string, including spaces. If <agent_name> contains spaces, you must enclose the entire name in double quotes (" ").

Default:  Default Database Agent 

Required:  Required when you have more than one Database Agent reporting to the Controller (whether there are more than one Database Agents running on the same machine or you have multiple Database Agents running on different machines. In addition, if you specify this property (Agent Name Property), you must also specify the Unique Host ID Property.

 Specify the Database Agent name under the following conditions:

 To enable more than one AppDynamics Database Agent to report data to the Controller, specify a unique name for this Database Agent. 

  • Any Database Agent you do not explicitly name automatically receives the name "Default Database Agent". Therefore, to prevent double-reporting of data, you must explicitly name either all the Database Agents in your environment or all but one of the Database Agents (namely, the default Database Agent) in your environment.
  • To support multiple Database Agents when you have databases spread across multiple networks, and one machine cannot access all the databases on all the networks. In this case you can have a uniquely named Database Agent in each network that monitors the databases only visible on that network. 
  • If you have multiple Database Agents running on the same machine under different user accounts to monitor SQL Server via Windows Authentication as various users.

 Naming the Database Agent is optional under the following conditions 

  •  If you have only one Database Agent, you do not need to specify the name of the Database Agent. 
  • To fortify your environment, add Database Agents to be a backup partner for other Database Agents. If you do not specify a name for the backup partner, a name will be generated for it. 

 Example-Ddbagent.name="Scarborough Network Database Agent"

Agent Is Backup Property 

Description: Specifies the name of the Database Agent you want the agent to backup. You can run additional backup Database Agents that take over for your primary Database Agents, ensuring your databases are continually monitored despite agent failure or during planned machine downtime. The additional Database Agents can run on the same machines as the primary Database Agents or different ones. 

 If you specify this property (Agent Is Backup Property), you must also specify the Unique Host ID Property system property. 

System Property: -Ddbagent.is.backup.for=<db_agent_name>

Type:  If <db_agent_name> contains spaces, you must enclose the entire name in double quotes (" ") on Windows and single quotes (' ') on Linux .

Default: N/A

Required: Only if you want the agent to backup another agent.

Example: -Ddbagent.is.backup.for="Scarborough Network Database Agent"

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 in the Welcome email AppDynamics sent to you.

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.

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