.NET Agent for Linux Environment Variables

Related pages:

This is a reference page for the configuration properties for the .NET Agent for Linux that you can set using system environment variables.

Linux environment variables are case sensitive, and Windows environment variables are not.

Agent Account Name

Specifies the account name for the SaaS or multi-tenant Controller.

Environment Variable: APPDYNAMICS_AGENT_ACCOUNT_NAME
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.

Agent Application Name

Specifies the business application you use in the Controller. If the application name does not exist, the Controller will create it when the agent registers. See Overview of Application Monitoring.

Environment Variable: APPDYNAMICS_AGENT_APPLICATION_NAME
Type: String
Default: None
Required: Yes

Agent Account Password

Specifies the account access key for the Controller.

Environment Variable: APPDYNAMICS_AGENT_ACCOUNT_ACCESS_KEY
Type: String
Default: None
Required: Yes

Agent Node Name

The name of the node.

In general, the node name must be unique within the business application and physical host. To use the same node name for multiple nodes on the same physical machine, create multiple virtual hosts using the Unique Host ID property. See Unique Host ID.

Environment Variable: APPDYNAMICS_AGENT_NODE_NAMEType: String
Default: None
Required: Yes

Agent Reuse Node Name

Set this environment variable to true to reuse node names in AppDynamics. When you set the property to true, you don't need to supply a node name, but you do need to provide a node name prefix using APPDYNAMICS_AGENT_REUSE_NODE_NAME_PREFIX.

This property is useful for monitoring environments where there are many CLRs with short life spans. When true, AppDynamics reuses the node names of historical CLRs for new CLRs. Reusing node names avoids a proliferation of differently named nodes in AppDynamics over time, particularly when the nodes are essentially identical processes that run over different times.

AppDynamics generates a node name with App, Tier, and Sequence number. The node names are pooled. For example, the sequence numbers are reused when the nodes are purged (based on the node lifetime).

When the .NET Agent for Linux starts up, it logs output to the console until it registers with the Controller and the Controller generates the node name.

The Controller reuses node names based on the node.retention.period property. See Historical and Disconnected Nodes.

Environment Variable: APPDYNAMICS_AGENT_REUSE_NODE_NAMEType: Boolean
Default: False
Required: No

Example: Using the following environmental variable specifications, the Controller generates a node name with the prefix reportGen. Node names will have suffixes --1, --2, and so on, depending on the number of nodes are running in parallel. The name of a node that is shut down and qualifies as a historical node may be reused by a new node.

APPDYNAMICS_AGENT_REUSE_NODE_NAME=true

APPDYNAMICS_AGENT_REUSE_NODE_NAME_PREFIX=reportGen

Agent Reuse Node Name Prefix

When you configure the agent to reuse node names, use this property to specify the prefix the Controller uses to generate node names dynamically.

Environment Variable: APPDYNAMICS_AGENT_REUSE_NODE_NAME_PREFIXType: String
Default: None
Required: When APPDYNAMICS_AGENT_REUSE_NODE_NAME=trueExample: Using the following environmental variable specifications, the agent directs the Controller to generate a node name with the prefix reportGen. Node names will have suffixes --1, --2, and so on, depending on how many nodes are running in parallel.

APPDYNAMICS_AGENT_REUSE_NODE_NAME=true

APPDYNAMICS_AGENT_REUSE_NODE_NAME_PREFIX=reportGen

Agent Tier Name

Specifies the name of the tier that this .NET node belongs to. Note that this is not the deployment name on the application server.

Environment Variable: APPDYNAMICS_AGENT_TIER_NAMEType: String
Default: None

Required: Yes

Analytics SSL Enabled

Specifies whether or not the .NET Agent for Linux sends the default transaction data to the Analytics Agent via SSL.

Environment Variable: APPDYNAMICS_ANALYTICS_SSL_ENABLED
Type: String
Default: False
Required: No

Analytics Hostname

Specifies the hostname or IP address of the analytics host.

Environment Variable: APPDYNAMICS_ANALYTICS_HOST_NAME
Type: String
Default: None
Required: No

Analytics Port

Specifies the port number of the analytics port.

Environment Variable: APPDYNAMICS_ANALYTICS_PORT
Type: Positive integer
Default: None
Required: No

Console Logger

Specifies the logging mode of the Console Logger.

Environment Variable: appdynamics.outputModeType: String {CONSOLE, ERROR, DEBUG, NONE}
Default: CONSOLE
Required: Not required, this is optional.

Controller Hostname

Specifies the hostname or the IP address of the AppDynamics 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 AppDynamics SaaS Controller, see the Welcome email from AppDynamics for the name of your Controller.

Environment Variable: APPDYNAMICS_CONTROLLER_HOST_NAMEType: String
Default: None
Required: Yes, may also be set in the agent AppDynamicsConfig.json file as "host".

Controller Port Number

Specifies the HTTP(S) port of the AppDynamics Controller. If the APPDYNAMICS.CONTROLLER.SSL.ENABLED environment variable is set to true, specify the HTTPS port of the Controller; otherwise, specify the HTTP port.

Environment Variable: APPDYNAMICS_CONTROLLER_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, may also be set in the agent AppDynamicsConfig.json file as "port".

Controller SSL Enabled

When set to true enables encryption over SSL between the agent and the Controller.

Environment Variable: APPDYNAMICS_CONTROLLER_SSL_ENABLED
Type: Boolean
Default: false

Required: No, may also be set in the agent AppDynamicsConfig.json file as "ssl".

Controller SSL Certfile

The path to the folder containing certificate files used to connect to the SSL-enabled Controller.

Environment Variable: APPDYNAMICS_CONTROLLER_SSL_CERTFILE
Type: String
Default: None

Required: No. Optionally, you can set in the agent AppDynamicsConfig.json file as "certfile".

Controller SSL Certdirectory

The path to the folder containing the certificate directory used to connect to the SSL-enabled Controller.

Certificate directory values are valid only if you do not input certificate files (APPDYNAMICS_CONTROLLER_SSL_CERTFILE).

Environment Variable: APPDYNAMICS_CONTROLLER_SSL_CERTDIR
Type: String
Default: None

Required: No. Optionally, you can set in the agent AppDynamicsConfig.json file as "certdir".

Controller TLS 1.2 Enabled

When set to true enables TLS 1.2 protocol for encrypted SSL connection between the agent and the Controller. This property enables when "Controller SSL Enabled" is also enabled.

Environment Variable: APPDYNAMICS_ENABLE_TLS_12
Type: Boolean
Default: False

Required: No. Optionally, you can set in the agent with the enable_tls12 property in configuration.

HTTP Proxy Host

The name of the proxy host.

Environment Variable: APPDYNAMICS_PROXY_HOST_NAME
Type: String
Default: None

Required: No, may also be set in the agent AppDynamicsConfig.json file in the "proxy" section.

HTTP Proxy Port

The port number of the proxy.

Environment Variable: APPDYNAMICS_PROXY_PORT
Type: Positive integer
Default: None

Required: No, may also be set in the agent AppDynamicsConfig.json file in the "proxy" section.

HTTP Proxy User

The name of the user that connects to the proxy.

Environment Variable: APPDYNAMICS_PROXY_AUTH_USER
Type: String
Default: None

Required: No, may also be set in the agent AppDynamicsConfig.json file in the "proxy" section.

HTTP Proxy Password

The password of the user that connects to the proxy.

Environment Variable: APPDYNAMICS_PROXY_AUTH_PASSWORD
Type: String
Default: None

Required: No, may also be set in the agent AppDynamicsConfig.json file in the "proxy" section.

Sample Agent Configuration File

The following environment variables can be set in the AppDynamicsConfig.json file:

APPDYNAMICS_CONTROLLER_HOST_NAME
APPDYNAMICS_CONTROLLER_PORT
APPDYNAMICS_CONTROLLER_SSL_ENABLED
APPDYNAMICS_CONTROLLER_SSL_CERTFILE
APPDYNAMICS_CONTROLLER_SSL_CERTDIR

The example file below demonstrates how to set these variables:

"controller":
{
   "host": "ControllerHost",
    "port": 8181,
     "account": "customer1",
      "password": "test",
       "ssl": true,
       "certdir": "/opt/appdynamics/dotnet/conf/",
       "certfile": "/opt/appdynamics/dotnet/conf/cacerts.pem",
        "enable_tls12": true,
        "proxy":
		{
			"host" : "proxy",
			"port" :900,
			"authentication" :
			{
				"username" : "user",
				"domain"  : "domainname",
				"password" :"pwd"
			}
		}
}

JS