Configuration Options for Node.js Agent

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

Install

Option Description Required Note
--agent_version string Set the AgentVersion. Yes N/A
--always_add_eum_metadata_in_http_headers Set the AlwaysAddEumMetadataInHttpHeaders. No N/A
--application_name string Set the ApplicationName. No The default value is nodeApp. It is Recommended to set to the actual application name.
--auto_snapshot_duration_seconds string Set the AutoSnapshotDurationSeconds. No N/A
--backup_dir string The 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.

 No N/A
--bt_entry_point_delay_disabled Set the BtEntryPointDelayDisabled. No N/A
--certificate_file string Set the CertificateFile. No N/A
--controller_account_access_key string Set the ControllerAccessKey. Yes N/A
--controller_account_name string Set the ControllerAccountName. Yes N/A
--controller_cert_file string Set the ControllerCertFile. No N/A
--controller_host_name string Set the ControllerHostName. Yes If using proxy, set appropriate proxy values.
--controller_port string Set the ControllerPort. Yes If not using proxy and enable_ssl is set to true, set controller_port=443. If using proxy, set appropriate proxy values.
--download_protocol string Set the DownloadProtocol. No The default value is appd.
--download_uri string Set the DownloadURI. No The default value is https://download-files.appdynamics.com.
--enable_ssl Set the EnableSSL. No
--eum_user_agent_allowlist string Set the EumUserAgentAllowlist. No The default values are Mozilla, Opera, WebKit, Nokia.
--group string Set the Group. No N/A
-h, --help help for node No N/A
--hostname string Set the Hostname. No N/A
--ini string config file No The default value is config.ini.
--install_agent_from string Set the InstallAgentFrom. No N/A
--keep_backup Set the KeepBackup. No N/A
--linux_custom_agent_install_path string Set the AgentCustomInstallPath. No Recommended. If not provided, agent will install under <smart-agent-home-dir>/../node-agent.
--linux_install_root string Set the AppDDefaultInstallRoot. No N/A
--log_dir string Set the LogDir. No N/A
--log_level string Set the LogLevel. No The default value is info.
--logging string Set the Logging. No N/A
--max_process_snapshots_per_period string Set the MaxProcessSnapshotsPerPeriod. No N/A
--no_node_name_suffix Set the NoNodeNameSuffix. No N/A
--node_agent_debug_logging Set the NodeAgentDebugLogging. No N/A
--node_agent_enableGraphQL Set the EnableGraphQL. No N/A
--node_name string Set the NodeName. No It is recommended to set to the actual node name. The default value is tesNode.
--npm_registry string Set the NPMRegistry. No The default value is https://registry.npmjs.org.
--process_snapshot_count_reset_period_seconds string Set the ProcessSnapshotCountResetPeriodSeconds. No N/A
--reuse_node Set the NodeReuse. No N/A
--reuse_node_prefix Set the NodeReusePrefix. No N/A
--root_tmp_dir string Set the RootTmpDir. No N/A
--temp_dir string Set 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. No N/A
--tier_name string Set the TierName. No It is recommended to set to actual tier name. The default value is tesTier.
--tmp_dir string Set the TmpDir. No N/A
--transaction_monitor_bt_max_duration_ms string Set the TransactionMonitorBTMaxDurationMs. No The default value is 120000.
--unique_host_id string Set the UniqueHostId. No N/A
--user string Set the User. No N/A
--wsgi_callable string Set the WsgiCallable. No The default value is application.
No N/A
--wsgi_script string Set the WsgiScript. No N/A

Uninstall

Option Description Required Note
--agent_version string Set the AgentVersion. No N/A
--always_add_eum_metadata_in_http_headers Set the AlwaysAddEumMetadataInHttpHeaders. No N/A
--application_name string Set the ApplicationName. No N/A
--auto_snapshot_duration_seconds string Set the AutoSnapshotDurationSeconds. No N/A
--backup_dir string The 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.

 Yes N/A
--bt_entry_point_delay_disabled Set the BtEntryPointDelayDisabled. No N/A
--certificate_file string Set the CertificateFile. No N/A
--controller_account_access_key string Set the ControllerAccessKey. Yes N/A
--controller_account_name string Set the ControllerAccountName. Yes N/A
--controller_cert_file string Set the ControllerCertFile. No N/A
--controller_host_name string Set the ControllerHostName. Yes If using proxy, set appropriate proxy values.
--controller_port string Set the ControllerPort. Yes If not using proxy and enable_ssl is set to true, set controller_port=443. If using proxy, set appropriate proxy values.
--download_protocol string Set the DownloadProtocol. No The default value is appd.
--download_uri string Set the DownloadURI. No The default value is https://download-files.appdynamics.com.
--enable_ssl Set the EnableSSL. No N/A
--eum_user_agent_allowlist string Set the EumUserAgentAllowlist. No The default values are Mozilla, Opera, WebKit, Nokia.
--group string Set the Group. No N/A
-h, --help help for node No N/A
--hostname string Set the Hostname. No N/A
--ini string config file No The default value is config.ini.
--install_agent_from string Set the InstallAgentFrom. No N/A
--keep_backup Set the KeepBackup. No N/A
--linux_custom_agent_install_path string Set the AgentCustomInstallPath. No Recommended. If not provided, agent will install under <smart-agent-home-dir>/../node-agent.
--linux_install_root string Set the AppDDefaultInstallRoot. No N/A
--log_dir string Set the LogDir. No N/A
--log_level string Set the LogLevel. No The default value is info.
--logging string Set the Logging. No N/A
--max_process_snapshots_per_period string Set the MaxProcessSnapshotsPerPeriod. No N/A
--no_node_name_suffix Set the NoNodeNameSuffix. No N/A
--node_agent_debug_logging Set the NodeAgentDebugLogging. No N/A
--node_agent_enableGraphQL Set the EnableGraphQL. No N/A
--node_name string Set the NodeName. No N/A
--npm_registry string Set the NPMRegistry. No The default value is https://registry.npmjs.org.
--process_snapshot_count_reset_period_seconds string Set the ProcessSnapshotCountResetPeriodSeconds. No N/A
--reuse_node Set the NodeReuse. No N/A
--reuse_node_prefix Set the NodeReusePrefix. No N/A
--root_tmp_dir string Set the RootTmpDir. No N/A
--temp_dir string Set the TempDir. No N/A
--tier_name string Set the TierName. No N/A
--tmp_dir string Set 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. No N/A
--transaction_monitor_bt_max_duration_ms string Set the TransactionMonitorBTMaxDurationMs. No The default value is 120000.
--unique_host_id string Set the UniqueHostId. No N/A
--user string Set the User. No N/A
--wsgi_callable string Set the WsgiCallable. No The default value is application.
--wsgi_module string Set the WsgiModule. No N/A
--wsgi_script string Set the WsgiScript. No N/A

Upgrade

Option Description Required Note
--agent_version string Set the AgentVersion. No N/A
--always_add_eum_metadata_in_http_headers Set the AlwaysAddEumMetadataInHttpHeaders. No N/A
--application_name string Set the ApplicationName. No The default value is nodeApp. It is Recommended to set to the actual application name.
--auto_snapshot_duration_seconds string Set the AutoSnapshotDurationSeconds. No N/A
--backup_dir string Set the AgentBackupDir. Yes N/A
--bt_entry_point_delay_disabled Set the BtEntryPointDelayDisabled. No N/A
--certificate_file string Set the CertificateFile. No N/A
--controller_account_access_key string Set the ControllerAccessKey. Yes N/A
--controller_account_name string Set the ControllerAccountName. Yes N/A
--controller_cert_file string Set the ControllerCertFile. No N/A
--controller_host_name string Set the ControllerHostName. Yes If using proxy, set appropriate proxy values.
--controller_port string Set the ControllerPort. Yes If not using proxy and enable_ssl is set to true, set controller_port=443. If using proxy, set appropriate proxy values.
--download_protocol string Set the DownloadProtocol. No The default value is appd.
--download_uri string Set the DownloadURI. No default "https://download-files.appdynamics.com"
--enable_ssl Set the EnableSSL. No N/A
--eum_user_agent_allowlist string Set the EumUserAgentAllowlist. No The default values are Mozilla, Opera, WebKit, Nokia.
--group string Set the Group. No N/A
-h, --help help for node No N/A
--hostname string Set the Hostname. No N/A
--ini string config file No The default value is config.ini.
--install_agent_from string Set the InstallAgentFrom. No N/A
--keep_backup Set the KeepBackup. No N/A
--linux_custom_agent_install_path string Set the AgentCustomInstallPath. No Recommended. If not provided, agent will install under <smart-agent-home-dir>/../node-agent.
--linux_install_root string Set the AppDDefaultInstallRoot. No N/A
--log_dir string Set the LogDir. No N/A
--log_level string Set the LogLevel. No The default value is info.
--logging string Set the Logging. No N/A
--max_process_snapshots_per_period string Set the MaxProcessSnapshotsPerPeriod. No N/A
--no_node_name_suffix Set the NoNodeNameSuffix. No N/A
--node_agent_debug_logging Set the NodeAgentDebugLogging. No N/A
--node_agent_enableGraphQL Set the EnableGraphQL. No N/A
--node_name string Set the NodeName. No The default value is tesNode.
--npm_registry string Set the NPMRegistry. No The default value is https://registry.npmjs.org.
--process_snapshot_count_reset_period_seconds string Set the ProcessSnapshotCountResetPeriodSeconds. No N/A
--reuse_node Set the NodeReuse. No N/A
--reuse_node_prefix Set the NodeReusePrefix. No N/A
--root_tmp_dir string Set the RootTmpDir. No N/A
--temp_dir string Set the TempDir. No N/A
--tier_name string Set the TierName. No It is recommended to set to actual tier name. The default value is tesTier.
--tmp_dir string Set the TmpDir. No N/A
--transaction_monitor_bt_max_duration_ms string Set the TransactionMonitorBTMaxDurationMs. No The default value is 120000.
--unique_host_id string Set the UniqueHostId. No N/A
--user string Set the User. No N/A
--wsgi_callable string Set the WsgiCallable. No The default value is application.
--wsgi_module string Set the WsgiModule. No N/A
--wsgi_script string Set the WsgiScript. No N/A