Page tree
Skip to end of metadata
Go to start of metadata

You can install the App Visibility server unattended (also called a silent installation). A silent installation, as described in this topic, requires no user interaction during installation. Alternatively, you can use the installation wizard.

The App Visibility server includes the following components:

  • One App Visibility portal component
  • One or more App Visibility collector components
  • One or more App Visibility proxy components

For details about the components, see Installing the App Visibility server components.

Perform the following procedures to install the App Visibility server components. For a very small environment or a test environment, you can install the portal, one collector, and one proxy on the same computer. When the App Visibility portal and collector components are installed on the same computer, they share the same database.

For most production environments, you install one App Visibility portal on one computer, several App Visibility collectors (each on a separate computer), and App Visibility proxies on separate computers that are in the network's demilitarized zone (DMZ).

The following files are used to configure the silent installation of App Visibility server:

  • (Windows) adop-silent-option.txt
  • (Linux) adop-silent-option

These files are located in the \ADOPServer\Disk1 folder in the installation file structure.

This topic presents the following sections:

Before you begin

Ensure that you have completed all preinstallation tasks.

The App Visibility proxy uses SSL-encrypted beacons and injection requests and therefore requires a KeyStore with a certificate that is trusted by the end users’ browsers. You can import the KeyStore during proxy installation or after installation.

Note

If you have one or more App Visibility server components from an earlier version, and you want to add server components to the same computer, upgrade the earlier components before you install new components.

If the KeyStore requires a password, prepare an encrypted password with the Maintenance Tool.

To set up the silent App Visibility server installation options file

  1. On the computer where you want to install one or more App Visibility server components, use a command line to open the relevant adop-silent-option file in edit mode.
  2. Specify a valid installation directory for the App Visibility server:

    -P installLocation=<directory>

    <directory> is the installation location. Ensure that the specified directory is empty.

    The following settings contain the default values:

    • (Windows) -P installLocation=C:\Program Files\BMC Software\App Visibility 
    • (Linux) -P installLocation=/opt/bmc/App_Visibility

      Best practice

      On Linux computers, use the default installation directory. Otherwise, you might experience issues related to permissions and access.
  3. Under the Install Features section, add a hash tag (#) before a server component that you do not want to install, or before a component that is already installed.

    # Install App Visibility Portal
    -A bmc_application_diagnostics_portal
    # Install App Visibility Collector
    -A bmc_application_diagnostics_collector
    # Install App Visibility Proxy
    -A bmc_application_diagnostics_proxy

    Note

    Ensure that you add a hash tag before a component that is already installed; otherwise, the installation fails.

  4. Under the Portal Configuration section, enter the details to connect to the portal.

    You must provide App Visibility portal configuration details, even if you are not currently installing the portal component.

    If required, modify the port numbers. Ensure that the App Visibility portal ports are available and can receive communication from the App Visibility agents. Specifically, ensure that your firewall enables this communication.

    -J portal_ip=localhost
    -J portal_communication_port=8100
    -J portal_support_port=8101
    

    Portal configuration parameter descriptions

    Parameter

    Description

    portal_ip

    IP address or host name of the App Visibility portal

    The default value is localhost.

    If you are installing the App Visibility portal, the value must be localhost.
    If you are installing the App Visibility collector or the App Visibility proxy (without the App Visibility portal on the same computer), enter the host name or IP address of the portal.

    portal_communication_port

    Listening port of the App Visibility portal

    The default port is 8100.

    portal_support_port

    Listening port of the portal support console. A support console to help detect issues is automatically activated with one-way SSL authentication.

    The default port is 8101.

  5. (For collector installation)  Modify the parameter values under the Collector Configuration section, as necessary.
    • If required, modify the port numbers for the relevant communication protocol. Ensure that the App Visibility collector ports are available and can receive communication from the App Visibility agents. Specifically, ensure that your firewall enables this communication.

      -J collector_communication_port=8200
      -J collector_support_port=8201
      

      Collector configuration parameter descriptions

      Parameter

      Description

      collector_communication_port

      Listening port of the App Visibility collector

      The default port is 8200.

      collector_support_port

      Listening port of the collector support console. A support console to help detect issues is automatically activated with one-way SSL authentication.

      The default port is 8201.

    • (For portal or collector installation) Modify the database retention period (days), and database size (GB):

      -J db_retention_time=35
      -J db_max_size=100

      Portal or Collector database parameter descriptions

      Parameter

      Description

      db_retention_time

      Number of days before which the historical data on the App Visibility collector database is overwritten.

      The default time is 35 days. The overwrite function launches automatically when the system reaches the specified retention time.

      db_max_size

      Maximum disk space allowed for data storage.

      The default size is 100 GB. For information about sizing considerations for components installed on the server, see Sizing App Visibility and Synthetic TEA Agent components.

      When the database reaches the maximum size, historical data is overwritten, regardless of the value defined in the database retention time parameter.

  6. (For proxy installation) Modify the parameter values under the Proxy Configuration section, as necessary.

    • If required, modify the port numbers for the relevant communication protocol. Ensure that the port numbers are available.

      -J proxy_communication_port=8300
      -J proxy_support_port=8301
      -J proxy_beacon_receiver_http_port=880
      -J proxy_beacon_receiver_https_port=8444

      Proxy configuration parameter descriptions

      Parameter

      Description

      proxy_communication_port

      Listening port of the proxy, communication from the portal and collector

      The default port is 8300.

      proxy_support_port

      Listening port of the proxy support console. A support console to help detect issues is automatically activated with one-way SSL authentication.

      The default port is 8301.

      proxy_beacon_receiver_http_port

      Listening port of the beacon receiver, HTTP communication from the end-user's browser

      The default port is 880.

      proxy_beacon_receiver_https_port

      Listening port of the beacon receiver, HTTPS communication from the end-user's browser

      The default port is 8444.

       

      App Visibility proxy requires a security certificate for use with SSL-encrypted beacons and injected requests. You can provide the location of the KeyStore file now, or you can import the KeyStore post-installation.

      -J import_proxy_keystore_now=false
      -J proxy_keystore_type=
      -J proxy_keystore_path=
      -J proxy_keystore_password_enc=

      KeyStore parameter descriptions

      Parameter

      Description

      import_proxy_keystore_now

      If false (default), import the KeyStore post-installation.

      To import the KeyStore file now, set to true and provide values for the other parameters.

      proxy_keystore_type

      Enter one of the following KeyStore types: JKS or PKCS12

      proxy_keystore_path

      Enter the full path to the KeyStore, which must be on a local drive.

      If the path has spaces, enclose it with quotation marks.

      proxy_keystore_password_enc

      Enter an encrypted password, if one exists, from the Maintenance Tool.

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

  7. (For collector or proxy installation) Under the Address Configuration section, configure the listening address (host name or IP address) of the computer on which you are installing the App Visibility collector.

    The App Visibility components use this address to contact the computer on which you are installing.

    -J callback_address=

    Note

    Ensure that the address is accessible from other components. If you need to change the address after installation, see Changing App Visibility collector settings to change the callback.address property.

  8. (For portal or collector installation) Under the Database Configuration section, configure the database by entering a port number for the App Visibility database that is created during the installation process.

    If required, modify the port number for the relevant communication protocol. Ensure that the port numbers are available.The default port number is 8800.

    -J db_port=8800
  9. Save and close the options file.

Example

-J portal_communication_port=8100
-J portal_support_port=8101
-J collector_communication_port=8200
-J collector_support_port=8201
-J db_retention_time=35
-J db_max_size=100
-J proxy_communication_port=8300
-J proxy_support_port=8301
-J proxy_beacon_receiver_http_port=880
-J proxy_beacon_receiver_https_port=8444
-J import_proxy_keystore_now=false
-J proxy_keystore_type=
-J proxy_keystore_path=
-J proxy_keystore_password_enc=
-J callback_address=myAppVisibilityServer
-J db_port=8800

To install the App Visibility server silently

  1. In a command line window, navigate to the \ADOPServer\Disk1 folder in the installation file structure.
  2. Run the silent installation of the App Visibility server with the following command:
    • Windows

      setup.exe -i silent -DOPTIONS_FILE=<fullFilePath>\adop-silent-option.txt
    • Linux

      ./setup.bin -i silent -DOPTIONS_FILE=<fullFilePath>/adop-silent-option

Notes

  • If the installation fails, you must uninstall what has been installed before re-running the installation. For more information about the uninstall process, see Uninstalling the App Visibility server.
  • The App Visibility server log files are located in the following directories:
    • (Windows) %temp%\adopserver_install_log.txt
    • (Linux) /tmp/adopserver_install_log.txt

Encrypting a password for silent APM proxy installation

The Maintenance Tool enables you to create an encrypted password, which the Diagnostic Server requires for importing a KeyStore. You must use an encrypted password so that the KeyStore password is not exposed in the adop-silent-option file.

You can run the Maintenance Tool in a GUI or from the command line interface (CLI):

 To encrypt a password by using the Maintenance Tool GUI (click here to expand steps)
  1. To open the Maintenance Tool, go to the temporaryDirectory/Disk/utilities directory where you downloaded the installation files.
  2. Run the ADOPServerMaintenanceTool utility and click the Encrypt tab.
  3. Enter your password in the Password and Confirm Password fields and click Encrypt.
  4. Copy and paste the value from the Encrypted Password field to the adop-silent-option file for the proxy_keystore_password_enc parameter.
    For example, if the encrypted password output is DES\:d70cbe3669602717ce66af37cce7ecf0, modify the proxy_keystore_password_enc parameter as follows:
    -J proxy_keystore_password_enc=DES\:d70cbe3669602717ce66af37cce7ecf0
 To encrypt a password by using a CLI (click here to expand steps)
  1. To open the Maintenance Tool, go to the temporaryDirectory\Disk\utilities directory where you downloaded the installation files.
  2. Run the following command, entering your password for the -password and -confirm_password options:

    • Windows

      ADOPServerMaintenanceTool.exe -silent -encrypt -encrypt -password=<password> -confirm_password=<password>
    • Linux

      ./ADOPServerMaintenanceTool.bin -silent -encrypt -encrypt -password=<password> -confirm_password=<password>

     

    Note

    If the password contains special characters, use quotation marks. For example:

    • (Windows

      ADOPServerMaintenanceTool.exe -silent -encrypt -encrypt -password="<password>" -confirm_password="<password>"

    • (Linux

      ./ADOPServerMaintenanceTool.bin -silent -encrypt -encrypt -password="<password>" -confirm_password="<password>"

  3. Copy and paste the output to the adop-silent-option file for your silent installation.
    For example, if the encrypted password output is DES\:d70cbe3669602717ce66af37cce7ecf0, modify the proxy_keystore_password_enc parameter as follows:
    -J proxy_keystore_password_enc=DES\:d70cbe3669602717ce66af37cce7ecf0

Where to go from here

Verify that the App Visibility server installation is successful.

Change the App Visibility database default password.

If you did not import the KeyStore file during installation, import the KeyStore post-installation.

Configure network settings.

Install the App Visibility agent for Java.

Install the App Visibility agent for .NET.

Install the BMC Synthetic Transaction Execution Adapter (TEA) Agent

Add the App Visibility portal to the TrueSight Console.

Related topics

Importing a KeyStore file or replacing the certificate

App Visibility installation process overview

BMC TrueSight Operations Management architecture