Performing the Diagnostics Server installation

The BMC Application Diagnostics Server includes three components:

• One Application Diagnostics Portal component, which manages Diagnostics Collectors, the APM Proxy, and Diagnostics Agents, and collects relevant data to display in the Console. The application diagnostics environment uses only one Portal component.
• One or more Application Diagnostics Collector components, which communicates with one or more Diagnostics Agents and stores the information for the monitored application. The application diagnostics environment uses one or more Collector components. You can install the component on a computer that does not have a Diagnostics Portal installation.
• One APM Proxy (required for active end-user monitoring only), receives and processes end-user experience data. To collect end-user metrics with the APM mode, you must install the APM Proxy. The application diagnostics environment uses only one APM Proxycomponent and you can install it on a computer that does not have a Diagnostics Portal installation.

   

Perform this procedure to install all the Diagnostics Server components on one computer, for a small environment, or each component on separate computers, such as for larger environments with several Diagnostics Collectors. When the Diagnostics Portal and Collector components are installed on the same computer, they share the same database.

You can use the installation wizard, as described in this topic, or perform a silent installation.

Before you begin

If you are installing the APM Proxy, you must have a KeyStore certificate and its password in clear text.

To install the Diagnostics Server

1. On the computer where you want to install one or more Diagnostics Server components, launch the installation wizard:

   • Windows

     Navigate to ADOPServer\Disk1 and double-click setup.cmd. In Windows 2008, the system may require you to right-click the setup.cmd icon to select to Run as administrator.

   • Linux
     
     1. Ensure that you have set the DISPLAY environment variable.
     2. Navigate to ADOPServer/Disk1 and run setup.sh.
2. In the Diagnostics Server Installer Welcome page, click Next.
3. On the License Agreement page, read the agreement and select the I agree to the terms of the license agreement option, and then click Next. If you do not agree to the terms of the license agreement, the installation process will end.

4. Select the Diagnostics Server component or components that you want to install, and then click Next:

   • Application Diagnostics Portal

   • Application Diagnostics Collector 

   • APM Proxy

   Note

   Installation configuration pages are displayed only for the selected component or components.

5. On the Directory Selection page, the system displays the available space on the current drive and the amount of space required.

   In the Destination Directory box, enter the path for the installation directory or click Browse to select a directory, and then click Next.

   Ensure that the directory is empty.

   • Windows

     Default directory: C:\Program Files\BMC Software\BMC Application Diagnostics

   • Linux

     Default directory: /opt/bmc/BMC_Application_Diagnostics
     
     

     Recommendation

     On Linux computers, BMC recommends using the default installation directory. Otherwise, you might experience issues related to permissions and access.

6. (For Portal installation) On the Portal Configuration page, define the following options, and then click Next.
   Ensure that the port you enter is available.

   Section	Options and descriptions
   Connection Security Level	Security option for communication between the application diagnostics components (Portal, Collector, Proxy, and Agent).  HTTP: Communication protocol is HTTP HTTPS: Communication protocol is authenticated and encrypted HTTPS See Securing the BMC Application Diagnostics components for information about security levels and certificates.
   Portal Connection	Listening ports of the Diagnostics Portal: HTTP Listening Port: The default port is 8100. HTTPS Listening Port: The default port is 8143.
   APM Console Connection	(Optional) If you are integrating BMC Application Diagnostics with other products, configure the connection to the BMC Application Management Console. The configuration enables links from products (such as Real User Analyzer or BMC ProactiveNet) that are integrated with BMC Application Diagnostics to link to Console. APM Console Host: BMC Application Management Console host name APM Console HTTPS Port: BMC Application Management Console listening port. The default port is 443. To enter the required information post-installation, see the "Configuring the BMC Application Management Console for integrations" section in the Enabling and activating integrations with BMC Application Diagnostics topic.

7. (For Collector installation) On the Collector Configuration page, provide the following system connection information and then click Next.
   Ensure that the port you enter is available.

   Option	Description
   HTTP Listening Port	HTTP listening port of the Collector. The default port is 8200.
   HTTPS Listening Port	HTTPS listening port of the Collector. The default port is 8243.

8. (For Collector installation) If you are installing the Diagnostics Collector on a computer that does not have a Diagnostics Portal installation, the Diagnostics Portal connection information is required.

    Click here to expand.

   Option	Description
   Portal Host or IP	Portal host name or IP address
   Portal Port	Listening port of the Portal (Enter the same port number that you entered in Portal configuration steps.)
   Use HTTPS	Portal security level (Select this option only if Portal security level is HTTPS.)

   Click Test Connection to check communication with the Portal.

9. (For APM Proxy installation) On the Proxy Configuration page, provide the following port numbers and then click Next.
   Ensure that the port you enter is available.

   Option	Description
   Proxy HTTP Port	HTTP listening port of the Proxy. The default port is 8300.
   Proxy HTTPS Port	HTTPS listening port of the Proxy. The default port is 8343.
   Proxy Beacon Receiver Port	Listening port of the beacon receiver. The default port is 8344.

10. (For APM Proxy installation) On the Proxy KeyStore Configuration page, choose an import option:

    • Import the KeyStore file now:

      1. Ensure that Import KeyStore file now is selected.

      2. Select the KeyStore type, JKS or PKCS12.

      3. Enter the KeyStore password, if one exists.

         The KeyStore password cannot contain the following characters: | ^ ; " < > ,

      4. Enter the full path or browse to the location of the KeyStore file.

      5. Click Next.

    • Import the KeyStore post-installation.

11. (For APM Proxy installation) If you are installing the APM Proxy on a computer that does not have a Diagnostics Portal installation, the Diagnostics Portal connection information is required.

     Click here to expand.

    Option	Description
    Portal Host or IP	Portal host name or IP address
    Portal Port	Listening port of the Portal (Enter the same port number that you entered in Portal configuration steps.)
    Use HTTPS	Portal security level (Select this option only if Portal security level is HTTPS.)

    Click Test Connection to check communication with the Portal.

12. On the Listening Address Configuration page, confirm the address of the computer on which you are installing the Diagnostics Server component or components.You can either accept the default address that is received from the operating system, or change the default address to the host name or IP address of the computer on which you are installing. The application diagnostics components use this address to connect to the computer on which you are installing.

    Note

    Ensure that the address is accessible from other components. If you need to change the address after installation, see Changing Diagnostics Portal settings.

13. (For Portal or Collector installation) On the Database Setup page, enter the database port number.
    The default port is 3301. A new database is created under the installationDirectory\ADOP_DB directory.

14. (For Portal or Collector installation) Enter the following values in the Database Configuration page.

    Option	Description
    Database Retention Time (days)	Number of days before which the historical data on the BMC Application Diagnostics Collector database is overwritten. The default time is 35 days. The overwrite function is automatically launched when the system reaches the specified retention time.
    Database Max Size (GB)	Maximum disk space allowed for database use. The default size is 100 GB. For information about sizing considerations for all software installed on the server, see Sizing the Application Diagnostics Server components. When the database reaches the maximum size, historical data will be overwritten regardless of the value defined in the database retention time parameter. Note: The wizard validates the space available on the installation directory and displays a validation error if there is insufficient space.

15. Verify that the information on the Installation Preview page reflects your installation correctly. Click Previous to make changes, or click Install.

16. After the installation is complete, click View Log to view the installation log files and confirm that the installation process was successful.
17. Click Done to exit the installation wizard.
18. (Optional) If the operating system's host name is incorrect or you want Diagnostics Server components to use an IP address to connect to one another, you must override the default host name configuration. The following links provide instructions:
    • Change the host name for communication with the Portal
    • Change the host name for communication with the Collector