Configuration Options for Node.js Agent

This includes the custom configuration options for Node.js Agent.

Install

OptionDescriptionRequiredNote
--agent_version stringSet the AgentVersion.YesN/A
--always_add_eum_metadata_in_http_headersSet the AlwaysAddEumMetadataInHttpHeaders.NoN/A
--application_name stringSet the ApplicationName.NoThe default value is nodeApp. It is Recommended to set to the actual application name.
--auto_snapshot_duration_seconds stringSet the AutoSnapshotDurationSeconds.NoN/A
--backup_dir stringThe agent backup directory.

This is used for saving the current directory of the agent to preserve and use during rollback.

The default value is the parent directory of the Smart Agent. For example,

If Smart Agent path is /opt/appdynamics/smartagent, the backup_dir path will be /opt/appdynamics/smartagent/backup.

NoN/A
--bt_entry_point_delay_disabledSet the BtEntryPointDelayDisabled.NoN/A
--certificate_file stringSet the CertificateFile.NoN/A
--controller_account_access_key stringSet the ControllerAccessKey.YesN/A
--controller_account_name stringSet the ControllerAccountName.YesN/A
--controller_cert_file stringSet the ControllerCertFile.NoN/A
--controller_host_name stringSet the ControllerHostName.YesIf using proxy, set appropriate proxy values.
--controller_port stringSet the ControllerPort.YesIf not using proxy and enable_ssl is set to true, set controller_port=443. If using proxy, set appropriate proxy values.
--download_protocol stringSet the DownloadProtocol.NoThe default value is appd.
--download_uri stringSet the DownloadURI.NoThe default value is https://download-files.appdynamics.com.
--enable_sslSet the EnableSSL.No
--eum_user_agent_allowlist stringSet the EumUserAgentAllowlist.NoThe default values are Mozilla, Opera, WebKit, Nokia.
--group stringSet the Group.NoN/A
-h, --helphelp for nodeNoN/A
--hostname stringSet the Hostname.NoN/A
--ini stringconfig fileNoThe default value is config.ini.
--install_agent_from stringSet the InstallAgentFrom.NoN/A
--keep_backupSet the KeepBackup.NoN/A
--linux_custom_agent_install_path stringSet the AgentCustomInstallPath.NoRecommended. If not provided, agent will install under <smart-agent-home-dir>/../node-agent.
--linux_install_root stringSet the AppDDefaultInstallRoot.NoN/A
--log_dir stringSet the LogDir.NoN/A
--log_level stringSet the LogLevel.NoThe default value is info.
--logging stringSet the Logging.NoN/A
--max_process_snapshots_per_period stringSet the MaxProcessSnapshotsPerPeriod.NoN/A
--no_node_name_suffixSet the NoNodeNameSuffix.NoN/A
--node_agent_debug_loggingSet the NodeAgentDebugLogging.NoN/A
--node_agent_enableGraphQLSet the EnableGraphQL.NoN/A
--node_name stringSet the NodeName.NoIt is recommended to set to the actual node name. The default value is tesNode.
--npm_registry stringSet the NPMRegistry.NoThe default value is https://registry.npmjs.org.
--process_snapshot_count_reset_period_seconds stringSet the ProcessSnapshotCountResetPeriodSeconds.NoN/A
--reuse_nodeSet the NodeReuse.NoN/A
--reuse_node_prefixSet the NodeReusePrefix.NoN/A
--root_tmp_dir stringSet the RootTmpDir.NoN/A
--temp_dir stringSet the temporary directory. The default value is the temporary directory of the operating system. For example, /tmp for linux operating system. This is used to perform the tasks such as downloading the agent, unzipping the artifacts, during the install process. This directory gets cleaned up after the execution of the task. NoN/A
--tier_name stringSet the TierName.NoIt is recommended to set to actual tier name. The default value is tesTier.
--tmp_dir stringSet the TmpDir.NoN/A
--transaction_monitor_bt_max_duration_ms stringSet the TransactionMonitorBTMaxDurationMs.NoThe default value is 120000.
--unique_host_id stringSet the UniqueHostId.NoN/A
--user stringSet the User.NoN/A
--wsgi_callable stringSet the WsgiCallable.NoThe default value is application.
NoN/A
--wsgi_script stringSet the WsgiScript.NoN/A

Uninstall

OptionDescriptionRequiredNote
--agent_version stringSet the AgentVersion.NoN/A
--always_add_eum_metadata_in_http_headersSet the AlwaysAddEumMetadataInHttpHeaders.NoN/A
--application_name stringSet the ApplicationName.NoN/A
--auto_snapshot_duration_seconds stringSet the AutoSnapshotDurationSeconds.NoN/A
--backup_dir stringThe agent backup directory.

This is used for saving the current directory of the agent to preserve and use during rollback.

The default value is the parent directory of the Smart Agent. For example,

If Smart Agent path is /opt/appdynamics/smartagent, the backup_dir path will be /opt/appdynamics/smartagent/backup.

YesN/A
--bt_entry_point_delay_disabledSet the BtEntryPointDelayDisabled.NoN/A
--certificate_file stringSet the CertificateFile.NoN/A
--controller_account_access_key stringSet the ControllerAccessKey.YesN/A
--controller_account_name stringSet the ControllerAccountName.YesN/A
--controller_cert_file stringSet the ControllerCertFile.NoN/A
--controller_host_name stringSet the ControllerHostName.YesIf using proxy, set appropriate proxy values.
--controller_port stringSet the ControllerPort.YesIf not using proxy and enable_ssl is set to true, set controller_port=443. If using proxy, set appropriate proxy values.
--download_protocol stringSet the DownloadProtocol.NoThe default value is appd.
--download_uri stringSet the DownloadURI.NoThe default value is https://download-files.appdynamics.com.
--enable_sslSet the EnableSSL.NoN/A
--eum_user_agent_allowlist stringSet the EumUserAgentAllowlist.NoThe default values are Mozilla, Opera, WebKit, Nokia.
--group stringSet the Group.NoN/A
-h, --helphelp for nodeNoN/A
--hostname stringSet the Hostname.NoN/A
--ini stringconfig fileNoThe default value is config.ini.
--install_agent_from stringSet the InstallAgentFrom.NoN/A
--keep_backupSet the KeepBackup.NoN/A
--linux_custom_agent_install_path stringSet the AgentCustomInstallPath.NoRecommended. If not provided, agent will install under <smart-agent-home-dir>/../node-agent.
--linux_install_root stringSet the AppDDefaultInstallRoot.NoN/A
--log_dir stringSet the LogDir.NoN/A
--log_level stringSet the LogLevel.NoThe default value is info.
--logging stringSet the Logging.NoN/A
--max_process_snapshots_per_period stringSet the MaxProcessSnapshotsPerPeriod.NoN/A
--no_node_name_suffixSet the NoNodeNameSuffix.NoN/A
--node_agent_debug_loggingSet the NodeAgentDebugLogging.NoN/A
--node_agent_enableGraphQLSet the EnableGraphQL.NoN/A
--node_name stringSet the NodeName.No N/A
--npm_registry stringSet the NPMRegistry.NoThe default value is https://registry.npmjs.org.
--process_snapshot_count_reset_period_seconds stringSet the ProcessSnapshotCountResetPeriodSeconds.NoN/A
--reuse_nodeSet the NodeReuse.NoN/A
--reuse_node_prefixSet the NodeReusePrefix.NoN/A
--root_tmp_dir stringSet the RootTmpDir.NoN/A
--temp_dir stringSet the TempDir.NoN/A
--tier_name stringSet the TierName.No N/A
--tmp_dir stringSet the temporary directory. The default value is the temporary directory of the operating system. For example, /tmp for linux operating system. This is used to perform the tasks such as downloading the agent, unzipping the artifacts, during the upgrade process. This directory gets cleaned up after the execution of the task.NoN/A
--transaction_monitor_bt_max_duration_ms stringSet the TransactionMonitorBTMaxDurationMs.NoThe default value is 120000.
--unique_host_id stringSet the UniqueHostId.NoN/A
--user stringSet the User.NoN/A
--wsgi_callable stringSet the WsgiCallable.NoThe default value is application.
--wsgi_module stringSet the WsgiModule.NoN/A
--wsgi_script stringSet the WsgiScript.NoN/A

Upgrade

OptionDescriptionRequiredNote
--agent_version stringSet the AgentVersion.NoN/A
--always_add_eum_metadata_in_http_headersSet the AlwaysAddEumMetadataInHttpHeaders.NoN/A
--application_name stringSet the ApplicationName.NoThe default value is nodeApp. It is Recommended to set to the actual application name.
--auto_snapshot_duration_seconds stringSet the AutoSnapshotDurationSeconds.NoN/A
--backup_dir stringSet the AgentBackupDir.YesN/A
--bt_entry_point_delay_disabledSet the BtEntryPointDelayDisabled.NoN/A
--certificate_file stringSet the CertificateFile.NoN/A
--controller_account_access_key stringSet the ControllerAccessKey.YesN/A
--controller_account_name stringSet the ControllerAccountName.YesN/A
--controller_cert_file stringSet the ControllerCertFile.NoN/A
--controller_host_name stringSet the ControllerHostName.YesIf using proxy, set appropriate proxy values.
--controller_port stringSet the ControllerPort.YesIf not using proxy and enable_ssl is set to true, set controller_port=443. If using proxy, set appropriate proxy values.
--download_protocol stringSet the DownloadProtocol.NoThe default value is appd.
--download_uri stringSet the DownloadURI.Nodefault "https://download-files.appdynamics.com"
--enable_sslSet the EnableSSL.NoN/A
--eum_user_agent_allowlist stringSet the EumUserAgentAllowlist.NoThe default values are Mozilla, Opera, WebKit, Nokia.
--group stringSet the Group.NoN/A
-h, --helphelp for nodeNoN/A
--hostname stringSet the Hostname.NoN/A
--ini stringconfig fileNoThe default value is config.ini.
--install_agent_from stringSet the InstallAgentFrom.NoN/A
--keep_backupSet the KeepBackup.NoN/A
--linux_custom_agent_install_path stringSet the AgentCustomInstallPath.NoRecommended. If not provided, agent will install under <smart-agent-home-dir>/../node-agent.
--linux_install_root stringSet the AppDDefaultInstallRoot.NoN/A
--log_dir stringSet the LogDir.NoN/A
--log_level stringSet the LogLevel.NoThe default value is info.
--logging stringSet the Logging.NoN/A
--max_process_snapshots_per_period stringSet the MaxProcessSnapshotsPerPeriod.NoN/A
--no_node_name_suffixSet the NoNodeNameSuffix.NoN/A
--node_agent_debug_loggingSet the NodeAgentDebugLogging.NoN/A
--node_agent_enableGraphQLSet the EnableGraphQL.NoN/A
--node_name stringSet the NodeName.NoThe default value is tesNode.
--npm_registry stringSet the NPMRegistry.NoThe default value is https://registry.npmjs.org.
--process_snapshot_count_reset_period_seconds stringSet the ProcessSnapshotCountResetPeriodSeconds.NoN/A
--reuse_nodeSet the NodeReuse.NoN/A
--reuse_node_prefixSet the NodeReusePrefix.NoN/A
--root_tmp_dir stringSet the RootTmpDir.NoN/A
--temp_dir stringSet the TempDir.NoN/A
--tier_name stringSet the TierName.No It is recommended to set to actual tier name. The default value is tesTier.
--tmp_dir stringSet the TmpDir.NoN/A
--transaction_monitor_bt_max_duration_ms stringSet the TransactionMonitorBTMaxDurationMs.NoThe default value is 120000.
--unique_host_id stringSet the UniqueHostId.NoN/A
--user stringSet the User.NoN/A
--wsgi_callable stringSet the WsgiCallable.NoThe default value is application.
--wsgi_module stringSet the WsgiModule.NoN/A
--wsgi_script stringSet the WsgiScript.NoN/A