PDFs

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Fixed incorrect hypens, DOCS-4225; also changed property values to monospace font

...

The proxy host name or IP address. 

Appd reference section

Element in controller-info.xml: N/A

System Property: 

-Dappdynamics.http.proxyHost

-Dappdynamics.https.proxyHost (Use if the agent is communicating with the Controller over SSL. Proxy authentication cannot be used with SSL.)

Environment Variable: N/A

Type: String

Default: None

Required: Yes, if using a proxy to connect to the Controller. Otherwise, no.

...

The proxy HTTP(S) port. The default ports are 8090 (HTTP) and 443 (HTTPS). 

Appd reference section

Element in controller-info.xml: N/A

System Property: 

-Dappdynamics.http.proxyPort

-Dappdynamics.https.proxyPort (Use if the agent is communicating with the Controller over SSL. Proxy authentication cannot be used with SSL.)

Environment Variable: N/A

Type: Positive Integer

Default: None

Required: Yes, if using a proxy to connect to the Controller. Otherwise, no.

...

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

Appd reference section

Element in controller-info.xml: N/A

System Property: -Dappdynamics.http.proxyUser

Environment Variable: N/A

Type: String

Default: None

Required: No

...

The absolute path to the file containing the password of the user that is authenticated by the proxy host. The password must be the first line of the file and must be in clear (unencrypted) text. To encrypt or obfuscate passwords, see Encrypt Credentials for Agent Configuration.

Appd reference section

Element in controller-info.xml: N/A

System Property: -Dappdynamics.http.proxyPasswordFile

Environment Variable: N/A

Type: String

Default: None

Required: No

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

Controller SSL Enabled 

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.

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

...

Used to override the default behavior for SSL validation.

Appd reference section

This property can have three states:

true:  Forces the agent to perform full validation of the certificate sent by the controller, enabling the agent to enforce the SSL trust chain.  Use this setting when a public certificate authority(CA) signs your Controller SSL certificate.

false: Forces the agent to perform minimal validation of the certificate. This property disables full validation of the Controller's SSL certificate. Use this setting when full validation of a SaaS certificate fails.

unspecified:  The validation performed by the agent depends on the context:

    • If the agent is connecting to a SaaS controller, full validation is performed.
    • If the agent is connecting to an on-premise controller, and the cacerts.jks file is present, then full validation is performed using the cacerts.jks file.
    • If the agent is connecting to an on-premise controller, and there is no cacerts.jks file, then minimal validation is performed 

Element in controller-info.xml: N/A

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

Environment Variable: N/A

Type: Boolean

Default: None

Required: No

...

When set to true, this property enables the Machine Agent HTTP listener. You can send metrics to the Machine Agent using its HTTP listener. You can report metrics through the Machine Agent by making HTTP calls to the agent instead of piping to the agent through sysout.

Appd reference section

Element in controller-info.xml: N/A

System Property: -Dmetric.http.listener

Environment Variable: N/A

Type: Boolean

Default: false

Required: No

...

To enable the Machine Agent HTTP listener, you must also specify the HTTP listener port.

Appd reference section

Element in controller-info.xml: N/A

System Property: -Dmetric.http.listener.port

Environment Variable: N/A

Type: Numeric

Default: 8293

Required: Only if the HTTP listener is enabled.

...

You must enable this mode if you want to collect and view Machine or Server metrics on a server with Machine and .NET Agents installed. For additional requirements and important notes, see .NET Compatibility Mode.

Appd reference section

Element in controller-info.xml: <dotnet-compatibility-mode>

System Property: -Dappdynamics.machine.agent.dotnetCompatibilityMode

Environment Variable: N/A

Type: boolean

Default: false

Required: This mode is required if you want to collect collect and view Machine or Server metrics on a server with Machine and .NET Agents installed.

...

Force the machine agent to create an APM node when the agent registers with the controller. 

Appd reference section

Element in controller-info.xml: <create-node-if-absent>

System Property: -Dappdynamics.machine.agent.registration.createNodeIfAbsent

Environment Variable: N/A

Type: Boolean

Default: true

Required: No. If you set the app/tier/node in your controller-info.xml file (existing upgrades or by accident), you can prevent the machine agent from creating APM nodes by setting this flag to false. See Standalone Machine Agent Installation Scenarios.

...

This property logically partitions a single physical host or virtual machine. In the context of installing the machine agent, the unique Host ID property is not required. However if you don’t define a unique Host ID, the Machine Agent uses the Java API to get the host ID. The results from the API can be inconsistent and in fact, the same JVM can sometimes return a different value for the same machine each time the machine agent is restarted. To avoid problems of this nature, we recommend that you set the value of unique Host ID to the host ID that you want to see in the UI. 

Appd reference section

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

System Property: -Dappdynamics.agent.uniqueHostId

Environment Variable: APPDYNAMICS_AGENT_UNIQUE_HOST_ID

Type: ASCII string without spaces and must be unique across the entire managed infrastructure. 

Default: None

Required: Optional, but recommended.

...

This setting controls the time, in milliseconds, to wait between sending Service Availability Monitoring periodic events to the controller. For support, licensing and other details,  see Service Availability Monitoring.

Appd reference section

Element in controller-info.xml: <sam-event-update-interval-millis>

System Property: -Dappdynamics.machine.agent.sam.event.updateIntervalMillis

Environment Variable: N/A

Type: Positive integer

Default: 300000 ms (5 minutes)

Required: No

...

This setting enables you to group servers together into arbitrary hierarchies by specifying a hierarchical path to the server. The server hierarchy displays in the Metric Browser and on the Server Monitoring Dashboard. The server hierarchy is also used to select subgroups of machines for health rules. The last element of the path indicates the server name, a name of your choice. This name appears as the Name on the Servers list. If the path contains spaces it must be enclosed in double-quotes. For more information, see Machine Agent Hierarchy.

Appd reference section

Element in controller-info.xml: <machine-path>

System Property: -Dappdynamics.machine.agent.hierarchyPath

Environment Variable: APPDYNAMICS_MACHINE_HIERARCHY_PATH

Type: ASCII string with path elements that are separated by a "|" (bar). 

Default: The value specified by Unique Host ID. If the last part of the machine hierarchy is empty, the Unique Host ID is the machine name. For example, if machine hierarchy is "Data Center 1|Rack 2|" and Unique host ID is "Host ID 3", then the machine hierarchy will become "Data Center 1|Rack 2|Host ID 3".

Required: No

Limitation: The length of the characters composing the machine-path up to, but not including, the last pipe cannot exceed 95 characters.

Examples:

  • System Properties: -Dappdynamics.machine.agent.hierarchyPath= "Data Center 1|Rack 2|Machine3"
  • controller-info.xml: 

    Code Block
    themeConfluence
    <machine-path>
         "Data Center 1|Rack 2|Machine3"
    </machine-path>
  • Environment Variable: APPDYNAMICS_MACHINE_HIERARCHY_PATH="Data Center 1|Rack 2|Machine3

...

The name of the logical business application that this JVM node belongs to. 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.

Appd reference section

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

System Property: -Dappdynamics.agent.applicationName

Environment Variable: APPDYNAMICS_AGENT_APPLICATION_NAME

Type: String

Defaults: None

Required: No. See Standalone Machine Agent Installation Scenarios.

...

The name of the logical tier that this JVM node belongs to. 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.

Appd reference section

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

System Property: -Dappdynamics.agent.tierName

Environment Variable: APPDYNAMICS_AGENT_TIER_NAME

Type: String

Defaults: None

Required: No. See Standalone Machine Agent Installation Scenarios.

...

The name of the JVM node. When not specified, this defaults to Node1 for the Machine Agent.

Appd reference section

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

System Property: -Dappdynamics.agent.nodeName

Environment Variable: APPDYNAMICS_AGENT_NODE_NAME

Type: String

Defaults: None

Required: No. See Standalone Machine Agent Installation Scenarios.