Javaエージェント構成プロパティ

The following are the Agent-Controller communication properties:

AWS Instance

The appdynamics-aws-instance-enabled property helps to enable agent retrieval of AWS instance-id by default during registration.

The property is enabled by default and the agent log includes Agent AWS instance-id retrieval enabled: true. To disable the property, set appdynamics.aws.instance.enabled=false. The agent log includes Agent AWS instance-id retrieval enabled: false.

System Property: -Dappdynamics.aws.instance.enabled

Environment Variable: APPDYNAMICS_AWS_INSTANCE_ENABLED

Type: Boolean

Default: True

Required: Yes

Controller Host

The hostname or the IP address of the Controller. Example values are 192.168.1.22 or myhost or myhost.example.com. This is the same host that you use to access the Splunk AppDynamics browser-based user interface. For an on-premises Controller, use the value for Application Server Host Name that was configured when the Controller was installed. If you are using the Splunk AppDynamics オンプレミス Controller service, see the Welcome email from Splunk AppDynamics.

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

If Enable Orchestration is true, and if the app agent is deployed in a compute cloud instance created by a Splunk AppDynamics workflow, do not set the Controller host unless you want to override the auto-detected value. See Enable Orchestration Property.

Controller Port

The HTTP(S) port of the Splunk AppDynamics Controller. This is the port used to access the Splunk 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

Environment Variable: APPDYNAMICS_CONTROLLER_PORT

Type: Positive Integer

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

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 a Splunk AppDynamics workflow, do not set the Controller port unless you want to override the auto-detected value. See Enable Orchestration Property.

Controller SSL Enabled

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.

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

Controller Keystore Password

The plain text value of the Controller certificate password. If Use Encrypted Credentials is true, encrypt the password. See Encrypt Agent Credentials.

Element in controller-info.xml: <controller-keystore-password>

System Property: -Dappdynamics.controller.keystorePassword

Environment Variable: APPDYNAMICS_CONTROLLER_KEYSTORE_PASSWORD

Type: String

Default: None

Required: No

Controller Keystore Filename

By default, the agent looks for a Java truststore file named cacerts.jks in the <agent_home>/<version>/conf directory in the agent home. Use this property to enable full validation of Controller SSL certificates with a different Java truststore file. See Enable SSL for the Java Agent.

Element in controller-info.xml: <controller-keystore-filename>

System Property: -Dappdynamics.controller.keystoreFileName

Environment Variable: APPDYNAMICS_CONTROLLER_KEYSTORE_FILENAME

Type: String

Default: None

Required: No

Force Default SSL Certificate Validation

Used to override the default behavior for SSL validation. The 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. See Enable SSL On-Premises with a Trusted CA Signed 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-premises 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-premises Controller, and there is no cacerts.jks file, then minimal validation is performed

Splunk AppDynamics Agent SSL Protocol

The SSL compatibility table in Agent and Controller Tenant Compatibility lists the default security protocol for the different versions of the Java Agent. If the default security protocol for your version of an agent is incompatible with the Controller or it is incompatible with an intervening proxy, pass the -Dappdynamics.agent.ssl.protocol system property to configure one of these security protocols:

• SSL
• TLS
• TLSv1.2
• TLSv1.1

System Property: -Dappdynamics.agent.ssl.protocol

Type: String

Default: See Agent and Controller Tenant Compatibility

Required: No

Configure Allowed TLS/SSL Protocols

Agent communication over TLS/SSL causes the agent to initialize the JVM security subsystem, which sets a permitted list of protocols. By default, Splunk AppDynamics excludes SSLv3 and TLSv1protocols due to the known vulnerabilities.

Once the JVM initializes, the list of permitted protocols cannot be changed. If you want to prevent the agent from disabling SSLv3 or TLSv1 protocols, you can configure them to be allowed by naming one (or both, separated by a comma) protocols using this property:

System Property: -Dappdynamics.agent.tls.allowedAlgorithms

Type: String

Default: None

Required: No

This example allows TSLv1.2 to be used by the JVM:

-Dappdynamics.agent.tls.allowedAlgorithms=TLSv1.2

Configure Disabled TLS/SSL Protocols

Agent communication over TLS/SSL causes the agent to initialize the JVM security subsystem, which sets a permitted list of algorithms.

Once the JVM initializes, the list of permitted protocols cannot be changed. If you want to prevent the agent from enabling certain algorithms, you can configure them to be disabled by naming one (or both, separated by a comma) algorithms using this property:

System Property: -Dappdynamics.agent.tls.disabledAlgorithms

Type: String

Default: None

Required: No

-Dappdynamics.agent.tls.disabledAlgorithms=RSASSA-PSS,RSAPSS

Use Encrypted Credentials

Before you enable Use Encrypted Credentials, see Encrypt Agent Credentials for instructions on how to initialize the Secure Credential Store.

Set Use Encrypted Credentials to True to configure the agent to use credentials encrypted with the Secure Credential Store. When you enable Use Encrypted Credentials, you must supply the Credential Store Filename and the obfuscated Credential Store Password.

When Use Encrypted Credentials is true, encrypt the following:

• Account Access Key
• Controller Keystore Password
• Proxy Password

Element in controller-info.xml: <use-encrypted-credentials>

Type: Boolean

Default: False

Required: No

Credential Store Filename

The absolute path to the Secure Credential Store keystore. See Encrypt Agent Credentials.

Element in controller-info.xml:

Type: String

Default: None

Required: If Use Encrypted Credentials is set to True

Credential Store Password

The obfuscated keystore password for the Secure Credential Store. See <credential-store-password> Encrypt Agent Credentials.

Element in controller-info.xml: <credential-store-filename>

Type: String

Default: None

Required: If Use Encrypted Credentials is set to True

自動命名

true に設定すると、Java エージェントはアプリケーションのノードに一意の名前を自動的に割り当てます。他のエージェント識別プロパティが別の設定で指定されていない場合、エージェントのティアとアプリケーションは自動的に命名されます。デフォルトの名前は MyApp、MyTier、および application_server@host の形式になります。このプロパティを有効にした後は、必ず JVM を再起動してください。サーバーが再起動されるまで、ノード名はコントローラ UI に null として表示されます。

controller-info.xml 内の要素：<auto-naming>

型：boolean

デフォルト：なし

**必須**

アプリケーション名

このJVMノードが属する合理的なビジネスアプリケーションの名前。これはアプリケーションサーバー上のデプロイメント名(ear/war/jar)ではないことにご注意ください。

構成された名前のビジネスアプリケーションが存在しない場合、自動的に作成されます。

controller-info.xml 内の要素：<application-name>

システムプロパティ：-Dappdynamics.agent.applicationName

環境変数：APPDYNAMICS_AGENT_APPLICATION_NAME

型：文字列

デフォルト：なし

必須：はい

ティア名

このJVMノードが属するティアの名前。これはアプリケーションサーバー上のデプロイメント名(ear/war/jar)ではないことにご注意ください。

JVM またはアプリケーションサーバー起動スクリプトに、-Dserver.tier のような、階層を参照するシステムプロパティがある場合、${server.tier} を階層名として使用できます。Javaエージェント設定にシステムプロパテイを使用するJavaエージェント設定にシステムプロパテイを使用する

エージェントは、最初にコントローラと接続したときにティアが存在しない場合、名前の付いたティアをコントローラに登録します。コントローラモデルに名前の付いたティアが存在する場合は、エージェントは既存のティアと関連付けられます。

controller-info.xml 内の要素：<tier-name>

システムプロパティ：-Dappdynamics.agent.tierName

環境変数：APPDYNAMICS_AGENT_TIER_NAME

型：文字列

デフォルト：なし

必須：はい

ノード名

ノードの名前。JVM が動的に作成される場合にシステムプロパティを使いノード名を設定する。

JVM またはアプリケーションサーバー起動スクリプトに、-Dserver.name のような、ノード名として使えるシステムプロパティがすでにある場合、${server.name} をノード名として使用できます。また、${server.name}_${host.name}.MyNode のような式を使ってノード名を定義できます。Javaエージェント設定にシステムプロパテイを使用するJavaエージェント設定にシステムプロパテイを使用する

一般的に、ノード名はビジネスアプリケーションおよび物理的なホスト内で一意でなければなりません。同じ物理マシン上で複数のノードに同じノード名を使用したい場合は、ユニークホストIDのプロパティを使って複数の仮想ホストを作成します。「ユニークホスト ID」を参照してください。

controller-info.xml 内の要素：<node-name>

システムプロパティ：-Dappdynamics.agent.nodeName

環境変数：APPDYNAMICS_AGENT_NODE_NAME

型：文字列

デフォルト：なし

必須：はい

ノード名を再利用

Splunk AppDynamicsこのプロパティを true に設定して でノード名を再利用します。プロパティが true の場合、ノード名を指定する必要はありませんが、-Dappdynamics.agent.reuse.nodeName.prefix を使用してノード名プレフィックスを指定する必要があります。

このプロパティは、寿命が短い JVM が多数ある環境のモニタリングに役立ちます。true の場合、Splunk AppDynamics は新しい JVM の過去の JVM のノード名を再利用します。これにより、本質的には同一プロセスのノードが異なる時間で実行される場合に、Splunk AppDynamics 内で別の名前が付いたノードが時間の経過とともに急増するのを回避できます。実際の作業負荷に基づき新しい JVM の起動とシャットダウンが行われる z/OS 動的ワークロード マネージャ ベースの環境などがこの環境の一例です。

Splunk AppDynamics はノード名をアプリ、ティア、シーケンス番号を使い生成します。ノード名はプールされます。たとえば、ノードがパージされる（ノードの存続期間に基づく）と、シーケンス番号が再利用されます。

Javaエージェントは起動すると、コントローラに登録されてコントローラがノード名を生成するまで、コンソールに出力を記録します。ログをファイルに書き込むようにエージェントを構成するには、<agent_home>/<version_number>/conf/logging で log4j-unknown.xml を編集します。「動的な環境における JVM のインストゥルメント化」を参照してください。

コントローラは、ノードの保持期間プロパティに基づいてノード名を再利用します。

システムプロパティ：-Dappdynamics.agent.reuse.nodeName

環境変数：APPDYNAMICS_JAVA_AGENT_REUSE_NODE_NAME（4.5.8 で新規追加）

type: boolean

デフォルト：False

必須：いいえ

例：以下の構成では、コントローラは「reportGen」というプレフィックスのあるノード名を生成します。並列で実行しているノードの数に応じて、ノード名には、-1 や -2 などのサフィックスが付きます。シャットダウンされ履歴ノードと見なされるノードの名前は、新しいノードにより再利用される場合があります。

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

ノード名プレフィックスを再利用

ノード名を再利用するようにエージェントを構成する際に、このプロパティを使用し、コントローラがノード名を動的に生成するのに使用するプレフィックスを指定します。

システムプロパティ：-Dappdynamics.agent.reuse.nodeName.prefix

環境変数：APPDYNAMICS_JAVA_AGENT_REUSE_NODE_NAME_PREFIX（4.5.8 で新規追加）

型：文字列

デフォルト：なし

必須：-Dappdynamics.agent.reuse.nodeName=true の場合

例：以下のプロパティ仕様を使い、エージェントはコントローラに「reportGen」というプレフィックスのあるノード名を生成するよう指示します。並列して実行しているノード数に応じて、ノード名には--1、 --2、などのサフィックスが付きます。

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

セルフサービス

プラットフォームに基づいて自動的にノードに名前を付けるようJavaエージェントを構成します。自動ノード命名を機能させるには、アプリケーション名とティア名を指定する必要があります。

システムプロパティ：-Dappdynamics.agent.selfService

型：文字列

tibco：Java エージェントは TIBCO プロセス名のノードに名前を付けます。詳細については、「TIBCO BusinessWorks の Java エージェントの構成」を参照してください。

デフォルト：なし

必須：いいえ

If the Splunk AppDynamics Controller is running in multi-tenant mode or if you are using the Splunk AppDynamics オンプレミス Controller, specify the account name and key for the agent to authenticate with the Controller.

If you are using the Splunk AppDynamics オンプレミス Controller, the account name is provided in the Welcome email sent by Splunk AppDynamics. You can also find this information in the <controller_home>/initial_account_access_info.txt file.

If the Controller is running in single-tenant mode, you only need to configure the account access key. You can find the unique access key for your Controller instance from the Observe License Usage page in the UI.

Account Name

The account name used to authenticate with the Controller.

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 Splunk AppDynamics オンプレミス Controller and other multi-tenant users; no for single-tenant users.

Account Access Key

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

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

Use the proxy properties to configure the agent to connect to the Controller through a proxy.

Proxy Host

The proxy host name or IP address.

System Property: -Dappdynamics.http.proxyHost

Type: String

Default: None

Required: No

Proxy Port

The proxy HTTP(S) port.

System Property: -Dappdynamics.http.proxyPort

Type: Positive Integer

Default: None

Required: No

Proxy User Name

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

System Property: -Dappdynamics.http.proxyUser

Type: String

Default: None

Required: No

Proxy Password

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.

If Use Encrypted Credentials is false, enter the password in plain text. If Use Encrypted Credentials is true, encrypt the password. See Use Encrypted Credentials.

System Property: -Dappdynamics.http.proxyPasswordFile

Type: String

Default: None

Required: No

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

Enable Orchestration

When set to true, enables auto-detection of the controller host and port when the app server is a compute cloud instance created by a Cisco AppDynamicsorchestration workflow. See Controller Host Property and Controller Port Property.

In a cloud compute environment, auto-detection is necessary for the Create Machine tasks in the workflow to run correctly.

If the host machine on which this agent resides is not created through Splunk AppDynamics workflow orchestration, this property should be set to false.

Element in controller-info.xml: <enable-orchestration>

Type: Boolean

Default: False

Required: No

Agent Runtime Directory

Sets the directory under which all files the agent writes at runtime. 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. The log folder location can be overridden with the appdynamics.agent.logs.dir property.

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

Redirect Logfiles

Sets the destination directory to which the logs will be written to.

System Property: -Dappdynamics.agent.logs.dir

Type: String

Default: <agent_home>/logs/<Node_Name>

Required: No

Custom Path for agent conf Directory

Sets a custom path for the agent conf directory. This is where the agent reads its static config files from. If you need to change custom-activity-correlation.xml or app-agent-config.xml and the agent installation is read-only, this instructs the agent to read the static config files from elsewhere

System Property:-

Type: String

Default: <agent_home>/ver4.5.x.x.x/conf

Required: No

Force Agent Registration

Set to true only under these conditions:

• The agent has been moved to a new application or tier from the UI, and
• You want to override that move by specifying a new application name or tier name in the agent configuration

Element in controller-info.xml: <force-agent-registration>

Type: Boolean

Default: False

Required: No

Auto Node Name Prefix

Set this property if you want the Controller to generate node names automatically using a prefix that you provide.

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

JoannaAutoNode_d39dbfc1-6f4b-4eb7-a788-c1c0135b6bcb

This property provides a similar function to the Reuse Node Name Prefix Property property. However, this property is not meant to be used in combination with reusing node names; use Reuse Node Name Prefix Property for those cases instead.

Element in controller-info.xml: Not applicable

System Property: -Dappdynamics.agent.auto.node.prefix=<your_prefix>

Type: String

Default: Serial number maintained by the Controller appended to the tier name

Required: No

Auto Logs Directory Cleanup

Set this property if you want the Java agent to automatically delete the older node directories. By default this property is disabled and set to 0

On every agent restart, the agent deletes the older node directories that have not been updated in the last hours as specified in the property. For example, if you set the property as follows:

-appdynamics.agent.log.dir.threshold.hours=4

On the next agent restart, the agent will delete the node directories that have not been updated in the last 4 hours.

Element in controller-info.xml: Not applicable

System Property: -appdynamics.agent.log.dir.threshold.hours

Type: Integer

Default: 0

Required: No

Cron/Batch JVM

Set this property to true if the JVM is a batch/cron process. You can use this property to stall the shutdown to allow the agent to send metrics before shutdown.

Element in controller-info.xml: Not applicable

System Property: -Dappdynamics.cron.vm

Type: Boolean

Default: False

Required: No

Unique Host ID

Logically partitions a single physical host or virtual machine such that it appears to the Controller that the application is running on different machines. Set the value to a string that is unique across the entire managed infrastructure. The string may not contain any spaces. If you have a machine agent associated with the application monitored by the app agent, then this property must be set on the machine agent to the same value. See Machine Agent Installation Scenarios.

System Property: -Dappdynamics.agent.uniqueHostId

Environment Variable: APPDYNAMICS_AGENT_UNIQUE_HOST_ID

Type: String

Default: None

Required: No

Agent Meta Info

Allows you to associate arbitrary information with a node, which can then be used as a basis for applying health rules or policies by node. For example, you can exclude a health rule from applying to agents tagged as test agents based on a meta-info property. Pass the property in key___value format (for example, "key1___value1").

For information on using the properties in health rules or policies (along with built-in meta-info properties), see Configure Health Rules or Configure Policies.

System Property: -Dappdynamics.agent.node.metaInfo

Type: String

Default: None

Required: No

Low Entropy

Addresses agent startup issues in systems with low to zero entropy available for seeding the PRNG algorithm. This is set to true by default. The NativePRNGNonBlocking algorithm is used through SecureRandom if the system property appdynamics.low.entropy is set. Windows is not affected by this change as it does not support NativePRNGNonBlocking, and continues to use the existing Secure Random implementation.

System Property: appdynamics.low.entropy=true

Element in controller-info.xml: No

Environment Variable: No

Type:Boolean

Default:True

Required: No

If appdynamics.low.entropy=true then the agent takes measures to ensure it does not block when generating random values, even in the absence of entropy.

For example: From Java Agent 20.11, the agent defaults to using NativePRNGNonBlocking as its SecureRandom implementation. This will try to use a non-blocking low entropy algorithm for UUID generation. Note that NativePRNGNonBlocking is not supported on Windows and defaults to the existing implementation of SHA1PRNG.

Analytics Agent

For use with the transaction analytics feature with a remote (or non-default) Analytics agent. See Enable the App Server Agent for a Remote Analytics Agent.

System Property: -Dappdynamics.analytics.agent.url

Element in controller-info.xml: No

Environment Variable: No

Type: String

Default: http://localhost:9090/v2/sinks/bt

Required: No

Use Simple Hostname

By default (unless overridden with the uniqueHostId system property), the agent determines the host name of the OS it is running in by reverse DNS lookup. In some circumstances, this host name may be set as the fully qualified domain name of the host name. If this property is set to true, the agent removes any domain name and uses the simple hostname to identify the host. In cases where the host name is an IP address (which happens if the DNS lookup fails) the full IP address in string form is used. The host name is used in mapping metrics gathered by the machine agent to application nodes (see Unique Host ID Property).

Element in controller-info.xml: <use-simple-hostname>

Type: Boolean

Default: False

Required: No

For example: If this property is set to true 'server.mydomain.com' becomes 'server'.

Dynamic Services JAR Signing

When set to True, it enables automatic JAR signing of the dynamic services. In addition, it Identifies vulnerabilities in the dynamic service workflow. Also, it provides checks to prevent loading and executing code from a malicious dynamic service. When Set to False, disables the JAR signing.

Element in controller-info.xml: <enable-jar-signing>

Type: Boolean

Default: True

Required: No

Identify JVM Vendors

Java Agent automatically identifies the underlying JVM. In case it identifies incorrectly, this flag can be used to override the automatically detected JVM vendor. This property identifies the JVM even when it is renamed. Set this property to true to identify the underlying JVM. By default, this property is disabled.

Element in controller-info.xml: Not Applicable

System Property:: -Dappdynamics.jvm.vendor

Type: String

Accepted Values: ibm, sun

Default: N/A

Required: No

Java Agent Tags

Tags are key-value pairs that are associated with your entities, such as applications, tiers, nodes, etc. These tags act as metadata that help you find your application resources in the Controller UI. You can reduce the Mean Time To Detection (MTTD) of any entity related issues by tagging them using appropriate custom tags. To know how to import tags in Controller, see Custom Tag APIs.

The Java Agent tags can defined during the agent registration using the system property or environmental variable. In case of conflict, the environmental variable takes precedence over system property. These tags are sent to the Controller UI and help filter data using tag-based filtering and tag-based columns. If you make changes to your tagging configuration, you must restart the agent.

System Property: -Dappdynamics.entity.tag.*

Here are example tags using system property:

• -Dappdynamics.entity.tag.key1 = value1
• -Dappdynamics.entity.tag.key2 = value2

Environment Variable: APPDYNAMICS_ENTITY_TAG_*

Here are example tags using environmental variable:

• APPDYNAMICS_ENTITY_TAG_key1=value1
• APPDYNAMICS_ENTITY_TAG_key2=value2

Type: String

Default: None

Required: Optional

Set the following system property true to disable tags.

System Property: -Dappdynamics.disable.tags

Type: Boolean

Default: False

Required: Optional