Performing the silent installation of the Diagnostics Agent for Java


Deploy and configure the BMC Application Diagnostics Agent for Java on the computer before connecting it to the application server instance. The BMC Application Diagnostics Agent for Java installation scripts are packaged with the BMC Application Diagnostics Installer. You can perform a silent installation, as described in this topic, or use the interactive installation mode.

This topic describes how to install the BMC Application Diagnostics Agent for Java in silent mode: 

Before you begin

Ensure that you have completed all tasks to prepare the environment for Agent installation.

Note

Installing the BMC Application Diagnostics Agent for Java requires administrative privileges on the application server that will be monitored, because a property has to be added to the Java command line. In addition, the OS user running the application server must have read and write permissions for the BMC Application Diagnostics Agent installation directory.

To install the Agent for Java in silent mode using default values

  1. From the directory with the Agent installation files, run the following command:
    • Windows

      adops-agent-install.bat -s -a <application_display_name>
    • Linux

      adops-agent-install.sh -s -a <application_display_name>

      The -s parameter specifies to install in silent mode, using the following default values:

      • Installation directory: The directory from which the installation script is run
      • Portal port: 8100
      • Portal host: localhost

      The -a parameter requires the display name of the application that the Agent monitors

  2. Configure the Java options according to the application server type so that the Agent displays in the list of available Agents.

To install the Agent for Java in silent mode using customized configuration settings

You can customize the silent installation to suit your deployment by running the install command with specified parameter values.

  1. From the directory with the Agent installation files, run the following command, and enter the values for the relevant parameters (see Installation command optionsfor parameter details):

    Tip

    Run the relevant command to display all parameters:

    • Windows: adops-agent-install.bat -h
    • Linux: adops-agent-install.sh -h

     

    • Windows

      adops-agent-install.bat -s -d <destination_path> -n <host_display_name> -a <application_display_name> -ti <tier_type> -portalProtocol <portal_protocol> -ph <portal_IP_Address> -t <portal_port> -phttph <proxy_http_host> -phttpp <proxy_http_port> -phttpsh <proxy_https_host> -phttpsp <proxy_https_port> -psocksh <proxy_socks_host> -psocksp <proxy_socks_port> -m <agent_mode>
    • Linux

      adops-agent-install.sh -s -d <destination_path> -n <host_display_name> -a <application_display_name> -ti <tier_type> -portalProtocol <portal_protocol> -ph <portal_IP_Address> -t <portal_port> -phttph <proxy_http_host> -phttpp <proxy_http_port> -phttpsh <proxy_https_host> -phttpsp <proxy_https_port> -psocksh <proxy_socks_host> -psocksp <proxy_socks_port> -m <agent_mode>


  2. After the installation is complete, you can view the parameters selected during installation in the bmc_ad_agent_install.log file which is located on the same folder as the install script and the agentInstaller.jar.
  3. Configure the Java options according to the application server type so that the Agent displays in the list of available Agents.

Installation command options

To run the silent installation, you must enter values for the -s (silent) option and the -a (application) option, and then remaining options use the default values. The following table describes the options that you can customize and their default values.

Examples of customized configuration settings

  • A customized silent installation on Windows. The Agent will be installed in c:\BMC\AD\Agent, and connect to the portal on goodhost.abcd.com.

    c:\>adops-agent-install.bat -s -d c:\BMC\AD\Agent -host FrontEndMachine -application AbcdStaplesApp -portalHost goodhost.abcd.com
  • A customized silent installation on Linux. The Agent will be installed in /usr/BMC/AD/agent, and connect to the portal on goodhost.abcd.com.

    prompt>adops-agent-install.sh -s -d /usr/BMC/AD/agent -host BackEndRHMachine -application AbcdStaplesApp -portalHost goodhost.abcd.com
  • A customized silent installation on Windows using a proxy, with customized configuration of the proxy HTTP and HTTPS host, and port.

    adops-agent-install.bat -s -application AbcdStaplesApp -phttph 10.64.180.2 -phttpp 80 -phttpsh 10.64.180.2 -phttpsp 443
  • A customized silent installation on Linux using a proxy, with customized configuration of the proxy SOCKS host and port:

    adops-agent-install.sh -s -application AbcdStaplesApp -psocksh 10.64.180.2 -psocksp 3128

To configure Java options

After you run the Diagnostics Agent for Java, configure Java options.

  1. Add the BMC Application Diagnostics parameters to the JVM options of your application server. In a command line window, enter the following parameters for JVM options according to each application server type:

    • Windows

      -javaagent:<installationDirectory>\ADOPsInstall\adops-agent.jar
      -Dcom.bmc.adops.agent.server.id="<uniqueID>"
    • Linux

      -javaagent:<installationDirectory>/ADOPsInstall/adops-agent.jar
      -Dcom.bmc.adops.agent.server.id="<uniqueID>"

    Replace the variables as follows:

    • Replace <installationDirectory> with the destination directory in which the Diagnostics Agent was installed.
       The javaagent option is required to connect the Diagnostics Agent to the JVM process. Enter the information that is relevant to your installation.
    • Replace <uniqueID> with a unique name to identify the application server instance.You can remove the -Dcom.bmc.adops.agent.server.id option if there is only one JVM process connected to a Diagnostics Agent on the same computer.

      Notes

      • The Diagnostics Agent log file is named bmc_ad_agent_install.log and is created in the same folder as the installation script and the agentInstaller.jar file.
      • If you are using JBoss, WebSphere, or WebLogic application servers, and the server ID was not provided, it is automatically generated by the BMC Application Diagnostics Agent according to application server instance properties.
      • If you are using a Tomcat application server, a default instance ID is used. If you have more than one application server, you must either enter a unique instance ID for each application server, or install a dedicated BMC Application Diagnostics Agent for each Tomcat instance that you install in parallel with another application server on the same computer. You can view the default IDs in the logs located in <agent_installation_directory>/instances/default/logs.
  2. If your application server is using Java 2 security, set Java 2 security options for application servers that have Java 2 security enabled. See Granting-Java-2-permissions-to-the-Diagnostic-Agent.
  3. Restart the application server or JVM process.

Where to go from here

Verify that the installation of the BMC Application Diagnostics Agent for Java is successful.

Configure BMC Application Diagnostics Portal in BMC Application Management Console, if you haven't already done so.

Log on to the user and command-line interfaces

 

Tip: For faster searching, add an asterisk to the end of your partial query. Example: cert*