PDFs

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Fixed incorrect hypens, DOCS-4225

...

The following command demonstrates a startup script that includes system properties to start and configure the Java Agent . The application is "ACMEOnline", the tier is "Inventory", and the node is "Inventory1". SampleApplication is the application file. 

...

Appd reference section
java

...

-javaagent:/home/appdynamics/agent/javaagent.jar

...

-Dappdynamics.controller.hostName=mycontroller.example.com

...

-Dappdynamics.controller.port=8090

...

-Dappdynamics.agent.applicationName=ACMEOnline

...

-Dappdynamics.agent.tierName=Inventory

...

-Dappdynamics.agent.nodeName=Inventory1

...

MyApplication.jar

...

Info

System property values are case-sensitive.

...

Appd reference section

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 app 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.

...

Appd reference section

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

System Property: -Dappdynamics.controller.port

Environment Variable: APPDYNAMICS_CONTROLLER_PORT

Type: Positive Integer

Default: For On-premise installations, port 8090 for HTTP and port 8181 for HTTPS are the defaults.
For the SaaS Controller Service, port 80 for HTTP and port 443 for HTTPS are the defaults.

Required: Yes, if the Enable Orchestration property is false.

If Enable Orchestration is true, and if the app 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.

...

If true, specifies that 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.

Appd reference section

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

...

Appd reference section

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

Type: Boolean

Default: None

Required: No

...

If a business application of the configured name does not exist, it is created automatically.

Appd reference section

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

System Property: -Dappdynamics.agent.applicationName

Environment Variable: APPDYNAMICS_AGENT_APPLICATION_NAME

Type: String

Default: None

Required: Yes

...

See Business Application, Tier, and Node Naming.

Appd reference section

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

System Property: -Dappdynamics.agent.tierName

Environment Variable: APPDYNAMICS_AGENT_TIER_NAME

Type: String

Default: None

Required: Yes

...

See Business Application, Tier, and Node Naming.

Appd reference section

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

System Property: -Dappdynamics.agent.nodeName

Environment Variable: APPDYNAMICS_AGENT_NODE_NAME

Type: String

Default: None

Required: Yes

 

...

The node name is generated by the Controller. The Controller reuses node names based on the node retention period property.

Appd reference section

System Property: -Dappdynamics.agent.reuse.nodeName

Type: Boolean

Default: False

Required: No

Example: With the following configuration, 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. 

-Dappdynamics.agent.reuse.nodeName=true -Dappdynamics.agent.reuse.nodeName.prefix=reportGen

...

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

Appd reference section

System Property: -Dappdynamics.agent.reuse.nodeName.prefix

Type: String

Default: None

Required: When -Dappdynamics.agent.reuse.nodeName=true

Example: Using the following property 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.

-Dappdynamics.agent.reuse.nodeName=true -Dappdynamics.agent.reuse.nodeName.prefix=reportGen

...

New in 4.2.15.6, configure the Java Agent to automatically name nodes based upon the platform. For automatic node naming to work, you must specify an application name and a tier name.

Appd reference section

System Property:  -Dappdynamics.agent.selfService

Type: String

Values:

tibco: The Java Agent names nodes for the TIBCO process name.  See Configure the Java Agent for TIBCO BusinessWorks for more information.

Default: None

Required: No

...

The account name used to authenticate with the Controller.

Appd reference section

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

System Properties: -Dappdynamics.agent.accountName

Environment Variable: APPDYNAMICS_AGENT_ACCOUNT_NAME

Type: String

Default: None

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

...

The account access key used to authenticate with the Controller. If Use Encrypted Credentials is true, encrypt the account access key. See Encrypt Credentials for Agent Configuration.

Appd reference section

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

System Properties: -Dappdynamics.agent.accountAccessKey

Environment Variable: APPDYNAMICS_AGENT_ACCOUNT_ACCESS_KEY

Type: String

Default: None

Required: Yes

...

The proxy host name or IP address.

Appd reference section

System Property: -Dappdynamics.http.proxyHost

Type: String

Default: None

Required: No

...

The proxy HTTP(S) port.

Appd reference section

System Property: -Dappdynamics.http.proxyPort

Type: Positive Integer

Default: None

Required: No

...

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

Appd reference section

System Property: -Dappdynamics.http.proxyUser

Type: String

Default: None

Required: No

...

If Use Encrypted Credentials is false, enter the password in plain text format. If Use Encrypted Credentials is true, encrypt the password as described in Encrypt Credentials for Agent Configuration.

Appd reference section

System Property: -Dappdynamics.http.proxyPasswordFile

Type: String

Default: None

Required: No

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

...

Sets the runtime directory for all runtime files (logs, transaction configuration) for nodes that use this agent installation. If this property is specified, all agent logs are written to <Agent-Runtime-Directory>/logs/node-name and transaction configuration is written to the <Agent-Runtime-Directory>/conf/node-name directory.

Appd reference section

Element in controller-info.xml:  <agent-runtime-dir>

System Property: -Dappdynamics.agent.runtime.dir

Environment Variable: APPDYNAMICS_AGENT_BASE_DIR 

Type: String

Default: <agent_home>/nodes

Required: No

...

Sets the destination directory to which to redirect log files for a node.

Appd reference section

System Property: -Dappdynamics.agent.logs.dir

Type: String

Default: <agent_home>/logs/<Node_Name>

Required: No

...

The Controller generates node names by concatenating the specified prefix with a UUID suffix. For example, if  you set the prefix as follows:

-Dappdynamics.agent.auto.node.prefix=JoannaAutoNode

The generated node name is

...