Installing the App Visibility server in the high-availability mode silently
Where you are in the Installation process
Step | Task |
---|---|
1 | Complete the planning activities |
2 | Prepare for TrueSight Operations Management installation |
3 | Install Remedy Single Sign-On |
4 | Install TrueSight Presentation Server |
5 | Install TrueSight Infrastructure Management (if licensed) |
6 | Install TrueSight App Visibility Manager — Phase A Task 1 (You are here) |
(Optional) Configure TrueSight App Visibility Manager for disaster recovery — Phase A Task 2 | |
Install TrueSight App Visibility Manager — Phase B | |
7 | Install Real End User Experience Monitoring Software Edition (If licensed) |
8 | Install TrueSight IT Data Analytics (If licensed) |
9 | Complete the post-installation activities |
The App Visibility server includes the following components:
- One pair of App Visibility portal nodes
- One or more pairs of App Visibility collector nodes
One or more App Visibility proxies
Note
The Proxy server can be used with multiple deployments (as a cluster) working together as a single entity.
The silent installation obtains the required user inputs from the adop-silent-option file, which is bundled along with the installer.
Installation of the App Visibility server consists of these tasks:
I. Setting options for the App Visibility portal
II. Setting options for the App Visibility collector
III. Setting options for the App Visibility proxy
IV. Installing the App Visibility server silently
To set options for silent installation of the App Visibility portal
Login to the host computer on which you want to install the app Visibility portal, and delete all the files from the temporary directory:
- (Windows) %temp%
- (Linux) /tmp
- Extract the downloaded files to a temporary directory.
- On the computer where you want to install the App Visibility portal, open the adop-silent-option file in edit mode.
Specify a valid installation directory. Ensure that the specified directory has no files or folders in it and that the directory path uses only ASCII characters.
-P installLocation=<directory>
<directory> is the installation location.
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.
- (Windows)
Under the Install Features section, add a hash character (#) before the server components that you do not want to install, so that only the portal component is indicated for installation.
# 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
Under the Portal Configuration section, enter the portal connection details.
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
The App Visibility portal must use the default value,
localhost
.portal_communication_port
Listening port of the App Visibility portal
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.
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 database
Parameter
Description
db_port Listening port of the App Visibility database
The default port is 8800.
db_retention_time
Number of days before 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 the portal database, 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.
To set up an HA environment, set
ha_enabled
totrue
and enter values for the current component and alternate component.The following example displays values for a portal in an HA environment.
-J ha_enabled=true -J ha_current_node_fqdn=myPortalA.bmc.com -J ha_alternate_node_fqdn=myPortalB.bmc.com -J ha_alternate_node_db_port=8800 -J ha_node_synchronization_port=5701
Parameter descriptions for the portal's alternate component
Parameter
Description
ha_enabled
Set to true to enable HA configuration for the portal.
The default value is
false
.ha_current_node_fqdn
FQDN of the current computer onto which you are installing the component.
ha_alternate_node_fqdn
FQDN of the alternate component's computer.
Note: The values for the Current Node FQDN and Alternate Node FQDN are case sensitive. Use only either an upper or lower case FQDN values.
ha_alternate_node_db_port
Database port of the alternate App Visibility portal.
The port must be the same number on the current and alternate nodes.
The default port is 8800.
ha_node_synchronization_port HA port that synchronizes data between the current and alternate nodes.
The port is dedicated for communication between nodes.
The port must be the same number on the current and alternate nodes.
The default port is 5701.
Save and close the options file.
Repeat steps 1 to 9 to install an App Visibility Portal secondary server.
After installing the Primary and Secondary App Visibility Portal 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 Portal HA.
To set options for silent installation of an App Visibility collector
- On the computer where you want to install the App Visibility collector, open the adop-silent-option file in edit mode.
Specify a valid installation directory.
Ensure that the specified directory has no files or folders in it and that the directory path uses only ASCII characters.
-P installLocation=<directory>
<directory> is the installation location.
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.
- (Windows)
Under the Install Features section, add a hash character (#) before the server components that you do not want to install, so that only the collector component is indicated for installation.
# 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
Under the Portal Configuration section, enter the details to connect to the portal.
Ensure that your firewall enables communication with the portal.
The default values are displayed below:
-J portal_ip=myPortalHost -J portal_communication_port=8100
Parameter descriptions for the portal configuration
Parameter
Description
portal_ip
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 a load balancing server manages access to the portal, enter the port number of the load balancer.
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 communication with the portal.
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.
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=
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 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 the historical data on the App Visibility collector database is deleted.
The default time is 35 days. The delete 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 the collector database, see Sizing App Visibility Manager and Synthetic TEA Agent components .
When the database reaches the maximum size, historical data is deleted, regardless of the value defined in the database retention time parameter.
To set up an HA environment, set
ha_enabled
totrue
and enter values for the current component and alternate component.The following example displays values for a collector in an HA environment.
-J ha_enabled=true -J ha_current_node_fqdn=myCollectorA.bmc.com -J ha_alternate_node_fqdn=myCollectorB.bmc.com -J ha_alternate_node_db_port=8800 -J ha_node_synchronization_port=5701
Parameter descriptions for the collector's alternate component
Parameter
Description
ha_enabled
Set to
true
to enable HA configuration for the collector.The default value is
false.
ha_current_node_fqdn
FQDN of the current computer onto which you are installing the component
ha_alternate_node_fqdn
FQDN of the alternate component's computer.
Note: The values for the Current Node FQDN and Alternate Node FQDN are case sensitive. Use only either an upper or lower case FQDN values.
ha_alternate_node_db_port
Database port of the alternate App Visibility collector
The port must be the same number on the current and alternate nodes.
The default port is 8800.
ha_node_synchronization_port HA port that synchronizes data between the current and alternate nodes
The port is dedicated for communication between nodes.
The port must be the same number on the current and alternate nodes.
The default port is 5701.
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 Save and close the options file.
- Repeat steps 1 to 10 to install an App Visibility collector secondary server.
To set options for silent installation of an App Visibility proxy
Note
The installation process includes several checks for connectivity to the App Visibility portal and to other App Visibility proxy servers and storage engines. The process cannot continue until the connectivity and cluster issues are resolved, unless you explicitly run the installation utility with a command to continue with such errors.
If you want to install the Proxy without testing connectivity (not recommended), run the installation utility from a command line with the -J continue_with_connectivity_error=true
parameter.
At your own risk, you will have to resolve connectivity and cluster issues after the installation process, and restart all the cluster nodes for the storage engines.
Encrypt a password to specify in the options file.
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 wizard interface or from the command-line interface (CLI).
To encrypt a password by using the Maintenance Tool wizard- To open the Maintenance Tool, go to the temporaryDirectory/Disk/utility directory where you downloaded the installation files.
- Run the ADOPServerMaintenanceTool utility and click the Encrypt tab.
- Enter your password in the Password and Confirm Password fields and click Encrypt.
- 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 theproxy_keystore_password_enc
parameter as follows:
-J
proxy_keystore_password_enc
=DES\:d70cbe3669602717ce66af37cce7ecf0
To encrypt a password by using a CLI- To open the Maintenance Tool, go to the temporaryDirectory\Disk\utility directory where you downloaded the installation files.
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>
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 theproxy_keystore_password_enc
parameter as follows:
-J
proxy_keystore_password_enc
=DES\:d70cbe3669602717ce66af37cce7ecf0
- On the computer where you want to install the App Visibility proxy, open the adop-silent-option file in edit mode.
Specify a valid installation directory.
Ensure that the specified directory has no files or folders in it and that the directory path uses only ASCII characters.
-P installLocation=<directory>
<directory> is the installation location.
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.
- (Windows)
Under the Install Features section, add a hash character (#) before the server components that you do not want to install, so that only the proxy component is indicated for installation.
# 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
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 your firewall enables communication with the portal from other components.
The default values are displayed below:
-J portal_ip=myPortalHost -J portal_communication_port=8100
Parameter descriptions for the portal configuration
Parameter
Description
portal_ip
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 a load balancing server manages access to the portal, enter the port number of the load balancer.
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_storage_http_port=8302
-J proxy_storage_transport_port=8303
-J proxy_beacon_receiver_http_port=8304
-J proxy_beacon_receiver_https_port=8305
-J proxy_storage_transport_ip=192.0.2.24
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_storage_http_port
Listening port of the App Visibility proxy database
The default port is 8302.
proxy_storage_transport_port Port for TCP communication between App Visibility proxy database nodes in a cluster
The default port is 8303.
proxy_beacon_receiver_http_port Listening port of the beacon receiver for HTTP communication from the end-user's browser
The default port is 8304.
proxy_beacon_receiver_https_port Listening port of the beacon receiver for HTTPS communication from the end-user's browser
The default port is 8305.
proxy_storage_transport_ip Used for communication between the different nodes in the storage cluster
The IP address must be available from other App Visibility proxy nodes.
If you do not provide a value, the default IP address is the first received by the system.
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 or replace the keystore after 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 keystoreParameter
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
orPKCS12
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: | ^ ; " < > ,
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 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.
Save and close the options file.
To install the App Visibility server silently
- In a command line window, navigate to the \ADOPServer\Disk1 folder in the installation file structure.
- 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
If the installation is successful, an indication is displayed in the command window.
To verify the App Visibility server installation
- Access the adopserver_install_log file:
(Windows) %temp%
(Linux) /tmp - Check for warnings or errors.
If no error messages are present, the installation was successful. According to what you installed, verify that the App Visibility server components are running:
- (Windows) Run services.msc and verify that the services are running:
For Collector and Portal- App Visibility Collector
- App Visibility Portal
- App Visibility PostgreSQL
- App Visibility Proxy
- App Visibility Elasticsearch
(Linux) Run the following commands to verify that the processes are running:
For Collector and Portal
ps -ea|grep adop_collectord
ps -ea|grep adop_portald
ps -ea|grep adop_apm_proxyd
For Proxy
ps -ea|grep av_pgsqld
ps -ea|grep apm_elasticsearch
- (Windows) Run services.msc and verify that the services are running:
Check for errors reported in the App Visibility log files in the following locations:
- Windows
- server_installationDirectory\collector\logs\collector.log
- server_installationDirectory\portal\logs\portal.log
- server_installationDirectory\apm-proxy\logs\apm-proxy.log
- Linux
- server_installationDirectory/collector/logs/collector.log
- server_installationDirectory/portal/logs/portal.log
server_installationDirectory/apm-proxy/logs/apm-proxy.log
Note
If a network port is occupied, the App Visibility server component stops, as reflected in the component log, but the log message does not give the reason.
- Windows
To configure the network settings
As the system administrator, configure your network to ensure that the App Visibility proxy can collect end-user browser data, and pass it on to the App Visibility collector and portal.
After you install the App Visibility server components, configure the following properties for the portal and the proxy:
- collectors.load.balancer.address. If the App Visibility portal and App Visibility collector are behind a load balancing or reverse proxy server, update the value of this property value to redirect App Visibility agent communication through the intermediary server and forward requests to the assigned App Visibility collectors. For instructions, see Changing App Visibility portal settings .
callback.address. If the App Visibility proxy that is behind a load balancing or reverse proxy server, update the value of this property to redirect end-user browser data through the intermediary server and forward requests to the App Visibility proxy. For instructions, see Changing App Visibility proxy settings.
Details about configuring load balancing servers varies among vendors. To properly configure your load balancing server, refer to your vendor's documentation.
Troubleshooting installation issues
If you face issues during installation, see Troubleshooting the App Visibility Manager deployment
Next step in the Installation process
Step 6 Phase B Task 1 — Now that you have successfully installed the App Visibility server, you must install the applicable App Visibility agent.
Comments
Log in or register to comment.