Controller Element

The controller element is a child of the appdynamics-agent element. It specifies the connection information for the Controller.

Note: The .NET Agent configuration utility only supports the configuration of one Controller per server.

Required Element:

<controller host="mycontroller.mycompany.com" port="8090" ssl="false" enable_tls12="false" high_availability="false" secure="false" enable_config_deployment="true"

Controller host attribute

The controller host attribute indicates the hostname or the IP address of the Controller. For an on-premises Controller, use the value for Application Server Host Name you provided when you installed the Controller. If you use the SaaS Controller, see the Welcome email from Splunk AppDynamics.

Type: String

Default: None

Required: Yes

Environment Variable: APPDYNAMICS.CONTROLLER.HOSTNAME

Controller port attribute

The controller port attribute specifies the HTTP or HTTPS port of the Controller. If the controller ssl attribute is set to true, specify the HTTPS port of the Controller; otherwise, specify the HTTP port.

Type: Positive Integer

Default: 8090

  • For On-premises installations, the defaults are port 8090 for HTTP and port 8181 for HTTPS.
  • For the SaaS Controller, use port 80 for HTTP or port 443 for HTTPS.

Required: Yes

Environment Variable: APPDYNAMICS.CONTROLLER.PORT

Controller ssl attribute

To enable encryption over SSL between the agent and the Controller, set the controller ssl attribute to true.

Type: Boolean

Default: false

Required: No

Environment Variable: APPDYNAMICS.CONTROLLER.SSL.ENABLED

Controller enable TLS 1.2 attribute

When you enable SSL, the agent secures communication to the Controller using the protocols set for ServicePointManager.SecurityProtocol in your application. Set the controller enable TLS 1.2 attribute to true to add TLS 1.2 as the first option in the list of protocols. This affects all secure communications from your application, not just requests to the Controller.

Type: Boolean

Default: false

Required: No

Controller high availability attribute

If you have your Controller setup for high availability, set the controller high availability attribute to true.

Type: Boolean

Default: false

Required: No

Controller secure attribute

If you set up the .NET Agent to encrypt credentials, the MSI installer package automatically sets the controller secure attribute to true. When controller secure is true, the .NET Agent ignores any credentials in the Account element or the Proxy element and uses the credentials from the Windows Credential Store. See Encrypt Credentials in .NET Agent Configuration

Type: Boolean

Default: false

Required: No

Controller enable config deployment attribute

By default, the .NET Agent checks for configuration updates to the config.xml from the Controller. If you want to disable the agent from config.xml configuration files from the Controller set the controller enable config deployment attribute to false. See Manage Configuration for .NET.

Type: Boolean

Default: true

Required: No

Controller Application Element

The controller application element is a child of the controller element. It indicates the name of the logical business application you see in the Controller interface.

The .NET Agent configuration utility only supports one business application per server. Use one of the following methods to support multiple applications:

  • Use tiers to organize different applications you instrument on a single server.
  • Or manually configure support for multiple business applications, see Configure Multiple Business Application Support for .NET.
    Note: Multiple application support requires different configuration elements, including the <applications> container element.

Required Element: <application name="MyDotNetApplication"/>

Application name attribute

Set the application name attribute to the business application you use in the Controller. If the application name does not exist, the Controller will create it when the agent registers. All instrumented applications in the config.xml register with the same business application in the Controller. See Overview of Application Monitoring.

Type: String, may also reference an environment variable. See Reference of Environment Variables.

Default: None

Required: Yes

Environment Variable: APPDYNAMICS.AGENT.APPLICATIONNAME

Note: You specify a Tier for individual applications in the App Agents Element.

Account Element

The account element is a child of the controller element. If the Controller runs in multi-tenant mode or if you use the SaaS Controller, specify the account name. For single-tenant accounts the default account name is customer1. If you are using the SaaS Controller, the account name is provided in the Welcome email from Splunk AppDynamics.

The agent requires to use your account access key as a password to authenticate with the Controller. For single-tenant accounts, you can view the access key in the Controller under Settings > License. If you are using the SaaS Controller, the account access key is provided in the Welcome email from Splunk AppDynamics.

Required Element: <account name="mycompany" password="myaccesskey"/>

Account name attribute

The account name attribute indicates the account name for the SaaS or multi-tenant Controller.

Type: String

Default: For single-tenant Controllers, the agent assumes the default of customer1 if you do not specify an account name.

Required: Only for SaaS or multi-tenant Controllers.

Environment Variable: APPDYNAMICS.AGENT.ACCOUNTNAME

Account password attribute

The account password attribute indicates the account access key for the Controller.

Type: String

Default: None

Required: Yes

Environment Variable: APPDYNAMICS.AGENT.ACCOUNTACCESSKEY

Proxy Element

The proxy element is a child of the controller element. Use it to configure the connection to the Controller through a proxy server with no authentication.

Optional Element: <proxy host="proxy-name" port="3128" enabled="true"/>

Proxy host attribute

The proxy host attribute indicates the proxy server hostname or IP address.

Type: String

Default: None

Required: host is required for the proxy element.

Proxy port attribute

The proxy port attribute indicates the proxy server port.

Type: Positive Integer

Default: None

Required: port is required for the proxy element.

Proxy enabled attribute

To enable Controller access through a proxy server, set the proxy enabled attribute to true.

Type: Boolean

Default: true

Required: No

Proxy - Authentication Element

The authentication element is a child of the proxy element. Use the authentication element to enable proxy authentication and to supply the credentials for your proxy server. For environments where security policies require you to secure credentials stored on disk, you can encrypt the credentials and store them in the Windows Credential Manager.

Optional Element: <authentication enabled="true" user_name="my_proxy_user" password="password" domain="my_windows_domain"/>

Proxy authentication enabled attribute

Set the proxy authentication enabled attribute to true to configure the agent to send credentials to a proxy server.

Type: Boolean

Default: false

Required: No

Proxy authentication username attribute

The proxy authentication username attribute indicates the name of the proxy user.

Type: String

Default: None

Required: The username attribute is required for the Authentication element

Proxy authentication password attribute

The proxy authentication password attribute indicates the password for the proxy user.

Type: String

Default: None

Required: No

Proxy authentication domain attribute

The proxy authentication domain attribute specifies the domain or realm where the username is located. This could be the host computer name, an Active Directory domain or DNS domain.

Type: String

Default: None

Required: No

Sample Controller Configuration with Proxy Authentication enabled

In this example, the agent accesses the controller through the proxy, myproxy.example.com using proxy authentication. The .NET Agent uses the credentials MyProxyUser@mydomain.com with password password to access the proxy server.

  <controller host="mycontroller.example.com">
    <application name="MyDotNetApplicaition" />
    <proxy host="myproxy.example.com" port="3128" enabled="true">
       <authentication enabled="true" user_name="MyProxyUser" password="password" domain="mydomain.com"/>
    </proxy>
  </controller>