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.

Optionally, you can install with high-availability (HA) redundancy; see App Visibility Manager high-availability deployment. In an HA environment, you install a component on one computer, and its alternate component on an identical computer.

The App Visibility server includes the following components:

  • One App Visibility portal, or in an HA environment, one pair of App Visibility portal nodes
  • One or more App Visibility collectors, or in an HA environment, one or more pairs of App Visibility collector nodes
  • One or more App Visibility proxies

For a description about the function of each component, see Installing the App Visibility server components.

Perform the procedures in this topic 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). In a high-availability deployment, the portal and collector components are installed in pairs: one active node and standby node for the portal (each on a separate computer); one or more pairs of active and standby nodes for the collectors (each on a separate computer).

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

Note

If you have one or more App Visibility server components from an earlier version, upgrade the earlier components before you install new components.
  • Complete all preinstallation tasks .
  • (For proxy installation) The App Visibility proxy requires a Certificate Authority (CA)-signed certificate.
    The proxy uses SSL-encrypted beacons and injection requests and therefore you must have a keystore with a certificate that is trusted by end-users’ browsers. You can import the keystore during proxy installation or after installation.
    If your application web pages are only HTTP, then after installation, you can change the protocol of the JavaScript fetch API to work with HTTP, instead of the default HTTPS. With HTTP, you do not need to import a keystore file.
  • (For collector and proxy installation) You must have the host name or IP address, and the port number, of the portal.
  • (For portal and collector installation) Determine how much database space you need. For guidelines, see Sizing App Visibility Manager and Synthetic TEA Agent components.

For a high-availability environment

Before you install high-availability components for the App Visibility portal, collector, or both, set up the required third-party load balancing server or servers. When you install the App Visibility components, you must have the following information:

  • For portal installation
    • Fully qualified domain name (FQDN) and port number of the computer that has the alternate portal node
    • Database port that is used by the alternate portal node's App Visibility database
  • For collector installation
    • App Visibility portal load balancer host name or IP address, and port number
    • Fully qualified domain name (FQDN) and port number of the computer that has the alternate collector node
    • Database port that is used by the alternate collector node's App Visibility database
    • Host name or IP address, and the port number, of the HA load balancer that manages access to the collector pair
  • For proxy installation
    • App Visibility portal load balancer host name or IP address, and port number

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, open the 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 and that the directory path uses only ASCII characters.

    The following values are the default:

    • (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 or you might experience issues related to permissions and access.
  3. Under the Install Features section, add a hash tag (#) before any server component that you do not want to install, or before any 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

    Notes

    • Add a hash tag before a component that is already installed; otherwise, the installation fails.
    • To set up a high-availability environment, you must install each App Visibility server component on a separate computer.
  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.

    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.

    The default values are displayed below:

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

    Parameter descriptions for the portal configuration

    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.
      If a load balancing server manages access to the portal, enter the host name or IP address of the load balancer.

    portal_communication_port

    Listening port of the App Visibility portal

    If you are installing the App Visibility collector or the App Visibility proxy, and if a load balancing server manages access to the portal, enter the port number of the load balancer.

    The default port is 8100.

    portal_integration_supportability_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.

    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.

    The default values are displayed below:

    -J collector_communication_port=8200
    -J collector_supportability_port=8201
    

    Parameter descriptions for the collector configuration

    Parameter

    Description

    collector_communication_port

    Listening port of the App Visibility collector

    The default port is 8200.

    collector_supportability_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.

  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_supportability_port=8301
      -J proxy_beacon_receiver_http_port=880
      -J proxy_beacon_receiver_https_port=8444

      Parameter descriptions for the proxy configuration

      Parameter

      Description

      proxy_communication_port

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

      The default port is 8300.

      proxy_supportability_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 for HTTP communication from the end-user's browser

      The default port is 880.

      proxy_beacon_receiver_https_port

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

      The default port is 8444.

    • The 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_alias=
      -J proxy_keystore_password_enc=

      Parameter descriptions for the proxy keystore

      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

      One of the following keystore types: JKS or PKCS12

      proxy_keystore_path

      Full path to the keystore, which must be on a local drive, including the file name and file extension

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

      proxy_keystore_alias Keystore alias

      proxy_keystore_password_enc

      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 or proxy.

    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) Modify the parameter values under the Database Configuration section, as necessary.

    -J db_port=8800
    -J db_retention_time=35
    -J db_max_size=100

    Parameter descriptions for the portal or collector database

    Parameter

    Description

    db_port

    Listening port of the App Visibility database

    The default port is 8800.

    db_retention_time

    Number of days before which the historical data on the App Visibility component 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 Manager 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.

  9. (For portal or collector with high-availability installation) To set up a high-availability environment, set ha_enabled to true and enter values for the current component and alternate component.

    For information about high availability, see App Visibility Manager high-availability deployment.

    The following example displays values for a collector in a high-availability environment.

    -J ha_enabled=true
    -J ha_current_node_fqdn=myCollectorA.bmc.com
    -J ha_current_node_port=8202
    -J ha_alternate_node_fqdn=myCollectorB.bmc.com
    -J ha_alternate_node_port=8202
    -J ha_alternate_node_db_port=8800

    Parameter descriptions for the portal or collector's alternate component

    Parameter

    Description

    ha_enabled

    Setting to enable HA component configuration
    The default value is false.

    ha_current_node_fqdn

    FQDN of the current computer onto which you are installing the component

     

    ha_current_node_port

    HA control port of the current component

    The port is dedicated for communication between nodes.

    ha_alternate_node_fqdn

    FQDN of the alternate component's computer

    ha_alternate_node_port

    HA control port of the alternate component

    The port is dedicated for communication between nodes.

    ha_alternate_node_db_port

    Listening port that is used by the alternate component's App Visibility database

  10. (For collector, high-availability installation) Enter values for the load balancer that manages access to the collector: 

    -J ha_lb_host=myCollectorLoadBalancer
    -J ha_lb_port=2500

    Parameter descriptions for the collector's load balancer

    Parameter

    Description

    ha_lb_host

    Host name or IP address of the load balancing server that manages access to the collector

    ha_lb_port

    Listening port of the load balancing server that manage access to the collector pair
  11. Save and close the options file.

    Examples

    Silent settings without HA

    -P installLocation=C:\Program Files\BMC Software\App Visibility
    -A bmc_application_diagnostics_portal
    -A bmc_application_diagnostics_collector
    -A bmc_application_diagnostics_proxy
    -J portal_ip=localhost
    -J portal_communication_port=8100
    -J portal_integration_supportability_port=8101
    -J collector_communication_port=8200
    -J collector_supportability_port=8201
    -J db_retention_time=35
    -J db_max_size=100
    -J proxy_communication_port=8300
    -J proxy_supportability_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_alias=
    -J proxy_keystore_password_enc=
    -J callback_address=myAppVisibilityServer
    -J db_port=8800
    -J ha_enabled=false
    -J ha_current_node_fqdn=
    -J ha_current_node_port=8102
    -J ha_alternate_node_fqdn=
    -J ha_alternate_node_port=8102
    -J ha_alternate_node_db_port=8800
    -J ha_lb_host=
    -J ha_lb_port=

    Silent settings with HA

    -P installLocation=C:\Program Files\BMC Software\App Visibility
    #-A bmc_application_diagnostics_portal
    -A bmc_application_diagnostics_collector
    #-A bmc_application_diagnostics_proxy
    -J portal_ip=myAppVisibilityPortal
    -J portal_communication_port=8100
    -J portal_integration_supportability_port=8101
    -J collector_communication_port=8200
    -J collector_supportability_port=8201
    -J db_retention_time=35
    -J db_max_size=100
    -J proxy_communication_port=8300
    -J proxy_supportability_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_alias=
    -J proxy_keystore_password_enc=
    -J callback_address=myCollectorA.bmc.com
    -J db_port=8800
    -J ha_enabled=true
    -J ha_current_node_fqdn=myCollectorA.bmc.com
    -J ha_current_node_port=8202
    -J ha_alternate_node_fqdn=myCollectorB.bmc.com
    -J ha_alternate_node_port=8202
    -J ha_alternate_node_db_port=8800
    -J ha_lb_host=myCollectorLoadBalancer
    -J ha_lb_port=2500

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
  3. (Optional: Only for a HA setup) Repeat the above steps to install a secondary or standby App Visibility server.
  4. (Optional: Only for a HA setup) After you install the Primary and Secondary App Visibility servers, you must configure the Load Balancer. 
    For the steps to configure a Load Balancer, you must contact your local Load Balancer administrator and provide the active and standby node details of the App Visibility server HA.

Notes

  • If the installation fails, you must run the uninstallation process 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/utility 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\utility directory where you downloaded the installation files.
  2. Run the following command, entering your password for the -password and -confirm_password options:

    • Windows

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

      ./ADOPServerMaintenanceTool.sh -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.

(For high availability) Follow the installation instructions again to install the alternate node for HA components. After both nodes are installed, configure the components in the load balancer.

(For App Visibility proxy) Import the KeyStore for after installation for the App Visibility proxy. If your application web pages are only HTTP, you can  change the protocol to work with HTTP, instead of the default HTTPS. With HTTP, you do not need to import a keystore file.

Install agents:

Add the App Visibility portal to the TrueSight Console.

Related topics

App Visibility installation process overview

App Visibility Manager high-availability deployment

TrueSight Operations Management architecture

 

1 Comment

  1.